mirror of
https://github.com/django/django.git
synced 2024-12-25 10:35:48 +00:00
cdbd5751d3
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5782 bcc190cf-cafb-0310-a4f2-bffc1f526a37
3720 lines
153 KiB
Python
3720 lines
153 KiB
Python
# -*- coding: utf-8 -*-
|
|
from localflavor import localflavor_tests
|
|
from regressions import regression_tests
|
|
|
|
form_tests = r"""
|
|
>>> from django.newforms import *
|
|
>>> from django.newforms.widgets import RadioFieldRenderer
|
|
>>> import datetime
|
|
>>> import time
|
|
>>> import re
|
|
>>> try:
|
|
... from decimal import Decimal
|
|
... except ImportError:
|
|
... from django.utils._decimal import Decimal
|
|
|
|
###########
|
|
# Widgets #
|
|
###########
|
|
|
|
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.
|
|
|
|
# TextInput Widget ############################################################
|
|
|
|
>>> w = TextInput()
|
|
>>> w.render('email', '')
|
|
u'<input type="text" name="email" />'
|
|
>>> w.render('email', None)
|
|
u'<input type="text" name="email" />'
|
|
>>> w.render('email', 'test@example.com')
|
|
u'<input type="text" name="email" value="test@example.com" />'
|
|
>>> w.render('email', 'some "quoted" & ampersanded value')
|
|
u'<input type="text" name="email" value="some "quoted" & ampersanded value" />'
|
|
>>> w.render('email', 'test@example.com', attrs={'class': 'fun'})
|
|
u'<input type="text" name="email" value="test@example.com" class="fun" />'
|
|
|
|
# Note that doctest in Python 2.4 (and maybe 2.5?) doesn't support non-ascii
|
|
# characters in output, so we're displaying the repr() here.
|
|
>>> w.render('email', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})
|
|
u'<input type="text" name="email" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" class="fun" />'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = TextInput(attrs={'class': 'fun'})
|
|
>>> w.render('email', '')
|
|
u'<input type="text" class="fun" name="email" />'
|
|
>>> w.render('email', 'foo@example.com')
|
|
u'<input type="text" class="fun" value="foo@example.com" name="email" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = TextInput(attrs={'class': 'pretty'})
|
|
>>> w.render('email', '', attrs={'class': 'special'})
|
|
u'<input type="text" class="special" name="email" />'
|
|
|
|
# PasswordInput Widget ############################################################
|
|
|
|
>>> w = PasswordInput()
|
|
>>> w.render('email', '')
|
|
u'<input type="password" name="email" />'
|
|
>>> w.render('email', None)
|
|
u'<input type="password" name="email" />'
|
|
>>> w.render('email', 'test@example.com')
|
|
u'<input type="password" name="email" value="test@example.com" />'
|
|
>>> w.render('email', 'some "quoted" & ampersanded value')
|
|
u'<input type="password" name="email" value="some "quoted" & ampersanded value" />'
|
|
>>> w.render('email', 'test@example.com', attrs={'class': 'fun'})
|
|
u'<input type="password" name="email" value="test@example.com" class="fun" />'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = PasswordInput(attrs={'class': 'fun'})
|
|
>>> w.render('email', '')
|
|
u'<input type="password" class="fun" name="email" />'
|
|
>>> w.render('email', 'foo@example.com')
|
|
u'<input type="password" class="fun" value="foo@example.com" name="email" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = PasswordInput(attrs={'class': 'pretty'})
|
|
>>> w.render('email', '', attrs={'class': 'special'})
|
|
u'<input type="password" class="special" name="email" />'
|
|
|
|
>>> w.render('email', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})
|
|
u'<input type="password" class="fun" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" name="email" />'
|
|
|
|
The render_value argument lets you specify whether the widget should render
|
|
its value. You may want to do this for security reasons.
|
|
>>> w = PasswordInput(render_value=True)
|
|
>>> w.render('email', 'secret')
|
|
u'<input type="password" name="email" value="secret" />'
|
|
>>> w = PasswordInput(render_value=False)
|
|
>>> w.render('email', '')
|
|
u'<input type="password" name="email" />'
|
|
>>> w.render('email', None)
|
|
u'<input type="password" name="email" />'
|
|
>>> w.render('email', 'secret')
|
|
u'<input type="password" name="email" />'
|
|
>>> w = PasswordInput(attrs={'class': 'fun'}, render_value=False)
|
|
>>> w.render('email', 'secret')
|
|
u'<input type="password" class="fun" name="email" />'
|
|
|
|
# HiddenInput Widget ############################################################
|
|
|
|
>>> w = HiddenInput()
|
|
>>> w.render('email', '')
|
|
u'<input type="hidden" name="email" />'
|
|
>>> w.render('email', None)
|
|
u'<input type="hidden" name="email" />'
|
|
>>> w.render('email', 'test@example.com')
|
|
u'<input type="hidden" name="email" value="test@example.com" />'
|
|
>>> w.render('email', 'some "quoted" & ampersanded value')
|
|
u'<input type="hidden" name="email" value="some "quoted" & ampersanded value" />'
|
|
>>> w.render('email', 'test@example.com', attrs={'class': 'fun'})
|
|
u'<input type="hidden" name="email" value="test@example.com" class="fun" />'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = HiddenInput(attrs={'class': 'fun'})
|
|
>>> w.render('email', '')
|
|
u'<input type="hidden" class="fun" name="email" />'
|
|
>>> w.render('email', 'foo@example.com')
|
|
u'<input type="hidden" class="fun" value="foo@example.com" name="email" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = HiddenInput(attrs={'class': 'pretty'})
|
|
>>> w.render('email', '', attrs={'class': 'special'})
|
|
u'<input type="hidden" class="special" name="email" />'
|
|
|
|
>>> w.render('email', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})
|
|
u'<input type="hidden" class="fun" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" name="email" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = HiddenInput(attrs={'class': 'pretty'})
|
|
>>> w.render('email', '', attrs={'class': 'special'})
|
|
u'<input type="hidden" class="special" name="email" />'
|
|
|
|
# MultipleHiddenInput Widget ##################################################
|
|
|
|
>>> w = MultipleHiddenInput()
|
|
>>> w.render('email', [])
|
|
u''
|
|
>>> w.render('email', None)
|
|
u''
|
|
>>> w.render('email', ['test@example.com'])
|
|
u'<input type="hidden" name="email" value="test@example.com" />'
|
|
>>> w.render('email', ['some "quoted" & ampersanded value'])
|
|
u'<input type="hidden" name="email" value="some "quoted" & ampersanded value" />'
|
|
>>> w.render('email', ['test@example.com', 'foo@example.com'])
|
|
u'<input type="hidden" name="email" value="test@example.com" />\n<input type="hidden" name="email" value="foo@example.com" />'
|
|
>>> w.render('email', ['test@example.com'], attrs={'class': 'fun'})
|
|
u'<input type="hidden" name="email" value="test@example.com" class="fun" />'
|
|
>>> w.render('email', ['test@example.com', 'foo@example.com'], attrs={'class': 'fun'})
|
|
u'<input type="hidden" name="email" value="test@example.com" class="fun" />\n<input type="hidden" name="email" value="foo@example.com" class="fun" />'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = MultipleHiddenInput(attrs={'class': 'fun'})
|
|
>>> w.render('email', [])
|
|
u''
|
|
>>> w.render('email', ['foo@example.com'])
|
|
u'<input type="hidden" class="fun" value="foo@example.com" name="email" />'
|
|
>>> w.render('email', ['foo@example.com', 'test@example.com'])
|
|
u'<input type="hidden" class="fun" value="foo@example.com" name="email" />\n<input type="hidden" class="fun" value="test@example.com" name="email" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = MultipleHiddenInput(attrs={'class': 'pretty'})
|
|
>>> w.render('email', ['foo@example.com'], attrs={'class': 'special'})
|
|
u'<input type="hidden" class="special" value="foo@example.com" name="email" />'
|
|
|
|
>>> w.render('email', ['ŠĐĆŽćžšđ'], attrs={'class': 'fun'})
|
|
u'<input type="hidden" class="fun" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" name="email" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = MultipleHiddenInput(attrs={'class': 'pretty'})
|
|
>>> w.render('email', ['foo@example.com'], attrs={'class': 'special'})
|
|
u'<input type="hidden" class="special" value="foo@example.com" name="email" />'
|
|
|
|
# FileInput Widget ############################################################
|
|
|
|
>>> w = FileInput()
|
|
>>> w.render('email', '')
|
|
u'<input type="file" name="email" />'
|
|
>>> w.render('email', None)
|
|
u'<input type="file" name="email" />'
|
|
>>> w.render('email', 'test@example.com')
|
|
u'<input type="file" name="email" value="test@example.com" />'
|
|
>>> w.render('email', 'some "quoted" & ampersanded value')
|
|
u'<input type="file" name="email" value="some "quoted" & ampersanded value" />'
|
|
>>> w.render('email', 'test@example.com', attrs={'class': 'fun'})
|
|
u'<input type="file" name="email" value="test@example.com" class="fun" />'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = FileInput(attrs={'class': 'fun'})
|
|
>>> w.render('email', '')
|
|
u'<input type="file" class="fun" name="email" />'
|
|
>>> w.render('email', 'foo@example.com')
|
|
u'<input type="file" class="fun" value="foo@example.com" name="email" />'
|
|
|
|
>>> w.render('email', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})
|
|
u'<input type="file" class="fun" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" name="email" />'
|
|
|
|
# Textarea Widget #############################################################
|
|
|
|
>>> w = Textarea()
|
|
>>> w.render('msg', '')
|
|
u'<textarea rows="10" cols="40" name="msg"></textarea>'
|
|
>>> w.render('msg', None)
|
|
u'<textarea rows="10" cols="40" name="msg"></textarea>'
|
|
>>> w.render('msg', 'value')
|
|
u'<textarea rows="10" cols="40" name="msg">value</textarea>'
|
|
>>> w.render('msg', 'some "quoted" & ampersanded value')
|
|
u'<textarea rows="10" cols="40" name="msg">some "quoted" & ampersanded value</textarea>'
|
|
>>> w.render('msg', 'value', attrs={'class': 'pretty', 'rows': 20})
|
|
u'<textarea class="pretty" rows="20" cols="40" name="msg">value</textarea>'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = Textarea(attrs={'class': 'pretty'})
|
|
>>> w.render('msg', '')
|
|
u'<textarea rows="10" cols="40" name="msg" class="pretty"></textarea>'
|
|
>>> w.render('msg', 'example')
|
|
u'<textarea rows="10" cols="40" name="msg" class="pretty">example</textarea>'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = Textarea(attrs={'class': 'pretty'})
|
|
>>> w.render('msg', '', attrs={'class': 'special'})
|
|
u'<textarea rows="10" cols="40" name="msg" class="special"></textarea>'
|
|
|
|
>>> w.render('msg', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})
|
|
u'<textarea rows="10" cols="40" name="msg" class="fun">\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111</textarea>'
|
|
|
|
# CheckboxInput Widget ########################################################
|
|
|
|
>>> w = CheckboxInput()
|
|
>>> w.render('is_cool', '')
|
|
u'<input type="checkbox" name="is_cool" />'
|
|
>>> w.render('is_cool', None)
|
|
u'<input type="checkbox" name="is_cool" />'
|
|
>>> w.render('is_cool', False)
|
|
u'<input type="checkbox" name="is_cool" />'
|
|
>>> w.render('is_cool', True)
|
|
u'<input checked="checked" type="checkbox" name="is_cool" />'
|
|
|
|
Using any value that's not in ('', None, False, True) will check the checkbox
|
|
and set the 'value' attribute.
|
|
>>> w.render('is_cool', 'foo')
|
|
u'<input checked="checked" type="checkbox" name="is_cool" value="foo" />'
|
|
|
|
>>> w.render('is_cool', False, attrs={'class': 'pretty'})
|
|
u'<input type="checkbox" name="is_cool" class="pretty" />'
|
|
|
|
You can also pass 'attrs' to the constructor:
|
|
>>> w = CheckboxInput(attrs={'class': 'pretty'})
|
|
>>> w.render('is_cool', '')
|
|
u'<input type="checkbox" class="pretty" name="is_cool" />'
|
|
|
|
'attrs' passed to render() get precedence over those passed to the constructor:
|
|
>>> w = CheckboxInput(attrs={'class': 'pretty'})
|
|
>>> w.render('is_cool', '', attrs={'class': 'special'})
|
|
u'<input type="checkbox" class="special" name="is_cool" />'
|
|
|
|
You can pass 'check_test' to the constructor. This is a callable that takes the
|
|
value and returns True if the box should be checked.
|
|
>>> w = CheckboxInput(check_test=lambda value: value.startswith('hello'))
|
|
>>> w.render('greeting', '')
|
|
u'<input type="checkbox" name="greeting" />'
|
|
>>> w.render('greeting', 'hello')
|
|
u'<input checked="checked" type="checkbox" name="greeting" value="hello" />'
|
|
>>> w.render('greeting', 'hello there')
|
|
u'<input checked="checked" type="checkbox" name="greeting" value="hello there" />'
|
|
>>> w.render('greeting', 'hello & goodbye')
|
|
u'<input checked="checked" type="checkbox" name="greeting" value="hello & goodbye" />'
|
|
|
|
A subtlety: If the 'check_test' argument cannot handle a value and raises any
|
|
exception during its __call__, then the exception will be swallowed and the box
|
|
will not be checked. In this example, the 'check_test' assumes the value has a
|
|
startswith() method, which fails for the values True, False and None.
|
|
>>> w.render('greeting', True)
|
|
u'<input type="checkbox" name="greeting" />'
|
|
>>> w.render('greeting', False)
|
|
u'<input type="checkbox" name="greeting" />'
|
|
>>> w.render('greeting', None)
|
|
u'<input type="checkbox" name="greeting" />'
|
|
|
|
# Select Widget ###############################################################
|
|
|
|
>>> w = Select()
|
|
>>> print w.render('beatle', 'J', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select name="beatle">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
|
|
If the value is None, none of the options are selected:
|
|
>>> print w.render('beatle', None, choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select name="beatle">
|
|
<option value="J">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
|
|
If the value corresponds to a label (but not to an option value), none of the options are selected:
|
|
>>> print w.render('beatle', 'John', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select name="beatle">
|
|
<option value="J">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
|
|
The value is compared to its str():
|
|
>>> print w.render('num', 2, choices=[('1', '1'), ('2', '2'), ('3', '3')])
|
|
<select name="num">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
>>> print w.render('num', '2', choices=[(1, 1), (2, 2), (3, 3)])
|
|
<select name="num">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
>>> print w.render('num', 2, choices=[(1, 1), (2, 2), (3, 3)])
|
|
<select name="num">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
|
|
The 'choices' argument can be any iterable:
|
|
>>> from itertools import chain
|
|
>>> def get_choices():
|
|
... for i in range(5):
|
|
... yield (i, i)
|
|
>>> print w.render('num', 2, choices=get_choices())
|
|
<select name="num">
|
|
<option value="0">0</option>
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
</select>
|
|
>>> things = ({'id': 1, 'name': 'And Boom'}, {'id': 2, 'name': 'One More Thing!'})
|
|
>>> class SomeForm(Form):
|
|
... somechoice = ChoiceField(choices=chain((('', '-'*9),), [(thing['id'], thing['name']) for thing in things]))
|
|
>>> f = SomeForm()
|
|
>>> f.as_table()
|
|
u'<tr><th><label for="id_somechoice">Somechoice:</label></th><td><select name="somechoice" id="id_somechoice">\n<option value="" selected="selected">---------</option>\n<option value="1">And Boom</option>\n<option value="2">One More Thing!</option>\n</select></td></tr>'
|
|
>>> f.as_table()
|
|
u'<tr><th><label for="id_somechoice">Somechoice:</label></th><td><select name="somechoice" id="id_somechoice">\n<option value="" selected="selected">---------</option>\n<option value="1">And Boom</option>\n<option value="2">One More Thing!</option>\n</select></td></tr>'
|
|
>>> f = SomeForm({'somechoice': 2})
|
|
>>> f.as_table()
|
|
u'<tr><th><label for="id_somechoice">Somechoice:</label></th><td><select name="somechoice" id="id_somechoice">\n<option value="">---------</option>\n<option value="1">And Boom</option>\n<option value="2" selected="selected">One More Thing!</option>\n</select></td></tr>'
|
|
|
|
You can also pass 'choices' to the constructor:
|
|
>>> w = Select(choices=[(1, 1), (2, 2), (3, 3)])
|
|
>>> print w.render('num', 2)
|
|
<select name="num">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
|
|
If 'choices' is passed to both the constructor and render(), then they'll both be in the output:
|
|
>>> print w.render('num', 2, choices=[(4, 4), (5, 5)])
|
|
<select name="num">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
<option value="5">5</option>
|
|
</select>
|
|
|
|
>>> w.render('email', 'ŠĐĆŽćžšđ', choices=[('ŠĐĆŽćžšđ', 'ŠĐabcĆŽćžšđ'), ('ćžšđ', 'abcćžšđ')])
|
|
u'<select name="email">\n<option value="1">1</option>\n<option value="2">2</option>\n<option value="3">3</option>\n<option value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" selected="selected">\u0160\u0110abc\u0106\u017d\u0107\u017e\u0161\u0111</option>\n<option value="\u0107\u017e\u0161\u0111">abc\u0107\u017e\u0161\u0111</option>\n</select>'
|
|
|
|
If choices is passed to the constructor and is a generator, it can be iterated
|
|
over multiple times without getting consumed:
|
|
>>> w = Select(choices=get_choices())
|
|
>>> print w.render('num', 2)
|
|
<select name="num">
|
|
<option value="0">0</option>
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
</select>
|
|
>>> print w.render('num', 3)
|
|
<select name="num">
|
|
<option value="0">0</option>
|
|
<option value="1">1</option>
|
|
<option value="2">2</option>
|
|
<option value="3" selected="selected">3</option>
|
|
<option value="4">4</option>
|
|
</select>
|
|
|
|
# NullBooleanSelect Widget ####################################################
|
|
|
|
>>> w = NullBooleanSelect()
|
|
>>> print w.render('is_cool', True)
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2" selected="selected">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> print w.render('is_cool', False)
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3" selected="selected">No</option>
|
|
</select>
|
|
>>> print w.render('is_cool', None)
|
|
<select name="is_cool">
|
|
<option value="1" selected="selected">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> print w.render('is_cool', '2')
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2" selected="selected">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> print w.render('is_cool', '3')
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3" selected="selected">No</option>
|
|
</select>
|
|
|
|
# SelectMultiple Widget #######################################################
|
|
|
|
>>> w = SelectMultiple()
|
|
>>> print w.render('beatles', ['J'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select multiple="multiple" name="beatles">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
>>> print w.render('beatles', ['J', 'P'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select multiple="multiple" name="beatles">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P" selected="selected">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
>>> print w.render('beatles', ['J', 'P', 'R'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select multiple="multiple" name="beatles">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P" selected="selected">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R" selected="selected">Ringo</option>
|
|
</select>
|
|
|
|
If the value is None, none of the options are selected:
|
|
>>> print w.render('beatles', None, choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select multiple="multiple" name="beatles">
|
|
<option value="J">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
|
|
If the value corresponds to a label (but not to an option value), none of the options are selected:
|
|
>>> print w.render('beatles', ['John'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select multiple="multiple" name="beatles">
|
|
<option value="J">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
|
|
If multiple values are given, but some of them are not valid, the valid ones are selected:
|
|
>>> print w.render('beatles', ['J', 'G', 'foo'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<select multiple="multiple" name="beatles">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G" selected="selected">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
|
|
The value is compared to its str():
|
|
>>> print w.render('nums', [2], choices=[('1', '1'), ('2', '2'), ('3', '3')])
|
|
<select multiple="multiple" name="nums">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
>>> print w.render('nums', ['2'], choices=[(1, 1), (2, 2), (3, 3)])
|
|
<select multiple="multiple" name="nums">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
>>> print w.render('nums', [2], choices=[(1, 1), (2, 2), (3, 3)])
|
|
<select multiple="multiple" name="nums">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
|
|
The 'choices' argument can be any iterable:
|
|
>>> def get_choices():
|
|
... for i in range(5):
|
|
... yield (i, i)
|
|
>>> print w.render('nums', [2], choices=get_choices())
|
|
<select multiple="multiple" name="nums">
|
|
<option value="0">0</option>
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
</select>
|
|
|
|
You can also pass 'choices' to the constructor:
|
|
>>> w = SelectMultiple(choices=[(1, 1), (2, 2), (3, 3)])
|
|
>>> print w.render('nums', [2])
|
|
<select multiple="multiple" name="nums">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
</select>
|
|
|
|
If 'choices' is passed to both the constructor and render(), then they'll both be in the output:
|
|
>>> print w.render('nums', [2], choices=[(4, 4), (5, 5)])
|
|
<select multiple="multiple" name="nums">
|
|
<option value="1">1</option>
|
|
<option value="2" selected="selected">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
<option value="5">5</option>
|
|
</select>
|
|
|
|
>>> w.render('nums', ['ŠĐĆŽćžšđ'], choices=[('ŠĐĆŽćžšđ', 'ŠĐabcĆŽćžšđ'), ('ćžšđ', 'abcćžšđ')])
|
|
u'<select multiple="multiple" name="nums">\n<option value="1">1</option>\n<option value="2">2</option>\n<option value="3">3</option>\n<option value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" selected="selected">\u0160\u0110abc\u0106\u017d\u0107\u017e\u0161\u0111</option>\n<option value="\u0107\u017e\u0161\u0111">abc\u0107\u017e\u0161\u0111</option>\n</select>'
|
|
|
|
# RadioSelect Widget ##########################################################
|
|
|
|
>>> w = RadioSelect()
|
|
>>> print w.render('beatle', 'J', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input checked="checked" type="radio" name="beatle" value="J" /> John</label></li>
|
|
<li><label><input type="radio" name="beatle" value="P" /> Paul</label></li>
|
|
<li><label><input type="radio" name="beatle" value="G" /> George</label></li>
|
|
<li><label><input type="radio" name="beatle" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
If the value is None, none of the options are checked:
|
|
>>> print w.render('beatle', None, choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input type="radio" name="beatle" value="J" /> John</label></li>
|
|
<li><label><input type="radio" name="beatle" value="P" /> Paul</label></li>
|
|
<li><label><input type="radio" name="beatle" value="G" /> George</label></li>
|
|
<li><label><input type="radio" name="beatle" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
If the value corresponds to a label (but not to an option value), none of the options are checked:
|
|
>>> print w.render('beatle', 'John', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input type="radio" name="beatle" value="J" /> John</label></li>
|
|
<li><label><input type="radio" name="beatle" value="P" /> Paul</label></li>
|
|
<li><label><input type="radio" name="beatle" value="G" /> George</label></li>
|
|
<li><label><input type="radio" name="beatle" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
The value is compared to its str():
|
|
>>> print w.render('num', 2, choices=[('1', '1'), ('2', '2'), ('3', '3')])
|
|
<ul>
|
|
<li><label><input type="radio" name="num" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="radio" name="num" value="2" /> 2</label></li>
|
|
<li><label><input type="radio" name="num" value="3" /> 3</label></li>
|
|
</ul>
|
|
>>> print w.render('num', '2', choices=[(1, 1), (2, 2), (3, 3)])
|
|
<ul>
|
|
<li><label><input type="radio" name="num" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="radio" name="num" value="2" /> 2</label></li>
|
|
<li><label><input type="radio" name="num" value="3" /> 3</label></li>
|
|
</ul>
|
|
>>> print w.render('num', 2, choices=[(1, 1), (2, 2), (3, 3)])
|
|
<ul>
|
|
<li><label><input type="radio" name="num" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="radio" name="num" value="2" /> 2</label></li>
|
|
<li><label><input type="radio" name="num" value="3" /> 3</label></li>
|
|
</ul>
|
|
|
|
The 'choices' argument can be any iterable:
|
|
>>> def get_choices():
|
|
... for i in range(5):
|
|
... yield (i, i)
|
|
>>> print w.render('num', 2, choices=get_choices())
|
|
<ul>
|
|
<li><label><input type="radio" name="num" value="0" /> 0</label></li>
|
|
<li><label><input type="radio" name="num" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="radio" name="num" value="2" /> 2</label></li>
|
|
<li><label><input type="radio" name="num" value="3" /> 3</label></li>
|
|
<li><label><input type="radio" name="num" value="4" /> 4</label></li>
|
|
</ul>
|
|
|
|
You can also pass 'choices' to the constructor:
|
|
>>> w = RadioSelect(choices=[(1, 1), (2, 2), (3, 3)])
|
|
>>> print w.render('num', 2)
|
|
<ul>
|
|
<li><label><input type="radio" name="num" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="radio" name="num" value="2" /> 2</label></li>
|
|
<li><label><input type="radio" name="num" value="3" /> 3</label></li>
|
|
</ul>
|
|
|
|
If 'choices' is passed to both the constructor and render(), then they'll both be in the output:
|
|
>>> print w.render('num', 2, choices=[(4, 4), (5, 5)])
|
|
<ul>
|
|
<li><label><input type="radio" name="num" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="radio" name="num" value="2" /> 2</label></li>
|
|
<li><label><input type="radio" name="num" value="3" /> 3</label></li>
|
|
<li><label><input type="radio" name="num" value="4" /> 4</label></li>
|
|
<li><label><input type="radio" name="num" value="5" /> 5</label></li>
|
|
</ul>
|
|
|
|
RadioSelect uses a RadioFieldRenderer to render the individual radio inputs.
|
|
You can manipulate that object directly to customize the way the RadioSelect
|
|
is rendered.
|
|
>>> w = RadioSelect()
|
|
>>> r = w.get_renderer('beatle', 'J', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
>>> for inp in r:
|
|
... print inp
|
|
<label><input checked="checked" type="radio" name="beatle" value="J" /> John</label>
|
|
<label><input type="radio" name="beatle" value="P" /> Paul</label>
|
|
<label><input type="radio" name="beatle" value="G" /> George</label>
|
|
<label><input type="radio" name="beatle" value="R" /> Ringo</label>
|
|
>>> for inp in r:
|
|
... print '%s<br />' % inp
|
|
<label><input checked="checked" type="radio" name="beatle" value="J" /> John</label><br />
|
|
<label><input type="radio" name="beatle" value="P" /> Paul</label><br />
|
|
<label><input type="radio" name="beatle" value="G" /> George</label><br />
|
|
<label><input type="radio" name="beatle" value="R" /> Ringo</label><br />
|
|
>>> for inp in r:
|
|
... print '<p>%s %s</p>' % (inp.tag(), inp.choice_label)
|
|
<p><input checked="checked" type="radio" name="beatle" value="J" /> John</p>
|
|
<p><input type="radio" name="beatle" value="P" /> Paul</p>
|
|
<p><input type="radio" name="beatle" value="G" /> George</p>
|
|
<p><input type="radio" name="beatle" value="R" /> Ringo</p>
|
|
>>> for inp in r:
|
|
... print '%s %s %s %s %s' % (inp.name, inp.value, inp.choice_value, inp.choice_label, inp.is_checked())
|
|
beatle J J John True
|
|
beatle J P Paul False
|
|
beatle J G George False
|
|
beatle J R Ringo False
|
|
|
|
You can create your own custom renderers for RadioSelect to use.
|
|
>>> class MyRenderer(RadioFieldRenderer):
|
|
... def render(self):
|
|
... return u'<br />\n'.join([unicode(choice) for choice in self])
|
|
>>> w = RadioSelect(renderer=MyRenderer)
|
|
>>> print w.render('beatle', 'G', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<label><input type="radio" name="beatle" value="J" /> John</label><br />
|
|
<label><input type="radio" name="beatle" value="P" /> Paul</label><br />
|
|
<label><input checked="checked" type="radio" name="beatle" value="G" /> George</label><br />
|
|
<label><input type="radio" name="beatle" value="R" /> Ringo</label>
|
|
|
|
A RadioFieldRenderer object also allows index access to individual RadioInput
|
|
objects.
|
|
>>> w = RadioSelect()
|
|
>>> r = w.get_renderer('beatle', 'J', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
>>> print r[1]
|
|
<label><input type="radio" name="beatle" value="P" /> Paul</label>
|
|
>>> print r[0]
|
|
<label><input checked="checked" type="radio" name="beatle" value="J" /> John</label>
|
|
>>> r[0].is_checked()
|
|
True
|
|
>>> r[1].is_checked()
|
|
False
|
|
>>> r[1].name, r[1].value, r[1].choice_value, r[1].choice_label
|
|
('beatle', u'J', u'P', u'Paul')
|
|
>>> r[10]
|
|
Traceback (most recent call last):
|
|
...
|
|
IndexError: list index out of range
|
|
|
|
# Unicode choices are correctly rendered as HTML
|
|
>>> w = RadioSelect()
|
|
>>> unicode(w.render('email', 'ŠĐĆŽćžšđ', choices=[('ŠĐĆŽćžšđ', 'ŠĐabcĆŽćžšđ'), ('ćžšđ', 'abcćžšđ')]))
|
|
u'<ul>\n<li><label><input checked="checked" type="radio" name="email" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" /> \u0160\u0110abc\u0106\u017d\u0107\u017e\u0161\u0111</label></li>\n<li><label><input type="radio" name="email" value="\u0107\u017e\u0161\u0111" /> abc\u0107\u017e\u0161\u0111</label></li>\n</ul>'
|
|
|
|
# Attributes provided at instantiation are passed to the constituent inputs
|
|
>>> w = RadioSelect(attrs={'id':'foo'})
|
|
>>> print w.render('beatle', 'J', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input checked="checked" type="radio" id="foo_0" value="J" name="beatle" /> John</label></li>
|
|
<li><label><input type="radio" id="foo_1" value="P" name="beatle" /> Paul</label></li>
|
|
<li><label><input type="radio" id="foo_2" value="G" name="beatle" /> George</label></li>
|
|
<li><label><input type="radio" id="foo_3" value="R" name="beatle" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
# Attributes provided at render-time are passed to the constituent inputs
|
|
>>> w = RadioSelect()
|
|
>>> print w.render('beatle', 'J', choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')), attrs={'id':'bar'})
|
|
<ul>
|
|
<li><label><input checked="checked" type="radio" id="bar_0" value="J" name="beatle" /> John</label></li>
|
|
<li><label><input type="radio" id="bar_1" value="P" name="beatle" /> Paul</label></li>
|
|
<li><label><input type="radio" id="bar_2" value="G" name="beatle" /> George</label></li>
|
|
<li><label><input type="radio" id="bar_3" value="R" name="beatle" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
# CheckboxSelectMultiple Widget ###############################################
|
|
|
|
>>> w = CheckboxSelectMultiple()
|
|
>>> print w.render('beatles', ['J'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="J" /> John</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="P" /> Paul</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="G" /> George</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
>>> print w.render('beatles', ['J', 'P'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="J" /> John</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="P" /> Paul</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="G" /> George</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
>>> print w.render('beatles', ['J', 'P', 'R'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="J" /> John</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="P" /> Paul</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="G" /> George</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
If the value is None, none of the options are selected:
|
|
>>> print w.render('beatles', None, choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input type="checkbox" name="beatles" value="J" /> John</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="P" /> Paul</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="G" /> George</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
If the value corresponds to a label (but not to an option value), none of the options are selected:
|
|
>>> print w.render('beatles', ['John'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input type="checkbox" name="beatles" value="J" /> John</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="P" /> Paul</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="G" /> George</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
If multiple values are given, but some of them are not valid, the valid ones are selected:
|
|
>>> print w.render('beatles', ['J', 'G', 'foo'], choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo')))
|
|
<ul>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="J" /> John</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="P" /> Paul</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="beatles" value="G" /> George</label></li>
|
|
<li><label><input type="checkbox" name="beatles" value="R" /> Ringo</label></li>
|
|
</ul>
|
|
|
|
The value is compared to its str():
|
|
>>> print w.render('nums', [2], choices=[('1', '1'), ('2', '2'), ('3', '3')])
|
|
<ul>
|
|
<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="nums" value="2" /> 2</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>
|
|
</ul>
|
|
>>> print w.render('nums', ['2'], choices=[(1, 1), (2, 2), (3, 3)])
|
|
<ul>
|
|
<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="nums" value="2" /> 2</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>
|
|
</ul>
|
|
>>> print w.render('nums', [2], choices=[(1, 1), (2, 2), (3, 3)])
|
|
<ul>
|
|
<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="nums" value="2" /> 2</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>
|
|
</ul>
|
|
|
|
The 'choices' argument can be any iterable:
|
|
>>> def get_choices():
|
|
... for i in range(5):
|
|
... yield (i, i)
|
|
>>> print w.render('nums', [2], choices=get_choices())
|
|
<ul>
|
|
<li><label><input type="checkbox" name="nums" value="0" /> 0</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="nums" value="2" /> 2</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="4" /> 4</label></li>
|
|
</ul>
|
|
|
|
You can also pass 'choices' to the constructor:
|
|
>>> w = CheckboxSelectMultiple(choices=[(1, 1), (2, 2), (3, 3)])
|
|
>>> print w.render('nums', [2])
|
|
<ul>
|
|
<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="nums" value="2" /> 2</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>
|
|
</ul>
|
|
|
|
If 'choices' is passed to both the constructor and render(), then they'll both be in the output:
|
|
>>> print w.render('nums', [2], choices=[(4, 4), (5, 5)])
|
|
<ul>
|
|
<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="nums" value="2" /> 2</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="4" /> 4</label></li>
|
|
<li><label><input type="checkbox" name="nums" value="5" /> 5</label></li>
|
|
</ul>
|
|
|
|
>>> w.render('nums', ['ŠĐĆŽćžšđ'], choices=[('ŠĐĆŽćžšđ', 'ŠĐabcĆŽćžšđ'), ('ćžšđ', 'abcćžšđ')])
|
|
u'<ul>\n<li><label><input type="checkbox" name="nums" value="1" /> 1</label></li>\n<li><label><input type="checkbox" name="nums" value="2" /> 2</label></li>\n<li><label><input type="checkbox" name="nums" value="3" /> 3</label></li>\n<li><label><input checked="checked" type="checkbox" name="nums" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" /> \u0160\u0110abc\u0106\u017d\u0107\u017e\u0161\u0111</label></li>\n<li><label><input type="checkbox" name="nums" value="\u0107\u017e\u0161\u0111" /> abc\u0107\u017e\u0161\u0111</label></li>\n</ul>'
|
|
|
|
# MultiWidget #################################################################
|
|
|
|
>>> class MyMultiWidget(MultiWidget):
|
|
... def decompress(self, value):
|
|
... if value:
|
|
... return value.split('__')
|
|
... return ['', '']
|
|
... def format_output(self, rendered_widgets):
|
|
... return u'<br />'.join(rendered_widgets)
|
|
>>> w = MyMultiWidget(widgets=(TextInput(attrs={'class': 'big'}), TextInput(attrs={'class': 'small'})))
|
|
>>> w.render('name', ['john', 'lennon'])
|
|
u'<input type="text" class="big" value="john" name="name_0" /><br /><input type="text" class="small" value="lennon" name="name_1" />'
|
|
>>> w.render('name', 'john__lennon')
|
|
u'<input type="text" class="big" value="john" name="name_0" /><br /><input type="text" class="small" value="lennon" name="name_1" />'
|
|
>>> w.render('name', 'john__lennon', attrs={'id':'foo'})
|
|
u'<input id="foo_0" type="text" class="big" value="john" name="name_0" /><br /><input id="foo_1" type="text" class="small" value="lennon" name="name_1" />'
|
|
>>> w = MyMultiWidget(widgets=(TextInput(attrs={'class': 'big'}), TextInput(attrs={'class': 'small'})), attrs={'id': 'bar'})
|
|
>>> w.render('name', ['john', 'lennon'])
|
|
u'<input id="bar_0" type="text" class="big" value="john" name="name_0" /><br /><input id="bar_1" type="text" class="small" value="lennon" name="name_1" />'
|
|
|
|
# SplitDateTimeWidget #########################################################
|
|
|
|
>>> w = SplitDateTimeWidget()
|
|
>>> w.render('date', '')
|
|
u'<input type="text" name="date_0" /><input type="text" name="date_1" />'
|
|
>>> w.render('date', None)
|
|
u'<input type="text" name="date_0" /><input type="text" name="date_1" />'
|
|
>>> w.render('date', datetime.datetime(2006, 1, 10, 7, 30))
|
|
u'<input type="text" name="date_0" value="2006-01-10" /><input type="text" name="date_1" value="07:30:00" />'
|
|
>>> w.render('date', [datetime.date(2006, 1, 10), datetime.time(7, 30)])
|
|
u'<input type="text" name="date_0" value="2006-01-10" /><input type="text" name="date_1" value="07:30:00" />'
|
|
|
|
You can also pass 'attrs' to the constructor. In this case, the attrs will be
|
|
included on both widgets.
|
|
>>> w = SplitDateTimeWidget(attrs={'class': 'pretty'})
|
|
>>> w.render('date', datetime.datetime(2006, 1, 10, 7, 30))
|
|
u'<input type="text" class="pretty" value="2006-01-10" name="date_0" /><input type="text" class="pretty" value="07:30:00" name="date_1" />'
|
|
|
|
##########
|
|
# 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.
|
|
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.
|
|
|
|
# CharField ###################################################################
|
|
|
|
>>> f = CharField()
|
|
>>> f.clean(1)
|
|
u'1'
|
|
>>> f.clean('hello')
|
|
u'hello'
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean([1, 2, 3])
|
|
u'[1, 2, 3]'
|
|
|
|
>>> f = CharField(required=False)
|
|
>>> f.clean(1)
|
|
u'1'
|
|
>>> f.clean('hello')
|
|
u'hello'
|
|
>>> f.clean(None)
|
|
u''
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean([1, 2, 3])
|
|
u'[1, 2, 3]'
|
|
|
|
CharField accepts an optional max_length parameter:
|
|
>>> f = CharField(max_length=10, required=False)
|
|
>>> f.clean('12345')
|
|
u'12345'
|
|
>>> f.clean('1234567890')
|
|
u'1234567890'
|
|
>>> f.clean('1234567890a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at most 10 characters (it has 11).']
|
|
|
|
CharField accepts an optional min_length parameter:
|
|
>>> f = CharField(min_length=10, required=False)
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean('12345')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at least 10 characters (it has 5).']
|
|
>>> f.clean('1234567890')
|
|
u'1234567890'
|
|
>>> f.clean('1234567890a')
|
|
u'1234567890a'
|
|
|
|
>>> f = CharField(min_length=10, required=True)
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('12345')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at least 10 characters (it has 5).']
|
|
>>> f.clean('1234567890')
|
|
u'1234567890'
|
|
>>> f.clean('1234567890a')
|
|
u'1234567890a'
|
|
|
|
# IntegerField ################################################################
|
|
|
|
>>> f = IntegerField()
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('1')
|
|
1
|
|
>>> isinstance(f.clean('1'), int)
|
|
True
|
|
>>> f.clean('23')
|
|
23
|
|
>>> f.clean('a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a whole number.']
|
|
>>> f.clean('1 ')
|
|
1
|
|
>>> f.clean(' 1')
|
|
1
|
|
>>> f.clean(' 1 ')
|
|
1
|
|
>>> f.clean('1a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a whole number.']
|
|
|
|
>>> f = IntegerField(required=False)
|
|
>>> f.clean('')
|
|
>>> repr(f.clean(''))
|
|
'None'
|
|
>>> f.clean(None)
|
|
>>> repr(f.clean(None))
|
|
'None'
|
|
>>> f.clean('1')
|
|
1
|
|
>>> isinstance(f.clean('1'), int)
|
|
True
|
|
>>> f.clean('23')
|
|
23
|
|
>>> f.clean('a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a whole number.']
|
|
>>> f.clean('1 ')
|
|
1
|
|
>>> f.clean(' 1')
|
|
1
|
|
>>> f.clean(' 1 ')
|
|
1
|
|
>>> f.clean('1a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a whole number.']
|
|
|
|
IntegerField accepts an optional max_value parameter:
|
|
>>> f = IntegerField(max_value=10)
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(1)
|
|
1
|
|
>>> f.clean(10)
|
|
10
|
|
>>> f.clean(11)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is less than or equal to 10.']
|
|
>>> f.clean('10')
|
|
10
|
|
>>> f.clean('11')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is less than or equal to 10.']
|
|
|
|
IntegerField accepts an optional min_value parameter:
|
|
>>> f = IntegerField(min_value=10)
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(1)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is greater than or equal to 10.']
|
|
>>> f.clean(10)
|
|
10
|
|
>>> f.clean(11)
|
|
11
|
|
>>> f.clean('10')
|
|
10
|
|
>>> f.clean('11')
|
|
11
|
|
|
|
min_value and max_value can be used together:
|
|
>>> f = IntegerField(min_value=10, max_value=20)
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(1)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is greater than or equal to 10.']
|
|
>>> f.clean(10)
|
|
10
|
|
>>> f.clean(11)
|
|
11
|
|
>>> f.clean('10')
|
|
10
|
|
>>> f.clean('11')
|
|
11
|
|
>>> f.clean(20)
|
|
20
|
|
>>> f.clean(21)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is less than or equal to 20.']
|
|
|
|
# FloatField ##################################################################
|
|
|
|
>>> f = FloatField()
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('1')
|
|
1.0
|
|
>>> isinstance(f.clean('1'), float)
|
|
True
|
|
>>> f.clean('23')
|
|
23.0
|
|
>>> f.clean('3.14')
|
|
3.1400000000000001
|
|
>>> f.clean('a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a number.']
|
|
>>> f.clean('1.0 ')
|
|
1.0
|
|
>>> f.clean(' 1.0')
|
|
1.0
|
|
>>> f.clean(' 1.0 ')
|
|
1.0
|
|
>>> f.clean('1.0a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a number.']
|
|
|
|
>>> f = FloatField(required=False)
|
|
>>> f.clean('')
|
|
|
|
>>> f.clean(None)
|
|
|
|
>>> f.clean('1')
|
|
1.0
|
|
|
|
FloatField accepts min_value and max_value just like IntegerField:
|
|
>>> f = FloatField(max_value=1.5, min_value=0.5)
|
|
|
|
>>> f.clean('1.6')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is less than or equal to 1.5.']
|
|
>>> f.clean('0.4')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is greater than or equal to 0.5.']
|
|
>>> f.clean('1.5')
|
|
1.5
|
|
>>> f.clean('0.5')
|
|
0.5
|
|
|
|
# DecimalField ################################################################
|
|
|
|
>>> f = DecimalField(max_digits=4, decimal_places=2)
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('1')
|
|
Decimal("1")
|
|
>>> isinstance(f.clean('1'), Decimal)
|
|
True
|
|
>>> f.clean('23')
|
|
Decimal("23")
|
|
>>> f.clean('3.14')
|
|
Decimal("3.14")
|
|
>>> f.clean('a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a number.']
|
|
>>> f.clean('1.0 ')
|
|
Decimal("1.0")
|
|
>>> f.clean(' 1.0')
|
|
Decimal("1.0")
|
|
>>> f.clean(' 1.0 ')
|
|
Decimal("1.0")
|
|
>>> f.clean('1.0a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a number.']
|
|
>>> f.clean('123.45')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure that there are no more than 4 digits in total.']
|
|
>>> f.clean('1.234')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure that there are no more than 2 decimal places.']
|
|
>>> f.clean('123.4')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure that there are no more than 2 digits before the decimal point.']
|
|
>>> f = DecimalField(max_digits=4, decimal_places=2, required=False)
|
|
>>> f.clean('')
|
|
|
|
>>> f.clean(None)
|
|
|
|
>>> f.clean('1')
|
|
Decimal("1")
|
|
|
|
DecimalField accepts min_value and max_value just like IntegerField:
|
|
>>> f = DecimalField(max_digits=4, decimal_places=2, max_value=Decimal('1.5'), min_value=Decimal('0.5'))
|
|
|
|
>>> f.clean('1.6')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is less than or equal to 1.5.']
|
|
>>> f.clean('0.4')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value is greater than or equal to 0.5.']
|
|
>>> f.clean('1.5')
|
|
Decimal("1.5")
|
|
>>> f.clean('0.5')
|
|
Decimal("0.5")
|
|
>>> f.clean('.5')
|
|
Decimal("0.5")
|
|
>>> f.clean('00.50')
|
|
Decimal("0.50")
|
|
|
|
# DateField ###################################################################
|
|
|
|
>>> import datetime
|
|
>>> f = DateField()
|
|
>>> f.clean(datetime.date(2006, 10, 25))
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59))
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59, 200))
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('2006-10-25')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('10/25/2006')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('10/25/06')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('Oct 25 2006')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('October 25 2006')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('October 25, 2006')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('25 October 2006')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('25 October, 2006')
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('2006-4-31')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
>>> f.clean('200a-10-25')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
>>> f.clean('25/10/06')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
|
|
>>> f = DateField(required=False)
|
|
>>> f.clean(None)
|
|
>>> repr(f.clean(None))
|
|
'None'
|
|
>>> f.clean('')
|
|
>>> repr(f.clean(''))
|
|
'None'
|
|
|
|
DateField accepts an optional input_formats parameter:
|
|
>>> f = DateField(input_formats=['%Y %m %d'])
|
|
>>> f.clean(datetime.date(2006, 10, 25))
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
|
|
datetime.date(2006, 10, 25)
|
|
>>> f.clean('2006 10 25')
|
|
datetime.date(2006, 10, 25)
|
|
|
|
The input_formats parameter overrides all default input formats,
|
|
so the default formats won't work unless you specify them:
|
|
>>> f.clean('2006-10-25')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
>>> f.clean('10/25/2006')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
>>> f.clean('10/25/06')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
|
|
# TimeField ###################################################################
|
|
|
|
>>> import datetime
|
|
>>> f = TimeField()
|
|
>>> f.clean(datetime.time(14, 25))
|
|
datetime.time(14, 25)
|
|
>>> f.clean(datetime.time(14, 25, 59))
|
|
datetime.time(14, 25, 59)
|
|
>>> f.clean('14:25')
|
|
datetime.time(14, 25)
|
|
>>> f.clean('14:25:59')
|
|
datetime.time(14, 25, 59)
|
|
>>> f.clean('hello')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
>>> f.clean('1:24 p.m.')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
|
|
TimeField accepts an optional input_formats parameter:
|
|
>>> f = TimeField(input_formats=['%I:%M %p'])
|
|
>>> f.clean(datetime.time(14, 25))
|
|
datetime.time(14, 25)
|
|
>>> f.clean(datetime.time(14, 25, 59))
|
|
datetime.time(14, 25, 59)
|
|
>>> f.clean('4:25 AM')
|
|
datetime.time(4, 25)
|
|
>>> f.clean('4:25 PM')
|
|
datetime.time(16, 25)
|
|
|
|
The input_formats parameter overrides all default input formats,
|
|
so the default formats won't work unless you specify them:
|
|
>>> f.clean('14:30:45')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
|
|
# DateTimeField ###############################################################
|
|
|
|
>>> import datetime
|
|
>>> f = DateTimeField()
|
|
>>> f.clean(datetime.date(2006, 10, 25))
|
|
datetime.datetime(2006, 10, 25, 0, 0)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59))
|
|
datetime.datetime(2006, 10, 25, 14, 30, 59)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59, 200))
|
|
datetime.datetime(2006, 10, 25, 14, 30, 59, 200)
|
|
>>> f.clean('2006-10-25 14:30:45')
|
|
datetime.datetime(2006, 10, 25, 14, 30, 45)
|
|
>>> f.clean('2006-10-25 14:30:00')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean('2006-10-25 14:30')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean('2006-10-25')
|
|
datetime.datetime(2006, 10, 25, 0, 0)
|
|
>>> f.clean('10/25/2006 14:30:45')
|
|
datetime.datetime(2006, 10, 25, 14, 30, 45)
|
|
>>> f.clean('10/25/2006 14:30:00')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean('10/25/2006 14:30')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean('10/25/2006')
|
|
datetime.datetime(2006, 10, 25, 0, 0)
|
|
>>> f.clean('10/25/06 14:30:45')
|
|
datetime.datetime(2006, 10, 25, 14, 30, 45)
|
|
>>> f.clean('10/25/06 14:30:00')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean('10/25/06 14:30')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean('10/25/06')
|
|
datetime.datetime(2006, 10, 25, 0, 0)
|
|
>>> f.clean('hello')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date/time.']
|
|
>>> f.clean('2006-10-25 4:30 p.m.')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date/time.']
|
|
|
|
DateField accepts an optional input_formats parameter:
|
|
>>> f = DateTimeField(input_formats=['%Y %m %d %I:%M %p'])
|
|
>>> f.clean(datetime.date(2006, 10, 25))
|
|
datetime.datetime(2006, 10, 25, 0, 0)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59))
|
|
datetime.datetime(2006, 10, 25, 14, 30, 59)
|
|
>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59, 200))
|
|
datetime.datetime(2006, 10, 25, 14, 30, 59, 200)
|
|
>>> f.clean('2006 10 25 2:30 PM')
|
|
datetime.datetime(2006, 10, 25, 14, 30)
|
|
|
|
The input_formats parameter overrides all default input formats,
|
|
so the default formats won't work unless you specify them:
|
|
>>> f.clean('2006-10-25 14:30:45')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date/time.']
|
|
|
|
>>> f = DateTimeField(required=False)
|
|
>>> f.clean(None)
|
|
>>> repr(f.clean(None))
|
|
'None'
|
|
>>> f.clean('')
|
|
>>> repr(f.clean(''))
|
|
'None'
|
|
|
|
# RegexField ##################################################################
|
|
|
|
>>> f = RegexField('^\d[A-F]\d$')
|
|
>>> f.clean('2A2')
|
|
u'2A2'
|
|
>>> f.clean('3F3')
|
|
u'3F3'
|
|
>>> f.clean('3G3')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
>>> f.clean(' 2A2')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
>>> f.clean('2A2 ')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
|
|
>>> f = RegexField('^\d[A-F]\d$', required=False)
|
|
>>> f.clean('2A2')
|
|
u'2A2'
|
|
>>> f.clean('3F3')
|
|
u'3F3'
|
|
>>> f.clean('3G3')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
>>> f.clean('')
|
|
u''
|
|
|
|
Alternatively, RegexField can take a compiled regular expression:
|
|
>>> f = RegexField(re.compile('^\d[A-F]\d$'))
|
|
>>> f.clean('2A2')
|
|
u'2A2'
|
|
>>> f.clean('3F3')
|
|
u'3F3'
|
|
>>> f.clean('3G3')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
>>> f.clean(' 2A2')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
>>> f.clean('2A2 ')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
|
|
RegexField takes an optional error_message argument:
|
|
>>> f = RegexField('^\d\d\d\d$', error_message='Enter a four-digit number.')
|
|
>>> f.clean('1234')
|
|
u'1234'
|
|
>>> f.clean('123')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a four-digit number.']
|
|
>>> f.clean('abcd')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a four-digit number.']
|
|
|
|
RegexField also access min_length and max_length parameters, for convenience.
|
|
>>> f = RegexField('^\d+$', min_length=5, max_length=10)
|
|
>>> f.clean('123')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at least 5 characters (it has 3).']
|
|
>>> f.clean('abc')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at least 5 characters (it has 3).']
|
|
>>> f.clean('12345')
|
|
u'12345'
|
|
>>> f.clean('1234567890')
|
|
u'1234567890'
|
|
>>> f.clean('12345678901')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at most 10 characters (it has 11).']
|
|
>>> f.clean('12345a')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid value.']
|
|
|
|
# EmailField ##################################################################
|
|
|
|
>>> f = EmailField()
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('person@example.com')
|
|
u'person@example.com'
|
|
>>> f.clean('foo')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
>>> f.clean('foo@')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
>>> f.clean('foo@bar')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
|
|
>>> f = EmailField(required=False)
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean(None)
|
|
u''
|
|
>>> f.clean('person@example.com')
|
|
u'person@example.com'
|
|
>>> f.clean('foo')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
>>> f.clean('foo@')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
>>> f.clean('foo@bar')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
|
|
EmailField also access min_length and max_length parameters, for convenience.
|
|
>>> f = EmailField(min_length=10, max_length=15)
|
|
>>> f.clean('a@foo.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at least 10 characters (it has 9).']
|
|
>>> f.clean('alf@foo.com')
|
|
u'alf@foo.com'
|
|
>>> f.clean('alf123456788@foo.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at most 15 characters (it has 20).']
|
|
|
|
# URLField ##################################################################
|
|
|
|
>>> f = URLField()
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('http://example.com')
|
|
u'http://example.com'
|
|
>>> f.clean('http://www.example.com')
|
|
u'http://www.example.com'
|
|
>>> f.clean('foo')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('example.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://example')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://example.')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
|
|
>>> f = URLField(required=False)
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean(None)
|
|
u''
|
|
>>> f.clean('http://example.com')
|
|
u'http://example.com'
|
|
>>> f.clean('http://www.example.com')
|
|
u'http://www.example.com'
|
|
>>> f.clean('foo')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('example.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://example')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://example.')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
|
|
URLField takes an optional verify_exists parameter, which is False by default.
|
|
This verifies that the URL is live on the Internet and doesn't return a 404 or 500:
|
|
>>> f = URLField(verify_exists=True)
|
|
>>> f.clean('http://www.google.com') # This will fail if there's no Internet connection
|
|
u'http://www.google.com'
|
|
>>> f.clean('http://example')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid URL.']
|
|
>>> f.clean('http://www.jfoiwjfoi23jfoijoaijfoiwjofiwjefewl.com') # bad domain
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This URL appears to be a broken link.']
|
|
>>> f.clean('http://google.com/we-love-microsoft.html') # good domain, bad page
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This URL appears to be a broken link.']
|
|
>>> f = URLField(verify_exists=True, required=False)
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean('http://www.google.com') # This will fail if there's no Internet connection
|
|
u'http://www.google.com'
|
|
|
|
URLField also access min_length and max_length parameters, for convenience.
|
|
>>> f = URLField(min_length=15, max_length=20)
|
|
>>> f.clean('http://f.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at least 15 characters (it has 12).']
|
|
>>> f.clean('http://example.com')
|
|
u'http://example.com'
|
|
>>> f.clean('http://abcdefghijklmnopqrstuvwxyz.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at most 20 characters (it has 37).']
|
|
|
|
# BooleanField ################################################################
|
|
|
|
>>> f = BooleanField()
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(True)
|
|
True
|
|
>>> f.clean(False)
|
|
False
|
|
>>> f.clean(1)
|
|
True
|
|
>>> f.clean(0)
|
|
False
|
|
>>> f.clean('Django rocks')
|
|
True
|
|
|
|
>>> f = BooleanField(required=False)
|
|
>>> f.clean('')
|
|
False
|
|
>>> f.clean(None)
|
|
False
|
|
>>> f.clean(True)
|
|
True
|
|
>>> f.clean(False)
|
|
False
|
|
>>> f.clean(1)
|
|
True
|
|
>>> f.clean(0)
|
|
False
|
|
>>> f.clean('Django rocks')
|
|
True
|
|
|
|
# ChoiceField #################################################################
|
|
|
|
>>> f = ChoiceField(choices=[('1', '1'), ('2', '2')])
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(1)
|
|
u'1'
|
|
>>> f.clean('1')
|
|
u'1'
|
|
>>> f.clean('3')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Select a valid choice. That choice is not one of the available choices.']
|
|
|
|
>>> f = ChoiceField(choices=[('1', '1'), ('2', '2')], required=False)
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean(None)
|
|
u''
|
|
>>> f.clean(1)
|
|
u'1'
|
|
>>> f.clean('1')
|
|
u'1'
|
|
>>> f.clean('3')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Select a valid choice. That choice is not one of the available choices.']
|
|
|
|
>>> f = ChoiceField(choices=[('J', 'John'), ('P', 'Paul')])
|
|
>>> f.clean('J')
|
|
u'J'
|
|
>>> f.clean('John')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Select a valid choice. That choice is not one of the available choices.']
|
|
|
|
# NullBooleanField ############################################################
|
|
|
|
>>> f = NullBooleanField()
|
|
>>> f.clean('')
|
|
>>> f.clean(True)
|
|
True
|
|
>>> f.clean(False)
|
|
False
|
|
>>> f.clean(None)
|
|
>>> f.clean('1')
|
|
>>> f.clean('2')
|
|
>>> f.clean('3')
|
|
>>> f.clean('hello')
|
|
|
|
# MultipleChoiceField #########################################################
|
|
|
|
>>> f = MultipleChoiceField(choices=[('1', '1'), ('2', '2')])
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean([1])
|
|
[u'1']
|
|
>>> f.clean(['1'])
|
|
[u'1']
|
|
>>> f.clean(['1', '2'])
|
|
[u'1', u'2']
|
|
>>> f.clean([1, '2'])
|
|
[u'1', u'2']
|
|
>>> f.clean((1, '2'))
|
|
[u'1', u'2']
|
|
>>> f.clean('hello')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a list of values.']
|
|
>>> f.clean([])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(())
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(['3'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Select a valid choice. 3 is not one of the available choices.']
|
|
|
|
>>> f = MultipleChoiceField(choices=[('1', '1'), ('2', '2')], required=False)
|
|
>>> f.clean('')
|
|
[]
|
|
>>> f.clean(None)
|
|
[]
|
|
>>> f.clean([1])
|
|
[u'1']
|
|
>>> f.clean(['1'])
|
|
[u'1']
|
|
>>> f.clean(['1', '2'])
|
|
[u'1', u'2']
|
|
>>> f.clean([1, '2'])
|
|
[u'1', u'2']
|
|
>>> f.clean((1, '2'))
|
|
[u'1', u'2']
|
|
>>> f.clean('hello')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a list of values.']
|
|
>>> f.clean([])
|
|
[]
|
|
>>> f.clean(())
|
|
[]
|
|
>>> f.clean(['3'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Select a valid choice. 3 is not one of the available choices.']
|
|
|
|
# ComboField ##################################################################
|
|
|
|
ComboField takes a list of fields that should be used to validate a value,
|
|
in that order.
|
|
>>> f = ComboField(fields=[CharField(max_length=20), EmailField()])
|
|
>>> f.clean('test@example.com')
|
|
u'test@example.com'
|
|
>>> f.clean('longemailaddress@example.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at most 20 characters (it has 28).']
|
|
>>> f.clean('not an e-mail')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
|
|
>>> f = ComboField(fields=[CharField(max_length=20), EmailField()], required=False)
|
|
>>> f.clean('test@example.com')
|
|
u'test@example.com'
|
|
>>> f.clean('longemailaddress@example.com')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Ensure this value has at most 20 characters (it has 28).']
|
|
>>> f.clean('not an e-mail')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid e-mail address.']
|
|
>>> f.clean('')
|
|
u''
|
|
>>> f.clean(None)
|
|
u''
|
|
|
|
# SplitDateTimeField ##########################################################
|
|
|
|
>>> f = SplitDateTimeField()
|
|
>>> f.clean([datetime.date(2006, 1, 10), datetime.time(7, 30)])
|
|
datetime.datetime(2006, 1, 10, 7, 30)
|
|
>>> f.clean(None)
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
>>> f.clean('hello')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a list of values.']
|
|
>>> f.clean(['hello', 'there'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.', u'Enter a valid time.']
|
|
>>> f.clean(['2006-01-10', 'there'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
>>> f.clean(['hello', '07:30'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
|
|
>>> f = SplitDateTimeField(required=False)
|
|
>>> f.clean([datetime.date(2006, 1, 10), datetime.time(7, 30)])
|
|
datetime.datetime(2006, 1, 10, 7, 30)
|
|
>>> f.clean(['2006-01-10', '07:30'])
|
|
datetime.datetime(2006, 1, 10, 7, 30)
|
|
>>> f.clean(None)
|
|
>>> f.clean('')
|
|
>>> f.clean([''])
|
|
>>> f.clean(['', ''])
|
|
>>> f.clean('hello')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a list of values.']
|
|
>>> f.clean(['hello', 'there'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.', u'Enter a valid time.']
|
|
>>> f.clean(['2006-01-10', 'there'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
>>> f.clean(['hello', '07:30'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
>>> f.clean(['2006-01-10', ''])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
>>> f.clean(['2006-01-10'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid time.']
|
|
>>> f.clean(['', '07:30'])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Enter a valid date.']
|
|
|
|
#########
|
|
# Forms #
|
|
#########
|
|
|
|
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.
|
|
|
|
# Form ########################################################################
|
|
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... birthday = DateField()
|
|
|
|
Pass a dictionary to a Form's __init__().
|
|
>>> p = Person({'first_name': u'John', 'last_name': u'Lennon', 'birthday': u'1940-10-9'})
|
|
>>> p.is_bound
|
|
True
|
|
>>> p.errors
|
|
{}
|
|
>>> p.is_valid()
|
|
True
|
|
>>> p.errors.as_ul()
|
|
u''
|
|
>>> p.errors.as_text()
|
|
u''
|
|
>>> p.cleaned_data
|
|
{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
|
|
>>> print p['first_name']
|
|
<input type="text" name="first_name" value="John" id="id_first_name" />
|
|
>>> print p['last_name']
|
|
<input type="text" name="last_name" value="Lennon" id="id_last_name" />
|
|
>>> print p['birthday']
|
|
<input type="text" name="birthday" value="1940-10-9" id="id_birthday" />
|
|
>>> print p['nonexistentfield']
|
|
Traceback (most recent call last):
|
|
...
|
|
KeyError: "Key 'nonexistentfield' not found in Form"
|
|
|
|
>>> for boundfield in p:
|
|
... print boundfield
|
|
<input type="text" name="first_name" value="John" id="id_first_name" />
|
|
<input type="text" name="last_name" value="Lennon" id="id_last_name" />
|
|
<input type="text" name="birthday" value="1940-10-9" id="id_birthday" />
|
|
>>> for boundfield in p:
|
|
... print boundfield.label, boundfield.data
|
|
First name John
|
|
Last name Lennon
|
|
Birthday 1940-10-9
|
|
>>> print p
|
|
<tr><th><label for="id_first_name">First name:</label></th><td><input type="text" name="first_name" value="John" id="id_first_name" /></td></tr>
|
|
<tr><th><label for="id_last_name">Last name:</label></th><td><input type="text" name="last_name" value="Lennon" id="id_last_name" /></td></tr>
|
|
<tr><th><label for="id_birthday">Birthday:</label></th><td><input type="text" name="birthday" value="1940-10-9" id="id_birthday" /></td></tr>
|
|
|
|
Empty dictionaries are valid, too.
|
|
>>> p = Person({})
|
|
>>> p.is_bound
|
|
True
|
|
>>> p.errors
|
|
{'first_name': [u'This field is required.'], 'last_name': [u'This field is required.'], 'birthday': [u'This field is required.']}
|
|
>>> p.is_valid()
|
|
False
|
|
>>> p.cleaned_data
|
|
Traceback (most recent call last):
|
|
...
|
|
AttributeError: 'Person' object has no attribute 'cleaned_data'
|
|
>>> print p
|
|
<tr><th><label for="id_first_name">First name:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="first_name" id="id_first_name" /></td></tr>
|
|
<tr><th><label for="id_last_name">Last name:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="last_name" id="id_last_name" /></td></tr>
|
|
<tr><th><label for="id_birthday">Birthday:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="birthday" id="id_birthday" /></td></tr>
|
|
>>> print p.as_table()
|
|
<tr><th><label for="id_first_name">First name:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="first_name" id="id_first_name" /></td></tr>
|
|
<tr><th><label for="id_last_name">Last name:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="last_name" id="id_last_name" /></td></tr>
|
|
<tr><th><label for="id_birthday">Birthday:</label></th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="birthday" id="id_birthday" /></td></tr>
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_first_name">First name:</label> <input type="text" name="first_name" id="id_first_name" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_last_name">Last name:</label> <input type="text" name="last_name" id="id_last_name" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul><label for="id_birthday">Birthday:</label> <input type="text" name="birthday" id="id_birthday" /></li>
|
|
>>> print p.as_p()
|
|
<ul class="errorlist"><li>This field is required.</li></ul>
|
|
<p><label for="id_first_name">First name:</label> <input type="text" name="first_name" id="id_first_name" /></p>
|
|
<ul class="errorlist"><li>This field is required.</li></ul>
|
|
<p><label for="id_last_name">Last name:</label> <input type="text" name="last_name" id="id_last_name" /></p>
|
|
<ul class="errorlist"><li>This field is required.</li></ul>
|
|
<p><label for="id_birthday">Birthday:</label> <input type="text" name="birthday" id="id_birthday" /></p>
|
|
|
|
If you don't pass any values to the Form's __init__(), or if you pass None,
|
|
the Form will be considered unbound and won't do any validation. Form.errors
|
|
will be an empty dictionary *but* Form.is_valid() will return False.
|
|
>>> p = Person()
|
|
>>> p.is_bound
|
|
False
|
|
>>> p.errors
|
|
{}
|
|
>>> p.is_valid()
|
|
False
|
|
>>> p.cleaned_data
|
|
Traceback (most recent call last):
|
|
...
|
|
AttributeError: 'Person' object has no attribute 'cleaned_data'
|
|
>>> print p
|
|
<tr><th><label for="id_first_name">First name:</label></th><td><input type="text" name="first_name" id="id_first_name" /></td></tr>
|
|
<tr><th><label for="id_last_name">Last name:</label></th><td><input type="text" name="last_name" id="id_last_name" /></td></tr>
|
|
<tr><th><label for="id_birthday">Birthday:</label></th><td><input type="text" name="birthday" id="id_birthday" /></td></tr>
|
|
>>> print p.as_table()
|
|
<tr><th><label for="id_first_name">First name:</label></th><td><input type="text" name="first_name" id="id_first_name" /></td></tr>
|
|
<tr><th><label for="id_last_name">Last name:</label></th><td><input type="text" name="last_name" id="id_last_name" /></td></tr>
|
|
<tr><th><label for="id_birthday">Birthday:</label></th><td><input type="text" name="birthday" id="id_birthday" /></td></tr>
|
|
>>> print p.as_ul()
|
|
<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>
|
|
>>> print p.as_p()
|
|
<p><label for="id_first_name">First name:</label> <input type="text" name="first_name" id="id_first_name" /></p>
|
|
<p><label for="id_last_name">Last name:</label> <input type="text" name="last_name" id="id_last_name" /></p>
|
|
<p><label for="id_birthday">Birthday:</label> <input type="text" name="birthday" id="id_birthday" /></p>
|
|
|
|
Unicode values are handled properly.
|
|
>>> p = Person({'first_name': u'John', 'last_name': u'\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111', 'birthday': '1940-10-9'})
|
|
>>> p.as_table()
|
|
u'<tr><th><label for="id_first_name">First name:</label></th><td><input type="text" name="first_name" value="John" id="id_first_name" /></td></tr>\n<tr><th><label for="id_last_name">Last name:</label></th><td><input type="text" name="last_name" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" id="id_last_name" /></td></tr>\n<tr><th><label for="id_birthday">Birthday:</label></th><td><input type="text" name="birthday" value="1940-10-9" id="id_birthday" /></td></tr>'
|
|
>>> p.as_ul()
|
|
u'<li><label for="id_first_name">First name:</label> <input type="text" name="first_name" value="John" id="id_first_name" /></li>\n<li><label for="id_last_name">Last name:</label> <input type="text" name="last_name" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" id="id_last_name" /></li>\n<li><label for="id_birthday">Birthday:</label> <input type="text" name="birthday" value="1940-10-9" id="id_birthday" /></li>'
|
|
>>> p.as_p()
|
|
u'<p><label for="id_first_name">First name:</label> <input type="text" name="first_name" value="John" id="id_first_name" /></p>\n<p><label for="id_last_name">Last name:</label> <input type="text" name="last_name" value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" id="id_last_name" /></p>\n<p><label for="id_birthday">Birthday:</label> <input type="text" name="birthday" value="1940-10-9" id="id_birthday" /></p>'
|
|
|
|
>>> p = Person({'last_name': u'Lennon'})
|
|
>>> p.errors
|
|
{'first_name': [u'This field is required.'], 'birthday': [u'This field is required.']}
|
|
>>> p.is_valid()
|
|
False
|
|
>>> p.errors.as_ul()
|
|
u'<ul class="errorlist"><li>first_name<ul class="errorlist"><li>This field is required.</li></ul></li><li>birthday<ul class="errorlist"><li>This field is required.</li></ul></li></ul>'
|
|
>>> print p.errors.as_text()
|
|
* first_name
|
|
* This field is required.
|
|
* birthday
|
|
* This field is required.
|
|
>>> p.cleaned_data
|
|
Traceback (most recent call last):
|
|
...
|
|
AttributeError: 'Person' object has no attribute 'cleaned_data'
|
|
>>> p['first_name'].errors
|
|
[u'This field is required.']
|
|
>>> p['first_name'].errors.as_ul()
|
|
u'<ul class="errorlist"><li>This field is required.</li></ul>'
|
|
>>> p['first_name'].errors.as_text()
|
|
u'* This field is required.'
|
|
|
|
>>> p = Person()
|
|
>>> print p['first_name']
|
|
<input type="text" name="first_name" id="id_first_name" />
|
|
>>> print p['last_name']
|
|
<input type="text" name="last_name" id="id_last_name" />
|
|
>>> print p['birthday']
|
|
<input type="text" name="birthday" id="id_birthday" />
|
|
|
|
cleaned_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 cleaned_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.cleaned_data
|
|
{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
|
|
|
|
cleaned_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 cleaned_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.cleaned_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.cleaned_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.
|
|
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. It will also put a <label> around
|
|
the human-readable labels for a field.
|
|
>>> p = Person(auto_id='%s_id')
|
|
>>> print p.as_table()
|
|
<tr><th><label for="first_name_id">First name:</label></th><td><input type="text" name="first_name" id="first_name_id" /></td></tr>
|
|
<tr><th><label for="last_name_id">Last name:</label></th><td><input type="text" name="last_name" id="last_name_id" /></td></tr>
|
|
<tr><th><label for="birthday_id">Birthday:</label></th><td><input type="text" name="birthday" id="birthday_id" /></td></tr>
|
|
>>> print p.as_ul()
|
|
<li><label for="first_name_id">First name:</label> <input type="text" name="first_name" id="first_name_id" /></li>
|
|
<li><label for="last_name_id">Last name:</label> <input type="text" name="last_name" id="last_name_id" /></li>
|
|
<li><label for="birthday_id">Birthday:</label> <input type="text" name="birthday" id="birthday_id" /></li>
|
|
>>> print p.as_p()
|
|
<p><label for="first_name_id">First name:</label> <input type="text" name="first_name" id="first_name_id" /></p>
|
|
<p><label for="last_name_id">Last name:</label> <input type="text" name="last_name" id="last_name_id" /></p>
|
|
<p><label for="birthday_id">Birthday:</label> <input type="text" name="birthday" id="birthday_id" /></p>
|
|
|
|
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><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.
|
|
>>> p = Person(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>First name: <input type="text" name="first_name" /></li>
|
|
<li>Last name: <input type="text" name="last_name" /></li>
|
|
<li>Birthday: <input type="text" name="birthday" /></li>
|
|
|
|
In this example, auto_id is False, but the "id" attribute for the "first_name"
|
|
field is given. Also note that field gets a <label>, while the others don't.
|
|
>>> class PersonNew(Form):
|
|
... first_name = CharField(widget=TextInput(attrs={'id': 'first_name_id'}))
|
|
... last_name = CharField()
|
|
... birthday = DateField()
|
|
>>> p = PersonNew(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<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>
|
|
|
|
If the "id" attribute is specified in the Form and auto_id is True, the "id"
|
|
attribute in the Form gets precedence.
|
|
>>> p = PersonNew(auto_id=True)
|
|
>>> print p.as_ul()
|
|
<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()
|
|
... get_spam = BooleanField()
|
|
>>> f = SignupForm(auto_id=False)
|
|
>>> print f['email']
|
|
<input type="text" name="email" />
|
|
>>> print f['get_spam']
|
|
<input type="checkbox" name="get_spam" />
|
|
|
|
>>> f = SignupForm({'email': 'test@example.com', 'get_spam': True}, auto_id=False)
|
|
>>> print f['email']
|
|
<input type="text" name="email" value="test@example.com" />
|
|
>>> print f['get_spam']
|
|
<input checked="checked" type="checkbox" name="get_spam" />
|
|
|
|
Any Field can have a Widget class passed to its constructor:
|
|
>>> class ContactForm(Form):
|
|
... subject = CharField()
|
|
... message = CharField(widget=Textarea)
|
|
>>> f = ContactForm(auto_id=False)
|
|
>>> print f['subject']
|
|
<input type="text" name="subject" />
|
|
>>> print f['message']
|
|
<textarea rows="10" cols="40" name="message"></textarea>
|
|
|
|
as_textarea(), as_text() and as_hidden() are shortcuts for changing the output
|
|
widget type:
|
|
>>> f['subject'].as_textarea()
|
|
u'<textarea rows="10" cols="40" name="subject"></textarea>'
|
|
>>> f['message'].as_text()
|
|
u'<input type="text" name="message" />'
|
|
>>> f['message'].as_hidden()
|
|
u'<input type="hidden" name="message" />'
|
|
|
|
The 'widget' parameter to a Field can also be an instance:
|
|
>>> class ContactForm(Form):
|
|
... subject = CharField()
|
|
... message = CharField(widget=Textarea(attrs={'rows': 80, 'cols': 20}))
|
|
>>> f = ContactForm(auto_id=False)
|
|
>>> print f['message']
|
|
<textarea rows="80" cols="20" name="message"></textarea>
|
|
|
|
Instance-level attrs are *not* carried over to as_textarea(), as_text() and
|
|
as_hidden():
|
|
>>> f['message'].as_text()
|
|
u'<input type="text" name="message" />'
|
|
>>> f = ContactForm({'subject': 'Hello', 'message': 'I love you.'}, auto_id=False)
|
|
>>> f['subject'].as_textarea()
|
|
u'<textarea rows="10" cols="40" name="subject">Hello</textarea>'
|
|
>>> f['message'].as_text()
|
|
u'<input type="text" name="message" value="I love you." />'
|
|
>>> f['message'].as_hidden()
|
|
u'<input type="hidden" name="message" value="I love you." />'
|
|
|
|
For a form with a <select>, use ChoiceField:
|
|
>>> class FrameworkForm(Form):
|
|
... name = CharField()
|
|
... language = ChoiceField(choices=[('P', 'Python'), ('J', 'Java')])
|
|
>>> f = FrameworkForm(auto_id=False)
|
|
>>> print f['language']
|
|
<select name="language">
|
|
<option value="P">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
>>> f = FrameworkForm({'name': 'Django', 'language': 'P'}, auto_id=False)
|
|
>>> print f['language']
|
|
<select name="language">
|
|
<option value="P" selected="selected">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
|
|
A subtlety: If one of the choices' value is the empty string and the form is
|
|
unbound, then the <option> for the empty-string choice will get selected="selected".
|
|
>>> class FrameworkForm(Form):
|
|
... name = CharField()
|
|
... language = ChoiceField(choices=[('', '------'), ('P', 'Python'), ('J', 'Java')])
|
|
>>> f = FrameworkForm(auto_id=False)
|
|
>>> print f['language']
|
|
<select name="language">
|
|
<option value="" selected="selected">------</option>
|
|
<option value="P">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
|
|
You can specify widget attributes in the Widget constructor.
|
|
>>> class FrameworkForm(Form):
|
|
... name = CharField()
|
|
... language = ChoiceField(choices=[('P', 'Python'), ('J', 'Java')], widget=Select(attrs={'class': 'foo'}))
|
|
>>> f = FrameworkForm(auto_id=False)
|
|
>>> print f['language']
|
|
<select class="foo" name="language">
|
|
<option value="P">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
>>> f = FrameworkForm({'name': 'Django', 'language': 'P'}, auto_id=False)
|
|
>>> print f['language']
|
|
<select class="foo" name="language">
|
|
<option value="P" selected="selected">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
|
|
When passing a custom widget instance to ChoiceField, note that setting
|
|
'choices' on the widget is meaningless. The widget will use the choices
|
|
defined on the Field, not the ones defined on the Widget.
|
|
>>> class FrameworkForm(Form):
|
|
... name = CharField()
|
|
... language = ChoiceField(choices=[('P', 'Python'), ('J', 'Java')], widget=Select(choices=[('R', 'Ruby'), ('P', 'Perl')], attrs={'class': 'foo'}))
|
|
>>> f = FrameworkForm(auto_id=False)
|
|
>>> print f['language']
|
|
<select class="foo" name="language">
|
|
<option value="P">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
>>> f = FrameworkForm({'name': 'Django', 'language': 'P'}, auto_id=False)
|
|
>>> print f['language']
|
|
<select class="foo" name="language">
|
|
<option value="P" selected="selected">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
|
|
You can set a ChoiceField's choices after the fact.
|
|
>>> class FrameworkForm(Form):
|
|
... name = CharField()
|
|
... language = ChoiceField()
|
|
>>> f = FrameworkForm(auto_id=False)
|
|
>>> print f['language']
|
|
<select name="language">
|
|
</select>
|
|
>>> f.fields['language'].choices = [('P', 'Python'), ('J', 'Java')]
|
|
>>> print f['language']
|
|
<select name="language">
|
|
<option value="P">Python</option>
|
|
<option value="J">Java</option>
|
|
</select>
|
|
|
|
Add widget=RadioSelect to use that widget with a ChoiceField.
|
|
>>> class FrameworkForm(Form):
|
|
... name = CharField()
|
|
... language = ChoiceField(choices=[('P', 'Python'), ('J', 'Java')], widget=RadioSelect)
|
|
>>> f = FrameworkForm(auto_id=False)
|
|
>>> print f['language']
|
|
<ul>
|
|
<li><label><input type="radio" name="language" value="P" /> Python</label></li>
|
|
<li><label><input type="radio" name="language" value="J" /> Java</label></li>
|
|
</ul>
|
|
>>> print f
|
|
<tr><th>Name:</th><td><input type="text" name="name" /></td></tr>
|
|
<tr><th>Language:</th><td><ul>
|
|
<li><label><input type="radio" name="language" value="P" /> Python</label></li>
|
|
<li><label><input type="radio" name="language" value="J" /> Java</label></li>
|
|
</ul></td></tr>
|
|
>>> print f.as_ul()
|
|
<li>Name: <input type="text" name="name" /></li>
|
|
<li>Language: <ul>
|
|
<li><label><input type="radio" name="language" value="P" /> Python</label></li>
|
|
<li><label><input type="radio" name="language" value="J" /> Java</label></li>
|
|
</ul></li>
|
|
|
|
Regarding auto_id and <label>, RadioSelect is a special case. Each radio button
|
|
gets a distinct ID, formed by appending an underscore plus the button's
|
|
zero-based index.
|
|
>>> f = FrameworkForm(auto_id='id_%s')
|
|
>>> print f['language']
|
|
<ul>
|
|
<li><label><input type="radio" id="id_language_0" value="P" name="language" /> Python</label></li>
|
|
<li><label><input type="radio" id="id_language_1" value="J" name="language" /> Java</label></li>
|
|
</ul>
|
|
|
|
When RadioSelect is used with auto_id, and the whole form is printed using
|
|
either as_table() or as_ul(), the label for the RadioSelect will point to the
|
|
ID of the *first* radio button.
|
|
>>> print f
|
|
<tr><th><label for="id_name">Name:</label></th><td><input type="text" name="name" id="id_name" /></td></tr>
|
|
<tr><th><label for="id_language_0">Language:</label></th><td><ul>
|
|
<li><label><input type="radio" id="id_language_0" value="P" name="language" /> Python</label></li>
|
|
<li><label><input type="radio" id="id_language_1" value="J" name="language" /> Java</label></li>
|
|
</ul></td></tr>
|
|
>>> print f.as_ul()
|
|
<li><label for="id_name">Name:</label> <input type="text" name="name" id="id_name" /></li>
|
|
<li><label for="id_language_0">Language:</label> <ul>
|
|
<li><label><input type="radio" id="id_language_0" value="P" name="language" /> Python</label></li>
|
|
<li><label><input type="radio" id="id_language_1" value="J" name="language" /> Java</label></li>
|
|
</ul></li>
|
|
>>> print f.as_p()
|
|
<p><label for="id_name">Name:</label> <input type="text" name="name" id="id_name" /></p>
|
|
<p><label for="id_language_0">Language:</label> <ul>
|
|
<li><label><input type="radio" id="id_language_0" value="P" name="language" /> Python</label></li>
|
|
<li><label><input type="radio" id="id_language_1" value="J" name="language" /> Java</label></li>
|
|
</ul></p>
|
|
|
|
MultipleChoiceField is a special case, as its data is required to be a list:
|
|
>>> class SongForm(Form):
|
|
... name = CharField()
|
|
... composers = MultipleChoiceField()
|
|
>>> f = SongForm(auto_id=False)
|
|
>>> print f['composers']
|
|
<select multiple="multiple" name="composers">
|
|
</select>
|
|
>>> class SongForm(Form):
|
|
... name = CharField()
|
|
... composers = MultipleChoiceField(choices=[('J', 'John Lennon'), ('P', 'Paul McCartney')])
|
|
>>> f = SongForm(auto_id=False)
|
|
>>> print f['composers']
|
|
<select multiple="multiple" name="composers">
|
|
<option value="J">John Lennon</option>
|
|
<option value="P">Paul McCartney</option>
|
|
</select>
|
|
>>> f = SongForm({'name': 'Yesterday', 'composers': ['P']}, auto_id=False)
|
|
>>> print f['name']
|
|
<input type="text" name="name" value="Yesterday" />
|
|
>>> print f['composers']
|
|
<select multiple="multiple" name="composers">
|
|
<option value="J">John Lennon</option>
|
|
<option value="P" selected="selected">Paul McCartney</option>
|
|
</select>
|
|
|
|
MultipleChoiceField rendered as_hidden() is a special case. Because it can
|
|
have multiple values, its as_hidden() renders multiple <input type="hidden">
|
|
tags.
|
|
>>> f = SongForm({'name': 'Yesterday', 'composers': ['P']}, auto_id=False)
|
|
>>> print f['composers'].as_hidden()
|
|
<input type="hidden" name="composers" value="P" />
|
|
>>> f = SongForm({'name': 'From Me To You', 'composers': ['P', 'J']}, auto_id=False)
|
|
>>> print f['composers'].as_hidden()
|
|
<input type="hidden" name="composers" value="P" />
|
|
<input type="hidden" name="composers" value="J" />
|
|
|
|
MultipleChoiceField can also be used with the CheckboxSelectMultiple widget.
|
|
>>> class SongForm(Form):
|
|
... name = CharField()
|
|
... composers = MultipleChoiceField(choices=[('J', 'John Lennon'), ('P', 'Paul McCartney')], widget=CheckboxSelectMultiple)
|
|
>>> f = SongForm(auto_id=False)
|
|
>>> print f['composers']
|
|
<ul>
|
|
<li><label><input type="checkbox" name="composers" value="J" /> John Lennon</label></li>
|
|
<li><label><input type="checkbox" name="composers" value="P" /> Paul McCartney</label></li>
|
|
</ul>
|
|
>>> f = SongForm({'composers': ['J']}, auto_id=False)
|
|
>>> print f['composers']
|
|
<ul>
|
|
<li><label><input checked="checked" type="checkbox" name="composers" value="J" /> John Lennon</label></li>
|
|
<li><label><input type="checkbox" name="composers" value="P" /> Paul McCartney</label></li>
|
|
</ul>
|
|
>>> f = SongForm({'composers': ['J', 'P']}, auto_id=False)
|
|
>>> print f['composers']
|
|
<ul>
|
|
<li><label><input checked="checked" type="checkbox" name="composers" value="J" /> John Lennon</label></li>
|
|
<li><label><input checked="checked" type="checkbox" name="composers" value="P" /> Paul McCartney</label></li>
|
|
</ul>
|
|
|
|
Regarding auto_id, CheckboxSelectMultiple is a special case. Each checkbox
|
|
gets a distinct ID, formed by appending an underscore plus the checkbox's
|
|
zero-based index.
|
|
>>> f = SongForm(auto_id='%s_id')
|
|
>>> print f['composers']
|
|
<ul>
|
|
<li><label><input type="checkbox" name="composers" value="J" id="composers_id_0" /> John Lennon</label></li>
|
|
<li><label><input type="checkbox" name="composers" value="P" id="composers_id_1" /> Paul McCartney</label></li>
|
|
</ul>
|
|
|
|
Data for a MultipleChoiceField should be a list. QueryDict and MultiValueDict
|
|
conveniently work with this.
|
|
>>> data = {'name': 'Yesterday', 'composers': ['J', 'P']}
|
|
>>> f = SongForm(data)
|
|
>>> f.errors
|
|
{}
|
|
>>> from django.http import QueryDict
|
|
>>> data = QueryDict('name=Yesterday&composers=J&composers=P')
|
|
>>> f = SongForm(data)
|
|
>>> f.errors
|
|
{}
|
|
>>> from django.utils.datastructures import MultiValueDict
|
|
>>> data = MultiValueDict(dict(name=['Yesterday'], composers=['J', 'P']))
|
|
>>> f = SongForm(data)
|
|
>>> f.errors
|
|
{}
|
|
|
|
The MultipleHiddenInput widget renders multiple values as hidden fields.
|
|
>>> class SongFormHidden(Form):
|
|
... name = CharField()
|
|
... composers = MultipleChoiceField(choices=[('J', 'John Lennon'), ('P', 'Paul McCartney')], widget=MultipleHiddenInput)
|
|
>>> f = SongFormHidden(MultiValueDict(dict(name=['Yesterday'], composers=['J', 'P'])), auto_id=False)
|
|
>>> print f.as_ul()
|
|
<li>Name: <input type="text" name="name" value="Yesterday" /><input type="hidden" name="composers" value="J" />
|
|
<input type="hidden" name="composers" value="P" /></li>
|
|
|
|
When using CheckboxSelectMultiple, the framework expects a list of input and
|
|
returns a list of input.
|
|
>>> f = SongForm({'name': 'Yesterday'}, auto_id=False)
|
|
>>> f.errors
|
|
{'composers': [u'This field is required.']}
|
|
>>> f = SongForm({'name': 'Yesterday', 'composers': ['J']}, auto_id=False)
|
|
>>> f.errors
|
|
{}
|
|
>>> f.cleaned_data
|
|
{'composers': [u'J'], 'name': u'Yesterday'}
|
|
>>> f = SongForm({'name': 'Yesterday', 'composers': ['J', 'P']}, auto_id=False)
|
|
>>> f.errors
|
|
{}
|
|
>>> f.cleaned_data
|
|
{'composers': [u'J', u'P'], 'name': u'Yesterday'}
|
|
|
|
Validation errors are HTML-escaped when output as HTML.
|
|
>>> class EscapingForm(Form):
|
|
... special_name = CharField()
|
|
... def clean_special_name(self):
|
|
... raise ValidationError("Something's wrong with '%s'" % self.cleaned_data['special_name'])
|
|
|
|
>>> f = EscapingForm({'special_name': "Nothing to escape"}, auto_id=False)
|
|
>>> print f
|
|
<tr><th>Special name:</th><td><ul class="errorlist"><li>Something's wrong with 'Nothing to escape'</li></ul><input type="text" name="special_name" value="Nothing to escape" /></td></tr>
|
|
>>> f = EscapingForm({'special_name': "Should escape < & > and <script>alert('xss')</script>"}, auto_id=False)
|
|
>>> print f
|
|
<tr><th>Special name:</th><td><ul class="errorlist"><li>Something's wrong with 'Should escape < & > and <script>alert('xss')</script>'</li></ul><input type="text" name="special_name" value="Should escape < & > and <script>alert('xss')</script>" /></td></tr>
|
|
|
|
# Validating multiple fields in relation to another ###########################
|
|
|
|
There are a couple of ways to do multiple-field validation. If you want the
|
|
validation message to be associated with a particular field, implement the
|
|
clean_XXX() method on the Form, where XXX is the field name. As in
|
|
Field.clean(), the clean_XXX() method should return the cleaned value. In the
|
|
clean_XXX() method, you have access to self.cleaned_data, which is a dictionary
|
|
of all the data that has been cleaned *so far*, in order by the fields,
|
|
including the current field (e.g., the field XXX if you're in clean_XXX()).
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10)
|
|
... password1 = CharField(widget=PasswordInput)
|
|
... password2 = CharField(widget=PasswordInput)
|
|
... def clean_password2(self):
|
|
... if self.cleaned_data.get('password1') and self.cleaned_data.get('password2') and self.cleaned_data['password1'] != self.cleaned_data['password2']:
|
|
... raise ValidationError(u'Please make sure your passwords match.')
|
|
... return self.cleaned_data['password2']
|
|
>>> f = UserRegistration(auto_id=False)
|
|
>>> f.errors
|
|
{}
|
|
>>> f = UserRegistration({}, auto_id=False)
|
|
>>> f.errors
|
|
{'username': [u'This field is required.'], 'password1': [u'This field is required.'], 'password2': [u'This field is required.']}
|
|
>>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'bar'}, auto_id=False)
|
|
>>> f.errors
|
|
{'password2': [u'Please make sure your passwords match.']}
|
|
>>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'foo'}, auto_id=False)
|
|
>>> f.errors
|
|
{}
|
|
>>> f.cleaned_data
|
|
{'username': u'adrian', 'password1': u'foo', 'password2': u'foo'}
|
|
|
|
Another way of doing multiple-field validation is by implementing the
|
|
Form's clean() method. If you do this, any ValidationError raised by that
|
|
method will not be associated with a particular field; it will have a
|
|
special-case association with the field named '__all__'.
|
|
Note that in Form.clean(), you have access to self.cleaned_data, a dictionary of
|
|
all the fields/values that have *not* raised a ValidationError. Also note
|
|
Form.clean() is required to return a dictionary of all clean data.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10)
|
|
... password1 = CharField(widget=PasswordInput)
|
|
... password2 = CharField(widget=PasswordInput)
|
|
... def clean(self):
|
|
... if self.cleaned_data.get('password1') and self.cleaned_data.get('password2') and self.cleaned_data['password1'] != self.cleaned_data['password2']:
|
|
... raise ValidationError(u'Please make sure your passwords match.')
|
|
... return self.cleaned_data
|
|
>>> f = UserRegistration(auto_id=False)
|
|
>>> f.errors
|
|
{}
|
|
>>> f = UserRegistration({}, auto_id=False)
|
|
>>> print f.as_table()
|
|
<tr><th>Username:</th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="text" name="username" maxlength="10" /></td></tr>
|
|
<tr><th>Password1:</th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="password" name="password1" /></td></tr>
|
|
<tr><th>Password2:</th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="password" name="password2" /></td></tr>
|
|
>>> f.errors
|
|
{'username': [u'This field is required.'], 'password1': [u'This field is required.'], 'password2': [u'This field is required.']}
|
|
>>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'bar'}, auto_id=False)
|
|
>>> f.errors
|
|
{'__all__': [u'Please make sure your passwords match.']}
|
|
>>> print f.as_table()
|
|
<tr><td colspan="2"><ul class="errorlist"><li>Please make sure your passwords match.</li></ul></td></tr>
|
|
<tr><th>Username:</th><td><input type="text" name="username" value="adrian" maxlength="10" /></td></tr>
|
|
<tr><th>Password1:</th><td><input type="password" name="password1" value="foo" /></td></tr>
|
|
<tr><th>Password2:</th><td><input type="password" name="password2" value="bar" /></td></tr>
|
|
>>> print f.as_ul()
|
|
<li><ul class="errorlist"><li>Please make sure your passwords match.</li></ul></li>
|
|
<li>Username: <input type="text" name="username" value="adrian" maxlength="10" /></li>
|
|
<li>Password1: <input type="password" name="password1" value="foo" /></li>
|
|
<li>Password2: <input type="password" name="password2" value="bar" /></li>
|
|
>>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'foo'}, auto_id=False)
|
|
>>> f.errors
|
|
{}
|
|
>>> f.cleaned_data
|
|
{'username': u'adrian', 'password1': u'foo', 'password2': u'foo'}
|
|
|
|
# Dynamic construction ########################################################
|
|
|
|
It's possible to construct a Form dynamically by adding to the self.fields
|
|
dictionary in __init__(). Don't forget to call Form.__init__() within the
|
|
subclass' __init__().
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... def __init__(self, *args, **kwargs):
|
|
... super(Person, self).__init__(*args, **kwargs)
|
|
... self.fields['birthday'] = DateField()
|
|
>>> p = Person(auto_id=False)
|
|
>>> print p
|
|
<tr><th>First name:</th><td><input type="text" name="first_name" /></td></tr>
|
|
<tr><th>Last name:</th><td><input type="text" name="last_name" /></td></tr>
|
|
<tr><th>Birthday:</th><td><input type="text" name="birthday" /></td></tr>
|
|
|
|
Instances of a dynamic Form do not persist fields from one Form instance to
|
|
the next.
|
|
>>> class MyForm(Form):
|
|
... def __init__(self, data=None, auto_id=False, field_list=[]):
|
|
... Form.__init__(self, data, auto_id)
|
|
... for field in field_list:
|
|
... self.fields[field[0]] = field[1]
|
|
>>> field_list = [('field1', CharField()), ('field2', CharField())]
|
|
>>> my_form = MyForm(field_list=field_list)
|
|
>>> print my_form
|
|
<tr><th>Field1:</th><td><input type="text" name="field1" /></td></tr>
|
|
<tr><th>Field2:</th><td><input type="text" name="field2" /></td></tr>
|
|
>>> field_list = [('field3', CharField()), ('field4', CharField())]
|
|
>>> my_form = MyForm(field_list=field_list)
|
|
>>> print my_form
|
|
<tr><th>Field3:</th><td><input type="text" name="field3" /></td></tr>
|
|
<tr><th>Field4:</th><td><input type="text" name="field4" /></td></tr>
|
|
|
|
>>> class MyForm(Form):
|
|
... default_field_1 = CharField()
|
|
... default_field_2 = CharField()
|
|
... def __init__(self, data=None, auto_id=False, field_list=[]):
|
|
... Form.__init__(self, data, auto_id)
|
|
... for field in field_list:
|
|
... self.fields[field[0]] = field[1]
|
|
>>> field_list = [('field1', CharField()), ('field2', CharField())]
|
|
>>> my_form = MyForm(field_list=field_list)
|
|
>>> print my_form
|
|
<tr><th>Default field 1:</th><td><input type="text" name="default_field_1" /></td></tr>
|
|
<tr><th>Default field 2:</th><td><input type="text" name="default_field_2" /></td></tr>
|
|
<tr><th>Field1:</th><td><input type="text" name="field1" /></td></tr>
|
|
<tr><th>Field2:</th><td><input type="text" name="field2" /></td></tr>
|
|
>>> field_list = [('field3', CharField()), ('field4', CharField())]
|
|
>>> my_form = MyForm(field_list=field_list)
|
|
>>> print my_form
|
|
<tr><th>Default field 1:</th><td><input type="text" name="default_field_1" /></td></tr>
|
|
<tr><th>Default field 2:</th><td><input type="text" name="default_field_2" /></td></tr>
|
|
<tr><th>Field3:</th><td><input type="text" name="field3" /></td></tr>
|
|
<tr><th>Field4:</th><td><input type="text" name="field4" /></td></tr>
|
|
|
|
Similarly, changes to field attributes do not persist from one Form instance
|
|
to the next.
|
|
>>> class Person(Form):
|
|
... first_name = CharField(required=False)
|
|
... last_name = CharField(required=False)
|
|
... def __init__(self, names_required=False, *args, **kwargs):
|
|
... super(Person, self).__init__(*args, **kwargs)
|
|
... if names_required:
|
|
... self.fields['first_name'].required = True
|
|
... self.fields['last_name'].required = True
|
|
>>> f = Person(names_required=False)
|
|
>>> f['first_name'].field.required, f['last_name'].field.required
|
|
(False, False)
|
|
>>> f = Person(names_required=True)
|
|
>>> f['first_name'].field.required, f['last_name'].field.required
|
|
(True, True)
|
|
>>> f = Person(names_required=False)
|
|
>>> f['first_name'].field.required, f['last_name'].field.required
|
|
(False, False)
|
|
>>> class Person(Form):
|
|
... first_name = CharField(max_length=30)
|
|
... last_name = CharField(max_length=30)
|
|
... def __init__(self, name_max_length=None, *args, **kwargs):
|
|
... super(Person, self).__init__(*args, **kwargs)
|
|
... if name_max_length:
|
|
... self.fields['first_name'].max_length = name_max_length
|
|
... self.fields['last_name'].max_length = name_max_length
|
|
>>> f = Person(name_max_length=None)
|
|
>>> f['first_name'].field.max_length, f['last_name'].field.max_length
|
|
(30, 30)
|
|
>>> f = Person(name_max_length=20)
|
|
>>> f['first_name'].field.max_length, f['last_name'].field.max_length
|
|
(20, 20)
|
|
>>> f = Person(name_max_length=None)
|
|
>>> f['first_name'].field.max_length, f['last_name'].field.max_length
|
|
(30, 30)
|
|
|
|
HiddenInput widgets are displayed differently in the as_table(), as_ul()
|
|
and as_p() output of a Form -- their verbose names are not displayed, and a
|
|
separate row is not displayed. They're displayed in the last row of the
|
|
form, directly after that row's form element.
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... hidden_text = CharField(widget=HiddenInput)
|
|
... birthday = DateField()
|
|
>>> p = Person(auto_id=False)
|
|
>>> print p
|
|
<tr><th>First name:</th><td><input type="text" name="first_name" /></td></tr>
|
|
<tr><th>Last name:</th><td><input type="text" name="last_name" /></td></tr>
|
|
<tr><th>Birthday:</th><td><input type="text" name="birthday" /><input type="hidden" name="hidden_text" /></td></tr>
|
|
>>> print p.as_ul()
|
|
<li>First name: <input type="text" name="first_name" /></li>
|
|
<li>Last name: <input type="text" name="last_name" /></li>
|
|
<li>Birthday: <input type="text" name="birthday" /><input type="hidden" name="hidden_text" /></li>
|
|
>>> print p.as_p()
|
|
<p>First name: <input type="text" name="first_name" /></p>
|
|
<p>Last name: <input type="text" name="last_name" /></p>
|
|
<p>Birthday: <input type="text" name="birthday" /><input type="hidden" name="hidden_text" /></p>
|
|
|
|
With auto_id set, a HiddenInput still gets an ID, but it doesn't get a label.
|
|
>>> p = Person(auto_id='id_%s')
|
|
>>> print p
|
|
<tr><th><label for="id_first_name">First name:</label></th><td><input type="text" name="first_name" id="id_first_name" /></td></tr>
|
|
<tr><th><label for="id_last_name">Last name:</label></th><td><input type="text" name="last_name" id="id_last_name" /></td></tr>
|
|
<tr><th><label for="id_birthday">Birthday:</label></th><td><input type="text" name="birthday" id="id_birthday" /><input type="hidden" name="hidden_text" id="id_hidden_text" /></td></tr>
|
|
>>> print p.as_ul()
|
|
<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" /><input type="hidden" name="hidden_text" id="id_hidden_text" /></li>
|
|
>>> print p.as_p()
|
|
<p><label for="id_first_name">First name:</label> <input type="text" name="first_name" id="id_first_name" /></p>
|
|
<p><label for="id_last_name">Last name:</label> <input type="text" name="last_name" id="id_last_name" /></p>
|
|
<p><label for="id_birthday">Birthday:</label> <input type="text" name="birthday" id="id_birthday" /><input type="hidden" name="hidden_text" id="id_hidden_text" /></p>
|
|
|
|
If a field with a HiddenInput has errors, the as_table() and as_ul() output
|
|
will include the error message(s) with the text "(Hidden field [fieldname]) "
|
|
prepended. This message is displayed at the top of the output, regardless of
|
|
its field's order in the form.
|
|
>>> p = Person({'first_name': 'John', 'last_name': 'Lennon', 'birthday': '1940-10-9'}, auto_id=False)
|
|
>>> print p
|
|
<tr><td colspan="2"><ul class="errorlist"><li>(Hidden field hidden_text) This field is required.</li></ul></td></tr>
|
|
<tr><th>First name:</th><td><input type="text" name="first_name" value="John" /></td></tr>
|
|
<tr><th>Last name:</th><td><input type="text" name="last_name" value="Lennon" /></td></tr>
|
|
<tr><th>Birthday:</th><td><input type="text" name="birthday" value="1940-10-9" /><input type="hidden" name="hidden_text" /></td></tr>
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>(Hidden field hidden_text) This field is required.</li></ul></li>
|
|
<li>First name: <input type="text" name="first_name" value="John" /></li>
|
|
<li>Last name: <input type="text" name="last_name" value="Lennon" /></li>
|
|
<li>Birthday: <input type="text" name="birthday" value="1940-10-9" /><input type="hidden" name="hidden_text" /></li>
|
|
>>> print p.as_p()
|
|
<ul class="errorlist"><li>(Hidden field hidden_text) This field is required.</li></ul>
|
|
<p>First name: <input type="text" name="first_name" value="John" /></p>
|
|
<p>Last name: <input type="text" name="last_name" value="Lennon" /></p>
|
|
<p>Birthday: <input type="text" name="birthday" value="1940-10-9" /><input type="hidden" name="hidden_text" /></p>
|
|
|
|
A corner case: It's possible for a form to have only HiddenInputs.
|
|
>>> class TestForm(Form):
|
|
... foo = CharField(widget=HiddenInput)
|
|
... bar = CharField(widget=HiddenInput)
|
|
>>> p = TestForm(auto_id=False)
|
|
>>> print p.as_table()
|
|
<input type="hidden" name="foo" /><input type="hidden" name="bar" />
|
|
>>> print p.as_ul()
|
|
<input type="hidden" name="foo" /><input type="hidden" name="bar" />
|
|
>>> print p.as_p()
|
|
<input type="hidden" name="foo" /><input type="hidden" name="bar" />
|
|
|
|
A Form's fields are displayed in the same order in which they were defined.
|
|
>>> class TestForm(Form):
|
|
... field1 = CharField()
|
|
... field2 = CharField()
|
|
... field3 = CharField()
|
|
... field4 = CharField()
|
|
... field5 = CharField()
|
|
... field6 = CharField()
|
|
... field7 = CharField()
|
|
... field8 = CharField()
|
|
... field9 = CharField()
|
|
... field10 = CharField()
|
|
... field11 = CharField()
|
|
... field12 = CharField()
|
|
... field13 = CharField()
|
|
... field14 = CharField()
|
|
>>> p = TestForm(auto_id=False)
|
|
>>> print p
|
|
<tr><th>Field1:</th><td><input type="text" name="field1" /></td></tr>
|
|
<tr><th>Field2:</th><td><input type="text" name="field2" /></td></tr>
|
|
<tr><th>Field3:</th><td><input type="text" name="field3" /></td></tr>
|
|
<tr><th>Field4:</th><td><input type="text" name="field4" /></td></tr>
|
|
<tr><th>Field5:</th><td><input type="text" name="field5" /></td></tr>
|
|
<tr><th>Field6:</th><td><input type="text" name="field6" /></td></tr>
|
|
<tr><th>Field7:</th><td><input type="text" name="field7" /></td></tr>
|
|
<tr><th>Field8:</th><td><input type="text" name="field8" /></td></tr>
|
|
<tr><th>Field9:</th><td><input type="text" name="field9" /></td></tr>
|
|
<tr><th>Field10:</th><td><input type="text" name="field10" /></td></tr>
|
|
<tr><th>Field11:</th><td><input type="text" name="field11" /></td></tr>
|
|
<tr><th>Field12:</th><td><input type="text" name="field12" /></td></tr>
|
|
<tr><th>Field13:</th><td><input type="text" name="field13" /></td></tr>
|
|
<tr><th>Field14:</th><td><input type="text" name="field14" /></td></tr>
|
|
|
|
Some Field classes have an effect on the HTML attributes of their associated
|
|
Widget. If you set max_length in a CharField and its associated widget is
|
|
either a TextInput or PasswordInput, then the widget's rendered HTML will
|
|
include the "maxlength" attribute.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10) # uses TextInput by default
|
|
... password = CharField(max_length=10, widget=PasswordInput)
|
|
... realname = CharField(max_length=10, widget=TextInput) # redundantly define widget, just to test
|
|
... address = CharField() # no max_length defined here
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" maxlength="10" /></li>
|
|
<li>Realname: <input type="text" name="realname" maxlength="10" /></li>
|
|
<li>Address: <input type="text" name="address" /></li>
|
|
|
|
If you specify a custom "attrs" that includes the "maxlength" attribute,
|
|
the Field's max_length attribute will override whatever "maxlength" you specify
|
|
in "attrs".
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, widget=TextInput(attrs={'maxlength': 20}))
|
|
... password = CharField(max_length=10, widget=PasswordInput)
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" maxlength="10" /></li>
|
|
|
|
# Specifying labels ###########################################################
|
|
|
|
You can specify the label for a field by using the 'label' argument to a Field
|
|
class. If you don't specify 'label', Django will use the field name with
|
|
underscores converted to spaces, and the initial letter capitalized.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, label='Your username')
|
|
... password1 = CharField(widget=PasswordInput)
|
|
... password2 = CharField(widget=PasswordInput, label='Password (again)')
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Your username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li>Password1: <input type="password" name="password1" /></li>
|
|
<li>Password (again): <input type="password" name="password2" /></li>
|
|
|
|
Labels for as_* methods will only end in a colon if they don't end in other
|
|
punctuation already.
|
|
>>> class Questions(Form):
|
|
... q1 = CharField(label='The first question')
|
|
... q2 = CharField(label='What is your name?')
|
|
... q3 = CharField(label='The answer to life is:')
|
|
... q4 = CharField(label='Answer this question!')
|
|
... q5 = CharField(label='The last question. Period.')
|
|
>>> print Questions(auto_id=False).as_p()
|
|
<p>The first question: <input type="text" name="q1" /></p>
|
|
<p>What is your name? <input type="text" name="q2" /></p>
|
|
<p>The answer to life is: <input type="text" name="q3" /></p>
|
|
<p>Answer this question! <input type="text" name="q4" /></p>
|
|
<p>The last question. Period. <input type="text" name="q5" /></p>
|
|
>>> print Questions().as_p()
|
|
<p><label for="id_q1">The first question:</label> <input type="text" name="q1" id="id_q1" /></p>
|
|
<p><label for="id_q2">What is your name?</label> <input type="text" name="q2" id="id_q2" /></p>
|
|
<p><label for="id_q3">The answer to life is:</label> <input type="text" name="q3" id="id_q3" /></p>
|
|
<p><label for="id_q4">Answer this question!</label> <input type="text" name="q4" id="id_q4" /></p>
|
|
<p><label for="id_q5">The last question. Period.</label> <input type="text" name="q5" id="id_q5" /></p>
|
|
|
|
A label can be a Unicode object or a bytestring with special characters.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, label='ŠĐĆŽćžšđ')
|
|
... password = CharField(widget=PasswordInput, label=u'\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111')
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> p.as_ul()
|
|
u'<li>\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111: <input type="text" name="username" maxlength="10" /></li>\n<li>\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111: <input type="password" name="password" /></li>'
|
|
|
|
If a label is set to the empty string for a field, that field won't get a label.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, label='')
|
|
... password = CharField(widget=PasswordInput)
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li> <input type="text" name="username" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration(auto_id='id_%s')
|
|
>>> print p.as_ul()
|
|
<li> <input id="id_username" type="text" name="username" maxlength="10" /></li>
|
|
<li><label for="id_password">Password:</label> <input type="password" name="password" id="id_password" /></li>
|
|
|
|
If label is None, Django will auto-create the label from the field name. This
|
|
is default behavior.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, label=None)
|
|
... password = CharField(widget=PasswordInput)
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration(auto_id='id_%s')
|
|
>>> print p.as_ul()
|
|
<li><label for="id_username">Username:</label> <input id="id_username" type="text" name="username" maxlength="10" /></li>
|
|
<li><label for="id_password">Password:</label> <input type="password" name="password" id="id_password" /></li>
|
|
|
|
# Initial data ################################################################
|
|
|
|
You can specify initial data for a field by using the 'initial' argument to a
|
|
Field class. This initial data is displayed when a Form is rendered with *no*
|
|
data. It is not displayed when a Form is rendered with any data (including an
|
|
empty dictionary). Also, the initial value is *not* used if data for a
|
|
particular required field isn't provided.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, initial='django')
|
|
... password = CharField(widget=PasswordInput)
|
|
|
|
Here, we're not submitting any data, so the initial value will be displayed.
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="django" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
|
|
Here, we're submitting data, so the initial value will *not* be displayed.
|
|
>>> p = UserRegistration({}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration({'username': u''}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration({'username': u'foo'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="foo" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
|
|
An 'initial' value is *not* used as a fallback if data is not provided. In this
|
|
example, we don't provide a value for 'username', and the form raises a
|
|
validation error rather than using the initial value for 'username'.
|
|
>>> p = UserRegistration({'password': 'secret'})
|
|
>>> p.errors
|
|
{'username': [u'This field is required.']}
|
|
>>> p.is_valid()
|
|
False
|
|
|
|
# Dynamic initial data ########################################################
|
|
|
|
The previous technique dealt with "hard-coded" initial data, but it's also
|
|
possible to specify initial data after you've already created the Form class
|
|
(i.e., at runtime). Use the 'initial' parameter to the Form constructor. This
|
|
should be a dictionary containing initial values for one or more fields in the
|
|
form, keyed by field name.
|
|
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10)
|
|
... password = CharField(widget=PasswordInput)
|
|
|
|
Here, we're not submitting any data, so the initial value will be displayed.
|
|
>>> p = UserRegistration(initial={'username': 'django'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="django" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration(initial={'username': 'stephane'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="stephane" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
|
|
The 'initial' parameter is meaningless if you pass data.
|
|
>>> p = UserRegistration({}, initial={'username': 'django'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration({'username': u''}, initial={'username': 'django'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration({'username': u'foo'}, initial={'username': 'django'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="foo" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
|
|
A dynamic 'initial' value is *not* used as a fallback if data is not provided.
|
|
In this example, we don't provide a value for 'username', and the form raises a
|
|
validation error rather than using the initial value for 'username'.
|
|
>>> p = UserRegistration({'password': 'secret'}, initial={'username': 'django'})
|
|
>>> p.errors
|
|
{'username': [u'This field is required.']}
|
|
>>> p.is_valid()
|
|
False
|
|
|
|
If a Form defines 'initial' *and* 'initial' is passed as a parameter to Form(),
|
|
then the latter will get precedence.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, initial='django')
|
|
... password = CharField(widget=PasswordInput)
|
|
>>> p = UserRegistration(initial={'username': 'babik'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="babik" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
|
|
# Callable initial data ########################################################
|
|
|
|
The previous technique dealt with raw values as initial data, but it's also
|
|
possible to specify callable data.
|
|
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10)
|
|
... password = CharField(widget=PasswordInput)
|
|
|
|
We need to define functions that get called later.
|
|
>>> def initial_django():
|
|
... return 'django'
|
|
>>> def initial_stephane():
|
|
... return 'stephane'
|
|
|
|
Here, we're not submitting any data, so the initial value will be displayed.
|
|
>>> p = UserRegistration(initial={'username': initial_django}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="django" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
|
|
The 'initial' parameter is meaningless if you pass data.
|
|
>>> p = UserRegistration({}, initial={'username': initial_django}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration({'username': u''}, initial={'username': initial_django}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Username: <input type="text" name="username" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration({'username': u'foo'}, initial={'username': initial_django}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="foo" maxlength="10" /></li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /></li>
|
|
|
|
A callable 'initial' value is *not* used as a fallback if data is not provided.
|
|
In this example, we don't provide a value for 'username', and the form raises a
|
|
validation error rather than using the initial value for 'username'.
|
|
>>> p = UserRegistration({'password': 'secret'}, initial={'username': initial_django})
|
|
>>> p.errors
|
|
{'username': [u'This field is required.']}
|
|
>>> p.is_valid()
|
|
False
|
|
|
|
If a Form defines 'initial' *and* 'initial' is passed as a parameter to Form(),
|
|
then the latter will get precedence.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, initial=initial_django)
|
|
... password = CharField(widget=PasswordInput)
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="django" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
>>> p = UserRegistration(initial={'username': initial_stephane}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="stephane" maxlength="10" /></li>
|
|
<li>Password: <input type="password" name="password" /></li>
|
|
|
|
# Help text ###################################################################
|
|
|
|
You can specify descriptive text for a field by using the 'help_text' argument
|
|
to a Field class. This help text is displayed when a Form is rendered.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, help_text='e.g., user@example.com')
|
|
... password = CharField(widget=PasswordInput, help_text='Choose wisely.')
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" maxlength="10" /> e.g., user@example.com</li>
|
|
<li>Password: <input type="password" name="password" /> Choose wisely.</li>
|
|
>>> print p.as_p()
|
|
<p>Username: <input type="text" name="username" maxlength="10" /> e.g., user@example.com</p>
|
|
<p>Password: <input type="password" name="password" /> Choose wisely.</p>
|
|
>>> print p.as_table()
|
|
<tr><th>Username:</th><td><input type="text" name="username" maxlength="10" /><br />e.g., user@example.com</td></tr>
|
|
<tr><th>Password:</th><td><input type="password" name="password" /><br />Choose wisely.</td></tr>
|
|
|
|
The help text is displayed whether or not data is provided for the form.
|
|
>>> p = UserRegistration({'username': u'foo'}, auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" value="foo" maxlength="10" /> e.g., user@example.com</li>
|
|
<li><ul class="errorlist"><li>This field is required.</li></ul>Password: <input type="password" name="password" /> Choose wisely.</li>
|
|
|
|
help_text is not displayed for hidden fields. It can be used for documentation
|
|
purposes, though.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, help_text='e.g., user@example.com')
|
|
... password = CharField(widget=PasswordInput)
|
|
... next = CharField(widget=HiddenInput, initial='/', help_text='Redirect destination')
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>Username: <input type="text" name="username" maxlength="10" /> e.g., user@example.com</li>
|
|
<li>Password: <input type="password" name="password" /><input type="hidden" name="next" value="/" /></li>
|
|
|
|
Help text can include arbitrary Unicode characters.
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, help_text='ŠĐĆŽćžšđ')
|
|
>>> p = UserRegistration(auto_id=False)
|
|
>>> p.as_ul()
|
|
u'<li>Username: <input type="text" name="username" maxlength="10" /> \u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111</li>'
|
|
|
|
# Subclassing forms ###########################################################
|
|
|
|
You can subclass a Form to add fields. The resulting form subclass will have
|
|
all of the fields of the parent Form, plus whichever fields you define in the
|
|
subclass.
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... birthday = DateField()
|
|
>>> class Musician(Person):
|
|
... instrument = CharField()
|
|
>>> p = Person(auto_id=False)
|
|
>>> print p.as_ul()
|
|
<li>First name: <input type="text" name="first_name" /></li>
|
|
<li>Last name: <input type="text" name="last_name" /></li>
|
|
<li>Birthday: <input type="text" name="birthday" /></li>
|
|
>>> m = Musician(auto_id=False)
|
|
>>> print m.as_ul()
|
|
<li>First name: <input type="text" name="first_name" /></li>
|
|
<li>Last name: <input type="text" name="last_name" /></li>
|
|
<li>Birthday: <input type="text" name="birthday" /></li>
|
|
<li>Instrument: <input type="text" name="instrument" /></li>
|
|
|
|
Yes, you can subclass multiple forms. The fields are added in the order in
|
|
which the parent classes are listed.
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... birthday = DateField()
|
|
>>> class Instrument(Form):
|
|
... instrument = CharField()
|
|
>>> class Beatle(Person, Instrument):
|
|
... haircut_type = CharField()
|
|
>>> b = Beatle(auto_id=False)
|
|
>>> print b.as_ul()
|
|
<li>First name: <input type="text" name="first_name" /></li>
|
|
<li>Last name: <input type="text" name="last_name" /></li>
|
|
<li>Birthday: <input type="text" name="birthday" /></li>
|
|
<li>Instrument: <input type="text" name="instrument" /></li>
|
|
<li>Haircut type: <input type="text" name="haircut_type" /></li>
|
|
|
|
# Forms with prefixes #########################################################
|
|
|
|
Sometimes it's necessary to have multiple forms display on the same HTML page,
|
|
or multiple copies of the same form. We can accomplish this with form prefixes.
|
|
Pass the keyword argument 'prefix' to the Form constructor to use this feature.
|
|
This value will be prepended to each HTML form field name. One way to think
|
|
about this is "namespaces for HTML forms". Notice that in the data argument,
|
|
each field's key has the prefix, in this case 'person1', prepended to the
|
|
actual field name.
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... birthday = DateField()
|
|
>>> data = {
|
|
... 'person1-first_name': u'John',
|
|
... 'person1-last_name': u'Lennon',
|
|
... 'person1-birthday': u'1940-10-9'
|
|
... }
|
|
>>> p = Person(data, prefix='person1')
|
|
>>> print p.as_ul()
|
|
<li><label for="id_person1-first_name">First name:</label> <input type="text" name="person1-first_name" value="John" id="id_person1-first_name" /></li>
|
|
<li><label for="id_person1-last_name">Last name:</label> <input type="text" name="person1-last_name" value="Lennon" id="id_person1-last_name" /></li>
|
|
<li><label for="id_person1-birthday">Birthday:</label> <input type="text" name="person1-birthday" value="1940-10-9" id="id_person1-birthday" /></li>
|
|
>>> print p['first_name']
|
|
<input type="text" name="person1-first_name" value="John" id="id_person1-first_name" />
|
|
>>> print p['last_name']
|
|
<input type="text" name="person1-last_name" value="Lennon" id="id_person1-last_name" />
|
|
>>> print p['birthday']
|
|
<input type="text" name="person1-birthday" value="1940-10-9" id="id_person1-birthday" />
|
|
>>> p.errors
|
|
{}
|
|
>>> p.is_valid()
|
|
True
|
|
>>> p.cleaned_data
|
|
{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
|
|
|
|
Let's try submitting some bad data to make sure form.errors and field.errors
|
|
work as expected.
|
|
>>> data = {
|
|
... 'person1-first_name': u'',
|
|
... 'person1-last_name': u'',
|
|
... 'person1-birthday': u''
|
|
... }
|
|
>>> p = Person(data, prefix='person1')
|
|
>>> p.errors
|
|
{'first_name': [u'This field is required.'], 'last_name': [u'This field is required.'], 'birthday': [u'This field is required.']}
|
|
>>> p['first_name'].errors
|
|
[u'This field is required.']
|
|
>>> p['person1-first_name'].errors
|
|
Traceback (most recent call last):
|
|
...
|
|
KeyError: "Key 'person1-first_name' not found in Form"
|
|
|
|
In this example, the data doesn't have a prefix, but the form requires it, so
|
|
the form doesn't "see" the fields.
|
|
>>> data = {
|
|
... 'first_name': u'John',
|
|
... 'last_name': u'Lennon',
|
|
... 'birthday': u'1940-10-9'
|
|
... }
|
|
>>> p = Person(data, prefix='person1')
|
|
>>> p.errors
|
|
{'first_name': [u'This field is required.'], 'last_name': [u'This field is required.'], 'birthday': [u'This field is required.']}
|
|
|
|
With prefixes, a single data dictionary can hold data for multiple instances
|
|
of the same form.
|
|
>>> data = {
|
|
... 'person1-first_name': u'John',
|
|
... 'person1-last_name': u'Lennon',
|
|
... 'person1-birthday': u'1940-10-9',
|
|
... 'person2-first_name': u'Jim',
|
|
... 'person2-last_name': u'Morrison',
|
|
... 'person2-birthday': u'1943-12-8'
|
|
... }
|
|
>>> p1 = Person(data, prefix='person1')
|
|
>>> p1.is_valid()
|
|
True
|
|
>>> p1.cleaned_data
|
|
{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
|
|
>>> p2 = Person(data, prefix='person2')
|
|
>>> p2.is_valid()
|
|
True
|
|
>>> p2.cleaned_data
|
|
{'first_name': u'Jim', 'last_name': u'Morrison', 'birthday': datetime.date(1943, 12, 8)}
|
|
|
|
By default, forms append a hyphen between the prefix and the field name, but a
|
|
form can alter that behavior by implementing the add_prefix() method. This
|
|
method takes a field name and returns the prefixed field, according to
|
|
self.prefix.
|
|
>>> class Person(Form):
|
|
... first_name = CharField()
|
|
... last_name = CharField()
|
|
... birthday = DateField()
|
|
... def add_prefix(self, field_name):
|
|
... return self.prefix and '%s-prefix-%s' % (self.prefix, field_name) or field_name
|
|
>>> p = Person(prefix='foo')
|
|
>>> print p.as_ul()
|
|
<li><label for="id_foo-prefix-first_name">First name:</label> <input type="text" name="foo-prefix-first_name" id="id_foo-prefix-first_name" /></li>
|
|
<li><label for="id_foo-prefix-last_name">Last name:</label> <input type="text" name="foo-prefix-last_name" id="id_foo-prefix-last_name" /></li>
|
|
<li><label for="id_foo-prefix-birthday">Birthday:</label> <input type="text" name="foo-prefix-birthday" id="id_foo-prefix-birthday" /></li>
|
|
>>> data = {
|
|
... 'foo-prefix-first_name': u'John',
|
|
... 'foo-prefix-last_name': u'Lennon',
|
|
... 'foo-prefix-birthday': u'1940-10-9'
|
|
... }
|
|
>>> p = Person(data, prefix='foo')
|
|
>>> p.is_valid()
|
|
True
|
|
>>> p.cleaned_data
|
|
{'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
|
|
|
|
# Forms with NullBooleanFields ################################################
|
|
|
|
NullBooleanField is a bit of a special case because its presentation (widget)
|
|
is different than its data. This is handled transparently, though.
|
|
|
|
>>> class Person(Form):
|
|
... name = CharField()
|
|
... is_cool = NullBooleanField()
|
|
>>> p = Person({'name': u'Joe'}, auto_id=False)
|
|
>>> print p['is_cool']
|
|
<select name="is_cool">
|
|
<option value="1" selected="selected">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> p = Person({'name': u'Joe', 'is_cool': u'1'}, auto_id=False)
|
|
>>> print p['is_cool']
|
|
<select name="is_cool">
|
|
<option value="1" selected="selected">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> p = Person({'name': u'Joe', 'is_cool': u'2'}, auto_id=False)
|
|
>>> print p['is_cool']
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2" selected="selected">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> p = Person({'name': u'Joe', 'is_cool': u'3'}, auto_id=False)
|
|
>>> print p['is_cool']
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3" selected="selected">No</option>
|
|
</select>
|
|
>>> p = Person({'name': u'Joe', 'is_cool': True}, auto_id=False)
|
|
>>> print p['is_cool']
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2" selected="selected">Yes</option>
|
|
<option value="3">No</option>
|
|
</select>
|
|
>>> p = Person({'name': u'Joe', 'is_cool': False}, auto_id=False)
|
|
>>> print p['is_cool']
|
|
<select name="is_cool">
|
|
<option value="1">Unknown</option>
|
|
<option value="2">Yes</option>
|
|
<option value="3" selected="selected">No</option>
|
|
</select>
|
|
|
|
# Basic form processing in a view #############################################
|
|
|
|
>>> from django.template import Template, Context
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10)
|
|
... password1 = CharField(widget=PasswordInput)
|
|
... password2 = CharField(widget=PasswordInput)
|
|
... def clean(self):
|
|
... if self.cleaned_data.get('password1') and self.cleaned_data.get('password2') and self.cleaned_data['password1'] != self.cleaned_data['password2']:
|
|
... raise ValidationError(u'Please make sure your passwords match.')
|
|
... return self.cleaned_data
|
|
>>> def my_function(method, post_data):
|
|
... if method == 'POST':
|
|
... form = UserRegistration(post_data, auto_id=False)
|
|
... else:
|
|
... form = UserRegistration(auto_id=False)
|
|
... if form.is_valid():
|
|
... return 'VALID: %r' % form.cleaned_data
|
|
... t = Template('<form action="" method="post">\n<table>\n{{ form }}\n</table>\n<input type="submit" />\n</form>')
|
|
... return t.render(Context({'form': form}))
|
|
|
|
Case 1: GET (an empty form, with no errors).
|
|
>>> print my_function('GET', {})
|
|
<form action="" method="post">
|
|
<table>
|
|
<tr><th>Username:</th><td><input type="text" name="username" maxlength="10" /></td></tr>
|
|
<tr><th>Password1:</th><td><input type="password" name="password1" /></td></tr>
|
|
<tr><th>Password2:</th><td><input type="password" name="password2" /></td></tr>
|
|
</table>
|
|
<input type="submit" />
|
|
</form>
|
|
|
|
Case 2: POST with erroneous data (a redisplayed form, with errors).
|
|
>>> print my_function('POST', {'username': 'this-is-a-long-username', 'password1': 'foo', 'password2': 'bar'})
|
|
<form action="" method="post">
|
|
<table>
|
|
<tr><td colspan="2"><ul class="errorlist"><li>Please make sure your passwords match.</li></ul></td></tr>
|
|
<tr><th>Username:</th><td><ul class="errorlist"><li>Ensure this value has at most 10 characters (it has 23).</li></ul><input type="text" name="username" value="this-is-a-long-username" maxlength="10" /></td></tr>
|
|
<tr><th>Password1:</th><td><input type="password" name="password1" value="foo" /></td></tr>
|
|
<tr><th>Password2:</th><td><input type="password" name="password2" value="bar" /></td></tr>
|
|
</table>
|
|
<input type="submit" />
|
|
</form>
|
|
|
|
Case 3: POST with valid data (the success message).
|
|
>>> print my_function('POST', {'username': 'adrian', 'password1': 'secret', 'password2': 'secret'})
|
|
VALID: {'username': u'adrian', 'password1': u'secret', 'password2': u'secret'}
|
|
|
|
# Some ideas for using templates with forms ###################################
|
|
|
|
>>> class UserRegistration(Form):
|
|
... username = CharField(max_length=10, help_text="Good luck picking a username that doesn't already exist.")
|
|
... password1 = CharField(widget=PasswordInput)
|
|
... password2 = CharField(widget=PasswordInput)
|
|
... def clean(self):
|
|
... if self.cleaned_data.get('password1') and self.cleaned_data.get('password2') and self.cleaned_data['password1'] != self.cleaned_data['password2']:
|
|
... raise ValidationError(u'Please make sure your passwords match.')
|
|
... return self.cleaned_data
|
|
|
|
You have full flexibility in displaying form fields in a template. Just pass a
|
|
Form instance to the template, and use "dot" access to refer to individual
|
|
fields. Note, however, that this flexibility comes with the responsibility of
|
|
displaying all the errors, including any that might not be associated with a
|
|
particular field.
|
|
>>> t = Template('''<form action="">
|
|
... {{ form.username.errors.as_ul }}<p><label>Your username: {{ form.username }}</label></p>
|
|
... {{ form.password1.errors.as_ul }}<p><label>Password: {{ form.password1 }}</label></p>
|
|
... {{ form.password2.errors.as_ul }}<p><label>Password (again): {{ form.password2 }}</label></p>
|
|
... <input type="submit" />
|
|
... </form>''')
|
|
>>> print t.render(Context({'form': UserRegistration(auto_id=False)}))
|
|
<form action="">
|
|
<p><label>Your username: <input type="text" name="username" maxlength="10" /></label></p>
|
|
<p><label>Password: <input type="password" name="password1" /></label></p>
|
|
<p><label>Password (again): <input type="password" name="password2" /></label></p>
|
|
<input type="submit" />
|
|
</form>
|
|
>>> print t.render(Context({'form': UserRegistration({'username': 'django'}, auto_id=False)}))
|
|
<form action="">
|
|
<p><label>Your username: <input type="text" name="username" value="django" maxlength="10" /></label></p>
|
|
<ul class="errorlist"><li>This field is required.</li></ul><p><label>Password: <input type="password" name="password1" /></label></p>
|
|
<ul class="errorlist"><li>This field is required.</li></ul><p><label>Password (again): <input type="password" name="password2" /></label></p>
|
|
<input type="submit" />
|
|
</form>
|
|
|
|
Use form.[field].label to output a field's label. You can specify the label for
|
|
a field by using the 'label' argument to a Field class. If you don't specify
|
|
'label', Django will use the field name with underscores converted to spaces,
|
|
and the initial letter capitalized.
|
|
>>> t = Template('''<form action="">
|
|
... <p><label>{{ form.username.label }}: {{ form.username }}</label></p>
|
|
... <p><label>{{ form.password1.label }}: {{ form.password1 }}</label></p>
|
|
... <p><label>{{ form.password2.label }}: {{ form.password2 }}</label></p>
|
|
... <input type="submit" />
|
|
... </form>''')
|
|
>>> print t.render(Context({'form': UserRegistration(auto_id=False)}))
|
|
<form action="">
|
|
<p><label>Username: <input type="text" name="username" maxlength="10" /></label></p>
|
|
<p><label>Password1: <input type="password" name="password1" /></label></p>
|
|
<p><label>Password2: <input type="password" name="password2" /></label></p>
|
|
<input type="submit" />
|
|
</form>
|
|
|
|
User form.[field].label_tag to output a field's label with a <label> tag
|
|
wrapped around it, but *only* if the given field has an "id" attribute.
|
|
Recall from above that passing the "auto_id" argument to a Form gives each
|
|
field an "id" attribute.
|
|
>>> t = Template('''<form action="">
|
|
... <p>{{ form.username.label_tag }}: {{ form.username }}</p>
|
|
... <p>{{ form.password1.label_tag }}: {{ form.password1 }}</p>
|
|
... <p>{{ form.password2.label_tag }}: {{ form.password2 }}</p>
|
|
... <input type="submit" />
|
|
... </form>''')
|
|
>>> print t.render(Context({'form': UserRegistration(auto_id=False)}))
|
|
<form action="">
|
|
<p>Username: <input type="text" name="username" maxlength="10" /></p>
|
|
<p>Password1: <input type="password" name="password1" /></p>
|
|
<p>Password2: <input type="password" name="password2" /></p>
|
|
<input type="submit" />
|
|
</form>
|
|
>>> print t.render(Context({'form': UserRegistration(auto_id='id_%s')}))
|
|
<form action="">
|
|
<p><label for="id_username">Username</label>: <input id="id_username" type="text" name="username" maxlength="10" /></p>
|
|
<p><label for="id_password1">Password1</label>: <input type="password" name="password1" id="id_password1" /></p>
|
|
<p><label for="id_password2">Password2</label>: <input type="password" name="password2" id="id_password2" /></p>
|
|
<input type="submit" />
|
|
</form>
|
|
|
|
User form.[field].help_text to output a field's help text. If the given field
|
|
does not have help text, nothing will be output.
|
|
>>> t = Template('''<form action="">
|
|
... <p>{{ form.username.label_tag }}: {{ form.username }}<br />{{ form.username.help_text }}</p>
|
|
... <p>{{ form.password1.label_tag }}: {{ form.password1 }}</p>
|
|
... <p>{{ form.password2.label_tag }}: {{ form.password2 }}</p>
|
|
... <input type="submit" />
|
|
... </form>''')
|
|
>>> print t.render(Context({'form': UserRegistration(auto_id=False)}))
|
|
<form action="">
|
|
<p>Username: <input type="text" name="username" maxlength="10" /><br />Good luck picking a username that doesn't already exist.</p>
|
|
<p>Password1: <input type="password" name="password1" /></p>
|
|
<p>Password2: <input type="password" name="password2" /></p>
|
|
<input type="submit" />
|
|
</form>
|
|
>>> Template('{{ form.password1.help_text }}').render(Context({'form': UserRegistration(auto_id=False)}))
|
|
u''
|
|
|
|
The label_tag() method takes an optional attrs argument: a dictionary of HTML
|
|
attributes to add to the <label> tag.
|
|
>>> f = UserRegistration(auto_id='id_%s')
|
|
>>> for bf in f:
|
|
... print bf.label_tag(attrs={'class': 'pretty'})
|
|
<label for="id_username" class="pretty">Username</label>
|
|
<label for="id_password1" class="pretty">Password1</label>
|
|
<label for="id_password2" class="pretty">Password2</label>
|
|
|
|
To display the errors that aren't associated with a particular field -- e.g.,
|
|
the errors caused by Form.clean() -- use {{ form.non_field_errors }} in the
|
|
template. If used on its own, it is displayed as a <ul> (or an empty string, if
|
|
the list of errors is empty). You can also use it in {% if %} statements.
|
|
>>> t = Template('''<form action="">
|
|
... {{ form.username.errors.as_ul }}<p><label>Your username: {{ form.username }}</label></p>
|
|
... {{ form.password1.errors.as_ul }}<p><label>Password: {{ form.password1 }}</label></p>
|
|
... {{ form.password2.errors.as_ul }}<p><label>Password (again): {{ form.password2 }}</label></p>
|
|
... <input type="submit" />
|
|
... </form>''')
|
|
>>> print t.render(Context({'form': UserRegistration({'username': 'django', 'password1': 'foo', 'password2': 'bar'}, auto_id=False)}))
|
|
<form action="">
|
|
<p><label>Your username: <input type="text" name="username" value="django" maxlength="10" /></label></p>
|
|
<p><label>Password: <input type="password" name="password1" value="foo" /></label></p>
|
|
<p><label>Password (again): <input type="password" name="password2" value="bar" /></label></p>
|
|
<input type="submit" />
|
|
</form>
|
|
>>> t = Template('''<form action="">
|
|
... {{ form.non_field_errors }}
|
|
... {{ form.username.errors.as_ul }}<p><label>Your username: {{ form.username }}</label></p>
|
|
... {{ form.password1.errors.as_ul }}<p><label>Password: {{ form.password1 }}</label></p>
|
|
... {{ form.password2.errors.as_ul }}<p><label>Password (again): {{ form.password2 }}</label></p>
|
|
... <input type="submit" />
|
|
... </form>''')
|
|
>>> print t.render(Context({'form': UserRegistration({'username': 'django', 'password1': 'foo', 'password2': 'bar'}, auto_id=False)}))
|
|
<form action="">
|
|
<ul class="errorlist"><li>Please make sure your passwords match.</li></ul>
|
|
<p><label>Your username: <input type="text" name="username" value="django" maxlength="10" /></label></p>
|
|
<p><label>Password: <input type="password" name="password1" value="foo" /></label></p>
|
|
<p><label>Password (again): <input type="password" name="password2" value="bar" /></label></p>
|
|
<input type="submit" />
|
|
</form>
|
|
|
|
###############
|
|
# Extra stuff #
|
|
###############
|
|
|
|
The newforms library comes with some extra, higher-level Field and Widget
|
|
classes that demonstrate some of the library's abilities.
|
|
|
|
# SelectDateWidget ############################################################
|
|
|
|
>>> from django.newforms.extras import SelectDateWidget
|
|
>>> w = SelectDateWidget(years=('2007','2008','2009','2010','2011','2012','2013','2014','2015','2016'))
|
|
>>> print w.render('mydate', '')
|
|
<select name="mydate_month">
|
|
<option value="1">January</option>
|
|
<option value="2">February</option>
|
|
<option value="3">March</option>
|
|
<option value="4">April</option>
|
|
<option value="5">May</option>
|
|
<option value="6">June</option>
|
|
<option value="7">July</option>
|
|
<option value="8">August</option>
|
|
<option value="9">September</option>
|
|
<option value="10">October</option>
|
|
<option value="11">November</option>
|
|
<option value="12">December</option>
|
|
</select>
|
|
<select name="mydate_day">
|
|
<option value="1">1</option>
|
|
<option value="2">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
<option value="5">5</option>
|
|
<option value="6">6</option>
|
|
<option value="7">7</option>
|
|
<option value="8">8</option>
|
|
<option value="9">9</option>
|
|
<option value="10">10</option>
|
|
<option value="11">11</option>
|
|
<option value="12">12</option>
|
|
<option value="13">13</option>
|
|
<option value="14">14</option>
|
|
<option value="15">15</option>
|
|
<option value="16">16</option>
|
|
<option value="17">17</option>
|
|
<option value="18">18</option>
|
|
<option value="19">19</option>
|
|
<option value="20">20</option>
|
|
<option value="21">21</option>
|
|
<option value="22">22</option>
|
|
<option value="23">23</option>
|
|
<option value="24">24</option>
|
|
<option value="25">25</option>
|
|
<option value="26">26</option>
|
|
<option value="27">27</option>
|
|
<option value="28">28</option>
|
|
<option value="29">29</option>
|
|
<option value="30">30</option>
|
|
<option value="31">31</option>
|
|
</select>
|
|
<select name="mydate_year">
|
|
<option value="2007">2007</option>
|
|
<option value="2008">2008</option>
|
|
<option value="2009">2009</option>
|
|
<option value="2010">2010</option>
|
|
<option value="2011">2011</option>
|
|
<option value="2012">2012</option>
|
|
<option value="2013">2013</option>
|
|
<option value="2014">2014</option>
|
|
<option value="2015">2015</option>
|
|
<option value="2016">2016</option>
|
|
</select>
|
|
>>> w.render('mydate', None) == w.render('mydate', '')
|
|
True
|
|
>>> print w.render('mydate', '2010-04-15')
|
|
<select name="mydate_month">
|
|
<option value="1">January</option>
|
|
<option value="2">February</option>
|
|
<option value="3">March</option>
|
|
<option value="4" selected="selected">April</option>
|
|
<option value="5">May</option>
|
|
<option value="6">June</option>
|
|
<option value="7">July</option>
|
|
<option value="8">August</option>
|
|
<option value="9">September</option>
|
|
<option value="10">October</option>
|
|
<option value="11">November</option>
|
|
<option value="12">December</option>
|
|
</select>
|
|
<select name="mydate_day">
|
|
<option value="1">1</option>
|
|
<option value="2">2</option>
|
|
<option value="3">3</option>
|
|
<option value="4">4</option>
|
|
<option value="5">5</option>
|
|
<option value="6">6</option>
|
|
<option value="7">7</option>
|
|
<option value="8">8</option>
|
|
<option value="9">9</option>
|
|
<option value="10">10</option>
|
|
<option value="11">11</option>
|
|
<option value="12">12</option>
|
|
<option value="13">13</option>
|
|
<option value="14">14</option>
|
|
<option value="15" selected="selected">15</option>
|
|
<option value="16">16</option>
|
|
<option value="17">17</option>
|
|
<option value="18">18</option>
|
|
<option value="19">19</option>
|
|
<option value="20">20</option>
|
|
<option value="21">21</option>
|
|
<option value="22">22</option>
|
|
<option value="23">23</option>
|
|
<option value="24">24</option>
|
|
<option value="25">25</option>
|
|
<option value="26">26</option>
|
|
<option value="27">27</option>
|
|
<option value="28">28</option>
|
|
<option value="29">29</option>
|
|
<option value="30">30</option>
|
|
<option value="31">31</option>
|
|
</select>
|
|
<select name="mydate_year">
|
|
<option value="2007">2007</option>
|
|
<option value="2008">2008</option>
|
|
<option value="2009">2009</option>
|
|
<option value="2010" selected="selected">2010</option>
|
|
<option value="2011">2011</option>
|
|
<option value="2012">2012</option>
|
|
<option value="2013">2013</option>
|
|
<option value="2014">2014</option>
|
|
<option value="2015">2015</option>
|
|
<option value="2016">2016</option>
|
|
</select>
|
|
|
|
# MultiWidget and MultiValueField #############################################
|
|
# MultiWidgets are widgets composed of other widgets. They are usually
|
|
# combined with MultiValueFields - a field that is composed of other fields.
|
|
# MulitWidgets can themselved be composed of other MultiWidgets.
|
|
# SplitDateTimeWidget is one example of a MultiWidget.
|
|
|
|
>>> class ComplexMultiWidget(MultiWidget):
|
|
... def __init__(self, attrs=None):
|
|
... widgets = (
|
|
... TextInput(),
|
|
... SelectMultiple(choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo'))),
|
|
... SplitDateTimeWidget(),
|
|
... )
|
|
... super(ComplexMultiWidget, self).__init__(widgets, attrs)
|
|
...
|
|
... def decompress(self, value):
|
|
... if value:
|
|
... data = value.split(',')
|
|
... return [data[0], data[1], datetime.datetime(*time.strptime(data[2], "%Y-%m-%d %H:%M:%S")[0:6])]
|
|
... return [None, None, None]
|
|
... def format_output(self, rendered_widgets):
|
|
... return u'\n'.join(rendered_widgets)
|
|
>>> w = ComplexMultiWidget()
|
|
>>> print w.render('name', 'some text,JP,2007-04-25 06:24:00')
|
|
<input type="text" name="name_0" value="some text" />
|
|
<select multiple="multiple" name="name_1">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P" selected="selected">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
<input type="text" name="name_2_0" value="2007-04-25" /><input type="text" name="name_2_1" value="06:24:00" />
|
|
|
|
>>> class ComplexField(MultiValueField):
|
|
... def __init__(self, required=True, widget=None, label=None, initial=None):
|
|
... fields = (
|
|
... CharField(),
|
|
... MultipleChoiceField(choices=(('J', 'John'), ('P', 'Paul'), ('G', 'George'), ('R', 'Ringo'))),
|
|
... SplitDateTimeField()
|
|
... )
|
|
... super(ComplexField, self).__init__(fields, required, widget, label, initial)
|
|
...
|
|
... def compress(self, data_list):
|
|
... if data_list:
|
|
... return '%s,%s,%s' % (data_list[0],''.join(data_list[1]),data_list[2])
|
|
... return None
|
|
|
|
>>> f = ComplexField(widget=w)
|
|
>>> f.clean(['some text', ['J','P'], ['2007-04-25','6:24:00']])
|
|
u'some text,JP,2007-04-25 06:24:00'
|
|
>>> f.clean(['some text',['X'], ['2007-04-25','6:24:00']])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'Select a valid choice. X is not one of the available choices.']
|
|
|
|
# If insufficient data is provided, None is substituted
|
|
>>> f.clean(['some text',['JP']])
|
|
Traceback (most recent call last):
|
|
...
|
|
ValidationError: [u'This field is required.']
|
|
|
|
>>> class ComplexFieldForm(Form):
|
|
... field1 = ComplexField(widget=w)
|
|
>>> f = ComplexFieldForm()
|
|
>>> print f
|
|
<tr><th><label for="id_field1_0">Field1:</label></th><td><input type="text" name="field1_0" id="id_field1_0" />
|
|
<select multiple="multiple" name="field1_1" id="id_field1_1">
|
|
<option value="J">John</option>
|
|
<option value="P">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
<input type="text" name="field1_2_0" id="id_field1_2_0" /><input type="text" name="field1_2_1" id="id_field1_2_1" /></td></tr>
|
|
|
|
>>> f = ComplexFieldForm({'field1_0':'some text','field1_1':['J','P'], 'field1_2_0':'2007-04-25', 'field1_2_1':'06:24:00'})
|
|
>>> print f
|
|
<tr><th><label for="id_field1_0">Field1:</label></th><td><input type="text" name="field1_0" value="some text" id="id_field1_0" />
|
|
<select multiple="multiple" name="field1_1" id="id_field1_1">
|
|
<option value="J" selected="selected">John</option>
|
|
<option value="P" selected="selected">Paul</option>
|
|
<option value="G">George</option>
|
|
<option value="R">Ringo</option>
|
|
</select>
|
|
<input type="text" name="field1_2_0" value="2007-04-25" id="id_field1_2_0" /><input type="text" name="field1_2_1" value="06:24:00" id="id_field1_2_1" /></td></tr>
|
|
|
|
>>> f.cleaned_data
|
|
{'field1': u'some text,JP,2007-04-25 06:24:00'}
|
|
|
|
#################################
|
|
# Tests of underlying functions #
|
|
#################################
|
|
|
|
# smart_unicode tests
|
|
>>> from django.utils.encoding import smart_unicode
|
|
>>> class Test:
|
|
... def __str__(self):
|
|
... return 'ŠĐĆŽćžšđ'
|
|
>>> class TestU:
|
|
... def __str__(self):
|
|
... return 'Foo'
|
|
... def __unicode__(self):
|
|
... return u'\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111'
|
|
>>> smart_unicode(Test())
|
|
u'\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111'
|
|
>>> smart_unicode(TestU())
|
|
u'\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111'
|
|
>>> smart_unicode(1)
|
|
u'1'
|
|
>>> smart_unicode('foo')
|
|
u'foo'
|
|
|
|
# flatatt tests
|
|
>>> from django.newforms.util import flatatt
|
|
>>> flatatt({'id': "header"})
|
|
u' id="header"'
|
|
>>> flatatt({'class': "news", 'title': "Read this"})
|
|
u' class="news" title="Read this"'
|
|
>>> flatatt({})
|
|
u''
|
|
|
|
####################################
|
|
# Test accessing errors in clean() #
|
|
####################################
|
|
|
|
>>> class UserForm(Form):
|
|
... username = CharField(max_length=10)
|
|
... password = CharField(widget=PasswordInput)
|
|
... def clean(self):
|
|
... data = self.cleaned_data
|
|
... if not self.errors:
|
|
... data['username'] = data['username'].lower()
|
|
... return data
|
|
|
|
>>> f = UserForm({'username': 'SirRobin', 'password': 'blue'})
|
|
>>> f.is_valid()
|
|
True
|
|
>>> f.cleaned_data['username']
|
|
u'sirrobin'
|
|
"""
|
|
|
|
__test__ = {
|
|
'form_tests': form_tests,
|
|
'localflavor': localflavor_tests,
|
|
'regressions': regression_tests,
|
|
}
|
|
|
|
if __name__ == "__main__":
|
|
import doctest
|
|
doctest.testmod()
|