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

fastlife/templates/Label.jinja

@@ -1,2 +1,18 @@
-
-<label for="{{attrs.for}}" class="{{attrs.class or LABEL_CLASS}}">{{content}}</label>
+{# doc
+  Produce ``<label>`` node.
+#}
+{# def
+  for_: Annotated[str | None, "unique identifier of the target element."] = None,
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.LABEL_CLASS`."
+  ] = None,
+#}
+<label
+    {%- if attrs.for %} for="{{attrs.for}}" {%- endif %}
+    class="{{attrs.class or LABEL_CLASS}}"
+    {%- if id %} id="{{id}}" {%- endif %}>
+  {{-content -}}
+</label>

fastlife/templates/Option.jinja

@@ -1,4 +1,16 @@
-{# def value, id=None, selected=False #}
-<option value="{{value}}" {%if id%}id="{{id}}" {% endif%} {%if selected%}selected{% endif%}>
+{# doc
+  Produce ``<option>`` node.
+#}
+{# def
+  value: Annotated[str, "posted value after submitted the selected value"],
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  selected: Annotated[
+    Literal[True],
+    "Used to select the option while rendering the form"
+  ] = False,
+#}
+<option value="{{value}}"
+  {%- if id %} id="{{id}}" {%- endif %}
+  {%- if selected %} selected {%- endif %}>
   {{- content -}}
 </option>

fastlife/templates/P.jinja

@@ -1,4 +1,16 @@
+{# doc
+  Produce ``<p>`` node.
+#}
 {# def
-id="",
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.P_CLASS`."
+  ] = None,
 #}
-<p {% if id %}id="{{id}}" {% endif %} class="{{ attrs.class or P_CLASS}}">{{content}}</p>
+<p
+  {%- if id %} id="{{id}}" {% endif %}
+  class="{{ attrs.class or P_CLASS }}">
+  {{- content -}}
+</p>

fastlife/templates/Radio.jinja

@@ -1,15 +1,37 @@
+{# doc
+  Produce a ``<input type="radio">`` with its associated label inside a div.
+#}
 {# def
-label,
-name,
-id,
-value,
-checked=false,
-disabled=false,
-onclick="",
+  label: Annotated[str, "label text associated to the radio"],
+  name: Annotated[str, "name of the submitted"],
+  value: Annotated[str, "value that will be submitted if selected"],
+  id: Annotated[str | None, "unique identifier of the element."],
+  checked: Annotated[bool, "Tick the radio button"] = False,
+  disabled: Annotated[bool, "Mark the radio button as disabled"] = False,
+  onclick: Annotated[str | None, "execute some javascript while clicking"] = None,
+  div_class: Annotated[
+    str | None,
+    "css class for the div node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.RADIO_DIV_CLASS`"
+  ] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the input node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.RADIO_INPUT_CLASS`"
+  ] = None,
+  label_class: Annotated[
+    str | None,
+    "css class for the label node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.RADIO_LABEL_CLASS`"
+  ] = None,
 #}
-<div class="{{attrs.div_class or RADIO_DIV_CLASS}}">
-  <input type="radio" name="{{name}}" id="{{id}}" value="{{value}}" {% if checked %}checked{% endif %}
-    class="{{attrs.class or RADIO_INPUT_CLASS}}" {% if onclick %}onclick="{{onclick}}" {% endif %} {%if
-    disabled%}disabled{%endif%}>
-  <Label :for="id" :class="attrs.label_class or RADIO_LABEL_CLASS">{{label}}</Label>
+<div class="{{ div_class or RADIO_DIV_CLASS }}">
+  <input type="radio" name="{{ name }}" id="{{ id }}" value="{{ value }}"
+    class="{{ attrs.class or RADIO_INPUT_CLASS }}"
+    {%- if onclick %} onclick="{{onclick}}" {%- endif %}
+    {%- if checked %} checked {%- endif %}
+    {%- if disabled %} disabled {%- endif %}>
+  <Label :for="id" :class="label_class or RADIO_LABEL_CLASS">
+      {{- label -}}
+  </Label>
 </div>

fastlife/templates/Select.jinja

@@ -1,9 +1,20 @@
+{# doc
+  Create html ``<select>`` node.
+#}
 {# def
-name,
-id,
-multiple=False,
+name: Annotated[str, "name of the submitted"],
+id: Annotated[str | None, "unique identifier of the element."] = None,
+class_: Annotated[
+  str | None,
+  "css class for the node, defaults to "
+  ":attr:`fastlife.templating.renderer.constants.Constants.SELECT_CLASS`."
+] = None,
+multiple: Annotated[bool, "Mark as multiple"] = False,
 #}
 
-<select name="{{name}}" id="{{id}}" class="{{attrs.class or SELECT_CLASS}}" {% if multiple %}multiple{% endif %}>
+<select name="{{name}}"
+  {%- if id %} id="{{ id }}" {%- endif %}
+  class="{{attrs.class or SELECT_CLASS}}"
+  {%- if multiple %} multiple {%- endif %}>
   {{- content -}}
 </select>

fastlife/templates/Summary.jinja

@@ -1,6 +1,17 @@
-{# def id, open=True #}
+{# doc
+  Create html ``<summary>`` node for the :jinjax:component:`Details` component.
+#}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.SUMMARY_CLASS`."
+  ] = None,
+  open: Annotated[bool, "Open or collapse the content of the details."] = True
+#}
 
-<summary id="{{id}}" class="flex items-center items-center font-medium cursor-pointer"
+<summary id="{{id}}" :class="attrs.class or SUMMARY_CLASS"
   style="list-style: none; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none;"
   onclick="document.getElementById('{{id}}-icon').classList.toggle('rotate-90')">
   <icons.ChevronRight :id="id + '-icon'"

fastlife/templates/Table.jinja

@@ -1,3 +1,14 @@
-<table class="{{attrs.class or TABLE_CLASS}}">
+{# doc html ``<table>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.TABLE_CLASS`."
+  ] = None,
+#}
+<table
+  {%- if id %} id="{{id}}" {%- endif %}
+  class="{{attrs.class or TABLE_CLASS}}">
   {{- content -}}
 </table>

fastlife/templates/Tbody.jinja

@@ -1,3 +1,13 @@
-<tbody>
+{# doc html ``<tbody>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node."
+  ] = None,
+#}
+<tbody
+  {%- if id %} id="{{id}}" {%- endif %}
+  {%- if class %} class="{{attrs.class}}" {%- endif %}>
   {{- content -}}
 </tbody>

fastlife/templates/Td.jinja

@@ -1,3 +1,14 @@
-<td class="{{attrs.class or TD_CLASS}}">
+{# doc html ``<td>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.TD_CLASS`"
+  ] = None,
+#}
+<td
+  {%- if id %} id="{{id}}" {%- endif %}
+  class="{{attrs.class or TD_CLASS}}">
   {{- content -}}
 </td>

fastlife/templates/Textarea.jinja

@@ -0,0 +1,18 @@
+{# doc html ``<textarea>`` node. #}
+{# def
+  name: Annotated[str, "name of the submitted"],
+  id: Annotated[str | None, "unique identifier of the element."],
+  aria_label: Annotated[str | None, "aria-label"] = None,
+  placeholder: Annotated[
+    str | None,
+    "brief hint to the user as to what kind of information is expected in the field"
+  ] = None,
+#}
+
+<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>

fastlife/templates/Tfoot.jinja

@@ -1,3 +1,13 @@
-<tfoot>
+{# doc html ``<tfoot>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node."
+  ] = None,
+#}
+<tfoot
+  {%- if id %} id="{{id}}" {%- endif %}
+  {%- if class %} class="{{attrs.class}}" {%- endif %}>
   {{- content -}}
 </tfoot>

fastlife/templates/Th.jinja

@@ -1,3 +1,14 @@
-<th class="{{attrs.class or TH_CLASS}}">
+{# doc html ``<th>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node, defaults to "
+    ":attr:`fastlife.templating.renderer.constants.Constants.TH_CLASS`."
+  ] = None,
+#}
+<th
+  {%- if id %} id="{{id}}" {%- endif %}
+  class="{{attrs.class or TH_CLASS}}">
   {{- content -}}
 </th>

fastlife/templates/Thead.jinja

@@ -1,3 +1,13 @@
-<thead>
+{# doc html ``<thead>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node"
+  ] = None,
+#}
+<thead
+  {%- if id %} id="{{id}}" {%- endif %}
+  {%- if class %} class="{{attrs.class}}" {%- endif %}>
   {{- content -}}
 </thead>

fastlife/templates/Tr.jinja

@@ -1,3 +1,13 @@
-<tr class="{{attrs.class}}">
+{# doc html ``<tr>`` node. #}
+{# def
+  id: Annotated[str | None, "unique identifier of the element."] = None,
+  class_: Annotated[
+    str | None,
+    "css class for the node."
+  ] = None,
+#}
+<tr
+  {%- if id %} id="{{id}}" {%- endif %}
+  {%- if class %} class="{{attrs.class}}" {%- endif %}>
   {{- content -}}
 </tr>

fastlife/templates/pydantic_form/Boolean.jinja

@@ -1,5 +1,6 @@
-{# def widget #}
-<pydantic_form.Widget :widget="widget" :removable="widget.removable">
+{# doc Render a checkbox and a label for boolean field. #}
+{# def widget: Annotated[fastlife.templating.renderer.widgets.boolean.BooleanWidget, "widget to display."] #}
+<pydantic_form.Widget :widget="widget">
   <div class="pt-4">
     <div class="flex items-center">
      <Checkbox :name="widget.name" type="checkbox" :id="widget.id" :checked="widget.value" value="1" />

fastlife/templates/pydantic_form/Checklist.jinja

@@ -1,8 +1,6 @@
-{# def
-widget,
-#}
-
-<pydantic_form.Widget :widget="widget" :removable="widget.removable">
+{# doc Render a list of checkbox and a label for Literal and enum fields #}
+{# def widget: Annotated[fastlife.templating.renderer.widgets.checklist.ChecklistWidget, "widget to display."] #}
+<pydantic_form.Widget :widget="widget">
   <div class="pt-4">
     <Details>
       <Summary :id="widget.id + '-summary'">

fastlife/templates/pydantic_form/Dropdown.jinja

@@ -1,6 +1,7 @@
-{# def widget #}
+{# doc Render a Select with options #}
+{# def widget: Annotated[fastlife.templating.renderer.widgets.dropdown.DropDownWidget, "widget to display."] #}
 
-<pydantic_form.Widget :widget="widget" :removable="widget.removable">
+<pydantic_form.Widget :widget="widget">
   <div class="pt-4">
     <Label :for="widget.id">{{widget.title}}</Label>
     <Select :name="widget.name" :id="widget.id">

fastlife/templates/pydantic_form/Error.jinja

@@ -1,4 +1,5 @@
-{# def text #}
-{% if text %}
+{# doc display an error for a field. #}
+{# def text: Annotated[str | None, "error message"] #}
+{%- if text -%}
 <span class="mt-2 text-sm text-danger-500 dark:text-danger-400">{{text}}</span>
-{% endif %}
+{%- endif -%}

fastlife/templates/pydantic_form/Hidden.jinja

@@ -1,2 +1,3 @@
-{# def widget #}
+{# doc Render a hidden input field for a field. #}
+{# def widget: Annotated[fastlife.templating.renderer.widgets.hidden.HiddenWidget, "widget to display."] #}
 <Hidden :name="widget.name" :value="widget.value" :id="widget.id" />

fastlife/templates/pydantic_form/Hint.jinja

@@ -1,4 +1,5 @@
-{# def text #}
+{# Display a hint message for a field. #}
+{# def text: Annotated[str | None, "hint text."] #}
 {% if text %}
 <span class="mt-2 text-sm text-neutral-500 dark:text-neutral-400">{{text}}</span>
 {% endif %}

fastlife/templates/pydantic_form/Model.jinja

@@ -1,7 +1,15 @@
-{# def widget, children_widget #}
+{# doc Widget for pydantic BaseModel subclasses. #}
+{# def
+    widget: Annotated[fastlife.templating.renderer.widgets.model.ModelWidget, "widget to display."],
+    children_widget : Annotated[
+        Sequence[fastlife.templating.renderer.widgets.base.Widget],
+        "child widgets for every fields of the model."
+    ],
+#}
 
-<pydantic_form.Widget :widget="widget" :removable="widget.removable">
-  <div id="{{widget.id}}" class="m-4">
+<pydantic_form.Widget :widget="widget">
+  <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 +21,10 @@
         {% endfor %}
       </div>
     </Details>
+    {% else %}
+        {% for child in children_widget %}
+        {{ child }}
+        {% endfor %}
+    {% endif %}
   </div>
 </pydantic_form.Widget>

fastlife/templates/pydantic_form/Sequence.jinja

@@ -1,6 +1,14 @@
-{# def widget, children_widgets, type #}
+{# doc Widget for pydantic BaseModel subclasses. #}
+{# def
+    widget: Annotated[fastlife.templating.renderer.widgets.sequence.SequenceWidget, "widget to display."],
+    children_widgets : Annotated[
+        Sequence[fastlife.templating.renderer.widgets.base.Widget],
+        "child widgets for every fields of the model."
+    ],
+    type: Annotated[fastlife.templating.renderer.widgets.base.TypeWrapper, "child type wrapped."]
+#}
 
-<pydantic_form.Widget :widget="widget" :removable="widget.removable">
+<pydantic_form.Widget :widget="widget">
   <Details :id="widget.id">
     <Summary :id="widget.id + '-summary'">
       <H3 :class="H3_SUMMARY_CLASS">{{widget.title}}</H3>
@@ -18,15 +26,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">

fastlife/templates/pydantic_form/Text.jinja

@@ -1,6 +1,6 @@
-{# def widget #}
+{# def widget: Annotated[fastlife.templating.renderer.widgets.text.TextWidget, "widget to display."] #}
 
-<pydantic_form.Widget :widget="widget" :removable="widget.removable">
+<pydantic_form.Widget :widget="widget">
   <div class="pt-4">
     <Label :for="widget.id">{{widget.title}}</Label>
     <pydantic_form.Error :text="widget.error" />

fastlife/templates/pydantic_form/Textarea.jinja

@@ -0,0 +1,32 @@
+{# doc
+Render textarea widget for field of type text of event sequence.
+
+::
+
+    from fastlife.templating.renderer.widgets.text import TextareaWidget
+    from pydantic import BaseModel, Field, field_validator
+
+    class TagsForm(BaseModel):
+
+        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 []
+
+ #}
+{# def widget: Annotated[fastlife.templating.renderer.widgets.text.TextareaWidget, "widget to display."] #}
+
+<pydantic_form.Widget :widget="widget">
+  <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>

fastlife/templates/pydantic_form/Union.jinja

@@ -1,4 +1,10 @@
-{# def widget, child, types, parent_type #}
+{# doc display widget for union type field #}
+{# def
+widget: Annotated[fastlife.templating.renderer.widgets.base.Widget, "widget to display."],
+child: Annotated[fastlife.templating.renderer.widgets.base.Widget, "current widget if any"],
+types: Annotated[Sequence[fastlife.templating.renderer.widgets.base.TypeWrapper], "Child types to choose"],
+parent_type: Annotated[fastlife.templating.renderer.widgets.base.TypeWrapper, "parent type"]
+#}
 
 <pydantic_form.Widget :widget="widget">
   <div id="{{widget.id}}">

fastlife/templates/pydantic_form/Widget.jinja

@@ -1,9 +1,12 @@
-{# def widget, removable=false #}
+{# doc Base component for widget #}
+{# def
+widget: Annotated[fastlife.templating.renderer.widgets.base.Widget, "widget to display."],
+#}
 {% set container_id = widget.id + "-container" %}
 <div id="{{container_id}}">
   {{ content }}
-  {% if removable %}
-  <Button type="button" :onclick={{"document.getElementById('" + container_id + "').remove()"}}>
+  {% if widget.removable %}
+  <Button type="button" :onclick={{"document.getElementById('" + container_id + "').remove()" }}>
     Remove
   </Button>
   {% endif %}

fastlife/templating/binding.py

@@ -1,21 +1,35 @@
+"""
+Bind template to the view in order to build an html response.
+"""
+
 from typing import Any, Callable
 
-from fastapi import Depends, Request, Response
+from fastapi import Depends, Response
 
-from fastlife.configurator.registry import Registry
+from fastlife.request import Request
 from fastlife.security.csrf import create_csrf_token
 
 Template = Callable[..., Response]
-TemplateEngine = Callable[["Registry", Request], Template]
+"""Type to annotate a FastAPI depency injection."""
+
+TemplateEngine = Callable[[Request], Template]
 
 
 def get_template(template: str, *, content_type: str = "text/html") -> TemplateEngine:
+    """
+    Return a closure to render the given template.
+
+    :param template: path to template to render.
+    :param content_type: response ``Content-Type`` header.
+    """
+
     def render_template(
-        reg: "Registry",
         request: Request,
         *,
         _create_csrf_token: Callable[..., str] = create_csrf_token,
     ) -> Template:
+        reg = request.registry
+
         def parametrizer(**kwargs: Any) -> Response:
             request.scope[reg.settings.csrf_token_name] = (
                 request.cookies.get(reg.settings.csrf_token_name)

fastlife/templating/renderer/__init__.py

@@ -1,9 +1,11 @@
+"""Template renderer."""
+
 from .abstract import AbstractTemplateRendererFactory
 from .constants import Constants
 from .jinjax import JinjaxTemplateRenderer
 
 __all__ = [
     "AbstractTemplateRendererFactory",
-    "Constants",
     "JinjaxTemplateRenderer",
+    "Constants",
 ]

fastlife/templating/renderer/abstract.py

@@ -1,3 +1,13 @@
+"""
+Base class to of the template renderer.
+
+Fastlife comes with :class:`fastlife.templating.renderer.jinjax.JinjaxTemplateRenderer`,
+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.
+
+"""
 import abc
 from typing import Any, Mapping, Optional, Type
 
@@ -5,7 +15,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):
@@ -15,7 +25,7 @@ class AbstractTemplateRenderer(abc.ABC):
     """
 
     route_prefix: str
-    """Used to buid pydantic form"""
+    """Used to buid pydantic form."""
 
     @abc.abstractmethod
     def render_template(
@@ -38,7 +48,7 @@ class AbstractTemplateRenderer(abc.ABC):
         to every templates. This can be used to fillout options in a select without
         performing an ajax request for example.
 
-        :param template: name of the template to render
+        :param template: name of the template to render.
         :param globals: some variable that will be passed to all rendered templates.
         :param params: paramaters that are limited to the main rendered templates.
         :return: The template rendering result.
@@ -46,7 +56,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.
@@ -57,16 +67,16 @@ class AbstractTemplateRenderer(abc.ABC):
 
         this function is used inside the template directly. And it will not render the
         <form> tag so the action/httpx post is not handled byu the method..
-        Somethinging like this
+        Somethinging like this:
 
         ::
 
-            <form action="" method="post">
+            <Form action="" method="post">
                 {{ pydantic_form(model) }}
-            </form>
+            </Form>
 
 
-        :param model: model to render
+        :param model: model to render.
         :param token: a random string that can be passed for testing purpose.
         """
         ...
@@ -94,6 +104,9 @@ class AbstractTemplateRenderer(abc.ABC):
 class AbstractTemplateRendererFactory(abc.ABC):
     """
     The template render factory.
+
+    The implementation of this class is found using the settings
+    :attr:`fastlife.config.settings.Settings.template_renderer_class`.
     """
 
     @abc.abstractmethod