hyperflask 0.5.0__tar.gz → 0.5.2__tar.gz

{hyperflask-0.5.0 → hyperflask-0.5.2}/PKG-INFO

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

{hyperflask-0.5.0 → hyperflask-0.5.2}/pyproject.toml

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

{hyperflask-0.5.0 → hyperflask-0.5.2}/src/hyperflask/app.py

@@ -57,7 +57,7 @@ class Hyperflask(Flask):
 
     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):
+                 config=None, config_filename="config.yml", database_uri=None, proxy_fix=True, healthcheck_url="/healthcheck", **kwargs):
 
         super().__init__(*args, **kwargs)
         if proxy_fix:
@@ -99,6 +99,7 @@ class Hyperflask(Flask):
             "HSTS_HEADER": False,
             "IMAGES_DEFAULT_LOADING": "lazy",
             "IMAGES_DEFAULT_DECODING": "async",
+            "HEALTHCHECK_URL": healthcheck_url,
         })
         if config:
             self.config.update(config)
@@ -261,6 +262,17 @@ class Hyperflask(Flask):
             except TemplateNotFound:
                 return self.make_response(("500 Internal Server Error", 500))
 
+        if self.config['HEALTHCHECK_URL']:
+            @self.route(self.config['HEALTHCHECK_URL'])
+            def healthcheck():
+                if not isinstance(self.db, UndefinedDatabase):
+                    try:
+                        with self.db as tx:
+                            tx.execute("SELECT 1")
+                    except Exception:
+                        return {"status": "error"}, 500
+                return {"status": "ok"}
+
     def relative_import_name(self, name):
         return f"{self.import_name}.{name}" if self.import_name != "__main__" else name
 

{hyperflask-0.5.0 → hyperflask-0.5.2}/src/hyperflask/cli/__init__.py

@@ -7,6 +7,7 @@ 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
+from .scaffold import gen
 
 
 def _create_app():
@@ -25,11 +26,7 @@ cli.add_command(run_command)
 cli.add_command(dev_command)
 cli.add_command(worker_command)
 cli.add_command(scheduler_command)
-
-
-@cli.command("init")
-def init_command():
-    pass
+cli.add_command(gen)
 
 
 @cli.command("build")

{hyperflask-0.5.0 → hyperflask-0.5.2}/src/hyperflask/cli/runner.py

@@ -6,29 +6,36 @@ import multiprocessing
 import gunicorn.app.base
 from subprocess import Popen
 from honcho.manager import Manager as BaseProcessManager
+from honcho.command import _parse_concurrency
+from honcho.environ import parse_procfile
+from honcho.printer import Printer
+from honcho import environ
+from flask_configurator.config import Config
 from ..factory import load_config
 from . import reloader # import hacky patch of werkzeug reloader
 
 
 @click.command("serve")
-@click.option('--gunicorn-opt', multiple=True)
+@click.option('--gunicorn-config')
+@click.option("--init-db", is_flag=True)
 @pass_script_info
 @click.pass_context
-def serve_command(ctx, info, host, port, gunicorn_opt, **run_kwargs):
+def serve_command(ctx, info, host, port, gunicorn_config, init_db, **run_kwargs):
+    if init_db:
+        print("Initializing database...")
+        Popen([sys.argv[0], "db", "init"]).wait()
+
     if os.environ.get("FLASK_DEBUG") == "1":
         ctx.invoke(flask_run_command, host=host, port=port, **run_kwargs)
-    else:
-        options = {
-            'proc_name': 'hyperflask',
-            'bind': f'{host}:{port}',
-            'workers': 1 + multiprocessing.cpu_count() * 2,
-            'max_requests': 1000,
-            'max_requests_jitter': 100
-        }
-        for opt in gunicorn_opt:
-            key, value = opt.split('=', 1)
-            options[key] = int(value) if value.isdigit() else value
-        GunicornServer(info.load_app, options).run()
+        return
+
+    GunicornServer(info.load_app, {
+        'proc_name': 'hyperflask',
+        'bind': f'{host}:{port}',
+        'workers': 1 + multiprocessing.cpu_count() * 2,
+        'max_requests': 1000,
+        'max_requests_jitter': 100
+    }, gunicorn_config).run()
 
 
 serve_command.params = flask_run_command.params + serve_command.params
@@ -41,13 +48,9 @@ serve_command.params = flask_run_command.params + serve_command.params
 @click.option('--concurrency')
 @click.option("--extend-procfile", is_flag=True)
 @click.option("--init-db/--no-init-db", is_flag=True, default=None)
+@click.option('--gunicorn-config')
 @click.option("--dev", is_flag=True)
-def run_command(processes, host, port, concurrency, extend_procfile, init_db, dev):
-    from honcho.command import _parse_concurrency
-    from honcho.environ import parse_procfile
-    from honcho.printer import Printer
-    from honcho import environ
-
+def run_command(processes, host, port, concurrency, extend_procfile, init_db, gunicorn_config, dev):
     if dev:
         os.environ["FLASK_DEBUG"] = "1"
 
@@ -59,6 +62,10 @@ def run_command(processes, host, port, concurrency, extend_procfile, init_db, de
     procfile = None
     config = load_config()
 
+    if not dev and not config.get('SECRET_KEY'):
+        print("Critical: No SECRET_KEY set, cannot run in production mode.")
+        sys.exit(1)
+
     for filename in [f"Procfile.{config['ENV']}", "Procfile"]:
         if os.path.exists(filename):
             with open(filename) as f:
@@ -70,21 +77,13 @@ def run_command(processes, host, port, concurrency, extend_procfile, init_db, de
         "worker": [sys.argv[0], "worker"],
         "scheduler": [sys.argv[0], "scheduler"]
     }
+    if gunicorn_config:
+        _processes["web"].extend(["--gunicorn-config", gunicorn_config])
     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:
-            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)
@@ -93,13 +92,19 @@ def run_command(processes, host, port, concurrency, extend_procfile, init_db, de
 
     processes = {name: " ".join(_processes[name]) if isinstance(_processes[name], list) else _processes[name]
                  for name in _processes if not processes or name in processes}
+    env = {}
+    if not dev:
+        env = {
+            "MERCURE_SUBSCRIBER_SECRET_KEY": config.get("MERCURE_SUBSCRIBER_SECRET_KEY", config['SECRET_KEY']),
+            "MERCURE_PUBLISHER_SECRET_KEY": config.get("MERCURE_PUBLISHER_SECRET_KEY", config['SECRET_KEY']),
+        }
 
     manager = ProcessManager(Printer(sys.stdout, colour=True))
-
     for p in environ.expand_processes(processes,
                                       concurrency=_parse_concurrency(concurrency),
                                       port=port):
         e = os.environ.copy()
+        e.update(env)
         e.update(p.env)
         manager.add_process(p.name, p.cmd, quiet=p.quiet, env=e)
 
@@ -130,14 +135,19 @@ class ProcessManager(BaseProcessManager):
 
 
 class GunicornServer(gunicorn.app.base.BaseApplication):
-    def __init__(self, app_loader, options=None):
+    def __init__(self, app_loader, config_defaults=None, config_filename=None):
         self.app_loader = app_loader
-        self.options = options or {}
+        self.config_defaults = config_defaults or {}
+        self.config_filename = config_filename
         super().__init__()
 
     def load_config(self):
-        config = {key: value for key, value in self.options.items()
-                  if key in self.cfg.settings and value is not None}
+        config = Config("", self.config_defaults, env_prefix="GUNICORN")
+        config.load(self.config_filename, default_env="production")
+
+        config = {key.lower(): value for key, value in config.items()
+                  if key.lower() in self.cfg.settings and value is not None}
+
         for key, value in config.items():
             self.cfg.set(key.lower(), value)
 

hyperflask-0.5.2/src/hyperflask/cli/scaffold.py

@@ -0,0 +1,32 @@
+from flask.cli import AppGroup, with_appcontext
+import random
+import click
+import os
+
+
+gen = AppGroup('gen', help='Generate various files and code snippets.')
+
+
+@gen.command('secret-key')
+@click.option('--save/--no-save', is_flag=True, default=True, help='Save the generated key to the .env file.')
+def generate_secret_key_command(save):
+    key = generate_secret_key()
+    if save:
+       save_env_var("FLASK_SECRET_KEY", key)
+    click.echo(key)
+
+
+def generate_secret_key():
+    return ''.join([random.SystemRandom().choice('abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)') for i in range(50)])
+
+
+def save_env_var(key, value):
+    env = []
+    if os.path.exists(".env"):
+        with open(".env", "r") as f:
+            env = f.readlines()
+    with open(".env", "w") as f:
+        for line in env:
+            if not line.startswith(f"{key}="):
+                f.write(f"{line}\n")
+        f.write(f"{key}={value}\n")

{hyperflask-0.5.0 → hyperflask-0.5.2}/src/hyperflask/components/core.py

@@ -7,7 +7,6 @@ from jinjapy import extract_frontmatter
 from ..utils.freezer import dynamic
 import importlib
 import re
-import os
 
 
 class BaseComponentAdapter:
@@ -71,8 +70,9 @@ class ComponentAdapter(BaseComponentAdapter):
             source, frontmatter = extract_frontmatter(f.read())
             if not self.template:
                 frontmatter = source
+            if not frontmatter:
+                return []
             return [m.upper() for m in http_method_funcs if re.search(rf"^(def\s+{m}\()|{m}\s*=", frontmatter, re.MULTILINE)]
-        return []
 
     def render(self, *args, **kwargs):
         caller = kwargs.pop('caller', None)