Changes between Initial Version and Version 1 of NewForms

Timestamp:

Jan 3, 2007, 3:10:45 PM (17 years ago)

Author:

anonymous

Comment:

--

NewForms

@@ +1 @@
+= !NewForms =
+Since newforms is mostly undocumented at the moment this page summarizes some useful information. This documentation should be considered complementary to the documentation on [http://www.djangoproject.com/documentation/newforms/]. It's mostly information extracted from the [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py unit tests for newforms] at the moment.
+
+== Widgets [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L8 Unit tests] ==
+Each Widget class corresponds to an HTML form widget. A Widget knows how to
+render itself, given a field name and some data. Widgets don't perform
+validation.
+
+=== Widget types ===
+List of widget types with their associated unit test for easy lookup.
+
+
+===== !TextInput [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L15 Unit test] =====
+===== !PasswordInput [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L46 Unit test] =====
+===== !HiddenInput [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L75 Unit test] =====
+===== !FileInput [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L109 Unit test] =====
+===== !TextArea [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L133 Unit test] =====
+===== !CheckBoxInput [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L162 Unit test] =====
+===== Select [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L215 Unit test] =====
+===== !SelectMultiple [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L299 Unit test] =====
+===== !RadioSelect [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L406 Unit test] =====
+===== !CheckBoxSelectMultiple [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L536 Unit test] =====
+
+
+== Fields ==
+Each Field class does some sort of validation. Each Field has a clean() method, which either raises django.newforms.!ValidationError or returns the "clean" data -- usually a Unicode object, but, in some rare cases, a list.
+
+Each Field's __init__() takes at least these parameters:
+
+ * ''required'' -- Boolean that specifies whether the field is required. True by default.[[br]]
+ * ''widget'' -- A Widget class, or instance of a Widget class, that should be used for this Field when displaying it. Each Field has a 
+ * ''default'' -- Widget that it'll use if you don't specify this. In most cases, the default widget is !TextInput.
+ * ''label'' -- A verbose name for this field, for use in displaying this field in a form. By default, Django will use a "pretty" version of  the form field name, if the Field is part of a Form.
+ * ''initial'' -- A value to use in this Field's initial display. This value is *not* used as a fallback if data isn't given.
+
+Other than that, the Field subclasses have class-specific options for __init__(). For example, !CharField has a max_length option.
+
+=== Field types [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L644 Unit tests] ===
+List of field types with their associated unit test for easy lookup.
+
+===== !CharField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L669 Unit test] =====
+Arguments:
+ * ''max_length'' -- (optional) Maximum number of characters
+ * ''min_length'' -- (optional) Minimum number of characters
+
+===== !IntegerField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L735 Unit test] =====
+Arguments:
+ * ''max_value'' -- (optional) Maximum value
+ * ''min_value'' -- (optional) Minimum value
+
+===== !DateField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L858 Unit test] =====
+Arguments:
+ * ''input_formats'' -- (optional) A list of strftime() input formats. These will override all other input formats
+
+===== !TimeField  [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L935 Unit test] =====
+
+===== !DateTimeField  [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L974 Unit test] =====
+
+===== !RegexField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1047 Unit test] =====
+Arguments:
+ * ''regex'' -- The regular expression in compiled or string form that the input should match
+
+===== !EmailField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1138 Unit test] =====
+Arguments:
+ * ''min_length'' -- Minimum length
+ * ''max_length'' -- Maximum length
+
+===== URLField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1197 Unit test] =====
+
+===== !BooleanField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1302 Unit test] =====
+Since html forms either return something like 'fieldname=on' in request.POST or request.GET, this value may not be set in form.clean_data. 
+
+Arguments:
+ * ''None''
+
+===== !ChoiceField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1340 Unit test] =====
+Arguments:
+ * ''choices'' -- A list of (key, value) pairs
+
+===== !MultipleChoiceField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1382 Unit test] =====
+Arguments:
+ * ''choices'' -- A list of (key, value) pairs
+
+===== !ComboField [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1448 Unit test] =====
+!ComboField takes a list of fields that should be used to validate a value, in that order.
+
+Arguments:
+ * ''choices'' -- A list of fields used to validate the input value
+clean() returns:
+ * ''unicode object''
+
+== Forms [http://code.djangoproject.com/browser/django/trunk/tests/regressiontests/forms/tests.py#L1489 Unit test] ==
+A Form is a collection of Fields. It knows how to validate a set of data and it knows how to render itself in a couple of default ways (e.g., an HTML table). You can pass it data in __init__(), as a dictionary.
+
+