Commit 584bd14d authored by Gabe Jackson's avatar Gabe Jackson Committed by Tim Graham
Browse files

Fixed #18134 -- BoundField.label_tag now includes the form's label_suffix 

There was an inconsistency between how the label_tag for forms were
generated depending on which method was used: as_p, as_ul and as_table
contained code to append the label_suffix where as label_tag called on a
form field directly did NOT append the label_suffix. The code for
appending the label_suffix has been moved in to the label_tag code of
the field and the HTML generation code for as_p, as_ul and as_table now
calls this code as well.

This is a backwards incompatible change because users who have added the
label_suffix manually in their templates may now get double label_suffix
characters in their forms.
parent a643e4d2

django/forms/forms.py

+4 −5
Original line number Diff line number Diff line
@@ -170,11 +170,6 @@ class BaseForm(object): 


                if bf.label:

                    label = conditional_escape(force_text(bf.label))

                    # Only add the suffix if the label does not end in

                    # punctuation.

                    if self.label_suffix:

                        if label[-1] not in ':?.!':

                            label = format_html('{0}{1}', label, self.label_suffix)

                    label = bf.label_tag(label) or ''

                else:

                    label = ''
@@ -522,6 +517,10 @@ class BoundField(object): 
        If attrs are given, they're used as HTML attributes on the <label> tag.

        """

        contents = contents or self.label

        # Only add the suffix if the label does not end in punctuation.

        if self.form.label_suffix:

            if contents[-1] not in ':?.!':

                contents = format_html('{0}{1}', contents, self.form.label_suffix)

        widget = self.field.widget

        id_ = widget.attrs.get('id') or self.auto_id

        if id_:

docs/ref/forms/api.txt

+8 −1
Original line number Diff line number Diff line
@@ -498,6 +498,8 @@ include ``%s`` -- then the library will act as if ``auto_id`` is ``True``. 


By default, ``auto_id`` is set to the string ``'id_%s'``.



.. attribute:: Form.label_suffix



Normally, a colon (``:``) will be appended after any label name when a form is

rendered. It's possible to change the colon to another character, or omit it

entirely, using the ``label_suffix`` parameter::
@@ -650,12 +652,17 @@ To separately render the label tag of a form field, you can call its 


    >>> f = ContactForm(data)

    >>> print(f['message'].label_tag())

    <label for="id_message">Message</label>

    <label for="id_message">Message:</label>



Optionally, you can provide the ``contents`` parameter which will replace the

auto-generated label tag. An optional ``attrs`` dictionary may contain

additional attributes for the ``<label>`` tag.



.. versionchanged:: 1.6



    The label now includes the form's :attr:`~django.forms.Form.label_suffix`

    (a semicolon, by default).



.. method:: BoundField.css_classes()



When you use Django's rendering shortcuts, CSS classes are used to

docs/releases/1.6.txt

+31 −0
Original line number Diff line number Diff line
@@ -581,6 +581,37 @@ It is still possible to convert the fetched rows to ``Model`` objects 
lazily by using the :meth:`~django.db.models.query.QuerySet.iterator()`

method.



:meth:`BoundField.label_tag<django.forms.BoundField.label_tag>` now includes the form's :attr:`~django.forms.Form.label_suffix`

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



This is consistent with how methods like

:meth:`Form.as_p<django.forms.Form.as_p>` and

:meth:`Form.as_ul<django.forms.Form.as_ul>` render labels.



If you manually render ``label_tag`` in your templates:



.. code-block:: html+django



    {{ form.my_field.label_tag }}: {{ form.my_field }}



you'll want to remove the semicolon (or whatever other separator you may be

using) to avoid duplicating it when upgrading to Django 1.6. The following

template in Django 1.6 will render identically to the above template in Django

1.5, except that the semicolon will appear inside the ``<label>`` element.



.. code-block:: html+django



     {{ form.my_field.label_tag }} {{ form.my_field }}



will render something like:



.. code-block:: html



    <label for="id_my_field">My Field:</label> <input id="id_my_field" type="text" name="my_field" />



If you want to keep the current behavior of rendering ``label_tag`` without

the ``label_suffix``, instantiate the form ``label_suffix=''``.



Miscellaneous

~~~~~~~~~~~~~

docs/topics/forms/index.txt

+11 −5
Original line number Diff line number Diff line
@@ -302,7 +302,7 @@ loop:: 
        {% for field in form %}

            <div class="fieldWrapper">

                {{ field.errors }}

                {{ field.label_tag }}: {{ field }}

                {{ field.label_tag }} {{ field }}

            </div>

        {% endfor %}

        <p><input type="submit" value="Send message" /></p>
@@ -316,8 +316,14 @@ attributes, which can be useful in your templates: 
    The label of the field, e.g. ``Email address``.



``{{ field.label_tag }}``

    The field's label wrapped in the appropriate HTML ``<label>`` tag,

    e.g. ``<label for="id_email">Email address</label>``

    The field's label wrapped in the appropriate HTML ``<label>`` tag.



    .. versionchanged:: 1.6



        This includes the form's :attr:`~django.forms.Form.label_suffix`. For

        example, the default ``label_suffix`` is a semicolon::



            <label for="id_email">Email address:</label>



``{{ field.value }}``

    The value of the field. e.g ``someone@example.com``
@@ -375,7 +381,7 @@ these two methods:: 
        {% for field in form.visible_fields %}

            <div class="fieldWrapper">

                {{ field.errors }}

                {{ field.label_tag }}: {{ field }}

                {{ field.label_tag }} {{ field }}

            </div>

        {% endfor %}

        <p><input type="submit" value="Send message" /></p>
@@ -403,7 +409,7 @@ using the :ttag:`include` tag to reuse it in other templates:: 
    {% for field in form %}

        <div class="fieldWrapper">

            {{ field.errors }}

            {{ field.label_tag }}: {{ field }}

            {{ field.label_tag }} {{ field }}

        </div>

    {% endfor %}

docs/topics/forms/modelforms.txt

+1 −1
Original line number Diff line number Diff line
@@ -907,7 +907,7 @@ Third, you can manually render each field:: 
        {{ formset.management_form }}

        {% for form in formset %}

            {% for field in form %}

                {{ field.label_tag }}: {{ field }}

                {{ field.label_tag }} {{ field }}

            {% endfor %}

        {% endfor %}

    </form>