Ticket #10427: django-display_value-r11298.patch

django/forms/forms.py

@@ -9 +9 @@
 from django.utils.encoding import StrAndUnicode, smart_unicode, force_unicode
 from django.utils.safestring import mark_safe
 
-from fields import Field, FileField
+from fields import Field, FileField, ChoiceField
 from widgets import Media, media_property, TextInput, Textarea
 from util import flatatt, ErrorDict, ErrorList, ValidationError
 
@@ -375 +375 @@
         auto_id = self.auto_id
         if auto_id and 'id' not in attrs and 'id' not in widget.attrs:
             attrs['id'] = auto_id
-        if not self.form.is_bound:
-            data = self.form.initial.get(self.name, self.field.initial)
-            if callable(data):
-                data = data()
-        else:
-            if isinstance(self.field, FileField) and self.data is None:
-                data = self.form.initial.get(self.name, self.field.initial)
-            else:
-                data = self.data
         if not only_initial:
             name = self.html_name
         else:
             name = self.html_initial_name
-        return widget.render(name, data, attrs=attrs)
+        return widget.render(name, self.value, attrs=attrs)
 
     def as_text(self, attrs=None, **kwargs):
         """
@@ -413 +404 @@
         return self.field.widget.value_from_datadict(self.form.data, self.form.files, self.html_name)
     data = property(_data)
 
+    def _value(self):
+        """
+        Returns the value for this BoundField, as rendered in widgets.
+        """
+        if not self.form.is_bound:
+            val = self.form.initial.get(self.name, self.field.initial)
+            if callable(val):
+                val = val()
+        else:
+            if isinstance(self.field, FileField) and self.data is None:
+                val = self.form.initial.get(self.name, self.field.initial)
+            else:
+                val = self.data
+        if val is None:
+            val = ''
+        return val
+    value = property(_value)
+
+    def _display_value(self):
+        """
+        Returns the displayed value for this BoundField, as rendered in widgets.
+        """
+        value = self.value
+        if isinstance(self.field, ChoiceField):
+            for (val, desc) in self.field.choices:
+                if val == value:
+                    return desc
+        return self.value
+    display_value = property(_display_value)
+
     def label_tag(self, contents=None, attrs=None):
         """
         Wraps the given contents in a <label>, if the field has an ID attribute.

django/contrib/formtools/templates/formtools/preview.html

@@ -8 +8 @@
 {% for field in form %}
 <tr>
 <th>{{ field.label }}:</th>
-<td>{{ field.data }}</td>
+<td>{{ field.display_value }}</td>
 </tr>
 {% endfor %}
 </table>

tests/regressiontests/forms/forms.py

@@ -1234 +1234 @@
 <option value="w">whiz</option>
 </select></li>
 
+# Bound field values ##########################################################
+
+It's possible to get to the value which would be used for rendering the widget
+for a field by using the BoundField's value attribute.
+
+>>> class UserRegistration(Form):
+...    username = CharField(max_length=10, initial='djangonaut')
+...    password = CharField(widget=PasswordInput)
+...    gender = ChoiceField(choices=(('M', 'Male'), ('F', 'Female')))
+...    role = ChoiceField(choices=(('user', 'Site user'), ('admin', 'Site admin')), initial='user')
+>>> p = UserRegistration({'password': 'foo', 'gender': 'M'})
+>>> print 'username.value =', p['username'].value
+username.value = 
+>>> print 'username.display_value =', p['username'].display_value
+username.display_value = 
+>>> print 'username.data = ', p['username'].data
+username.data = None
+>>> print 'password.value =', p['password'].value
+password.value = foo
+>>> print 'password.display_value =', p['password'].display_value
+password.display_value = foo
+>>> print 'password.data =', p['password'].data
+password.data = foo
+>>> print 'gender.value =', p['gender'].value
+gender.value = M
+>>> print 'gender.display_value =', p['gender'].display_value
+gender.display_value = Male
+>>> print 'gender.data =', p['gender'].data
+gender.data = M
+>>> print 'role.value =', p['role'].value
+role.value = 
+>>> print 'role.display_value =', p['role'].display_value
+role.display_value = 
+>>> print 'role.data =', p['role'].data
+role.data = None
+
+The value of username is empty because the form is bound -- the value wasn't
+specified, and so is empty. This differs if the form were to be unbound:
+
+>>> p = UserRegistration()
+>>> print p['username'].value
+djangonaut
+
 # Help text ###################################################################
 
 You can specify descriptive text for a field by using the 'help_text' argument

docs/ref/forms/fields.txt

@@ -257 +257 @@
 In the `built-in Field classes`_ section below, each ``Field`` defines the
 error message keys it uses.
 
+Field data versus value
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 1.1
+
+.. attribute:: Field.value
+.. attribute:: Field.data
+
+Sometimes, it's necessary -- or at least easier -- to render the form entirely
+on your own. In such a case, you might want to get to what Django's form
+rendering would use for the HTML `value` attribute.
+
+It's quite easy, actually::
+
+    >>> f = CommentForm({'comment': 'Foobar'}, initial={'name': 'instance'})
+    >>> f['name'].value
+    'instance'
+    >>> f['comment'].value
+    'Foobar'
+
+The value attribute takes initial data into account on form level (i.e.,
+passing it to the initializer as seen in previous section), as well as field
+level.
+
+The resolution process is, step by step, the following:
+
+ 1. If the form has data for this field, use it;
+ 2. if the form has initial data for this field, use it;
+ 3. if the field has initial data, use it; and lastly
+ 4. use the empty string.
+
 Built-in ``Field`` classes
 --------------------------