Changeset 5218

Timestamp:

05/13/07 21:57:42 (2 years ago)

Author:

adrian

Message:

Added unit tests and docs for the newforms case in which the form's data doesn't include a value for a nonrequired field

Files:

• django/trunk/docs/newforms.txt (modified) (3 diffs)
• django/trunk/tests/regressiontests/forms/tests.py (modified) (4 diffs)

django/trunk/docs/newforms.txt

@@ -187 +187 @@
-    False
-
-Form`` attribute ``errors``
+errors`` attribute
-
-    >>> f.errors
@@ -199 +199 @@
-form's data will be validated the first time either you call ``is_valid()`` or
-access ``errors``.
+
+The validation routines will only get called once, regardless of how many times
+you access ``errors`` or call ``is_valid()``. This means that if validation has
+side effects, those side effects will only be triggered once.
-
-Behavior of unbound forms
@@ -276 +280 @@
-    >>> f.clean_data # Doesn't contain extra_field_1, etc.
-    {'cc_myself': True, 'message': u'Hi there', 'sender': u'foo@example.com', 'subject': u'hello'}
+
+``clean_data`` will include a key and value for *all* fields defined in the
+``Form``, even if the data didn't include a value for fields that are not
+required. In this example, the data dictionary doesn't include a value for the
+``nick_name`` field, but ``clean_data`` includes it, with an empty value::
+
+    >>> class OptionalPersonForm(Form):
+    ...     first_name = CharField()
+    ...     last_name = CharField()
+    ...     nick_name = CharField(required=False)
+    >>> data = {'first_name': u'John', 'last_name': u'Lennon'}
+    >>> f = OptionalPersonForm(data)
+    >>> f.is_valid()
+    True
+    >>> f.clean_data
+    {'nick_name': u'', 'first_name': u'John', 'last_name': u'Lennon'}
+
+In this above example, the ``clean_data`` value for ``nick_name`` is set to an
+empty string, because ``nick_name`` is ``CharField``, and ``CharField``s treat
+empty values as an empty string. Each field type knows what its "blank" value
+is -- e.g., for ``DateField``, it's ``None`` instead of the empty string.
-
-Behavior of unbound forms

django/trunk/tests/regressiontests/forms/tests.py

@@ -1916 +1916 @@
->>> p.clean_data
-{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
+
+clean_data will include a key and value for *all* fields defined in the Form,
+even if the Form's data didn't include a value for fields that are not
+required. In this example, the data dictionary doesn't include a value for the
+"nick_name" field, but clean_data includes it. For CharFields, it's set to the
+empty string.
+>>> class OptionalPersonForm(Form):
+...     first_name = CharField()
+...     last_name = CharField()
+...     nick_name = CharField(required=False)
+>>> data = {'first_name': u'John', 'last_name': u'Lennon'}
+>>> f = OptionalPersonForm(data)
+>>> f.is_valid()
+True
+>>> f.clean_data
+{'nick_name': u'', 'first_name': u'John', 'last_name': u'Lennon'}
+
+For DateFields, it's set to None.
+>>> class OptionalPersonForm(Form):
+...     first_name = CharField()
+...     last_name = CharField()
+...     birth_date = DateField(required=False)
+>>> data = {'first_name': u'John', 'last_name': u'Lennon'}
+>>> f = OptionalPersonForm(data)
+>>> f.is_valid()
+True
+>>> f.clean_data
+{'birth_date': None, 'first_name': u'John', 'last_name': u'Lennon'}
-
-"auto_id" tells the Form to add an "id" attribute to each form element.
@@ -3379 +3407 @@
-
-# MultiWidget and MultiValueField #############################################
- 
+
-# combined with MultiValueFields - a field that is composed of other fields.
-# MulitWidgets can themselved be composed of other MultiWidgets.
@@ -3387 +3415 @@
-...     def __init__(self, attrs=None):
-...         widgets = (
- 
+
-...             SelectMultiple(choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo'))),
-...             SplitDateTimeWidget(),
@@ -3412 +3440 @@
-
->>> class ComplexField(MultiValueField):
- 
+
-...         fields = (
- 
+
-...             MultipleChoiceField(choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo'))),
-...             SplitDateTimeField()
-...         )
- 
+
-...
-...     def compress(self, data_list):