Integrate more into Form rendering API

Override BoundField to allow fields to be rendered using '{{ field.as_field_group }}' instead
of relying on template tags. This eliminates the need for '{% dsfr_form_field %}'.

Also implement Toggle form field

Author: christophehenry

dsfr/fields.py

@@ -1,9 +1,9 @@
 from django.core.exceptions import ValidationError
-from django.forms.fields import MultiValueField, IntegerField
+from django.forms.fields import MultiValueField, IntegerField, BooleanField
 
-from .widgets import NumberCursor
+from .widgets import NumberCursor, Toggle
 
-__all__ = ["IntegerRangeField"]
+__all__ = ["IntegerRangeField", "ToggleField"]
 
 
 class IntegerRangeField(MultiValueField):
@@ -49,3 +49,14 @@ def compress(self, data_list: list[int]) -> range:
                 "Le second nombre doit être supérieur au premier pour déterminer un intervalle"
             )
         return range(data_list[0], data_list[1] + 1)
+
+
+class ToggleField(BooleanField):
+    widget = Toggle
+    template_name = "dsfr/toggle.html"
+
+    def __init__(self, **kwargs):
+        kwargs["label_suffix"] = ""
+        super().__init__(**kwargs)
+        if self.disabled:
+            self.widget.attrs.setdefault("disabled", "true")

dsfr/forms.py

@@ -1,11 +1,12 @@
 import warnings
 from pathlib import Path
 
+import django
 from django import forms
 from django.forms.renderers import DjangoTemplates, get_default_renderer
 from django.utils.functional import cached_property
 
-from .utils import dsfr_input_class_attr
+from dsfr.utils import dsfr_input_class_attr
 
 
 class DsfrDjangoTemplates(DjangoTemplates):
@@ -24,17 +25,53 @@ def engine(self):  # type: ignore
         )
 
 
+class DsfrBoundField(forms.BoundField):
+    if django.VERSION < (5, 0):
+        """
+        Compatibility with Django<5.0
+        https://docs.djangoproject.com/en/5.0/ref/forms/api/#django.forms.BoundField.as_field_group
+        """
+
+        def as_field_group(self):
+            return self.render()
+
+    @property
+    def template_name(self):
+        template_name = self.field.template_name or getattr(
+            self.field.__class__, "template_name", None
+        )
+        if template_name:
+            return template_name
+
+        match self.widget_type:
+            case "checkboxinput":
+                return "dsfr/form_field_snippets/checkbox_snippet.html"
+            case "checkboxselectmultiple" | "inlinecheckboxselectmultiple":
+                return "dsfr/form_field_snippets/checkboxselectmultiple_snippet.html"
+            case "radioselect" | "inlineradioselect":
+                return "dsfr/form_field_snippets/radioselect_snippet.html"
+            case "richradioselect":
+                return "dsfr/form_field_snippets/richradioselect_snippet.html"
+            case "numbercursor":
+                return "dsfr/form_field_snippets/numbercursor_snippet.html"
+            case "segmentedcontrol":
+                return "dsfr/form_field_snippets/segmented_control_snippet.html"
+            case _:
+                return "dsfr/form_field_snippets/input_snippet.html"
+
+    def label_tag(self, contents=None, attrs=None, label_suffix=None, tag=None):
+        if hasattr(self.field.widget, "dsfr_label_attrs"):
+            attrs = {**self.field.widget.dsfr_label_attrs, **(attrs or {})}
+        return super().label_tag(contents, attrs, label_suffix, tag)
+
+
 class DsfrBaseForm(forms.Form):
     """
     A base form that adds the necessary classes on relevant fields
     """
 
     template_name = "dsfr/form_snippet.html"  # type: ignore
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        for visible in self.visible_fields():
-            dsfr_input_class_attr(visible)
+    bound_field_class = DsfrBoundField
 
     @property
     def default_renderer(self):  # type: ignore
@@ -46,6 +83,36 @@ def default_renderer(self):  # type: ignore
             else get_default_renderer()
         )
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        for visible in self.visible_fields():
+            dsfr_input_class_attr(visible)
+
+    if django.VERSION < (5, 2):
+        """
+        Compatibility with Django<5.2
+        https://docs.djangoproject.com/en/5.2/releases/5.2/#simplified-override-of-boundfield
+        """
+
+        def __getitem__(self, name):
+            try:
+                field = self.fields[name]
+            except KeyError:
+                raise KeyError(
+                    "Key '%s' not found in '%s'. Choices are: %s."
+                    % (
+                        name,
+                        self.__class__.__name__,
+                        ", ".join(sorted(self.fields)),
+                    )
+                )
+            if name not in self._bound_fields_cache:
+                bound_field_class = getattr(
+                    self, "bound_field_class", self.bound_field_class
+                )
+                self._bound_fields_cache[name] = bound_field_class(self, field, name)
+            return self._bound_fields_cache[name]
+
     def get_context(self) -> dict:
         from django.conf import settings
 

dsfr/templates/dsfr/form_base.html

@@ -36,7 +36,7 @@
         {# Everything that needs to be in the for loop #}
         {% block inside_form %}
         {% endblock inside_form %}
-        {% include "dsfr/form_field_snippets/field_snippet.html" %}
+        {{ field.as_field_group }}
       {% endfor %}
       {# If you need to add formsets after the form #}
       {% block extra_formset_after %}

dsfr/templates/dsfr/form_field_snippets/checkbox_snippet.html

@@ -3,7 +3,7 @@
   {{ field|dsfr_input_class_attr|attr:"type:checkbox" }}
   <label for="{{ field.id_for_label }}" class="fr-label">
     {# djlint:off #}
-    {{ field.label }}{% if not DSFR_MARK_OPTIONAL_FIELDS and field.field.required %}<span class="fr-required-marker" aria-hidden="true"> *</span>{% elif DSFR_MARK_OPTIONAL_FIELDS and not field.field.required %} {% translate '(Optional)' %}{% endif %}
+    {{ field.label }}{% dsfr_mark_optionnal_fields field %}
     {% if field.help_text %}
       <span class="fr-hint-text" id="{{ field.auto_id }}_helptext">{{ field.help_text|safe }}</span>
     {% endif %}

dsfr/templates/dsfr/form_field_snippets/checkboxselectmultiple_snippet.html

@@ -5,7 +5,7 @@
   <legend class="fr-fieldset__legend fr-fieldset__legend--regular"
           id="{{ field.auto_id }}-legend">
     {# djlint:off #}
-    {{ field.label }}{% if not DSFR_MARK_OPTIONAL_FIELDS and field.field.required %}<span class="fr-required-marker" aria-hidden="true"> *</span>{% elif DSFR_MARK_OPTIONAL_FIELDS and not field.field.required %} {% translate '(Optional)' %}{% endif %}
+    {{ field.label }}{% dsfr_mark_optionnal_fields field %}
     {% if field.help_text %}
       <span class="fr-hint-text" id="{{ field.auto_id }}_helptext">{{ field.help_text|safe }}</span>
     {% endif %}

dsfr/templates/dsfr/form_field_snippets/field_snippet.html

@@ -3,7 +3,7 @@
 <div class="{{ field.field.widget.group_class|default:'fr-input-group' }}{% if field.errors %} {{ field.field.widget.group_class|default:'fr-input-group' }}--error{% endif %}{% if field.field.disabled %} fr-input-group--disabled{% endif %}">
   <label for="{{ field.id_for_label }}" class="fr-label">
     {# djlint:off #}
-    {{ field.label }}{% if not DSFR_MARK_OPTIONAL_FIELDS and field.field.required %}<span class="fr-required-marker" aria-hidden="true"> *</span>{% elif DSFR_MARK_OPTIONAL_FIELDS and not field.field.required %} {% translate '(Optional)' %}{% endif %}
+    {{ field.label }}{% dsfr_mark_optionnal_fields field %}
     {% if field.help_text %}
       <span class="fr-hint-text" id="{{ field.id_for_label }}_helptext">{{ field.help_text|safe }}</span>
     {% endif %}

dsfr/templates/dsfr/form_field_snippets/input_snippet.html

@@ -3,7 +3,7 @@
 <div class="fr-range-group {% if field.errors %}fr-range-group--error{% endif %} {% if field.field.disabled %}fr-range-group--disabled{% endif %}">
   <label for="{{ field.id_for_label }}" class="fr-label">
     {# djlint:off #}
-    {{ field.label }}{% if not DSFR_MARK_OPTIONAL_FIELDS and field.field.required %}<span class="fr-required-marker" aria-hidden="true"> *</span>{% elif DSFR_MARK_OPTIONAL_FIELDS and not field.field.required %} {% translate '(Optional)' %}{% endif %}
+    {{ field.label }}{% dsfr_mark_optionnal_fields field %}
     {% if field.help_text %}
       <span class="fr-hint-text" id="{{ field.id_for_label }}_helptext">
         {{ field.help_text|safe }}, valeur

dsfr/templates/dsfr/form_field_snippets/numbercursor_snippet.html

@@ -5,7 +5,7 @@
   <legend class="fr-fieldset__legend fr-fieldset__legend--regular"
           id="{{ field.auto_id }}-legend">
     {# djlint:off #}
-    {{ field.label }}{% if not DSFR_MARK_OPTIONAL_FIELDS and field.field.required %}<span class="fr-required-marker" aria-hidden="true"> *</span>{% elif DSFR_MARK_OPTIONAL_FIELDS and not field.field.required %} {% translate '(Optional)' %}{% endif %}
+    {{ field.label }}{% dsfr_mark_optionnal_fields field %}
     {% if field.help_text %}
       <span class="fr-hint-text" id="{{ field.auto_id }}_helptext">{{ field.help_text|safe }}</span>
     {% endif %}

dsfr/templates/dsfr/form_field_snippets/radioselect_snippet.html

@@ -5,5 +5,9 @@
   </section>
 {% endif %}
 {% for field in form %}
-  {% dsfr_form_field field %}
+  {% if field.is_hidden %}
+    {{ field.as_hidden }}
+  {% else %}
+    {{ field.as_field_group }}
+  {% endif %}
 {% endfor %}