Hardcoded HTML in python code.

[sesostris]

There is a hardcoded snippet of HTML in the django.contrib.admin.templatetags.admin_list module on lines 99 to 110 that will be used in the header of the changelist results table.

​https://github.com/django/django/blob/0e445badd54fafc75dd1a5dff9fee6e6a171eafe/django/contrib/admin/templatetags/admin_list.py#L99C1-L110C25

            # if the field is the action checkbox: no sorting and special class
            if field_name == "action_checkbox":
                aria_label = _("Select all objects on this page for an action")
                yield {
                    "text": mark_safe(
                        f'<input type="checkbox" id="action-toggle" '
                        f'aria-label="{aria_label}">'
                    ),
                    "class_attrib": mark_safe(' class="action-checkbox-column"'),
                    "sortable": False,
                }
                continue

It would be better to use a CheckboxInput widget to render this HTML element. The code would look like this:

from django.forms import CheckboxInput

        # if the field is the action checkbox: no sorting and special class
        if field_name == "action_checkbox":
            widget = CheckboxInput(
                attrs={
                    "aria-label": _(
                        "Select all objects on this page for an action"
                    ),
                    "id": "action-toggle",
                }
            )
            yield {
                "text": mark_safe(
                    widget.render(name="action-toggle", value=False)
                ),
                "class_attrib": mark_safe(' class="action-checkbox-column"'),
                "sortable": False,
            }
            continue

[David Smith]

Thank you for the ticket.

I'm not sure it's worth changing as there are test failures with this change so it is not equivalent. The ticket mentions that using a widget would be better but I'm unsure why using a widget and rending the HTML using the template engine would be better in this particular case.

[Natalia Bidart]

I would also like to read the answer to the last question (why using a widget and rending the HTML using the template engine would be better) but is worth nothing that the following diff has the test passing OK so at a code level it seems equivalent:

django/contrib/admin/templatetags/admin_list.py

@@ -1 +1 @@
 import datetime
 
+from django.forms import CheckboxInput
 from django.contrib.admin.templatetags.admin_urls import add_preserved_filters
 from django.contrib.admin.utils import (
     display_for_field,
@@ -99 +100 @@
             # if the field is the action checkbox: no sorting and special class
             if field_name == "action_checkbox":
                 aria_label = _("Select all objects on this page for an action")
+                widget = CheckboxInput(
+                    attrs={
+                        "aria-label": aria_label,
+                        "id": "action-toggle",
+                    }
+                )
                 yield {
                     "text": mark_safe(
-                        f'<input type="checkbox" id="action-toggle" '
-                        f'aria-label="{aria_label}">'
+                        widget.render(name="action-toggle", value=False)
                     ),
                     "class_attrib": mark_safe(' class="action-checkbox-column"'),
                     "sortable": False,

tests/admin_changelist/tests.py

@@ -359 +359 @@
             "Failed to find expected row element: %s" % table_output,
         )
         self.assertInHTML(
-            '<input type="checkbox" id="action-toggle" '
+            '<input type="checkbox" id="action-toggle" name="action-toggle"'
             'aria-label="Select all objects on this page for an action">',
             table_output,
         )