hyperflask 0.4.2__tar.gz → 0.4.4__tar.gz

{hyperflask-0.4.2 → hyperflask-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperflask
-Version: 0.4.2
+Version: 0.4.4
 Summary: Full stack web framework
 Author: Maxime Bouroumeau-Fuseau
 Author-email: Maxime Bouroumeau-Fuseau <maxime.bouroumeau@gmail.com>
@@ -8,7 +8,7 @@ License-Expression: MIT
 Requires-Dist: flask>=3.0.0,<4.0.0
 Requires-Dist: flask-assets-pipeline~=0.7
 Requires-Dist: flask-babel-hyper~=5.1
-Requires-Dist: flask-collections~=0.2
+Requires-Dist: flask-collections~=0.3
 Requires-Dist: flask-configurator~=0.1
 Requires-Dist: flask-debugtoolbar~=0.16
 Requires-Dist: flask-file-routes~=0.3

{hyperflask-0.4.2 → hyperflask-0.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hyperflask"
-version = "0.4.2"
+version = "0.4.4"
 description = "Full stack web framework"
 authors = [
     {"name" = "Maxime Bouroumeau-Fuseau", email = "maxime.bouroumeau@gmail.com"}
@@ -12,7 +12,7 @@ dependencies = [
     "flask>=3.0.0,<4.0.0",
     "flask-assets-pipeline ~=0.7",
     "flask-babel-hyper ~=5.1",
-    "flask-collections ~=0.2",
+    "flask-collections ~=0.3",
     "flask-configurator ~=0.1",
     "flask-debugtoolbar ~=0.16",
     "flask-file-routes ~=0.3",

{hyperflask-0.4.2 → hyperflask-0.4.4}/src/hyperflask/__init__.py

@@ -1,6 +1,7 @@
 from flask import *
 from .app import Hyperflask
 from .utils.htmx import htmx_redirect, htmx_oob
+from .utils.freezer import StaticMode, static, dynamic
 from .security import csp_nonce
 
 # useful exports from hyperflask managed extensions

{hyperflask-0.4.2 → hyperflask-0.4.4}/src/hyperflask/app.py

@@ -20,7 +20,6 @@ from flask_suspense import Suspense, render_template, suspense_before_render_tem
 #from flask_observability import Observability
 # 3rd party extensions
 from flask_wtf.csrf import CSRFProtect
-from flask_frozen import Freezer
 from htmx_flask import Htmx
 from flask_mailman import Mail
 from flask_debugtoolbar import DebugToolbarExtension
@@ -31,6 +30,7 @@ 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.metadata import metadata_tags
+from .utils.freezer import StaticMode, Freezer, freezer_url_generator
 from .components import register_components
 from .model import Model, File as SQLFileType, UndefinedDatabase
 from .actors import AppContextMiddleware, discover_broker, make_actor_decorator
@@ -41,7 +41,6 @@ from jinja_super_macros.registry import FileLoader
 from jinja_wtforms.extractor import map_jinja_call_node_to_func
 from sqlorm.sql_template import SQLTemplate
 from periodiq import PeriodiqMiddleware
-import dramatiq
 import os
 
 
@@ -55,7 +54,7 @@ map_jinja_call_node_to_func(lazy_gettext, "lazy_gettext")
 class Hyperflask(Flask):
     config_class = Config
 
-    def __init__(self, *args, static_mode="hybrid", instrument=False, layouts_folder="layouts",
+    def __init__(self, *args, static_mode=StaticMode.DYNAMIC, instrument=False, layouts_folder="layouts",
                  emails_folder="emails", forms_folder="forms", assets_folder="assets", pages_folder="pages", migrations_folder="migrations",
                  config=None, config_filename="config.yml", database_uri=None, proxy_fix=True, **kwargs):
 
@@ -64,8 +63,12 @@ class Hyperflask(Flask):
             self.wsgi_app = ProxyFix(self.wsgi_app, x_for=1, x_proto=1, x_host=1, x_prefix=1)
 
         self.config.update({
-            "FREEZER_DESTINATION": os.path.join(self.root_path, "_site"),
+            "FREEZER_DESTINATION": "_site",
             "FREEZER_STATIC_IGNORE": [],
+            "FREEZER_IGNORE_404_NOT_FOUND": True,
+            "FREEZER_IGNORE_MIMETYPE_WARNINGS": True,
+            "FREEZER_REDIRECT_POLICY": "ignore",
+            "FREEZER_DEFAULT_FILE_EXTENSION": "html",
             "WTF_CSRF_CHECK_DEFAULT": False,
             "OTEL_INSTRUMENT": instrument,
             "DEBUG_TB_INTERCEPT_REDIRECTS": False,
@@ -114,8 +117,9 @@ class Hyperflask(Flask):
             })
             self.config.setdefault("HSTS_HEADER", "max-age=31556926; includeSubDomains") # 1 year
 
-        if (self.config['URL_FOR_SERVER_NAME'] or self.config.get('SERVER_NAME')) and not self.config.get('MERCURE_HUB_URL') and not self.config.get('MERCURE_PUBLIC_HUB_URL'):
-            self.config['MERCURE_PUBLIC_HUB_URL'] = True
+        if not self.debug and not self.testing and not self.config.get('MERCURE_HUB_URL'):
+            self.config['MERCURE_HUB_URL'] = "http://localhost:5300/.well-known/mercure"
+            self.config.setdefault('MERCURE_PUBLIC_HUB_URL', True)
 
         #self.otel = Observability(self)
 
@@ -139,7 +143,7 @@ class Hyperflask(Flask):
         ])
 
         DebugToolbarExtension(self)
-        self.freezer = Freezer(self, with_no_argument_rules=False)
+        self.freezer = Freezer(self, with_no_argument_rules=False, log_url_for=self.config.get('FREEZER_LOG_URL_FOR', False))
         self.freezer.register_generator(lambda: freezer_url_generator(self))
         self.csrf = CSRFProtect(self)
         Htmx(self)
@@ -285,21 +289,3 @@ class HyperModuleView(ModuleView):
 
     def _render_template(self):
         return render_template(page.template)
-
-
-def static(func):
-    pass
-
-
-def dynamic(func=None, static_template=None):
-    def decorator(func):
-        pass
-    return decorator(func) if func else decorator
-
-
-def freezer_url_generator(app):
-    """URL generator for URL rules that take no arguments."""
-    for rule in app.url_map.iter_rules():
-        if not rule.arguments and 'GET' in rule.methods and not rule.endpoint.startswith('mercure'):
-            app.logger.info(rule.endpoint)
-            yield rule.endpoint, {}

{hyperflask-0.4.2 → hyperflask-0.4.4}/src/hyperflask/cli/__init__.py

@@ -4,6 +4,7 @@ from flask_assets_pipeline import cli as assets_cli
 import click
 from ..factory import create_app
 from ..security import generate_csp_policy
+from ..utils.freezer import StaticMode
 from .runner import serve_command, run_command, dev_command
 from .worker import worker_command, scheduler_command
 
@@ -31,16 +32,12 @@ def init_command():
     pass
 
 
-@cli.command("freeze")
-def freeze_command():
-    current_app.freezer.freeze()
-
-
 @cli.command("build")
 @click.pass_context
 def build_command(ctx):
     ctx.invoke(assets_cli.build)
-    ctx.invoke(freeze_command)
+    if StaticMode(current_app.config['STATIC_MODE']) != StaticMode.DYNAMIC:
+        current_app.freezer.freeze()
 
 
 @cli.command("csp-header")
@@ -48,6 +45,5 @@ def csp_header_command():
     click.echo(generate_csp_policy())
 
 
-
 def main():
     cli.main()

{hyperflask-0.4.2 → hyperflask-0.4.4}/src/hyperflask/cli/runner.py

@@ -55,38 +55,41 @@ def run_command(processes, host, port, concurrency, extend_procfile, init_db, de
         print("Initializing database...")
         Popen([sys.argv[0], "db", "init"]).wait()
 
-    _processes = None
+    _processes = {}
+    procfile = None
     config = load_config()
 
     for filename in [f"Procfile.{config['ENV']}", "Procfile"]:
         if os.path.exists(filename):
             with open(filename) as f:
-                _processes = parse_procfile(f.read()).processes
+                procfile = parse_procfile(f.read()).processes
             break
 
-    if _processes is None or extend_procfile:
-        if not _processes:
-            _processes = {}
-        _processes.update({
-            "web": [sys.argv[0], "serve", "--host", host, "--port", "$PORT"],
-            "worker": [sys.argv[0], "worker"],
-            "scheduler": [sys.argv[0], "scheduler"]
-        })
-        if dev:
-            _processes["assets"] = [sys.argv[0], "assets", "dev"]
-            _processes["worker"].extend(["-p", "1", "-t", "1"])
+    _processes = {
+        "web": [sys.argv[0], "serve", "--host", host, "--port", "$PORT"],
+        "worker": [sys.argv[0], "worker"],
+        "scheduler": [sys.argv[0], "scheduler"]
+    }
+    if dev:
+        _processes["assets"] = [sys.argv[0], "assets", "dev"]
+        _processes["worker"].extend(["-p", "1", "-t", "1"])
+    else:
+        _processes["mercurehub"] = [sys.executable, "-m", "flask_mercure_sse.server", "--port", "$PORT"]
+        subscriber_secret_key = config.get("MERCURE_SUBSCRIBER_SECRET_KEY", config.get('SECRET_KEY'))
+        if subscriber_secret_key:
+            _processes["mercurehub"].extend(["--subscriber-secret", subscriber_secret_key])
         else:
-            _processes["mercurehub"] = [sys.executable, "-m", "flask_mercure_sse.server"]
-            subscriber_secret_key = config.get("MERCURE_SUBSCRIBER_SECRET_KEY", config.get('SECRET_KEY'))
-            if subscriber_secret_key:
-                _processes["mercurehub"].extend(["--subscriber-secret", subscriber_secret_key])
-            else:
-                print("Warning: No MERCURE_SUBSCRIBER_SECRET_KEY or SECRET_KEY set, Mercure subscriber will not be authenticated.")
-            publisher_secret_key = config.get("MERCURE_PUBLISHER_SECRET_KEY", config.get('SECRET_KEY'))
-            if publisher_secret_key:
-                _processes["mercurehub"].extend(["--publisher-secret", publisher_secret_key])
-            else:
-                print("Warning: No MERCURE_PUBLISHER_SECRET_KEY or SECRET_KEY set, cannot publish Mercure messages.")
+            print("Warning: No MERCURE_SUBSCRIBER_SECRET_KEY or SECRET_KEY set, Mercure subscriber will not be authenticated.")
+        publisher_secret_key = config.get("MERCURE_PUBLISHER_SECRET_KEY", config.get('SECRET_KEY'))
+        if publisher_secret_key:
+            _processes["mercurehub"].extend(["--publisher-secret", publisher_secret_key])
+        else:
+            print("Warning: No MERCURE_PUBLISHER_SECRET_KEY or SECRET_KEY set, cannot publish Mercure messages.")
+
+    if procfile and extend_procfile:
+        _processes.update(procfile)
+    elif procfile:
+        _processes = procfile
 
     processes = {name: " ".join(_processes[name]) if isinstance(_processes[name], list) else _processes[name]
                  for name in _processes if not processes or name in processes}

{hyperflask-0.4.2 → hyperflask-0.4.4}/src/hyperflask/components/core.py

@@ -4,6 +4,7 @@ from flask.views import http_method_funcs
 from flask_file_routes import page
 from flask_suspense import render_template
 from jinjapy import extract_frontmatter
+from ..utils.freezer import dynamic
 import importlib
 import re
 import os
@@ -43,6 +44,7 @@ class ComponentAdapter(BaseComponentAdapter):
         if methods:
             app.add_url_rule(url, self.name, view_func=self.view_func, methods=methods)
 
+    @dynamic
     def view_func(self):
         props = {}
         page.template = self.template

hyperflask-0.4.4/src/hyperflask/utils/freezer.py

@@ -0,0 +1,56 @@
+from flask_frozen import Freezer as FlaskFreezer
+from pathlib import Path
+from enum import Enum
+
+
+class StaticMode(Enum):
+    STATIC = "static"
+    HYBRID = "hybrid"
+    DYNAMIC = "dynamic"
+
+
+class Freezer(FlaskFreezer):
+    @property
+    def root(self):
+        return Path(self.app.config['FREEZER_DESTINATION'])
+
+    def _check_endpoints(self, seen_endpoints):
+        if StaticMode(self.app.config['STATIC_MODE']) != StaticMode.STATIC:
+            return
+        super()._check_endpoints(seen_endpoints)
+
+    def urlpath_to_filepath(self, path):
+        """Convert URL path like /admin/ to file path like admin/index.html."""
+        if path.endswith('/'):
+            path += 'index.html'
+        # Remove the initial slash that should always be there
+        assert path.startswith('/')
+        if self.app.config.get('FREEZER_DEFAULT_FILE_EXTENSION') and '.' not in path.split('/')[-1]:
+            path += f".{self.app.config['FREEZER_DEFAULT_FILE_EXTENSION']}"
+        return path[1:]
+
+
+def static(func=None, values=None):
+    if func is None:
+        return lambda f: static(f, values=values)
+    func.__freezer__ = True
+    func.__freezer_values__ = values
+    return func
+
+
+def dynamic(func):
+    func.__freezer__ = False
+    return func
+
+
+def freezer_url_generator(app):
+    """URL generator for URL rules that take no arguments."""
+    for rule in app.url_map.iter_rules():
+        if rule.arguments or 'GET' not in rule.methods:
+            continue
+        if rule.endpoint.startswith('mercure_hub'):
+            continue
+        if rule.endpoint in app.view_functions and not getattr(app.view_functions[rule.endpoint], '__freezer__', True):
+            continue
+        values = getattr(app.view_functions.get(rule.endpoint), '__freezer_values__', None) or {}
+        yield rule.endpoint, values