# -*- coding: utf-8 -*-

r"""

>>> from django.newforms import *

>>> import datetime

>>> import re

###########

# 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 &quot;quoted&quot; &amp; 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 &quot;quoted&quot; &amp; 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 &quot;quoted&quot; &amp; 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 &quot;quoted&quot; &amp; 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 &quot;quoted&quot; &amp; 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 name="msg"></textarea>'

>>> w.render('msg', None)

u'<textarea name="msg"></textarea>'

>>> w.render('msg', 'value')

u'<textarea name="msg">value</textarea>'

>>> w.render('msg', 'some "quoted" & ampersanded value')

u'<textarea name="msg">some &quot;quoted&quot; &amp; ampersanded value</textarea>'

>>> w.render('msg', 'value', attrs={'class': 'pretty'})

u'<textarea name="msg" class="pretty">value</textarea>'

You can also pass 'attrs' to the constructor:

>>> w = Textarea(attrs={'class': 'pretty'})

>>> w.render('msg', '')

u'<textarea class="pretty" name="msg"></textarea>'

>>> w.render('msg', 'example')

u'<textarea class="pretty" name="msg">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 class="special" name="msg"></textarea>'

>>> w.render('msg', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})

u'<textarea class="fun" name="msg">\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 &amp; 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 ##########################################################