fastlifeweb 0.9.7__tar.gz → 0.10.0__tar.gz

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastlifeweb
-Version: 0.9.7
+Version: 0.10.0
 Summary: High-level web framework
 Home-page: https://github.com/mardiros/fastlife
 License: BSD-derived

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/pyproject.toml

@@ -15,7 +15,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
   "Topic :: Internet :: WWW/HTTP",
 ]
-version = "0.9.7"
+version = "0.10.0"
 
 [tool.poetry.dependencies]
 python = "^3.11"
@@ -52,11 +52,20 @@ pytailwindcss = "^0.2.0"
 [tool.pyright]
 include = ["src"]
 typeCheckingMode = "strict"
+reportMissingTypeStubs = false
 
 [[tool.mypy.overrides]]
+module =  "fastlife.*"
 disallow_any_generics = true
 disallow_untyped_defs = true
-module = "fastlife.*"
+
+[[tool.mypy.overrides]]
+module = [
+  "behave",
+  "venusian"
+]
+ignore_missing_imports = true
+
 
 [tool.isort]
 profile = "black"

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/configurator/configurator.py

@@ -21,7 +21,7 @@ from typing import (
     Union,
 )
 
-import venusian  # type: ignore
+import venusian
 from fastapi import Depends, FastAPI, Request, Response
 from fastapi.params import Depends as DependsType
 from fastapi.staticfiles import StaticFiles

fastlifeweb-0.9.7/src/fastlife/request/model_result.py → fastlifeweb-0.10.0/src/fastlife/request/form.py

@@ -11,7 +11,7 @@ T = TypeVar("T", bound=BaseModel)
 """Template type for form serialized model"""
 
 
-class ModelResult(Generic[T]):
+class FormModel(Generic[T]):
     prefix: str
     model: T
     errors: Mapping[str, str]
@@ -26,9 +26,19 @@ class ModelResult(Generic[T]):
         self.is_valid = is_valid
 
     @classmethod
-    def default(cls, prefix: str, pydantic_type: Type[T]) -> "ModelResult[T]":
+    def default(cls, prefix: str, pydantic_type: Type[T]) -> "FormModel[T]":
         return cls(prefix, pydantic_type.model_construct(), {})
 
+    def edit(self, pydantic_type: T) -> None:
+        """
+        Load the form with the given model and consider it as valid for the user.
+
+        No error will be reported.
+        """
+        self.model = pydantic_type
+        self.errors = {}
+        self.is_valid = True
+
     @property
     def form_data(self) -> Mapping[str, Any]:
         return {self.prefix: self.model.model_dump()}
@@ -36,7 +46,7 @@ class ModelResult(Generic[T]):
     @classmethod
     def from_payload(
         cls, prefix: str, pydantic_type: Type[T], data: Mapping[str, Any]
-    ) -> "ModelResult[T]":
+    ) -> "FormModel[T]":
         try:
             return cls(prefix, pydantic_type(**data.get(prefix, {})), {}, True)
         except ValidationError as exc:
@@ -75,17 +85,17 @@ class ModelResult(Generic[T]):
             return cls(prefix, model, errors)
 
 
-def model(
+def form_model(
     cls: Type[T], name: str | None = None
-) -> Callable[[Mapping[str, Any]], ModelResult[T]]:
+) -> Callable[[Mapping[str, Any]], FormModel[T]]:
     """
     Build a model, a class of type T based on Pydandic Base Model from a form payload.
     """
 
-    def to_model(data: MappingFormData, registry: Registry) -> ModelResult[T]:
+    def to_model(data: MappingFormData, registry: Registry) -> FormModel[T]:
         prefix = name or registry.settings.form_data_model_prefix
         if not data:
-            return ModelResult[T].default(prefix, cls)
-        return ModelResult[T].from_payload(prefix, cls, data)
+            return FormModel[T].default(prefix, cls)
+        return FormModel[T].from_payload(prefix, cls, data)
 
     return Depends(to_model)

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templates/Form.jinja

@@ -2,9 +2,10 @@
 method="",
 action=None,
 hx_post=None,
+hx_disable=None,
 #}
-<form class="{{attrs.class or FORM_CLASS}}" {% if hx_post is not none
-  %}hx-post="{% if hx_post is not true %}{{hx_post}}{% endif%}" {% endif %}{% if action is not none
+<form class="{{attrs.class or FORM_CLASS}}" {% if hx_disable %}hx-disable {% else %}{% if hx_post is not none
+  %}hx-post="{% if hx_post is not true %}{{hx_post}}{% endif%}" {% endif %}{% endif %}{% if action is not none
   %}action="{{action}}" {% endif %}{% if method %}method="{{method}}" {% endif %}>
   <CsrfToken />
   {{ content }}

fastlifeweb-0.10.0/src/fastlife/templates/Textarea.jinja

@@ -0,0 +1,11 @@
+{# def
+name,
+value="",
+id="",
+aria_label="",
+placeholder="",
+#}
+
+<textarea name="{{name}}" {% if id %}id="{{id}}" {% endif %}{% if aria_label
+  %}aria-label="{{aria_label}}" {% endif %} {% if placeholder %}placeholder="{{placeholder}}" {% endif %}
+  class="{{attrs.class or INPUT_CLASS}}">{{content}}</textarea>

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templates/pydantic_form/Model.jinja

@@ -1,7 +1,8 @@
 {# def widget, children_widget #}
 
 <pydantic_form.Widget :widget="widget" :removable="widget.removable">
-  <div id="{{widget.id}}" class="m-4">
+  <div id="{{widget.id}}"{% if widget.nested %} class="m-4"{%endif%}>
+    {% if widget.nested %}
     <Details>
       <Summary :id="widget.id + '-summary'">
         <H3 :class="H3_SUMMARY_CLASS">{{widget.title}}</H3>
@@ -13,5 +14,10 @@
         {% endfor %}
       </div>
     </Details>
+    {% else %}
+        {% for child in children_widget %}
+        {{ child }}
+        {% endfor %}
+    {% endif %}
   </div>
 </pydantic_form.Widget>

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templates/pydantic_form/Sequence.jinja

@@ -18,15 +18,16 @@
       </script>
 
       <div id="{{widget.id}}-content" class="m-4" data-length="{{children_widgets|length|string}}">
-        {% for child in children_widgets %}
-        {% set container_id = widget.id + "-container" %}
+        {% set container_id = widget.id + "-children-container" %}
         <div id="{{container_id}}">
+          {% for child in children_widgets %}
           {{ child }}
+          {% endfor%}
         </div>
-        {% endfor%}
       </div>
+
       <div>
-        {% set container_id = "#" + widget.id + "-container" %}
+        {% set container_id = "#" + widget.id + "-children-container" %}
         {% set add_id = widget.id + "-add" %}
         {% set vals = 'js:{"name": '+ fnGetName + '(), "token": "' + type.token + '", "removable": true}' %}
         <Button type="button" :hx-target="container_id" hx-swap="beforeend" :id="add_id" :hx-vals="vals" :hx-get="type.url">

fastlifeweb-0.10.0/src/fastlife/templates/pydantic_form/Textarea.jinja

@@ -0,0 +1,10 @@
+{# def widget #}
+<pydantic_form.Widget :widget="widget" :removable="widget.removable">
+  <div class="pt-4">
+    <Label :for="widget.id">{{widget.title}}</Label>
+    <pydantic_form.Error :text="widget.error" />
+    <Textarea :name="widget.name" :id="widget.id" :aria-label="widget.aria_label">{% for v in widget.value%}{{v}}
+{% endfor %}</Textarea>
+    <pydantic_form.Hint :text="widget.hint" />
+  </div>
+</pydantic_form.Widget>

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templates/pydantic_form/Widget.jinja

@@ -3,7 +3,7 @@
 <div id="{{container_id}}">
   {{ content }}
   {% if removable %}
-  <Button type="button" :onclick={{"document.getElementById('" + container_id + "').remove()"}}>
+  <Button type="button" :onclick={{"document.getElementById('" + container_id + "').remove()" }}>
     Remove
   </Button>
   {% endif %}

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/abstract.py

@@ -5,7 +5,7 @@ from fastapi import Request
 from markupsafe import Markup
 from pydantic.fields import FieldInfo
 
-from fastlife.request.model_result import ModelResult
+from fastlife.request.form import FormModel
 
 
 class AbstractTemplateRenderer(abc.ABC):
@@ -46,7 +46,7 @@ class AbstractTemplateRenderer(abc.ABC):
 
     @abc.abstractmethod
     def pydantic_form(
-        self, model: ModelResult[Any], *, token: Optional[str] = None
+        self, model: FormModel[Any], *, token: Optional[str] = None
     ) -> Markup:
         """
         Render an http form from a given model.

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/jinjax.py

@@ -5,7 +5,7 @@ from jinjax.catalog import Catalog
 from markupsafe import Markup
 from pydantic.fields import FieldInfo
 
-from fastlife.request.model_result import ModelResult
+from fastlife.request.form import FormModel
 from fastlife.templating.renderer.widgets.factory import WidgetFactory
 
 if TYPE_CHECKING:
@@ -69,7 +69,7 @@ class JinjaxRenderer(AbstractTemplateRenderer):
         )
 
     def pydantic_form(
-        self, model: ModelResult[Any], *, token: Optional[str] = None
+        self, model: FormModel[Any], *, token: Optional[str] = None
     ) -> Markup:
         return WidgetFactory(self, token).get_markup(model)
 

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/base.py

@@ -23,6 +23,8 @@ class Widget(abc.ABC, Generic[T]):
     "variable name, nested variables have dots"
     title: str
     "Human title for the widget"
+    hint: str
+    "A help message for the the widget"
     aria_label: str
     "Non visible text alternative"
     token: str
@@ -37,6 +39,7 @@ class Widget(abc.ABC, Generic[T]):
         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,
@@ -45,6 +48,7 @@ class Widget(abc.ABC, Generic[T]):
         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

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/boolean.py

@@ -7,6 +7,8 @@ class BooleanWidget(Widget[bool]):
         name: str,
         *,
         title: str | None,
+        hint: str | None = None,
+        aria_label: str | None = None,
         value: bool = False,
         error: str | None = None,
         removable: bool = False,
@@ -15,6 +17,8 @@ class BooleanWidget(Widget[bool]):
         super().__init__(
             name,
             title=title,
+            hint=hint,
+            aria_label=aria_label,
             value=value,
             error=error,
             removable=removable,

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/checklist.py

@@ -29,6 +29,8 @@ class ChecklistWidget(Widget[Sequence[Checkable]]):
         name: str,
         *,
         title: str | None,
+        hint: str | None = None,
+        aria_label: str | None = None,
         value: Sequence[Checkable],
         error: str | None = None,
         token: str,
@@ -40,6 +42,8 @@ class ChecklistWidget(Widget[Sequence[Checkable]]):
             error=error,
             token=token,
             title=title,
+            hint=hint,
+            aria_label=aria_label,
             removable=removable,
         )
 

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/dropdown.py

@@ -9,12 +9,13 @@ class DropDownWidget(Widget[str]):
         name: str,
         *,
         title: Optional[str],
+        hint: Optional[str] = None,
+        aria_label: Optional[str] = None,
         value: Optional[str] = None,
         error: str | None = None,
         options: Sequence[Tuple[str, str]] | Sequence[str],
         removable: bool = False,
         token: Optional[str] = None,
-        hint: Optional[str] = None,
     ) -> None:
         super().__init__(
             name,
@@ -23,6 +24,8 @@ class DropDownWidget(Widget[str]):
             title=title,
             token=token,
             removable=removable,
+            hint=hint,
+            aria_label=aria_label,
         )
         self.options: list[dict[str, str]] = []
         for opt in options:
@@ -30,7 +33,6 @@ class DropDownWidget(Widget[str]):
                 self.options.append({"value": opt[0], "text": opt[1]})
             else:
                 self.options.append({"value": opt, "text": opt})
-        self.hint = hint
 
     def get_template(self) -> str:
         return "pydantic_form.Dropdown"

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/factory.py

@@ -11,7 +11,7 @@ from markupsafe import Markup
 from pydantic import BaseModel, EmailStr, SecretStr, ValidationError
 from pydantic.fields import FieldInfo
 
-from fastlife.request.model_result import ModelResult
+from fastlife.request.form import FormModel
 from fastlife.shared_utils.infer import is_complex_type, is_union
 from fastlife.templating.renderer.abstract import AbstractTemplateRenderer
 from fastlife.templating.renderer.widgets.boolean import BooleanWidget
@@ -20,7 +20,7 @@ from fastlife.templating.renderer.widgets.dropdown import DropDownWidget
 from fastlife.templating.renderer.widgets.hidden import HiddenWidget
 from fastlife.templating.renderer.widgets.sequence import SequenceWidget
 
-from .base import Widget, get_title
+from .base import Widget
 from .model import ModelWidget
 from .text import TextWidget
 from .union import UnionWidget
@@ -33,7 +33,7 @@ class WidgetFactory:
 
     def get_markup(
         self,
-        model: ModelResult[Any],
+        model: FormModel[Any],
         *,
         removable: bool = False,
         field: FieldInfo | None = None,
@@ -86,7 +86,12 @@ class WidgetFactory:
                             value=value,
                             removable=removable,
                             title=field.title if field else "",
-                            aria_label=field.description if field else None,
+                            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),
                         ),
@@ -154,18 +159,18 @@ class WidgetFactory:
         removable: bool,
     ) -> Widget[Any]:
         ret: dict[str, Any] = {}
-        for key, field in typ.model_fields.items():
+        for key, child_field in typ.model_fields.items():
             child_key = f"{field_name}.{key}" if field_name else key
-            if field.exclude:
+            if child_field.exclude:
                 continue
-            if field.annotation is None:
+            if child_field.annotation is None:
                 raise ValueError(  # coverage: ignore
-                    f"Missing annotation for {field} in {child_key}"
+                    f"Missing annotation for {child_field} in {child_key}"
                 )
             ret[key] = self.build(
-                field.annotation,
+                child_field.annotation,
                 name=child_key,
-                field=field,
+                field=child_field,
                 value=value.get(key),
                 form_errors=form_errors,
                 removable=False,
@@ -174,9 +179,16 @@ class WidgetFactory:
             field_name,
             value=list(ret.values()),
             removable=removable,
-            title=get_title(typ),
+            title=field.title if field and field.title 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(field_name),
+            nested=field is not None,
         )
 
     def build_union(
@@ -233,6 +245,12 @@ class WidgetFactory:
             value=child,
             children_types=types,  # type: ignore
             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,
             removable=removable,
             error=form_errors.get(field_name),
@@ -264,8 +282,13 @@ class WidgetFactory:
         ]
         return SequenceWidget(
             field_name,
-            hint=field.description if field else "",
             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
+            ),
             value=items,
             item_type=typ,  # type: ignore
             token=self.token,
@@ -320,6 +343,12 @@ class WidgetFactory:
         return ChecklistWidget(
             field_name,
             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,
             value=choices,
             removable=removable,
@@ -339,6 +368,12 @@ class WidgetFactory:
             field_name,
             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,
             value=value,
             error=form_errors.get(field_name),
@@ -355,11 +390,16 @@ class WidgetFactory:
     ) -> Widget[Any]:
         return TextWidget(
             field_name,
-            hint=field.description if field else "",
             input_type="email",
             placeholder=str(field.examples[0]) if field and field.examples else None,
             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,
             value=str(value),
             error=form_errors.get(field_name),
@@ -376,11 +416,16 @@ class WidgetFactory:
     ) -> Widget[Any]:
         return TextWidget(
             field_name,
-            hint=field.description if field else "",
             input_type="password",
             placeholder=str(field.examples[0]) if field and field.examples else None,
             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,
             value=value.get_secret_value() if isinstance(value, SecretStr) else value,
             error=form_errors.get(field_name),
@@ -407,6 +452,12 @@ class WidgetFactory:
             options=choices,
             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,
             value=str(value),
             error=form_errors.get(field_name),
@@ -427,6 +478,12 @@ class WidgetFactory:
             options=options,  # type: ignore
             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,
             value=str(value),
             error=form_errors.get(field_name),
@@ -443,11 +500,15 @@ class WidgetFactory:
     ) -> Widget[Any]:
         return TextWidget(
             field_name,
-            hint=field.description if field else None,
             placeholder=str(field.examples[0]) if field and field.examples else None,
-            aria_label=field.description if field else None,
-            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
+            ),
+            removable=removable,
             token=self.token,
             value=str(value),
             error=form_errors.get(field_name),

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/hidden.py

@@ -1,3 +1,4 @@
+from typing import Any
 from .base import Widget
 
 
@@ -8,6 +9,7 @@ class HiddenWidget(Widget[str]):
         *,
         value: str,
         token: str,
+        **kwargs: Any,
     ) -> None:
         super().__init__(name, value=value, token=token)
 

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/model.py

@@ -16,16 +16,22 @@ class ModelWidget(Widget[Sequence[Widget[Any]]]):
         error: str | None = None,
         removable: bool,
         title: str,
+        hint: str | None = None,
+        aria_label: str | None = None,
         token: str,
+        nested: bool,
     ):
         super().__init__(
             name,
             title=title,
+            hint=hint,
+            aria_label=aria_label,
             value=value,
             error=error,
             removable=removable,
             token=token,
         )
+        self.nested = nested
 
     def get_template(self) -> str:
         return "pydantic_form.Model"

{fastlifeweb-0.9.7 → fastlifeweb-0.10.0}/src/fastlife/templating/renderer/widgets/sequence.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional, Sequence, Type
+from typing import Any, Sequence, Type
 
 from markupsafe import Markup
 
@@ -12,9 +12,10 @@ class SequenceWidget(Widget[Sequence[Widget[Any]]]):
         self,
         name: str,
         *,
-        title: Optional[str],
-        hint: Optional[str],
-        value: Optional[Sequence[Widget[Any]]],
+        title: str | None,
+        hint: str | None = None,
+        aria_label: str | None = None,
+        value: Sequence[Widget[Any]] | None,
         error: str | None = None,
         item_type: Type[Any],
         token: str,
@@ -25,11 +26,12 @@ class SequenceWidget(Widget[Sequence[Widget[Any]]]):
             value=value,
             error=error,
             title=title,
+            hint=hint,
+            aria_label=aria_label,
             token=token,
             removable=removable,
         )
         self.item_type = item_type
-        self.hint = hint
 
     def get_template(self) -> str:
         return "pydantic_form/Sequence"