Changeset 4306

Timestamp:

01/10/07 18:04:27 (2 years ago)

Author:

adrian

Message:

newforms: Added unit tests and docs explaining that clean_data will only ever contain fields of the form, even if extra fields are passed in data

Files:

• django/trunk/docs/newforms.txt (modified) (1 diff)
• django/trunk/tests/regressiontests/forms/tests.py (modified) (1 diff)

django/trunk/docs/newforms.txt

@@ -254 +254 @@
-    ...
-    AttributeError: 'ContactForm' object has no attribute 'clean_data'
+
+``clean_data`` will always *only* contain a key for fields defined in the
+``Form``, even if you pass extra data when you define the ``Form``. In this
+example, we pass a bunch of extra fields to the ``ContactForm`` constructor,
+but ``clean_data`` contains only the form's fields::
+
+    >>> data = {'subject': 'hello',
+    ...         'message': 'Hi there',
+    ...         'sender': 'foo@example.com',
+    ...         'cc_myself': True,
+    ...         'extra_field_1': 'foo',
+    ...         'extra_field_2': 'bar',
+    ...         'extra_field_3': 'baz'}
+    >>> f = ContactForm(data)
+    >>> f.is_valid()
+    True
+    >>> 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'}
-
-Behavior of unbound forms

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

@@ -1647 +1647 @@
->>> print p['birthday']
-<input type="text" name="birthday" id="id_birthday" />
+
+clean_data will always *only* contain a key for fields defined in the
+Form, even if you pass extra data when you define the Form. In this
+example, we pass a bunch of extra fields to the form constructor,
+but clean_data contains only the form's fields.
+>>> data = {'first_name': u'John', 'last_name': u'Lennon', 'birthday': u'1940-10-9', 'extra1': 'hello', 'extra2': 'hello'}
+>>> p = Person(data)
+>>> p.is_valid()
+True
+>>> p.clean_data
+{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
-
-"auto_id" tells the Form to add an "id" attribute to each form element.