hyperflask 0.2.3__tar.gz → 0.2.4__tar.gz

{hyperflask-0.2.3 → hyperflask-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperflask
-Version: 0.2.3
+Version: 0.2.4
 Summary: Full stack web framework
 Author: Maxime Bouroumeau-Fuseau
 Author-email: Maxime Bouroumeau-Fuseau <maxime.bouroumeau@gmail.com>

{hyperflask-0.2.3 → hyperflask-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hyperflask"
-version = "0.2.3"
+version = "0.2.4"
 description = "Full stack web framework"
 authors = [
     {"name" = "Maxime Bouroumeau-Fuseau", email = "maxime.bouroumeau@gmail.com"}

{hyperflask-0.2.3 → hyperflask-0.2.4}/src/hyperflask/app.py

@@ -28,7 +28,7 @@ from flask_debugtoolbar import DebugToolbarExtension
 # from hyperflask
 from .forms import Form
 from .utils.page_actions import page_action_url
-from .utils.htmx import htmx_oob
+from .utils.htmx import htmx_oob, respond_with_flash_messages
 from .utils.markdown import jinja_markdown, MarkdownExtension
 from .utils.html import sanitize_html, nl2br
 from .utils.models import File as SQLFileType
@@ -69,6 +69,8 @@ class Hyperflask(Flask):
             "OTEL_INSTRUMENT": instrument,
             "DRAMATIQ_BROKER": "dramatiq.brokers.redis:RedisBroker",
             "DEBUG_TB_INTERCEPT_REDIRECTS": False,
+            "SESSION_COOKIE_HTTPONLY": True,
+            "SESSION_COOKIE_SAMESITE": "Lax",
             # Hyperflask specific
             "LAYOUT": "layouts/default.html",
             "STATIC_MODE": static_mode,
@@ -76,7 +78,9 @@ class Hyperflask(Flask):
             "HTMX_EXT": ["hf-modal"],
             "HTMX_BOOST_SITE": False,
             "MARKDOWN_OPTIONS": {"extensions": ["fenced_code", "nl2br", "attr_list", "admonition", "codehilite"]},
-            "MARKDOWN_SANITIZER_CONFIG": {}
+            "MARKDOWN_SANITIZER_CONFIG": {},
+            "FLASH_TOAST_OOB": True,
+            "FLASH_TOAST_REMOVE_AFTER": None
         })
         if config:
             self.config.update(config)
@@ -95,6 +99,7 @@ class Hyperflask(Flask):
         self.jinja_env.add_extension(WtformExtension)
         self.jinja_env.add_extension(MarkdownExtension)
         self.jinja_env.filters.update(markdown=jinja_markdown, sanitize=sanitize_html, nl2br=nl2br)
+        self.jinja_env.globals.update(page_action_url=page_action_url, app=self)
         self.jinja_env.form_base_cls = Form
         self.jinja_env.default_layout = self.config["LAYOUT"]
         self.forms = self.jinja_env.forms
@@ -148,7 +153,6 @@ class Hyperflask(Flask):
         })
         self.assets.bundle(
             {"@hyperflask": ["app.js"],
-             "@hyperflask/reactive": ["reactive.js"],
              "@hyperflask/alpine": ["alpine.js"]},
             from_package="hyperflask",
             assets_folder="static"
@@ -175,7 +179,8 @@ class Hyperflask(Flask):
             for macro in self.macros.create_from_directory(os.path.join(self.root_path, forms_folder)):
                 self.forms.register(self.macros.resolve_template(macro), macro)
 
-        self.jinja_env.globals.update(page_action_url=page_action_url)
+        if self.config["FLASH_TOAST_OOB"]:
+            self.after_request(respond_with_flash_messages)
 
         self.collections.register_freezer_generator(self.freezer)
 

{hyperflask-0.2.3 → hyperflask-0.2.4}/src/hyperflask/layouts/email.mjml

@@ -21,10 +21,10 @@
       </mj-style>
       {% endblock %}
     </mj-head>
-    <mj-body {% block body_tags %}background-color="{{config.get("EMAIL_BACKGROUND_COLOR", "#c8c8c8")}}" width="600px"{% endblock %}>
-      <mj-section full-width="full-width" background-color="{{config.get("EMAIL_BACKGROUND_ACCENT_COLOR", "#a6a6a6")}}" padding-bottom="0">
+    <mj-body {% block body_tags %}background-color="{{config.get("EMAIL_BACKGROUND_COLOR", "#ebebebff")}}" width="600px"{% endblock %}>
+      <mj-section full-width="full-width" background-color="{{config.get("EMAIL_BACKGROUND_ACCENT_COLOR", "#d1d1d1ff")}}" padding-bottom="0">
         <mj-column width="100%">
-          <mj-text color="#4d4d4d" font-weight="bold" align="center" font-size="16px" letter-spacing="1px">
+          <mj-text color="#474747ff" font-weight="bold" align="center" font-size="16px" letter-spacing="1px">
             {% block brand %}
               {{config.get("SITE_TITLE", "")}}
             {% endblock %}

{hyperflask-0.2.3 → hyperflask-0.2.4}/src/hyperflask/layouts/web.html

@@ -6,9 +6,6 @@
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         {% endblock %}
-        {% if config["PWA"] -%}
-        <link rel="manifest" href="{{url_for("pwa_manifest")}}" />
-        {%- endif %}
         {% block page_title %}<title>{% if page_title is defined %}{{ page_title }}{% if config.get("SITE_TITLE") %} | {% endif %}{% endif %}{% if config.get("SITE_TITLE") %}{{config["SITE_TITLE"]}}{% endif %}</title>{% endblock %}
         {% asset_tags %}
         {% block head_assets %}{% endblock %}
@@ -25,7 +22,7 @@
         {% block footer %}{% endblock %}
         {% block flash_messages %}
           {% autoescape false %} {# Jinja bug #}
-            <{FlashMessages}/>
+            <{FlashMessagesToast}/>
           {% endautoescape %}
         {% endblock %}
         {% block body_end %}{% endblock %}

{hyperflask-0.2.3 → hyperflask-0.2.4}/src/hyperflask/page_helpers.py

@@ -1,5 +1,5 @@
 from flask_file_routes import DEFAULT_HELPERS
-from flask import g, current_app
+from flask import current_app
 from .utils.page_actions import page_action
 
 
@@ -18,19 +18,11 @@ def form(page):
     return form_helper
 
 
-def stream(page):
-    g.__page_stream__ = True
-    return
-
-
 def action(page):
-    def decorator(func=None, name=None):
-        return page_action(func, name)
-    return decorator
+    return page_action
 
 
 DEFAULT_HELPERS.update(csrf_protect=csrf_protect,
                        forms=forms,
                        form=form,
-                       stream=stream,
-                       action=action)
+                       action=action)

hyperflask-0.2.4/src/hyperflask/static/app.js

@@ -0,0 +1,14 @@
+import htmx from "htmx.org";
+import "htmx-ext-sse";
+import "./htmx-exts";
+import "./app.css";
+
+const DEFAULT_HTMX_EXTS = ['hf-modal', 'hx-bottom-scroll-on-trigger', 'hx-active-url'];
+document.body.setAttribute('hx-ext', [document.body.getAttribute('hx-ext'), ...DEFAULT_HTMX_EXTS].filter(Boolean).join(","))
+
+window.htmx = htmx;
+export { htmx };
+
+if (window.Alpine) {
+    window.Alpine.start()
+}

hyperflask-0.2.4/src/hyperflask/static/htmx-exts.js

@@ -0,0 +1,107 @@
+import htmx from "htmx.org";
+
+(function () {
+  let triggerElement = false, enableTriggerElement;
+  htmx.defineExtension("hf-modal", {
+    getSelectors() {
+        return ['[hf-modal]'];
+    },
+    onEvent(name, evt) {
+      if (name === "htmx:beforeProcessNode" && evt.target.hasAttribute("hf-modal")) {
+        evt.target.setAttribute("hx-get", evt.target.getAttribute("hf-modal"));
+        evt.target.setAttribute("hx-target", "body");
+        evt.target.setAttribute("hx-swap", "beforeend");
+      } else if (name === "htmx:beforeRequest" && evt.target.hasAttribute("hf-modal")) {
+        triggerElement = evt.target;
+        enableTriggerElement = !evt.target.disabled;
+        evt.target.disabled = true;
+      } else if (name === "htmx:load" && triggerElement) {
+        if (evt.target.tagName === "DIALOG") {
+          evt.target.showModal();
+          const form = evt.target.querySelector("form[hf-modal-form]");
+          if (form) {
+            form.setAttribute("hx-target", "closest dialog");
+            form.setAttribute("hx-swap", "delete");
+            form.setAttribute("hx-disabled-elt", "this");
+            if (!form.hasAttribute("action")) {
+              form.setAttribute("action", triggerElement.getAttribute("hf-modal"));
+            }
+            setTimeout(() => {
+              form.querySelector("input:not([type=hidden])")?.focus();
+            }, 100);
+          }
+        }
+        if (enableTriggerElement) {
+          triggerElement.disabled = false;
+        }
+        triggerElement = null;
+      }
+    }
+  });
+})();
+
+htmx.defineExtension("hx-bottom-scroll-on-trigger", {
+  getSelectors() {
+      return ['[hx-bottom-scroll-on-trigger]'];
+  },
+  onEvent(name, evt) {
+    if (name === "htmx:afterProcessNode" && evt.target.hasAttribute("hx-bottom-scroll-on-trigger")) {
+        const elt = evt.target;
+        elt.scrollTop = elt.scrollHeight - elt.clientHeight;
+        elt.classList.add("at-bottom");
+        elt.addEventListener("scroll", (e) => {
+          if (e.target.scrollTop < e.target.scrollHeight - e.target.clientHeight - 20) {
+            e.target.classList.remove("at-bottom");
+          } else {
+            e.target.classList.add("at-bottom");
+          }
+        });
+        return;
+    }
+
+    const eventName = evt.target.getAttribute("hx-bottom-scroll-on-trigger");
+    if (name === eventName && evt.target.classList.contains("at-bottom")) {
+      evt.target.scrollTop = evt.target.scrollHeight - evt.target.clientHeight;
+    }
+  }
+});
+
+htmx.defineExtension("hx-active-url", {
+  init() {
+    function ensureLinksAreActive() {
+      const nodes = document.querySelectorAll('a[hx-active-url], [hx-active-url] a');
+      nodes.forEach((a) => {
+        let url;
+        for (const attr of ['hx-push-url', 'hx-replace-url', 'href', 'hx-get']) {
+          if (a.hasAttribute(attr)) {
+            if (attr !== "href" && a.getAttribute(attr) === "true") {
+              url = new URL(a.getAttribute('hx-get'), window.location.origin);
+            } else {
+              url = new URL(a.getAttribute(attr), window.location.origin);
+            }
+            break;
+          }
+        }
+        if (!url) return;
+        const activeClass = a.closest("[hx-active-url]")?.getAttribute("hx-active-url");
+        if (!activeClass) return;
+        if (url.pathname === window.location.pathname && url.search === window.location.search) {
+          a.classList.add(activeClass);
+        } else {
+          a.classList.remove(activeClass);
+        }
+      });
+    }
+    document.addEventListener('DOMContentLoaded', ensureLinksAreActive);
+    document.addEventListener("htmx:pushedIntoHistory", ensureLinksAreActive);
+  },
+  getSelectors() {
+      return ['[hx-href]'];
+  },
+  onEvent(name, evt) {
+    if (name === "htmx:beforeProcessNode" && evt.target.hasAttribute("hx-href")) {
+      evt.target.setAttribute('href', evt.target.getAttribute('hx-href'));
+      evt.target.setAttribute('hx-push-url', evt.target.getAttribute('hx-href'));
+    }
+  }
+});

hyperflask-0.2.4/src/hyperflask/ui/flash.html

@@ -0,0 +1,17 @@
+
+{% macro FlashMessages() -%}
+  {%- for category, message in get_flashed_messages(True) -%}
+    <{FlashMessage category=category}>{{message}}</{FlashMessage}>
+  {%- endfor -%}
+{%- endmacro %}
+
+{% macro FlashMessage(category="info") -%}
+  {%- set message = caller() -%}
+  <{Alert color=category class="flash-message" **kwargs }>{{message}}</{Alert}>
+{%- endmacro %}
+
+{% macro FlashMessagesToast() -%}
+  <{Toast id="flash-messages-toast" class="z-1000"}>
+    <{FlashMessages}/>
+  </{Toast}>
+{%- endmacro %}

hyperflask-0.2.4/src/hyperflask/ui/sse.html

@@ -0,0 +1,14 @@
+
+{% macro MercureStream(topic=None, private=True, hx_swap="beforeend", type=None, auto_scroll=False) -%}
+<div {% if topic %}hx-ext="sse" sse-connect="{{mercure_authentified_hub_url(topic) if private else mercure_hub_url(topic)}}"{% endif %}
+  sse-swap="{{mercure_topic(topic if topic and not type and app.extensions['mercure_sse'].type_is_topic else (type or 'message'))}}"
+  hx-swap="{{hx_swap}}" {% if auto_scroll %}hx-bottom-scroll-on-trigger="htmx:sseMessage"{% endif %} {{html_attrs(**kwargs)}}>
+    {{ caller() }}
+</div>
+{%- endmacro %}
+
+{% macro MercureStreamContext(topics, private=True) -%}
+<div hx-ext="sse" sse-connect="{{mercure_authentified_hub_url(topics) if private else mercure_hub_url(topic)}}" {{html_attrs(**kwargs)}}>
+    {{ caller() }}
+</div>
+{%- endmacro %}

hyperflask-0.2.4/src/hyperflask/utils/htmx.py

@@ -0,0 +1,64 @@
+from htmx_flask import request
+from htmx_flask import make_response
+from markupsafe import Markup
+from flask import get_flashed_messages, current_app, json
+import re
+
+
+def htmx_redirect(url):
+    return make_response(redirect=url)
+
+
+def htmx_oob(html, swap="outerHTML", target=None, wrap=True):
+    if not request.htmx:
+        return ""
+    if callable(html):
+        html = html()
+    swap_oob = f"{swap}:{target}" if target else swap
+    html = str(html).strip()
+    m = re.match(r'<([a-z\-0-9]+)', html, re.I)
+    if swap != "outerHTML" and wrap:
+        wrap_tag = wrap if wrap is not True else {"tr": "table", "li": "ul"}.get(m.group(1).lower() if m else None, "div")
+        html = f"<{wrap_tag} hx-swap-oob=\"{swap_oob}\">{html}</{wrap_tag}>"
+    elif m:
+        tag, html = html.split(" ", 1)
+        html = f"{tag} hx-swap-oob=\"{swap_oob}\" {html}"
+        if wrap and tag[1:].lower() in ("tr", "td", "th", "thead", "tbody", "tfoot", "colgroup", "caption", "col"):
+            html = f"<template>{html}</template>"
+    return Markup(html)
+
+
+def respond_with_htmx_oob(response, html, **kwargs):
+    response.set_data(htmx_oob(html, **kwargs) + response.get_data(as_text=True))
+    return response
+
+
+def add_hx_trigger(response, event, data=None):
+    if "HX-Trigger" not in response.headers:
+        trigger = json.dumps({event: data}) if data is not None else event
+        response.headers["HX-Trigger"] = trigger
+        return response
+
+    trigger = response.headers["HX-Trigger"]
+    if trigger.startswith("{"):
+        trigger = json.loads(trigger)
+    else:
+        trigger = {trigger: None}
+    trigger[event] = data
+    response.headers["HX-Trigger"] = trigger
+    return response
+
+
+def respond_with_flash_messages(response, only_if_htmx=True, target="#flash-messages-toast"):
+    if only_if_htmx and not request.htmx:
+        return response
+
+    messages = []
+    for category, message in get_flashed_messages(with_categories=True):
+        props = {"category": category, "caller": lambda: message}
+        if current_app.config["FLASH_TOAST_REMOVE_AFTER"]:
+            props["remove-me"] = current_app.config["FLASH_TOAST_REMOVE_AFTER"]
+        messages.append(htmx_oob(current_app.macros.FlashMessage(**props), swap="beforestart", target=target))
+
+    response.set_data("\n".join(messages) + response.get_data(as_text=True))
+    return response

hyperflask-0.2.3/src/hyperflask/reactivity.py

@@ -1,52 +0,0 @@
-from jinja2.ext import Extension
-from jinja_super_macros import html_tag
-from flask import current_app
-from flask_mercure_sse import mercure_hub_url
-from markupsafe import Markup
-from collections import namedtuple
-
-
-ReactiveInfo = namedtuple("ReactiveInfo", ["topic", "events", "render", "html_attrs", "tagname"], defaults=[None, None, None, "hf-reactive"])
-
-
-def reactive(obj, attr=None):
-    if attr and hasattr(getattr(obj, attr), "__reactive__"):
-        obj = getattr(obj, attr)
-        attr = None
-    elif not hasattr(obj, "__reactive__"):
-        return getattr(obj, attr) if attr else obj
-    info = ReactiveInfo(*obj.__reactive__(attr))
-    return render_reactive(info, getattr(obj, attr) if attr else obj)
-
-
-def render_reactive(info, default_value=""):
-    html_attrs = info.html_attrs or {}
-    html_attrs.setdefault("mercure-url", mercure_hub_url())
-    if info.topic:
-        html_attrs.setdefault("topic", info.topic)
-    if info.events:
-        html_attrs.setdefault("events", ",".join(info.events))
-    return html_tag(info.tagname, html_attrs) + (info.render() if info.render else default_value) + Markup(f"</{info.tagname}>")
-
-
-class ReactiveExtension(Extension):
-    def __init__(self, environment):
-        super().__init__(environment)
-        environment.globals["reactive"] = reactive
-
-    def preprocess(self, source, name, filename=None):
-        pos = source.find("{!")
-        while pos >= 0:
-            end = source.find("!}", pos)
-            if end < 0:
-                raise Exception("Missing closing bracket for reactive")
-            value = source[pos + 2:end]
-            if "." in value:
-                obj, attr = value.rsplit(".", 1)
-                args = [obj, f'"{attr}"']
-            else:
-                args = [value]
-            replacement = "{{ reactive(" + ", ".join(args) + ") }}"
-            source = source[:pos] + replacement + source[end + 2:]
-            pos = source.find("{!", pos + len(replacement) + 2)
-        return source

hyperflask-0.2.3/src/hyperflask/static/app.js

@@ -1,47 +0,0 @@
-import htmx from "htmx.org";
-import 'htmx-ext-sse';
-import "./app.css";
-
-(function() {
-  let triggerElement = false, enableTriggerElement;
-  htmx.defineExtension("hf-modal", {
-    getSelectors: function() {
-        return ['[hf-modal]'];
-    },
-    onEvent: function(name, evt) {
-      if (name === "htmx:beforeProcessNode" && evt.target.hasAttribute("hf-modal")) {
-        evt.target.setAttribute("hx-get", evt.target.getAttribute("hf-modal"));
-        evt.target.setAttribute("hx-target", "body");
-        evt.target.setAttribute("hx-swap", "beforeend");
-      } else if (name === "htmx:beforeRequest" && evt.target.hasAttribute("hf-modal")) {
-        triggerElement = evt.target;
-        enableTriggerElement = !evt.target.disabled;
-        evt.target.disabled = true;
-      } else if (name === "htmx:load" && triggerElement) {
-        if (evt.target.tagName === "DIALOG") {
-          evt.target.showModal();
-          const form = evt.target.querySelector("form[hf-modal-form]");
-          if (form) {
-            form.setAttribute("hx-target", "closest dialog");
-            form.setAttribute("hx-swap", "delete");
-            form.setAttribute("hx-disabled-elt", "this");
-            if (!form.hasAttribute("action")) {
-              form.setAttribute("action", triggerElement.getAttribute("hf-modal"));
-            }
-          }
-        }
-        if (enableTriggerElement) {
-          triggerElement.disabled = false;
-        }
-        triggerElement = null;
-      }
-    }
-  });
-})();
-
-window.htmx = htmx;
-export { htmx };
-
-if (window.Alpine) {
-    window.Alpine.start()
-}

hyperflask-0.2.3/src/hyperflask/static/reactive.js

@@ -1,39 +0,0 @@
-
-class HyperflaskReactive extends HTMLElement {
-  connectedCallback() {
-    const swap = this.getAttribute('swap');
-    const prop = this.getAttribute('prop');
-    const escape = this.getAttribute('escape') !== null;
-    const url = new URL(this.getAttribute('mercure-url'));
-    url.searchParams.append('topic', this.getAttribute('topic'));
-    this.eventSource = new EventSource(url);
-    const listener = (event) => {
-      let data = event.data;
-      if (prop) {
-        data = JSON.parse(data)[prop];
-      }
-      if (swap && swap != 'innerHTML') {
-        this[escape ? 'insertAdjacentText' : 'insertAdjacentHTML'](swap, data);
-      } else {
-        this[escape ? 'innerText' : 'innerHTML'] = data;
-        window.htmx.process(this);
-      }
-    };
-    const events = this.getAttribute('events');
-    if (events) {
-      events.split(' ').forEach(event => {
-        this.eventSource.addEventListener(event, listener);
-      });
-    } else {
-      this.eventSource.onmessage = listener;
-    }
-  }
-
-  disconnectedCallback() {
-    this.eventSource.close();
-  }
-}
-
-if (!customElements.get('hf-reactive')) {
-  customElements.define('hf-reactive', HyperflaskReactive);
-}

hyperflask-0.2.3/src/hyperflask/ui/flash.html

@@ -1,8 +0,0 @@
-
-{% macro FlashMessages() -%}
-  <{Toast id="flash-messages"}>
-    {% for category, message in get_flashed_messages(True) %}
-      <{Alert color=category}>{{message}}</{Alert}>
-    {% endfor %}
-  </{Toast}>
-{%- endmacro %}

hyperflask-0.2.3/src/hyperflask/ui/sse.html

@@ -1,6 +0,0 @@
-
-{% macro MercureStream(topic, private=True, hx_swap="beforeend", type="message") -%}
-<div hx-ext="sse" sse-connect="{{mercure_authentified_hub_url(topic) if private else mercure_hub_url(topic)}}" sse-swap="{{type}}" hx-swap="{{hx_swap}}" {{html_attrs(**kwargs)}}>
-    {{ caller() }}
-</div>
-{%- endmacro %}

hyperflask-0.2.3/src/hyperflask/utils/htmx.py

@@ -1,27 +0,0 @@
-from htmx_flask import request
-from htmx_flask import make_response
-from markupsafe import Markup
-import re
-
-
-def htmx_redirect(url):
-    return make_response(redirect=url)
-
-
-def htmx_oob(html, swap="outerHTML", target=None, wrap=True):
-    if not request.htmx:
-        return ""
-    if callable(html):
-        html = html()
-    swap_oob = f"{swap}:{target}" if target else swap
-    html = str(html).strip()
-    m = re.match(r'<([a-z\-0-9]+)', html, re.I)
-    if swap != "outerHTML" and wrap:
-        wrap_tag = wrap if wrap is not True else {"tr": "table", "li": "ul"}.get(m.group(1).lower() if m else None, "div")
-        html = f"<{wrap_tag} hx-swap-oob=\"{swap_oob}\">{html}</{wrap_tag}>"
-    elif m:
-        tag, html = html.split(" ", 1)
-        html = f"{tag} hx-swap-oob=\"{swap_oob}\" {html}"
-        if wrap and tag[1:].lower() in ("tr", "td", "th", "thead", "tbody", "tfoot", "colgroup", "caption", "col"):
-            html = f"<template>{html}</template>"
-    return Markup(html)

hyperflask-0.2.3/src/hyperflask/utils/s3.py

@@ -1,4 +0,0 @@
-
-
-def create_upload_url():
-    pass