flask-spa 0.1.1__tar.gz

flask_spa-0.1.1/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: flask-spa
+Version: 0.1.1
+Summary: Components to build Flask single page applications
+Author-email: Martin Mohnhaupt <martin.mohnhaupt@etik.com>
+Maintainer-email: Martin Mohnhaupt <martin.mohnhaupt@etik.com>
+License-Expression: MIT
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: flask>=3.1.2

flask_spa-0.1.1/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "flask-spa"
+version = "0.1.1"
+description = "Components to build Flask single page applications"
+authors = [{ name = "Martin Mohnhaupt", email = "martin.mohnhaupt@etik.com" }]
+maintainers = [
+    { name = "Martin Mohnhaupt", email = "martin.mohnhaupt@etik.com" },
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = ["flask>=3.1.2"]
+
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+line-length = 230

flask_spa-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flask_spa-0.1.1/src/flask_spa.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: flask-spa
+Version: 0.1.1
+Summary: Components to build Flask single page applications
+Author-email: Martin Mohnhaupt <martin.mohnhaupt@etik.com>
+Maintainer-email: Martin Mohnhaupt <martin.mohnhaupt@etik.com>
+License-Expression: MIT
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: flask>=3.1.2

flask_spa-0.1.1/src/flask_spa.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/flask_spa.egg-info/PKG-INFO
+src/flask_spa.egg-info/SOURCES.txt
+src/flask_spa.egg-info/dependency_links.txt
+src/flask_spa.egg-info/requires.txt
+src/flask_spa.egg-info/top_level.txt
+src/spa_flask/__init__.py
+src/spa_flask/components.py
+src/spa_flask/events.py
+src/spa_flask/middleware.py

flask_spa-0.1.1/src/flask_spa.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flask_spa-0.1.1/src/flask_spa.egg-info/requires.txt

@@ -0,0 +1 @@
+flask>=3.1.2

flask_spa-0.1.1/src/flask_spa.egg-info/top_level.txt

@@ -0,0 +1 @@
+spa_flask

flask_spa-0.1.1/src/spa_flask/__init__.py

@@ -0,0 +1,59 @@
+from os import PathLike
+
+from flask import Flask
+
+from .components import Alert, ConfirmDialog, Dialog, Severity, SpaComponent, Toast
+from .events import SpaEvent
+from .middleware import FlaskMiddleware
+
+
+class SpaFlask(Flask):
+    """The `SpaFlask` class inherits the `Flask` class. It integrates the `SpaMiddleware` and adds functionality to th base class.
+
+    Args:
+        Flask (Flask): the `Flask` base class
+    """
+
+    def __init__(
+        self,
+        import_name: str,
+        static_url_path: str | None = None,
+        static_folder: str | PathLike[str] | None = "static",
+        static_host: str | None = None,
+        host_matching: bool = False,
+        subdomain_matching: bool = False,
+        template_folder: str | PathLike[str] | None = "templates",
+        instance_path: str | None = None,
+        instance_relative_config: bool = False,
+        root_path: str | None = None,
+    ):
+        # Call the base class initializer
+        super().__init__(import_name, static_url_path, static_folder, static_host, host_matching, subdomain_matching, template_folder, instance_path, instance_relative_config, root_path)
+        # Add the Flask middleware
+        self._middleware = FlaskMiddleware(self)
+
+    def set_title(self, title: str):
+        self._middleware.title(title)
+
+    def create_component(self, object: SpaComponent) -> None:
+        self._middleware._events.append(SpaEvent.create_from_object(object))
+
+    def toast(self, severity: Severity, header: str, message: str, redirect_url="") -> None:
+        component = Toast(severity, header, message, redirect_url)
+        event = SpaEvent.create_from_object(component)
+        self._middleware.add_event(event)
+
+    def alert(self, severity: Severity, message: str, redirect_url: str = "") -> None:
+        component = Alert(severity, message, redirect_url)
+        event = SpaEvent.create_from_object(component)
+        self._middleware.add_event(event)
+
+    def dialog(self, header: str, message: str, lang: str, accept_url: str, dismiss_url: str) -> None:
+        component = Dialog(header, message, lang, accept_url, dismiss_url)
+        event = SpaEvent.create_from_object(component)
+        self._middleware.add_event(event)
+
+    def confirm(self, header: str, message: str, lang: str, accept_url: str, dismiss_url: str) -> None:
+        component = ConfirmDialog(header, message, lang, accept_url, dismiss_url)
+        event = SpaEvent.create_from_object(component)
+        self._middleware.add_event(event)

flask_spa-0.1.1/src/spa_flask/components.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+from enum import StrEnum
+
+
+class SpaComponent:
+    """Base class for SPA components"""
+
+    pass
+
+
+class Severity(StrEnum):
+    """Class representing a severity level"""
+
+    DANGER = "danger"
+    WARNING = "warning"
+    SUCCESS = "success"
+    INFO = "info"
+    DEFAULT = "primary"
+
+
+@dataclass
+class Dialog(SpaComponent):
+    """Class representing a dialog"""
+
+    header: str = "Header not defined"
+    body: str = "Body not defined"
+    lang: str = "en"
+    accept_url: str = ""
+    dismiss_url: str = ""
+
+
+@dataclass
+class ConfirmDialog(SpaComponent):
+    """Class representing a confirmation dialog"""
+
+    header: str = "Header not defined"
+    body: str = "Body not defined"
+    lang: str = "en"
+    accept_url: str = ""
+    dismiss_url: str = ""
+
+
+@dataclass
+class Toast(SpaComponent):
+    """Class representing a toast message"""
+
+    category: Severity = Severity.DEFAULT
+    header: str = "Header not defined"
+    body: str = "Body not defined"
+    redirect_url: str = ""
+
+
+@dataclass
+class Alert(SpaComponent):
+    """Class representing an alert message"""
+
+    category: Severity = Severity.DEFAULT
+    message: str = "Message not defined"
+    redirect_url: str = ""

flask_spa-0.1.1/src/spa_flask/events.py

@@ -0,0 +1,22 @@
+from dataclasses import asdict, dataclass, field
+from typing import Dict
+
+from .components import Alert, ConfirmDialog, Dialog, SpaComponent, Toast
+
+
+@dataclass
+class SpaEvent:
+    type: str = ""
+    detail: Dict = field(default_factory=Dict)
+
+    @staticmethod
+    def create_from_object(object: SpaComponent) -> "SpaEvent":
+        if isinstance(object, Dialog):
+            return SpaEvent("nd:dialog", asdict(object))
+        if isinstance(object, Toast):
+            return SpaEvent("nd:toast", asdict(object))
+        if isinstance(object, Alert):
+            return SpaEvent("nd:alert", asdict(object))
+        if isinstance(object, ConfirmDialog):
+            return SpaEvent("nd:confirm", asdict(object))
+        return SpaEvent()

flask_spa-0.1.1/src/spa_flask/middleware.py

@@ -0,0 +1,62 @@
+import json
+from dataclasses import asdict, is_dataclass
+from typing import List
+
+from flask import Flask, Request, Response, request
+
+from .components import SpaComponent
+from .events import SpaEvent
+
+
+class FlaskMiddleware:
+    def __init__(self, app: Flask) -> None:
+        self._app = app
+        self._wsgi_app = app.wsgi_app
+        self._request: Request
+        self._response: Response
+        self._title: str | None = None
+        self._events: List[SpaEvent] = []
+
+        with app.app_context():
+            print("MW", "First call")
+
+        app.wsgi_app = self
+
+        @app.before_request
+        def _():
+            self._request = request
+
+        @app.after_request
+        def _(response: Response):
+            return response
+
+    def __call__(self, environ, start_response):
+
+        def custom_start_response(status: str, headers: List, exc_info=None):
+            if self._events:
+                payload = [asdict(_) for _ in self._events]
+                headers.append(("x-nd-event", json.dumps(payload)))
+                self._events.clear()
+
+            if self._title:
+                headers.append(("x-nd-title", self._title))
+                self._title = ""
+
+            return start_response(status, headers, exc_info)
+
+        return self._wsgi_app(environ, custom_start_response)
+
+    def as_json(self, obj) -> str:
+        result = json.dumps(None)
+        if is_dataclass(obj) and not isinstance(obj, type):
+            result = json.dumps(asdict(obj))
+        return result
+
+    def title(self, title) -> None:
+        self._title = title
+
+    def send(self, obj: SpaComponent) -> None:
+        self._events.append(SpaEvent.create_from_object(obj))
+
+    def add_event(self, event: SpaEvent):
+        self._events.append(event)