fastlifeweb 0.18.0__tar.gz → 0.19.0__tar.gz

fastlifeweb-0.19.0/CHANGELOG.md

@@ -0,0 +1,202 @@
+## 0.19.0  - Released on 2024-11-07
+* Drop Babel from depenencies for i18n, rely on GNUTranslations only
+* Change License to MIT
+* Replace poetry by uv/pdm
+* Update CI workflows
+
+## 0.18.0  - Released on 2024-10-13
+* Make the sphinx pluging {mod}`fastlife.adapters.jinjax.jinjax_ext.jinjax_doc`
+  parts from the API in order to let users build their own component documentation.
+
+## 0.17.0  - Released on 2024-10-08
+* Fix @configure decorator signature for GenericConfigurator
+* Breaking change - rename Configurator.set_open_tag to Configurator.set_openapi_tag
+
+## 0.16.4  - Released on 2024-10-04
+* Add support of x-real-port for port detection, fallback port to 0 instead of None if missing
+
+## 0.16.3  - Released on 2024-10-03
+* Fix middleware that process the x-forwarded-headers to respect ASGI spec for client
+
+## 0.16.2  - Released on 2024-10-03
+* Add a new property all_registered_permissions on the Configurator class
+
+## 0.16.1  - Released on 2024-10-03
+* Fix import in the SecurityPolicy that make it unusable.
+
+## 0.16.0  - Released on 2024-10-02
+* Make the Configurator, Request and Registry Generic.
+* Breaking change, remove settings `api_swagger_ui_url` and `api_redoc_url`
+  now to register those url, use
+  {meth}`fastlife.config.configurator.GenericConfigurator.set_api_documentation_info`
+* Breaking change, in the method
+  {meth}`fastlife.config.configurator.GenericConfigurator.set_api_documentation_info`
+  summary is now kwargs only.
+
+## 0.15.1  - Released on 2024-09-29
+* Hotfix components to create tables
+
+## 0.15.0  - Released on 2024-09-29
+* Add an {class}`fastlife.security.policy.AbstractSecurityPolicy` class
+* New method {meth}`fastlife.config.configurator.GenericConfigurator.set_security_policy`
+* Breaking change, the check_permission has been removed from the settings.
+  to configure the permission policy, a security policy has to be implemented.
+
+## 0.14.0  - Released on 2024-09-26
+* Implemement method add_template_search_path in the configurator
+* Add a route_prefix in the configurator for configurator.include
+
+## 0.13.0  - Released on 2024-09-25
+* Add a way to handle api
+* Add a @view_config decorator to register route
+* Add a @resource decorator to handle CRUD resource in rest format
+* Add @exception_handler decorator
+* Add i18n support
+
+## 0.12.0  - Released on 2024-09-19
+* Add a way to register API routes and expose api doc
+
+## 0.11.1  - Released on 2024-09-18
+* Update FastAPI version
+
+## 0.11.0  - Released on 2024-09-18
+* Huge documentation update
+  * Use sphinx-autodoc2
+  * Add documentation for the components.
+* Breaking change in the configurator.
+  * get_app has been renamed get_asgi_app
+  * a few internals classes moved/renamed.
+
+## 0.10.0  - Released on 2024-08-24
+
+* Rename model_result and ModelResult to form_model and FormModel
+* Add an edit method for FormModel
+* Add a Textarea widget and fix Hidden widget
+* Fix rendering of sequence
+* Do not render main form as nested models
+* Add many functional tests for form field generations
+
+## 0.9.7  - Released on 2024-08-21
+
+* Add title attribute to icons
+
+## 0.9.6  - Released on 2024-08-18
+
+* Add more buttons options for htmx ajax call
+* Fix Option id
+
+## 0.9.5  - Released on 2024-08-17
+
+* Use icons to customize collapsible widget for sequence
+* Add parameter for button to avoid send params
+
+## 0.9.4  - Released on 2024-08-16
+
+* Don't update browser url while manipulating autoform lists
+
+## 0.9.3  - Released on 2024-08-16
+
+* Fix autoform widgets from jinjax migration
+
+## 0.9.2  - Released on 2024-08-13
+
+* Add a constants class for global variable in templates
+* Use icons to customize collapsible widget
+
+## 0.9.1  - Released on 2024-08-12
+
+* Replace fa icons by hero icons
+
+## 0.9.0  - Released on 2024-08-12
+
+* Add fa Icons (extra)
+
+## 0.8.0  - Released on 2024-08-10
+
+* Upgrade JinjaX (Template update required, use vue-like syntax now)
+
+## 0.7.3  - Released on 2024-08-10
+
+* Add some HTML markup
+
+## 0.7.2  - Released on 2024-08-07
+
+* Fix https behind a reverse proxy
+
+## 0.7.1  - Released on 2024-08-04
+
+* Add the registry on request for exception handler
+
+## 0.7.0  - Released on 2024-08-04
+
+* Rewrite how the registry is handled, now part of the request (request.registry)
+* Update to get hx-confirm and hx-delete on button
+
+## 0.6.1  - Released on 2024-04-27
+
+* Display errors on every widget
+
+## 0.6.0  - Released on 2024-04-25
+
+* Refactor the pydantic_form to start handling errors in form.
+
+## 0.5.1  - Released on 2024-04-24
+
+* Fix minimum dependency version for JinjaX
+
+## 0.5.0  - Released on 2024-04-24
+
+* Implement new types for pydantic form: Enum, Set[Literal] and Set[Enum]
+
+## 0.4.1  - Released on 2024-04-20
+
+* Add globals to render custom widget with global data
+
+## 0.4.0  - Released on 2024-04-20
+
+* Update JinjaX for global template var support
+* Add lots of missing unit tests
+* Add support of more html form element
+* Update deps
+
+## 0.3.1  - Released on 2024-03-29
+
+* Update FastAPI
+
+## 0.3.0  - Released on 2024-03-29
+
+* Replace jinja2 by JinjaX
+
+## 0.2.3  - Released on 2024-01-29
+
+* Add support of relative import in :class:`Configurator.include` method
+
+## 0.2.2  - Released on 2024-01-28
+
+* Add another settings for session domain cookie
+* Update test client wrapper and also wrap bs4 tag
+* Fix session cleanup to properly logout
+
+## 0.2.1  - Released on 2024-01-27
+
+* Change add_route signature
+  * Set the name of the route mandatory and first argument (breaking change)
+  * Add a permission argument
+  * Add a settings to inject a check_permission handler
+
+## 0.2.0  - Released on 2024-01-24
+
+* Add a session wrapper in the test client
+  Allows to initialize session data in tests
+
+## 0.1.2  - Released on 2024-01-15
+
+* Handle sessions
+
+## 0.1.1  - Released on 2024-01-05
+
+* Update fastapi depencency
+
+## 0.1.0  - Released on 2024-01-05
+
+* Initial release

fastlifeweb-0.19.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Guillaume Gauvrit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/PKG-INFO

@@ -1,37 +1,38 @@
 Metadata-Version: 2.1
 Name: fastlifeweb
-Version: 0.18.0
+Version: 0.19.0
 Summary: High-level web framework
-Home-page: https://github.com/mardiros/fastlife
-License: BSD-derived
-Author: Guillaume Gauvrit
-Author-email: guillaume@gauvr.it
-Requires-Python: >=3.11,<4.0
+Author-Email: Guillaume Gauvrit <guillaume@gauvr.it>
+License: MIT License
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Provides-Extra: doc
+Classifier: Topic :: Internet :: WWW/HTTP
+Project-URL: Homepage, https://mardiros.github.io/fastlife
+Project-URL: Documentation, https://mardiros.github.io/fastlife
+Project-URL: Repository, https://github.com/mardiros/fastlife.git
+Project-URL: Issues, https://github.com/mardiros/fastlife/issues
+Project-URL: Changelog, https://mardiros.github.io/fastlife/user/changelog.html
+Requires-Python: >=3.11
+Requires-Dist: fastapi[standard]<1,>=0.115.0
+Requires-Dist: itsdangerous<3,>=2.1.2
+Requires-Dist: jinjax<0.45,>=0.44
+Requires-Dist: markupsafe<3,>=2.1.3
+Requires-Dist: multidict<7,>=6.0.5
+Requires-Dist: pydantic<3,>=2.5.3
+Requires-Dist: pydantic-settings<3,>=2.0.3
+Requires-Dist: python-multipart<1,>=0.0.9
+Requires-Dist: venusian<4,>=3.0.0
 Provides-Extra: testing
-Requires-Dist: babel (>=2.16.0,<3.0.0)
-Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0) ; extra == "testing"
-Requires-Dist: fastapi[standard] (>=0.115.0,<0.116.0)
-Requires-Dist: itsdangerous (>=2.1.2,<3.0.0)
-Requires-Dist: jinjax (>=0.44,<0.45)
-Requires-Dist: markupsafe (>=2.1.3,<3.0.0)
-Requires-Dist: multidict (>=6.0.5,<7.0.0)
-Requires-Dist: pydantic (>=2.5.3,<3.0.0)
-Requires-Dist: pydantic-settings (>=2.0.3,<3.0.0)
-Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
-Requires-Dist: sphinx (>=7.0.1,<8.0.0) ; extra == "doc"
-Requires-Dist: venusian (>=3.0.0,<4.0.0)
-Project-URL: Repository, https://github.com/mardiros/fastlife
+Requires-Dist: beautifulsoup4; extra == "testing"
+Provides-Extra: docs
+Requires-Dist: furo>=2024.5.6; extra == "docs"
+Requires-Dist: linkify-it-py<3,>=2.0.3; extra == "docs"
+Requires-Dist: myst-parser<5,>=4.0.0; extra == "docs"
+Requires-Dist: sphinx<8,>=7.0.1; extra == "docs"
+Requires-Dist: sphinx-autodoc2<1,>=0.5.0; extra == "docs"
 Description-Content-Type: text/markdown
 
 # Fastlife
@@ -85,4 +86,3 @@ The package is available on pypi with the name fastlifeweb.
 ```bash
 pip install fastlifeweb
 ```
-

fastlifeweb-0.19.0/pyproject.toml

@@ -0,0 +1,150 @@
+[project]
+authors = [
+    { name = "Guillaume Gauvrit", email = "guillaume@gauvr.it" },
+]
+description = "High-level web framework"
+name = "fastlifeweb"
+readme = "README.md"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP",
+]
+version = "0.19.0"
+requires-python = ">=3.11"
+dependencies = [
+    "fastapi[standard] >=0.115.0,<1",
+    "itsdangerous >=2.1.2,<3",
+    "jinjax >=0.44,<0.45",
+    "markupsafe >=2.1.3,<3",
+    "multidict >=6.0.5,<7",
+    "pydantic >=2.5.3,<3",
+    "pydantic-settings >=2.0.3,<3",
+    "python-multipart >=0.0.9,<1",
+    "venusian >=3.0.0,<4",
+]
+
+[project.license]
+text = "MIT License"
+
+[project.urls]
+Homepage = "https://mardiros.github.io/fastlife"
+Documentation = "https://mardiros.github.io/fastlife"
+Repository = "https://github.com/mardiros/fastlife.git"
+Issues = "https://github.com/mardiros/fastlife/issues"
+Changelog = "https://mardiros.github.io/fastlife/user/changelog.html"
+
+[project.optional-dependencies]
+testing = [
+    "beautifulsoup4",
+]
+docs = [
+    "furo >=2024.5.6",
+    "linkify-it-py >=2.0.3,<3",
+    "myst-parser >=4.0.0,<5",
+    "sphinx >=7.0.1,<8",
+    "sphinx-autodoc2 >=0.5.0,<1",
+]
+
+[tool.pdm.build]
+includes = [
+    "src",
+    "CHANGELOG.md",
+    "tailwind.config.js",
+]
+excludes = [
+    "tests",
+]
+
+[tool.pyright]
+include = [
+    "src",
+]
+typeCheckingMode = "strict"
+reportMissingTypeStubs = false
+venvPath = ".venv"
+
+[[tool.mypy.overrides]]
+module = "fastlife.*"
+disallow_any_generics = true
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = [
+    "behave",
+    "venusian",
+    "docutils",
+]
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+select = [
+    "B",
+    "I",
+    "F",
+    "UP",
+    "RUF",
+]
+
+[tool.isort]
+profile = "black"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+filterwarnings = [
+    "error",
+    "ignore:.*Deprecated call to `pkg_resources.declare_namespace:DeprecationWarning",
+    "ignore:.*find_module\\(\\) is deprecated.*:DeprecationWarning",
+    "ignore:.*FileFinder.find_loader\\(\\) is deprecated.*:DeprecationWarning",
+    "ignore:.*Pydantic serializer warnings.*:UserWarning",
+]
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "if TYPE_CHECKING:",
+    "except ImportError",
+    "\\s+\\.\\.\\.$",
+    "# coverage: ignore",
+]
+
+[dependency-groups]
+dev = [
+    "babel >=2.16.0,<3",
+    "beautifulsoup4 >= 4.12.2,<5",
+    "behave >= 1.2.6,<2",
+    "email-validator >= 2.0.0.post2,<3",
+    "heroicons >= 2.7.0,<3",
+    "httpx >= 0.25.0,<0.26",
+    "hypercorn >= 0.14.4,<0.15",
+    "mypy >= 1.4.0,<2",
+    "pytailwindcss >= 0.2.0,<0.3",
+    "pytest >= 8.2.0,<9",
+    "pytest-asyncio >= 0.21.0,<0.22",
+    "pytest-cov >= 4.1.0,<5",
+    "pytest-playwright >= 0.4.3,<0.5",
+    "sphinx >=7.0.1,<8",
+    "types-beautifulsoup4 >= 4.12.0.6,<5",
+]
+doc = [
+    "furo >=2024.5.6",
+    "linkify-it-py >=2.0.3,<3",
+    "myst-parser >=4.0.0,<5",
+    "sphinx >=7.0.1,<8",
+    "sphinx-autodoc2 >=0.5.0,<1",
+]
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/src/fastlife/__init__.py

@@ -1,3 +1,7 @@
+from importlib import metadata
+
+__version__ = metadata.version("fastlifeweb")
+
 from fastapi import Response
 
 from .config import (

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/src/fastlife/adapters/jinjax/renderer.py

@@ -3,6 +3,7 @@ Template rending based on JinjaX.
 """
 
 import logging
+import textwrap
 from collections.abc import Mapping, MutableMapping, Sequence
 from typing import (
     TYPE_CHECKING,
@@ -16,6 +17,7 @@ from fastlife import Request
 from fastlife.adapters.jinjax.widget_factory.factory import WidgetFactory
 from fastlife.request.form import FormModel
 from fastlife.request.localizer import get_localizer
+from fastlife.templates.inline import InlineTemplate
 
 if TYPE_CHECKING:
     from fastlife.config.settings import Settings  # coverage: ignore
@@ -102,8 +104,7 @@ class JinjaxRenderer(AbstractTemplateRenderer):
             child components without "props drilling".
         :param params: parameters used to render the template.
         """
-        # Jinja template does accept the file extention while rendering the template
-        # we strip it before rendering.
+
         template = template[: -len(self.settings.jinjax_file_ext) - 1]
         if globals:
             self.globals.update(globals)
@@ -116,6 +117,27 @@ class JinjaxRenderer(AbstractTemplateRenderer):
             template, __globals=self.build_globals(), **params
         )
 
+    def render_inline(self, template: InlineTemplate) -> str:
+        """
+        Render the JinjaX component with the given parameter.
+
+        :param template: the template to render
+        :param globals: parameters that will be used by the JinjaX component and all its
+            child components without "props drilling".
+        :param params: parameters used to render the template.
+        """
+        params = template.model_dump()
+        src = (
+            f"{{# def {', '.join(params.keys())} #}}\n"
+            f"{textwrap.dedent(template.template)}"
+        )
+        return self.catalog.render(
+            template.__class__.__qualname__,
+            __source=src,
+            __globals=self.build_globals(),
+            **params,
+        )
+
     def pydantic_form(
         self, model: FormModel[Any], *, token: str | None = None
     ) -> Markup:

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/src/fastlife/config/configurator.py

@@ -466,7 +466,11 @@ class GenericConfigurator(Generic[TRegistry]):
         :param path: path of the route, use `{curly_brace}` to inject FastAPI Path
             parameters.
         :param endpoint: the function that will reveive the request.
-        :param permission: a permission to validate by the security policy.
+        :param template: the template rendered by the
+            {class}`fastlife.service.templates.AbstractTemplateRenderer`.
+        :param permission: a permission to validate by the
+            {class}`Security Policy <fastlife.security.policy.AbstractSecurityPolicy>`.
+        :param status_code: customize response status code.
         :param methods: restrict route to a list of http methods.
         :return: the configurator.
         """

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/src/fastlife/config/views.py

@@ -36,14 +36,20 @@ def view_config(
     methods: list[str] | None = None,
 ) -> Callable[..., Any]:
     """
-    A decorator function to add a view in the app.
+    A decorator function to register a view in the
+    {class}`Configurator <fastlife.config.configurator.GenericConfigurator>`
+    while scaning a module using {func}`include
+    <fastlife.config.configurator.GenericConfigurator.include>`.
 
     :param name: name of the route, used to build route from the helper
         {meth}`fastlife.request.request.Request.url_for` in order to create links.
     :param path: path of the route, use `{curly_brace}` to inject FastAPI Path
         parameters.
+    :param template: the template rendered by the
+        {class}`fastlife.services.templates.AbstractTemplateRenderer`.
     :param permission: a permission to validate by the
-        {attr}`fastlife.config.settings.Settings.check_permission` function.
+        {class}`Security Policy <fastlife.security.policy.AbstractSecurityPolicy>`.
+    :param status_code: customize response status code.
     :param methods: restrict route to a list of http methods.
 
     :return: the configuration callback.

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/src/fastlife/security/policy.py

@@ -63,6 +63,7 @@ class HasPermission(int, metaclass=BoolMeta):
     where authenticated user are not redirected. they have an error message,
     or the frontend may use the information to adapt its interface.
     """
+
     kind: Literal["allowed", "unauthenticated", "denied"]
     reason: str
 

{fastlifeweb-0.18.0 → fastlifeweb-0.19.0}/src/fastlife/services/templates.py

@@ -1,12 +1,11 @@
 """
 Base class to of the template renderer.
 
-Fastlife comes with {class}`fastlife.templating.renderer.jinjax.JinjaxEngine`,
-the rendering engine, it can be overriden from the setting
-:attr:`fastlife.config.settings.Settings.template_renderer_class`.
-
-In that case, those base classes have to be implemented.
+Fastlife comes with {class}`fastlife.adapters.jinjax.renderer.JinjaxEngine`,
+the rendering engine.
 
+More template engine can be registered using the configurator method
+{meth}`add_renderer <fastlife.config.configurator.GenericConfigurator.add_renderer>`
 """
 
 import abc
@@ -15,6 +14,7 @@ from typing import Any
 
 from fastlife import Request, Response
 from fastlife.security.csrf import create_csrf_token
+from fastlife.templates.inline import InlineTemplate
 
 TemplateParams = Mapping[str, Any]
 
@@ -43,7 +43,7 @@ class AbstractTemplateRenderer(abc.ABC):
         status_code: int = 200,
         content_type: str = "text/html",
         globals: Mapping[str, Any] | None = None,
-        params: TemplateParams,
+        params: TemplateParams | InlineTemplate,
         _create_csrf_token: Callable[..., str] = create_csrf_token,
     ) -> Response:
         """
@@ -54,7 +54,10 @@ class AbstractTemplateRenderer(abc.ABC):
         request.scope[reg.settings.csrf_token_name] = (
             request.cookies.get(reg.settings.csrf_token_name) or _create_csrf_token()
         )
-        data = self.render_template(template, **params)
+        if isinstance(params, InlineTemplate):
+            data = self.render_inline(params)
+        else:
+            data = self.render_template(template, **params)
         resp = Response(
             data, status_code=status_code, headers={"Content-Type": content_type}
         )
@@ -94,6 +97,15 @@ class AbstractTemplateRenderer(abc.ABC):
         :return: The template rendering result.
         """
 
+    @abc.abstractmethod
+    def render_inline(self, template: InlineTemplate) -> str:
+        """
+        Render an inline template.
+
+        :param template: the template to render.
+        :return: The template rendering result.
+        """
+
 
 class AbstractTemplateRendererFactory(abc.ABC):
     """