Ticket #3064: newforms_label.patch

django/newforms/forms.py

@@ -3 +3 @@
 """
 
 from django.utils.datastructures import SortedDict
+from django.utils.html import escape
 from fields import Field
 from widgets import TextInput, Textarea
 from util import ErrorDict, ErrorList, ValidationError
@@ -190 +191 @@
         "Returns a string of HTML for representing this as a <textarea>."
         return self.as_widget(Textarea(), attrs)
 
+    def _verbose_name(self):
+        return pretty_name(self._name)
+    verbose_name = property(_verbose_name)
+
     def _label(self):
-        return pretty_name(self._name)
+        """
+        Returns the verbose field name (HTML escaped) and wraps with an HTML
+        label tag if either the field has an auto_id or the default widget has
+        an id attribute.
+        """
+        label = escape(self.verbose_name)
+        id = self._field.widget.attrs.get('id') or self.auto_id
+        if id:
+            label = '<label for="%s">%s</label>' % (escape(id), label)
+        return label
     label = property(_label)
 
     def _auto_id(self):

tests/regressiontests/forms/tests.py

@@ -1252 +1252 @@
 "auto_id" tells the Form to add an "id" attribute to each form element.
 If it's a string that contains '%s', Django will use that as a format string
 into which the field's name will be inserted.
+Form elements with ids also get html label tags.
 >>> p = Person(auto_id='id_%s')
 >>> print p.as_ul()
-<li>First name: <input type="text" name="first_name" id="id_first_name" /></li>
-<li>Last name: <input type="text" name="last_name" id="id_last_name" /></li>
-<li>Birthday: <input type="text" name="birthday" id="id_birthday" /></li>
+<li><label for="id_first_name">First name</label>: <input type="text" name="first_name" id="id_first_name" /></li>
+<li><label for="id_last_name">Last name</label>: <input type="text" name="last_name" id="id_last_name" /></li>
+<li><label for="id_birthday">Birthday</label>: <input type="text" name="birthday" id="id_birthday" /></li>
 
 If auto_id is any True value whose str() does not contain '%s', the "id"
 attribute will be the name of the field.
 >>> p = Person(auto_id=True)
 >>> print p.as_ul()
-<li>First name: <input type="text" name="first_name" id="first_name" /></li>
-<li>Last name: <input type="text" name="last_name" id="last_name" /></li>
-<li>Birthday: <input type="text" name="birthday" id="birthday" /></li>
+<li><label for="first_name">First name</label>: <input type="text" name="first_name" id="first_name" /></li>
+<li><label for="last_name">Last name</label>: <input type="text" name="last_name" id="last_name" /></li>
+<li><label for="birthday">Birthday</label>: <input type="text" name="birthday" id="birthday" /></li>
 
 If auto_id is any False value, an "id" attribute won't be output unless it
 was manually entered.
@@ -1282 +1283 @@
 ...     birthday = DateField()
 >>> p = PersonNew(auto_id=False)
 >>> print p.as_ul()
-<li>First name: <input type="text" id="first_name_id" name="first_name" /></li>
+<li><label for="first_name_id">First name</label>: <input type="text" id="first_name_id" name="first_name" /></li>
 <li>Last name: <input type="text" name="last_name" /></li>
 <li>Birthday: <input type="text" name="birthday" /></li>
 
@@ -1290 +1291 @@
 attribute in the Form gets precedence.
 >>> p = PersonNew(auto_id=True)
 >>> print p.as_ul()
-<li>First name: <input type="text" id="first_name_id" name="first_name" /></li>
-<li>Last name: <input type="text" name="last_name" id="last_name" /></li>
-<li>Birthday: <input type="text" name="birthday" id="birthday" /></li>
+<li><label for="first_name_id">First name</label>: <input type="text" id="first_name_id" name="first_name" /></li>
+<li><label for="last_name">Last name</label>: <input type="text" name="last_name" id="last_name" /></li>
+<li><label for="birthday">Birthday</label>: <input type="text" name="birthday" id="birthday" /></li>
 
 >>> class SignupForm(Form):
 ...     email = EmailField()