fastlifeweb 0.20.1__tar.gz → 0.21.0__tar.gz

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.21.0  - Released on 2024-11-15
+* Make the InlineTemplate the only way to render views template.
+  * Breaking change: template args is not supported in Configutor.add_route.
+  * Breaking change: template args is not supported in @view_config.
+  * Breaking change: template and Template dedendencies have been removed.
+* Add new method in the configurator to register global vars for template:
+    {meth}`fastlife.config.configurator.GenericConfigurator.add_renderer_global`.
+* Add npgettext i18n helper method support.
+* Remove babel from dependency list (only a dev dependency).
+
 ## 0.20.1  - Released on 2024-11-09
 * Add a new class GenericRegistry in order to properly type custom Configurator / Registry / Settings
 * Using InlineTemplate, we can pass arbitrary types for pydantic form

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastlifeweb
-Version: 0.20.1
+Version: 0.21.0
 Summary: High-level web framework
 Author-Email: Guillaume Gauvrit <guillaume@gauvr.it>
 License: MIT License

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/pyproject.toml

@@ -13,7 +13,7 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Internet :: WWW/HTTP",
 ]
-version = "0.20.1"
+version = "0.21.0"
 requires-python = ">=3.11"
 dependencies = [
     "fastapi[standard] >=0.115.0,<1",

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/__init__.py

@@ -3,6 +3,7 @@ from importlib import metadata
 __version__ = metadata.version("fastlifeweb")
 
 from fastapi import Response
+from fastapi.responses import RedirectResponse
 
 from .config import (
     Configurator,
@@ -15,6 +16,7 @@ from .config import (
     resource_view,
     view_config,
 )
+from .domain.model.template import JinjaXTemplate
 from .request import GenericRequest, Registry, Request, get_request
 
 # from .request.form_data import model
@@ -39,4 +41,7 @@ __all__ = [
     "get_request",
     "Registry",
     "Response",
+    "RedirectResponse",
+    # Template
+    "JinjaXTemplate",
 ]

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/renderer.py

@@ -4,7 +4,7 @@ Template rending based on JinjaX.
 
 import logging
 import textwrap
-from collections.abc import Mapping, MutableMapping, Sequence
+from collections.abc import Sequence
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -66,58 +66,10 @@ class JinjaxRenderer(AbstractTemplateRenderer):
         super().__init__(request)
         self.catalog = catalog
         self.settings = request.registry.settings
-        self.globals: MutableMapping[str, Any] = {}
         self.translations = get_localizer(request)
+        self.globals["pydantic_form"] = self.pydantic_form
 
-    def build_globals(self) -> Mapping[str, Any]:
-        """
-        Build globals variables accessible in any templates.
-
-        * `request` is the {class}`current request <fastlife.request.request.Request>`
-        * `csrf_token` is used to build for {jinjax:component}`CsrfToken`.
-        """
-        settings = self.settings
-        ret = {
-            "request": self.request,
-            "csrf_token": {
-                "name": settings.csrf_token_name,
-                "value": self.request.scope.get(settings.csrf_token_name, ""),
-            },
-            "pydantic_form": self.pydantic_form,
-            "localizer": self.translations,
-            **self.globals,
-        }
-        return ret
-
-    def render_template(
-        self,
-        template: str,
-        *,
-        globals: Mapping[str, Any] | None = None,
-        **params: Any,
-    ) -> 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.
-        """
-
-        template = template[: -len(self.settings.jinjax_file_ext) - 1]
-        if globals:
-            self.globals.update(globals)
-
-        self.catalog.jinja_env.install_gettext_translations(  # type: ignore
-            self.translations, newstyle=True
-        )
-
-        return self.catalog.render(  # type: ignore
-            template, __globals=self.build_globals(), **params
-        )
-
-    def render_inline(self, template: InlineTemplate) -> str:
+    def render_template(self, template: InlineTemplate) -> str:
         """
         Render the JinjaX component with the given parameter.
 
@@ -134,7 +86,7 @@ class JinjaxRenderer(AbstractTemplateRenderer):
         return self.catalog.render(
             template.__class__.__qualname__,
             __source=src,
-            __globals=self.build_globals(),
+            __globals=self.globals,
             **params,
         )
 

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/bool_builder.py

@@ -28,9 +28,9 @@ class BoolBuilder(BaseWidgetBuilder[bool]):
     ) -> BooleanWidget:
         """Build the widget."""
         return BooleanWidget(
-            field_name,
+            name=field_name,
             removable=removable,
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/emailstr_builder.py

@@ -8,9 +8,10 @@ from pydantic.networks import EmailStr
 
 from fastlife.adapters.jinjax.widget_factory.base import BaseWidgetBuilder
 from fastlife.adapters.jinjax.widgets.text import TextWidget
+from fastlife.domain.model.types import Builtins
 
 
-class EmailStrBuilder(BaseWidgetBuilder[EmailStr]):
+class EmailStrBuilder(BaseWidgetBuilder[Builtins]):
     """Builder for Pydantic EmailStr."""
 
     def accept(self, typ: type[Any], origin: type[Any] | None) -> bool:
@@ -23,17 +24,17 @@ class EmailStrBuilder(BaseWidgetBuilder[EmailStr]):
         field_name: str,
         field_type: type[Any],
         field: FieldInfo | None,
-        value: EmailStr | None,
+        value: Builtins | None,
         form_errors: Mapping[str, Any],
         removable: bool,
     ) -> TextWidget:
         """Build the widget."""
         return TextWidget(
-            field_name,
+            name=field_name,
             input_type="email",
             placeholder=str(field.examples[0]) if field and field.examples else None,
             removable=removable,
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/enum_builder.py

@@ -31,10 +31,10 @@ class EnumBuilder(BaseWidgetBuilder[Enum]):
         """Build the widget."""
         options = [(item.name, item.value) for item in field_type]  # type: ignore
         return DropDownWidget(
-            field_name,
+            name=field_name,
             options=options,  # type: ignore
             removable=removable,
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/factory.py

@@ -4,15 +4,16 @@ Create markup for pydantic forms.
 
 import secrets
 from collections.abc import Mapping
-from inspect import isclass
-from typing import Any, cast, get_origin
+from typing import TYPE_CHECKING, Any, get_origin
 
 from markupsafe import Markup
 from pydantic.fields import FieldInfo
 
-from fastlife.adapters.jinjax.widgets.base import Widget
+from fastlife.adapters.jinjax.widgets.base import CustomWidget, Widget
 from fastlife.request.form import FormModel
-from fastlife.services.templates import AbstractTemplateRenderer
+
+if TYPE_CHECKING:
+    from fastlife.services.templates import AbstractTemplateRenderer
 
 from .base import BaseWidgetBuilder
 from .bool_builder import BoolBuilder
@@ -35,7 +36,7 @@ class WidgetFactory:
     :param token: reuse a token.
     """
 
-    def __init__(self, renderer: AbstractTemplateRenderer, token: str | None = None):
+    def __init__(self, renderer: "AbstractTemplateRenderer", token: str | None = None):
         self.renderer = renderer
         self.token = token or secrets.token_urlsafe(4).replace("_", "-")
         self.builders: list[BaseWidgetBuilder[Any]] = [
@@ -131,24 +132,22 @@ class WidgetFactory:
         """
         if field and field.metadata:
             for widget in field.metadata:
-                if isclass(widget) and issubclass(widget, Widget):
-                    return cast(
-                        Widget[Any],
-                        widget(
-                            name,
-                            value=value,
-                            removable=removable,
-                            title=field.title if field else "",
-                            hint=field.description if field else None,
-                            aria_label=(
-                                field.json_schema_extra.get("aria_label")  # type:ignore
-                                if field and field.json_schema_extra
-                                else None
-                            ),
-                            token=self.token,
-                            error=form_errors.get(name),
+                if isinstance(widget, CustomWidget):
+                    ret: Widget[Any] = widget.typ(
+                        name=name,
+                        value=value,
+                        removable=removable,
+                        title=field.title or "" if field else "",
+                        hint=field.description if field else None,
+                        aria_label=(
+                            field.json_schema_extra.get("aria_label")  # type:ignore
+                            if field and field.json_schema_extra
+                            else None
                         ),
+                        token=self.token,
+                        error=form_errors.get(name),
                     )
+                    return ret
 
         type_origin = get_origin(typ)
         for builder in self.builders:

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/literal_builder.py

@@ -8,9 +8,10 @@ from pydantic.fields import FieldInfo
 from fastlife.adapters.jinjax.widget_factory.base import BaseWidgetBuilder
 from fastlife.adapters.jinjax.widgets.dropdown import DropDownWidget
 from fastlife.adapters.jinjax.widgets.hidden import HiddenWidget
+from fastlife.domain.model.types import AnyLiteral
 
 
-class LiteralBuilder(BaseWidgetBuilder[str]):  # str|int|bool
+class LiteralBuilder(BaseWidgetBuilder[AnyLiteral]):
     """Builder for Literal."""
 
     def accept(self, typ: type[Any], origin: type[Any] | None) -> bool:
@@ -23,7 +24,7 @@ class LiteralBuilder(BaseWidgetBuilder[str]):  # str|int|bool
         field_name: str,
         field_type: type[Any],  # a literal actually
         field: FieldInfo | None,
-        value: str | None,
+        value: AnyLiteral | None,
         form_errors: Mapping[str, Any],
         removable: bool,
     ) -> HiddenWidget | DropDownWidget:
@@ -31,15 +32,15 @@ class LiteralBuilder(BaseWidgetBuilder[str]):  # str|int|bool
         choices: list[str] = field_type.__args__  # type: ignore
         if len(choices) == 1:
             return HiddenWidget(
-                field_name,
+                name=field_name,
                 value=choices[0],
                 token=self.factory.token,
             )
         return DropDownWidget(
-            field_name,
-            options=choices,
+            name=field_name,
+            options=choices,  # type: ignore
             removable=removable,
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/model_builder.py

@@ -47,11 +47,11 @@ class ModelBuilder(BaseWidgetBuilder[Mapping[str, Any]]):
                 form_errors=form_errors,
                 removable=False,
             )
-        return ModelWidget(
-            field_name,
+        return ModelWidget[Any](
+            name=field_name,
             value=list(ret.values()),
             removable=removable,
-            title=field.title if field and field.title else "",
+            title=field.title or "" if field and field.title else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/secretstr_builder.py

@@ -30,11 +30,11 @@ class SecretStrBuilder(BaseWidgetBuilder[SecretStr]):
     ) -> Widget[SecretStr]:
         """Build the widget."""
         return TextWidget(
-            field_name,
+            name=field_name,
             input_type="password",
             placeholder=str(field.examples[0]) if field and field.examples else None,
             removable=removable,
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/sequence_builder.py

@@ -41,9 +41,9 @@ class SequenceBuilder(BaseWidgetBuilder[Sequence[Any]]):
             )
             for idx, v in enumerate(value)
         ]
-        return SequenceWidget(
-            field_name,
-            title=field.title if field else "",
+        return SequenceWidget[Any](
+            name=field_name,
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/set_builder.py

@@ -65,8 +65,8 @@ class SetBuilder(BaseWidgetBuilder[set[Any]]):
             raise NotImplementedError  # coverage: ignore
 
         return ChecklistWidget(
-            field_name,
-            title=field.title if field else "",
+            name=field_name,
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/simpletype_builder.py

@@ -1,23 +1,22 @@
 """Handle simple types (str, int, float, ...)."""
 
 from collections.abc import Mapping
-from decimal import Decimal
 from typing import Any
-from uuid import UUID
 
 from pydantic.fields import FieldInfo
 
 from fastlife.adapters.jinjax.widget_factory.base import BaseWidgetBuilder
 from fastlife.adapters.jinjax.widgets.base import Widget
 from fastlife.adapters.jinjax.widgets.text import TextWidget
+from fastlife.domain.model.types import Builtins
 
 
-class SimpleTypeBuilder(BaseWidgetBuilder[str | int | str | float | Decimal | UUID]):
+class SimpleTypeBuilder(BaseWidgetBuilder[Builtins]):
     """Builder for simple types."""
 
     def accept(self, typ: type[Any], origin: type[Any] | None) -> bool:
         """True for simple types: int, str, float, Decimal, UUID"""
-        return issubclass(typ, int | str | float | Decimal | UUID)
+        return issubclass(typ, Builtins)
 
     def build(
         self,
@@ -25,15 +24,15 @@ class SimpleTypeBuilder(BaseWidgetBuilder[str | int | str | float | Decimal | UU
         field_name: str,
         field_type: type[Any],
         field: FieldInfo | None,
-        value: int | str | float | Decimal | UUID | None,
+        value: Builtins | None,
         form_errors: Mapping[str, Any],
         removable: bool,
-    ) -> Widget[int | str | float | Decimal | UUID]:
+    ) -> Widget[Builtins]:
         """Build the widget."""
         return TextWidget(
-            field_name,
+            name=field_name,
             placeholder=str(field.examples[0]) if field and field.examples else None,
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widget_factory/union_builder.py

@@ -70,12 +70,12 @@ class UnionBuilder(BaseWidgetBuilder[Any]):
                         removable=False,
                     )
 
-        widget = UnionWidget(
-            field_name,
+        widget = UnionWidget[Any](
+            name=field_name,
             # we assume those types are BaseModel
             value=child,
             children_types=types,  # type: ignore
-            title=field.title if field else "",
+            title=field.title or "" if field else "",
             hint=field.description if field else None,
             aria_label=(
                 field.json_schema_extra.get("aria_label")  # type:ignore

{fastlifeweb-0.20.1 → fastlifeweb-0.21.0}/src/fastlife/adapters/jinjax/widgets/base.py

@@ -1,12 +1,13 @@
 """Widget base class."""
 
-import abc
 import secrets
 from collections.abc import Mapping
-from typing import Any, Generic, TypeVar
+from typing import Any, Generic, Self, TypeVar
 
 from markupsafe import Markup
+from pydantic import Field, model_validator
 
+from fastlife.domain.model.template import JinjaXTemplate
 from fastlife.services.templates import AbstractTemplateRenderer
 from fastlife.shared_utils.infer import is_union
 
@@ -21,7 +22,7 @@ def get_title(typ: type[Any]) -> str:
     )
 
 
-class Widget(abc.ABC, Generic[T]):
+class Widget(JinjaXTemplate, Generic[T]):
     """
     Base class for widget of pydantic fields.
 
@@ -39,48 +40,37 @@ class Widget(abc.ABC, Generic[T]):
 
     name: str
     "variable name, nested variables have dots."
-    value: T | None
+    id: str = Field(default="")
+    "variable name, nested variables have dots."
+    value: T | None = Field(default=None)
     """Value of the field."""
-    title: str
+    title: str = Field(default="")
     "Human title for the widget."
-    hint: str
+    hint: str | None = Field(default=None)
     "A help message for the the widget."
-    aria_label: str
+
+    error: str | None = Field(default=None)
+    "Error message."
+
+    aria_label: str | None = Field(default=None)
     "Non visible text alternative."
-    token: str
+    token: str = Field(default="")
     "unique token to ensure id are unique in the DOM."
-    removable: bool
+    removable: bool = Field(default=False)
     "Indicate that the widget is removable from the dom."
 
-    def __init__(
-        self,
-        name: str,
-        *,
-        value: T | None = None,
-        error: str | None = None,
-        title: str | None = None,
-        hint: str | None = None,
-        token: str | None = None,
-        aria_label: str | None = None,
-        removable: bool = False,
-    ):
-        self.name = name
-        self.value = value
-        self.error = error
-        self.title = title or name.split(".")[-1]
-        self.hint = hint or ""
-        self.aria_label = aria_label or ""
-        self.token = token or secrets.token_urlsafe(4).replace("_", "-")
-        self.removable = removable
-        self.id = f"{self.name}-{self.token}".replace("_", "-").replace(".", "-")
-
-    @abc.abstractmethod
-    def get_template(self) -> str:
-        """Get the widget component template."""
+    @model_validator(mode="after")
+    def fill_props(self) -> Self:
+        self.title = self.title or self.name.split(".")[-1]
+        self.token = self.token or secrets.token_urlsafe(4).replace("_", "-")
+        self.id = self.id or f"{self.name}-{self.token}".replace("_", "-").replace(
+            ".", "-"
+        )
+        return self
 
     def to_html(self, renderer: AbstractTemplateRenderer) -> Markup:
         """Return the html version."""
-        return Markup(renderer.render_template(self.get_template(), widget=self))
+        return Markup(renderer.render_template(self))
 
 
 def _get_fullname(typ: type[Any]) -> str:
@@ -90,6 +80,16 @@ def _get_fullname(typ: type[Any]) -> str:
     return f"{typ.__module__}:{typ.__name__}"
 
 
+TWidget = TypeVar("TWidget", bound=Widget[Any])
+
+
+class CustomWidget(Generic[TWidget]):
+    typ: type[Any]
+
+    def __init__(self, typ: type[TWidget]) -> None:
+        self.typ = typ
+
+
 class TypeWrapper:
     """
     Wrap children types for union type.

fastlifeweb-0.21.0/src/fastlife/adapters/jinjax/widgets/boolean.py

@@ -0,0 +1,25 @@
+"""
+Widget for field of type bool.
+"""
+
+from .base import Widget
+
+
+class BooleanWidget(Widget[bool]):
+    """
+    Widget for field of type bool.
+    """
+
+    template = """
+    <pydantic_form.Widget :widget_id="id" :removable="removable">
+      <div class="pt-4">
+        <div class="flex items-center">
+         <Checkbox :name="name" :id="id" :checked="value" value="1" />
+         <Label :for="id" class="ms-2 text-base text-neutral-900 dark:text-white">
+            {{title|safe}}
+          </Label>
+        </div>
+       <pydantic_form.Error :text="error" />
+      </div>
+    </pydantic_form.Widget>
+    """

fastlifeweb-0.21.0/src/fastlife/adapters/jinjax/widgets/checklist.py

@@ -0,0 +1,64 @@
+"""
+Widget for field of type Set.
+"""
+
+from collections.abc import Sequence
+from typing import Self
+
+from pydantic import BaseModel, Field, model_validator
+
+from .base import Widget
+
+
+class Checkable(BaseModel):
+    """A checkable field from a checklist."""
+
+    label: str
+    name: str
+    value: str
+    token: str
+    checked: bool
+    error: str | None = Field(default=None)
+
+    id: str | None = Field(default=None)
+    field_name: str | None = Field(default=None)
+
+    @model_validator(mode="after")
+    def fill_props(self) -> Self:
+        self.id = f"{self.name}-{self.value}-{self.token}".replace(".", "-")
+        self.field_name = f"{self.name}[]"
+        return self
+
+
+class ChecklistWidget(Widget[Sequence[Checkable]]):
+    """
+    Widget for field of type Set.
+    """
+
+    template = """
+    <pydantic_form.Widget :widget_id="id" :removable="removable">
+      <div class="pt-4">
+        <Details>
+          <Summary :id="id + '-summary'">
+            <H3 :class="H3_SUMMARY_CLASS">{{title}}</H3>
+            <pydantic_form.Error :text="error" />
+          </Summary>
+          <div>
+            {% for value in value %}
+            <div class="flex items-center mb-4">
+                <Checkbox :name="value.field_name" type="checkbox"
+                    :id="value.id"
+                    :value="value.value"
+                    :checked="value.checked" />
+                <Label :for="value.id"
+                    class="ms-2 text-base text-neutral-900 dark:text-white">
+                    {{- value.label -}}
+                </Label>
+                <pydantic_form.Error :text="value.error" />
+            </div>
+            {% endfor %}
+          </div>
+        </Details>
+      </div>
+    </pydantic_form.Widget>
+    """