fastlifeweb 0.9.7__py3-none-any.whl → 0.11.0__py3-none-any.whl

fastlife/templating/renderer/widgets/checklist.py

@@ -1,3 +1,7 @@
+"""
+Widget for field of type Set.
+"""
+
 from typing import Sequence
 
 from pydantic import BaseModel, Field
@@ -6,6 +10,8 @@ from .base import Widget
 
 
 class Checkable(BaseModel):
+    """A checkable field from a checklist."""
+
     label: str
     name: str
     value: str
@@ -24,11 +30,26 @@ class Checkable(BaseModel):
 
 
 class ChecklistWidget(Widget[Sequence[Checkable]]):
+    """
+    Widget for field of type Set.
+
+    :param name: field name.
+    :param title: title for the widget.
+    :param hint: hint for human.
+    :param aria_label: html input aria-label value.
+    :param value: current value.
+    :param error: error of the value if any.
+    :param removable: display a button to remove the widget for optional fields.
+    :param token: token used to get unique id on the form.
+    """
+
     def __init__(
         self,
         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 +61,8 @@ class ChecklistWidget(Widget[Sequence[Checkable]]):
             error=error,
             token=token,
             title=title,
+            hint=hint,
+            aria_label=aria_label,
             removable=removable,
         )
 

fastlife/templating/renderer/widgets/dropdown.py

@@ -1,20 +1,39 @@
+"""
+Widget for field of type Enum or Literal.
+"""
+
 from typing import Optional, Sequence, Tuple
 
 from .base import Widget
 
 
 class DropDownWidget(Widget[str]):
+    """
+    Widget for field of type Enum or Literal.
+
+    :param name: field name.
+    :param title: title for the widget.
+    :param hint: hint for human.
+    :param aria_label: html input aria-label value.
+    :param value: current value.
+    :param error: error of the value if any.
+    :param options: List of possible values.
+    :param removable: display a button to remove the widget for optional fields.
+    :param token: token used to get unique id on the form.
+    """
+
     def __init__(
         self,
         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 +42,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 +51,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"

fastlife/templating/renderer/widgets/factory.py

@@ -1,39 +1,49 @@
+"""
+Transform.
+"""
+
 import secrets
 from collections.abc import MutableSequence, Sequence
 from decimal import Decimal
 from enum import Enum
 from inspect import isclass
 from types import NoneType
-from typing import Any, Literal, Mapping, Optional, Type, cast, get_origin
+from typing import Any, Literal, Mapping, Type, cast, get_origin
 from uuid import UUID
 
 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.base import Widget
 from fastlife.templating.renderer.widgets.boolean import BooleanWidget
 from fastlife.templating.renderer.widgets.checklist import Checkable, ChecklistWidget
 from fastlife.templating.renderer.widgets.dropdown import DropDownWidget
 from fastlife.templating.renderer.widgets.hidden import HiddenWidget
+from fastlife.templating.renderer.widgets.model import ModelWidget
 from fastlife.templating.renderer.widgets.sequence import SequenceWidget
-
-from .base import Widget, get_title
-from .model import ModelWidget
-from .text import TextWidget
-from .union import UnionWidget
+from fastlife.templating.renderer.widgets.text import TextWidget
+from fastlife.templating.renderer.widgets.union import UnionWidget
 
 
 class WidgetFactory:
-    def __init__(self, renderer: AbstractTemplateRenderer, token: Optional[str] = None):
+    """
+    Form builder for pydantic model.
+
+    :param renderer: template engine to render widget.
+    :param token: reuse a token.
+    """
+
+    def __init__(self, renderer: AbstractTemplateRenderer, token: str | None = None):
         self.renderer = renderer
         self.token = token or secrets.token_urlsafe(4).replace("_", "-")
 
     def get_markup(
         self,
-        model: ModelResult[Any],
+        model: FormModel[Any],
         *,
         removable: bool = False,
         field: FieldInfo | None = None,
@@ -86,7 +96,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),
                         ),
@@ -148,24 +163,24 @@ class WidgetFactory:
         self,
         field_name: str,
         typ: Type[BaseModel],
-        field: Optional[FieldInfo],
+        field: FieldInfo | None,
         value: Mapping[str, Any],
         form_errors: Mapping[str, Any],
         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,16 +189,23 @@ 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(
         self,
         field_name: str,
         field_type: Type[Any],
-        field: Optional[FieldInfo],
+        field: FieldInfo | None,
         value: Any,
         form_errors: Mapping[str, Any],
         removable: bool,
@@ -233,6 +255,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),
@@ -244,8 +272,8 @@ class WidgetFactory:
         self,
         field_name: str,
         field_type: Type[Any],
-        field: Optional[FieldInfo],
-        value: Optional[Sequence[Any]],
+        field: FieldInfo | None,
+        value: Sequence[Any] | None,
         form_errors: Mapping[str, Any],
         removable: bool,
     ) -> Widget[Any]:
@@ -264,8 +292,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,
@@ -277,8 +310,8 @@ class WidgetFactory:
         self,
         field_name: str,
         field_type: Type[Any],
-        field: Optional[FieldInfo],
-        value: Optional[Sequence[Any]],
+        field: FieldInfo | None,
+        value: Sequence[Any] | None,
         form_errors: Mapping[str, Any],
         removable: bool,
     ) -> Widget[Any]:
@@ -320,6 +353,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 +378,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 +400,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 +426,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 +462,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 +488,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 +510,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),

fastlife/templating/renderer/widgets/hidden.py

@@ -1,13 +1,29 @@
+from typing import Any
+
 from .base import Widget
 
 
 class HiddenWidget(Widget[str]):
+    '''
+    Widget to annotate to display a field as an hidden field.
+
+    ::
+        from pydantic import BaseModel
+        from fastlife.templating.renderer.widgets.hidden import HiddenWidget
+
+        class MyForm(BaseModel):
+            id: Annotated[str, HiddenWidget] = Field(...)
+            """Identifier in the database."""
+
+    '''
+
     def __init__(
         self,
         name: str,
         *,
         value: str,
         token: str,
+        **kwargs: Any,
     ) -> None:
         super().__init__(name, value=value, token=token)
 

fastlife/templating/renderer/widgets/model.py

@@ -16,22 +16,28 @@ 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"
 
     def to_html(self, renderer: AbstractTemplateRenderer) -> Markup:
-        """Return the html version"""
+        """Return the html version."""
         children_widget = [child.to_html(renderer) for child in self.value or []]
         kwargs = {
             "widget": self,

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"
@@ -38,7 +40,7 @@ class SequenceWidget(Widget[Sequence[Widget[Any]]]):
         return TypeWrapper(self.item_type, route_prefix, self.name, self.token)
 
     def to_html(self, renderer: "AbstractTemplateRenderer") -> Markup:
-        """Return the html version"""
+        """Return the html version."""
         children = [Markup(item.to_html(renderer)) for item in self.value or []]
         return Markup(
             renderer.render_template(

fastlife/templating/renderer/widgets/text.py

@@ -4,32 +4,108 @@ from .base import Widget
 
 
 class TextWidget(Widget[str]):
+    """
+    Widget for text like field (email, ...).
+
+    :param name: input name.
+    :param title: title for the widget.
+    :param hint: hint for human.
+    :param aria_label: html input aria-label value.
+    :param placeholder: html input placeholder value.
+    :param error: error of the value if any.
+    :param value: current value.
+    :param removable: display a button to remove the widget for optional fields.
+    :param token: token used to get unique id on the form.
+    """
+
     def __init__(
         self,
         name: str,
         *,
         title: Optional[str],
+        hint: Optional[str] = None,
         aria_label: Optional[str] = None,
         placeholder: Optional[str] = None,
         error: str | None = None,
-        removable: bool = False,
         value: str = "",
-        token: Optional[str] = None,
-        hint: Optional[str] = None,
         input_type: str = "text",
+        removable: bool = False,
+        token: str,
     ) -> None:
         super().__init__(
             name,
             value=value,
             title=title,
+            hint=hint,
             aria_label=aria_label,
             token=token,
             error=error,
             removable=removable,
         )
         self.placeholder = placeholder or ""
-        self.hint = hint
         self.input_type = input_type
 
     def get_template(self) -> str:
         return "pydantic_form.Text"
+
+
+class TextareaWidget(Widget[str]):
+    """
+    Render a Textearea for a string or event a sequence of string.
+
+    ```
+    from fastlife.templating.renderer.widgets.text import TextareaWidget
+    from pydantic import BaseModel, Field, field_validator
+
+    class TaggedParagraphForm(BaseModel):
+        paragraph: Annotated[str, TextareaWidget] = Field(...)
+        tags: Annotated[Sequence[str], TextareaWidget] = Field(
+            default_factory=list,
+            title="Tags",
+            description="One tag per line",
+        )
+
+        @field_validator("tags", mode="before")
+        def split(cls, s: Any) -> Sequence[str]:
+            return s.split() if s else []
+    ```
+
+    :param name: input name.
+    :param title: title for the widget.
+    :param hint: hint for human.
+    :param aria_label: html input aria-label value.
+    :param placeholder: html input placeholder value.
+    :param error: error of the value if any.
+    :param value: current value.
+    :param removable: display a button to remove the widget for optional fields.
+    :param token: token used to get unique id on the form.
+
+    """
+
+    def __init__(
+        self,
+        name: str,
+        *,
+        title: Optional[str],
+        hint: Optional[str] = None,
+        aria_label: Optional[str] = None,
+        placeholder: Optional[str] = None,
+        error: str | None = None,
+        value: str = "",
+        removable: bool = False,
+        token: str,
+    ) -> None:
+        super().__init__(
+            name,
+            value=value,
+            title=title,
+            hint=hint,
+            aria_label=aria_label,
+            token=token,
+            error=error,
+            removable=removable,
+        )
+        self.placeholder = placeholder or ""
+
+    def get_template(self) -> str:
+        return "pydantic_form.Textarea"

fastlife/templating/renderer/widgets/union.py

@@ -1,3 +1,6 @@
+"""
+Widget for field of type Union.
+"""
 from typing import Any, Optional, Sequence, Type, Union
 
 from markupsafe import Markup
@@ -9,22 +12,41 @@ from .base import TypeWrapper, Widget
 
 
 class UnionWidget(Widget[Widget[Any]]):
+    """
+    Widget for union types.
+
+    :param name: input name.
+    :param title: title for the widget.
+    :param hint: hint for human.
+    :param aria_label: html input aria-label value.
+    :param value: current value.
+    :param error: error of the value if any.
+    :param children_types: childrens types list.
+    :param removable: display a button to remove the widget for optional fields.
+    :param token: token used to get unique id on the form.
+
+    """
+
     def __init__(
         self,
         name: str,
         *,
         title: Optional[str],
+        hint: Optional[str] = None,
+        aria_label: Optional[str] = None,
         value: Optional[Widget[Any]],
         error: str | None = None,
         children_types: Sequence[Type[BaseModel]],
+        removable: bool = False,
         token: str,
-        removable: bool,
     ):
         super().__init__(
             name,
             value=value,
             error=error,
             title=title,
+            hint=hint,
+            aria_label=aria_label,
             token=token,
             removable=removable,
         )
@@ -32,6 +54,7 @@ class UnionWidget(Widget[Widget[Any]]):
         self.parent_name = name
 
     def build_types(self, route_prefix: str) -> Sequence[TypeWrapper]:
+        """Wrap types in the union in order to get the in their own widgets."""
         return [
             TypeWrapper(typ, route_prefix, self.name, self.token)
             for typ in self.children_types
@@ -41,7 +64,7 @@ class UnionWidget(Widget[Widget[Any]]):
         return "pydantic_form.Union"
 
     def to_html(self, renderer: "AbstractTemplateRenderer") -> Markup:
-        """Return the html version"""
+        """Return the html version."""
         child = Markup(self.value.to_html(renderer)) if self.value else ""
         return Markup(
             renderer.render_template(