1
0
mirror of https://github.com/django/django.git synced 2025-10-26 07:06:08 +00:00

Fixed #34077 -- Added form field rendering.

This commit is contained in:
David Smith
2022-11-02 20:13:16 +00:00
committed by Mariusz Felisiak
parent d33368b4ab
commit cad376f844
16 changed files with 324 additions and 33 deletions

View File

@@ -1,7 +1,7 @@
import re
from django.core.exceptions import ValidationError
from django.forms.utils import pretty_name
from django.forms.utils import RenderableFieldMixin, pretty_name
from django.forms.widgets import MultiWidget, Textarea, TextInput
from django.utils.functional import cached_property
from django.utils.html import format_html, html_safe
@@ -10,8 +10,7 @@ from django.utils.translation import gettext_lazy as _
__all__ = ("BoundField",)
@html_safe
class BoundField:
class BoundField(RenderableFieldMixin):
"A Field plus data"
def __init__(self, form, field, name):
@@ -26,12 +25,7 @@ class BoundField:
else:
self.label = self.field.label
self.help_text = field.help_text or ""
def __str__(self):
"""Render this field as an HTML widget."""
if self.field.show_hidden_initial:
return self.as_widget() + self.as_hidden(only_initial=True)
return self.as_widget()
self.renderer = form.renderer
@cached_property
def subwidgets(self):
@@ -81,6 +75,13 @@ class BoundField:
self.name, self.form.error_class(renderer=self.form.renderer)
)
@property
def template_name(self):
return self.field.template_name or self.form.renderer.field_template_name
def get_context(self):
return {"field": self}
def as_widget(self, widget=None, attrs=None, only_initial=False):
"""
Render the field by rendering the passed widget, adding any HTML

View File

@@ -107,6 +107,7 @@ class Field:
localize=False,
disabled=False,
label_suffix=None,
template_name=None,
):
# required -- Boolean that specifies whether the field is required.
# True by default.
@@ -164,6 +165,7 @@ class Field:
self.error_messages = messages
self.validators = [*self.default_validators, *validators]
self.template_name = template_name
super().__init__()

View File

@@ -4,16 +4,7 @@
{% endif %}
{% for field, errors in fields %}
<div{% set classes = field.css_classes() %}{% if classes %} class="{{ classes }}"{% endif %}>
{% if field.use_fieldset %}
<fieldset>
{% if field.label %}{{ field.legend_tag() }}{% endif %}
{% else %}
{% if field.label %}{{ field.label_tag() }}{% endif %}
{% endif %}
{% if field.help_text %}<div class="helptext">{{ field.help_text|safe }}</div>{% endif %}
{{ errors }}
{{ field }}
{% if field.use_fieldset %}</fieldset>{% endif %}
{{ field.as_field_group() }}
{% if loop.last %}
{% for field in hidden_fields %}{{ field }}{% endfor %}
{% endif %}

View File

@@ -0,0 +1,10 @@
{% if field.use_fieldset %}
<fieldset>
{% if field.label %}{{ field.legend_tag() }}{% endif %}
{% else %}
{% if field.label %}{{ field.label_tag() }}{% endif %}
{% endif %}
{% if field.help_text %}<div class="helptext">{{ field.help_text|safe }}</div>{% endif %}
{{ field.errors }}
{{ field }}
{% if field.use_fieldset %}</fieldset>{% endif %}

View File

@@ -19,6 +19,7 @@ def get_default_renderer():
class BaseRenderer:
form_template_name = "django/forms/div.html"
formset_template_name = "django/forms/formsets/div.html"
field_template_name = "django/forms/field.html"
def get_template(self, template_name):
raise NotImplementedError("subclasses must implement get_template()")

View File

@@ -4,16 +4,7 @@
{% endif %}
{% for field, errors in fields %}
<div{% with classes=field.css_classes %}{% if classes %} class="{{ classes }}"{% endif %}{% endwith %}>
{% if field.use_fieldset %}
<fieldset>
{% if field.label %}{{ field.legend_tag }}{% endif %}
{% else %}
{% if field.label %}{{ field.label_tag }}{% endif %}
{% endif %}
{% if field.help_text %}<div class="helptext">{{ field.help_text|safe }}</div>{% endif %}
{{ errors }}
{{ field }}
{% if field.use_fieldset %}</fieldset>{% endif %}
{{ field.as_field_group }}
{% if forloop.last %}
{% for field in hidden_fields %}{{ field }}{% endfor %}
{% endif %}

View File

@@ -0,0 +1,10 @@
{% if field.use_fieldset %}
<fieldset>
{% if field.label %}{{ field.legend_tag }}{% endif %}
{% else %}
{% if field.label %}{{ field.label_tag }}{% endif %}
{% endif %}
{% if field.help_text %}<div class="helptext">{{ field.help_text|safe }}</div>{% endif %}
{{ field.errors }}
{{ field }}
{% if field.use_fieldset %}</fieldset>{% endif %}

View File

@@ -58,6 +58,29 @@ class RenderableMixin:
__html__ = render
class RenderableFieldMixin(RenderableMixin):
def as_field_group(self):
return self.render()
def as_hidden(self):
raise NotImplementedError(
"Subclasses of RenderableFieldMixin must provide an as_hidden() method."
)
def as_widget(self):
raise NotImplementedError(
"Subclasses of RenderableFieldMixin must provide an as_widget() method."
)
def __str__(self):
"""Render this field as an HTML widget."""
if self.field.show_hidden_initial:
return self.as_widget() + self.as_hidden(only_initial=True)
return self.as_widget()
__html__ = __str__
class RenderableFormMixin(RenderableMixin):
def as_p(self):
"""Render as <p> elements."""