窗口小部件¶ T0>

一个小部件是Django表示的HTML输入元素。 Widget 负责渲染HTML和提取GET/POST 字典中的数据。

由内置小部件生成的HTML使用HTML5语法,以<!DOCTYPE html>为目标。 例如,它使用布尔属性,如checked,而不是checked='checked'的XHTML样式。

小贴士

不要将Widget 与form fields搞混淆。 表单字段负责验证输入并直接在模板中使用。 Widget 负责渲染网页上HTML 表单的输入元素和提取提交的原始数据。 但是,Widget 需要assigned给表单字段。

指定小部件

每当你指定表单的一个字段的时候,Django 将使用适合其数据类型的默认Widget。 若要查找每个字段使用的Widget,参见Built-in Field classes文档。

然而,如果你想要使用一个不同的Widget,你可以在定义字段时使用widget 参数。 像这样:

from django import forms

class CommentForm(forms.Form):
    name = forms.CharField()
    url = forms.URLField()
    comment = forms.CharField(widget=forms.Textarea)

这将使用一个Textarea Widget来设置表单的评论 ,而不是默认的TextInput Widget。

设置小部件的参数

许多小部件具有可选的额外参数;在字段上定义窗口小部件时可以设置它们。 在下面的示例中,设置了SelectDateWidgetyears 属性:

from django import forms

BIRTH_YEAR_CHOICES = ('1980', '1981', '1982')
FAVORITE_COLORS_CHOICES = (
    ('blue', 'Blue'),
    ('green', 'Green'),
    ('black', 'Black'),
)

class SimpleForm(forms.Form):
    birth_year = forms.DateField(widget=forms.SelectDateWidget(years=BIRTH_YEAR_CHOICES))
    favorite_colors = forms.MultipleChoiceField(
        required=False,
        widget=forms.CheckboxSelectMultiple,
        choices=FAVORITE_COLORS_CHOICES,
    )

可用的Widget 以及它们接收的参数,参见Built-in widgets

小部件继承自Select小部件

继承自Select 的Widget 负责处理HTML 选项。 它们呈现给用户一个可以选择的选项列表。 不同的小部件呈现出不同的选择; Select小部件本身使用<select> HTML列表表示,而RadioSelect使用单选按钮。

ChoiceField 字段默认使用Select Widget 上显示的选项来自ChoiceField,对ChoiceField.choices 的改变将更新Select.choices 像这样:

>>> from django import forms
>>> CHOICES = (('1', 'First',), ('2', 'Second',))
>>> choice_field = forms.ChoiceField(widget=forms.RadioSelect, choices=CHOICES)
>>> choice_field.choices
[('1', 'First'), ('2', 'Second')]
>>> choice_field.widget.choices
[('1', 'First'), ('2', 'Second')]
>>> choice_field.widget.choices = ()
>>> choice_field.choices = (('1', 'First and only',),)
>>> choice_field.widget.choices
[('1', 'First and only')]

提供choices 属性的Widget 也可以用于不是基于选项的字段 , 例如CharField —— 当选项与模型有关而不只是Widget 时,建议使用基于ChoiceField 的字段。

定制小部件实例

当Django 渲染Widget 成HTML 时,它只渲染最少的标记 —— Django 不会添加class 的名称和特定于Widget 的其它属性。 这表示,网页上所有TextInput 的外观是一样的。

有两种自定义Widget 的方式:基于每个per widget instance和基于每个per widget class

样式化小部件实例

如果你想让某个Widget 实例与其它Widget 看上去不一样,你需要在Widget 对象实例化并赋值给一个表单字段时指定额外的属性(以及可能需要在你的CSS 文件中添加一些规则)。

例如下面这个简单的表单:

from django import forms

class CommentForm(forms.Form):
    name = forms.CharField()
    url = forms.URLField()
    comment = forms.CharField()

这个表单包含三个默认的TextInput Widget,以默认的方式渲染 —— 没有CSS 类、没有额外的属性。 这表示每个Widget 的输入框将渲染得一模一样:

>>> f = CommentForm(auto_id=False)
>>> f.as_table()
<tr><th>Name:</th><td><input type="text" name="name" required /></td></tr>
<tr><th>Url:</th><td><input type="url" name="url" required /></td></tr>
<tr><th>Comment:</th><td><input type="text" name="comment" required /></td></tr>

在真正得网页中,你可能不想让每个Widget 看上去都一样。 你可能想要给comment 一个更大的输入元素,你可能想让‘name’ Widget 具有一些特殊的CSS 类。 可以指定‘type’ 属性使用的是新式的HTML5 输入类型。 在创建Widget 时使用Widget.attrs 参数可以实现:

class CommentForm(forms.Form):
    name = forms.CharField(widget=forms.TextInput(attrs={'class': 'special'}))
    url = forms.URLField()
    comment = forms.CharField(widget=forms.TextInput(attrs={'size': '40'}))

Django 将在渲染的输出中包含额外的属性:

>>> f = CommentForm(auto_id=False)
>>> f.as_table()
<tr><th>Name:</th><td><input type="text" name="name" class="special" required /></td></tr>
<tr><th>Url:</th><td><input type="url" name="url" required /></td></tr>
<tr><th>Comment:</th><td><input type="text" name="comment" size="40" required /></td></tr>

你还可以使用attrs 设置HTML id 参见BoundField.id_for_label 示例。

样式小部件类

可以添加(cssjavascript)给Widget,以及深度定制它们的外观和行为。

概况来讲,你需要子类化Widget 并define a “Media” inner classcreate a “media” property

这些方法涉及到Python 高级编程,详细细节在Form Assets 主题中讲述。

基本小部件类

WidgetMultiWidget 是所有built-in widgets 的基类,并可用于自定义Widget 的基类。

Widget

Widget(attrs=None)[source]

这是个抽象类,它不可以渲染,但是提供基本的属性attrs 你可以在自定义的Widget 中实现或覆盖render() 方法。

ATTRS T0> ¶ T1>

包含渲染后的Widget 将要设置的HTML 属性。

>>> from django import forms
>>> name = forms.TextInput(attrs={'size': 10, 'title': 'Your name',})
>>> name.render('name', 'A name')
'<input title="Your name" type="text" name="name" value="A name" size="10" required />'

如果你给一个属性赋值TrueFalse,它将渲染成一个HTML5 风格的布尔属性:

>>> name = forms.TextInput(attrs={'required': True})
>>> name.render('name', 'A name')
'<input name="name" type="text" value="A name" required />'
>>>
>>> name = forms.TextInput(attrs={'required': False})
>>> name.render('name', 'A name')
'<input name="name" type="text" value="A name" />'
supports_microseconds T0> ¶ T1>

属性默认为True 如果设置为False,则datetimetime值的微秒部分将被设置为0

format_value(value)[source]

清除并返回一个用于小部件模板的值。 value不能保证是有效的输入,因此子类的实现应该防御性地编程。

在Django更改1.10:

在旧版本中,此方法是名为_format_value()的私有API。 旧的名称将工作,直到Django 2.0。

get_contextnamevalueattrs[source] ¶ T6>
Django中的新功能1.11。

返回在渲染窗口小部件模板时要使用的值的字典。 默认情况下,该字典包含一个单一的键'widget',它是包含以下键的小部件的字典表示形式:

  • 'name'name参数中的字段的名称。
  • 'is_hidden':一个布尔值,表示该小部件是否被隐藏。
  • 'required':一个布尔值,表示是否需要此窗口小部件的字段。
  • 'value':由format_value()返回的值。
  • 'attrs':要在已渲染的小部件上设置HTML属性。 attrs属性和attrs参数的组合。
  • 'template_name'self.template_name的值。

Widget子类可以通过覆盖此方法来提供自定义上下文值。

id_for_label(id_)[source]

给定该字段的ID,返回此小部件的HTML ID属性,以供<label>使用。 如果ID不可用,则返回None

这个钩子是必要的,因为一些小部件具有多个HTML元素,因此具有多个ID。 在这种情况下,该方法应该返回与widget的标签中的第一个ID相对应的ID值。

render(name, value, attrs=None, renderer=None)[source]

使用给定的渲染器将小部件渲染为HTML。 如果rendererNone,则使用FORM_RENDERER设置中的渲染器。

在Django更改1.11:

添加了renderer参数。 支持不接受的子类将在Django 2.1中被删除。

value_from_datadictdatafilesname[source] T6>

根据一个字典和该Widget 的名称,返回该Widget 的值。 files可能包含来自request.FILES的数据。 如果没有提供value,则返回None 在处理表单数据的过程中,value_from_datadict 可能调用多次,所以如果你自定义并添加额外的耗时处理时,你应该自己实现一些缓存机制。

value_omitted_from_data数据文件名称[source] ¶ T6>
Django中的新功能1.10.2。

给定datafiles字典和此小部件的名称,返回是否有数据或文件的小部件。

该方法的结果会影响模型窗体falls back to its default

特殊情况是CheckboxInputCheckboxSelectMultipleSelectMultiple,它始终返回False,因为未选中的复选框并未选择 &lt; select multiple&gt;不会出现在HTML表单提交的数据中,因此用户是否提交了值是未知的。

use_required_attribute(initial)[source]
Django中的新功能1.10.1。

给定一个表单域的initial值,返回是否可以使用required 表单使用此方法与Field.requiredForm.use_required_attribute一起确定是否显示每个字段的required属性。

默认情况下,为隐藏的小部件返回False,否则返回True 特殊情况是ClearableFileInput,当initial未设置时返回FalseCheckboxSelectMultiple,它始终返回False,因为浏览器验证将需要检查所有复选框,而不是至少一个。

在与浏览器验证不兼容的自定义小部件中覆盖此方法。 例如,由隐藏的textarea元素支持的WSYSIWG文本编辑器小部件可能希望始终返回False,以避免在隐藏字段上进行浏览器验证。

MultiWidget

MultiWidget小部件attrs = None[source]

由多个Widget 组合而成的Widget。 MultiWidget 始终与MultiValueField 联合使用。

MultiWidget 具有一个必选参数:

小窗口 T0> ¶ T1>

一个包含需要的Widget 的可迭代对象。

以及一个必需的方法:

decompress(value)[source]

这个方法接受来自字段的一个“压缩”的值,并返回“解压”的值的一个列表。 可以假设输入的值是合法的,但不一定是非空的。

子类必须实现 这个方法,而且因为值可能为空,实现必须要防卫这点。

“解压”的基本原理是需要“分离”组合的表单字段的值为每个Widget 的值。

有个例子是,SplitDateTimeWidgetdatetime 值分离成两个独立的值分别表示日期和时间:

from django.forms import MultiWidget

class SplitDateTimeWidget(MultiWidget):

    # ...

    def decompress(self, value):
        if value:
            return [value.date(), value.time().replace(microsecond=0)]
        return [None, None]

小贴士

注意,MultiValueField 有一个compress() 方法用于相反的工作 —— 将所有字段的值组合成一个值。

它提供一些自定义上下文:

get_contextnamevalueattrs[source] ¶ T6>

除了Widget.get_context()中描述的'widget'之外,MultiValueWidget添加了一个widget['subwidgets']

这些可以在窗口小部件模板中循环:

{% for subwidget in widget.subwidgets %}
    {% include widget.template_name with widget=subwidget %}
{% endfor %}

下面示例中的Widget 继承MultiWidget 以在不同的选择框中显示年、月、日。 这个Widget 主要想用于DateField 而不是MultiValueField,所以我们实现了value_from_datadict()

from datetime import date
from django.forms import widgets

class DateSelectorWidget(widgets.MultiWidget):
    def __init__(self, attrs=None):
        # create choices for days, months, years
        # example below, the rest snipped for brevity.
        years = [(year, year) for year in (2011, 2012, 2013)]
        _widgets = (
            widgets.Select(attrs=attrs, choices=days),
            widgets.Select(attrs=attrs, choices=months),
            widgets.Select(attrs=attrs, choices=years),
        )
        super(DateSelectorWidget, self).__init__(_widgets, attrs)

    def decompress(self, value):
        if value:
            return [value.day, value.month, value.year]
        return [None, None, None]

    def value_from_datadict(self, data, files, name):
        datelist = [
            widget.value_from_datadict(data, files, name + '_%s' % i)
            for i, widget in enumerate(self.widgets)]
        try:
            D = date(
                day=int(datelist[0]),
                month=int(datelist[1]),
                year=int(datelist[2]),
            )
        except ValueError:
            return ''
        else:
            return str(D)

构造器在一个元组中创建了多个Select widget。 super类使用这个元组来启动widget。

必需的decompress()方法将datetime.date 值拆成年、月和日的值,对应每个widget。 注意这个方法如何处理valueNone的情况。

value_from_datadict()的默认实现会返回一个列表,对应每一个Widget 当和MultiValueField一起使用MultiWidget的时候,这样会非常合理,但是由于我们想要和拥有单一值得DateField一起使用这个widget,我们必须覆写这一方法,将所有子widget的数据组装成datetime.date 这个方法从POST 字典中获取数据,并且构造和验证日期。 如果日期有效,会返回它的字符串,否则会返回一个空字符串,它会使form.is_valid返回False

内置小部件

Django 提供所有基本的HTML Widget,并在django.forms.widgets 模块中提供一些常见的Widget 组,包括the input of textvarious checkboxes and selectorsuploading fileshandling of multi-valued input

处理文本输入的小部件

这些Widget 使用HTML 元素inputtextarea

TextInput

TextInput[source]
  • input_type'text'
  • template_name'django/forms/widgets/text.html'
  • 呈现为:&lt; input type =“text” ...&gt;

NumberInput

NumberInput[source]
  • input_type'number'
  • template_name'django/forms/widgets/number.html'
  • 呈现为:&lt; input type =“number” ...&gt;

注意,不是所有浏览器的number输入类型都支持输入本地化的数字。 Django本身避免将它们用于将localize属性设置为True的字段。

EmailInput

EmailInput[source]
  • input_type'email'
  • template_name'django/forms/widgets/email.html'
  • 呈现为:&lt; input type =“email” ...&gt;

URLInput

URLInput[source]
  • input_type'url'
  • template_name'django/forms/widgets/url.html'
  • 呈现为:&lt; input type =“url” ...&gt;

PasswordInput

PasswordInput[source]
  • input_type'password'
  • template_name'django/forms/widgets/password.html'
  • 呈现为:&lt; input type =“password” ...&gt;

接收一个可选的参数:

render_value T0> ¶ T1>

决定在验证错误后重新显示表单时,Widget 是否填充(默认为False)。

HiddenInput

HiddenInput[source]
  • input_type'hidden'
  • template_name'django/forms/widgets/hidden.html'
  • 呈现为:&lt; input type =“hidden” ...&gt;

注意,还有一个MultipleHiddenInput Widget,它封装一组隐藏的输入元素。

DateInput

DateInput[source]
  • input_type'text'
  • template_name'django/forms/widgets/date.html'
  • 呈现为:&lt; input type =“text” ...&gt;

接收的参数与TextInput 相同,但是带有一些可选的参数:

格式 T0> ¶ T1>

字段的初始值应该显示的格式。

如果没有提供format 参数,默认的格式为参考Format localizationDATE_INPUT_FORMATS 中找到的第一个格式。

DateTimeInput

DateTimeInput[source]
  • input_type'text'
  • template_name'django/forms/widgets/datetime.html'
  • 呈现为:&lt; input type =“text” ...&gt;

接收的参数与TextInput 相同,但是带有一些可选的参数:

格式 T0> ¶ T1>

字段的初始值应该显示的格式。

如果没有提供format 参数,默认的格式为参考Format localizationDATETIME_INPUT_FORMATS 中找到的第一个格式。

默认情况下,时间值的微秒部分始终设置为0 如果需要微秒,请使用supports_microseconds属性设置为True的子类。

TimeInput

TimeInput[source]
  • input_type'text'
  • template_name'django/forms/widgets/time.html'
  • 呈现为:&lt; input type =“text” ...&gt;

接收的参数与TextInput 相同,但是带有一些可选的参数:

格式 T0> ¶ T1>

字段的初始值应该显示的格式。

如果没有提供format 参数,默认的格式为参考Format localizationTIME_INPUT_FORMATS 中找到的第一个格式。

有关微秒的处理,请参阅DateTimeInput

Textarea

Textarea[source]
  • template_name'django/forms/widgets/textarea.html'
  • 呈现为:<textarea>...</textarea>

选择器和复选框小部件

这些小部件使用HTML元素<select>&lt; input type =“checkbox”&gt; t2 >和&lt; input type =“radio”&gt;

呈现多个选项的窗口小部件具有指定用于呈现每个选项的模板的option_template_name属性。 For example, for the Select widget, select_option.html renders the <option> for a <select>.

CheckboxInput

CheckboxInput[source]
  • input_type'checkbox'
  • template_name'django/forms/widgets/checkbox.html'
  • 呈现为:&lt; input type =“checkbox” ...&gt;

接收一个可选的参数:

check_test T0> ¶ T1>

一个可调用的对象,接收CheckboxInput 的值并如果复选框应该勾上返回True

Select

Select[source]
  • template_name'django/forms/widgets/select.html'
  • option_template_name'django/forms/widgets/select_option.html'
  • 呈现为:&lt; select&gt;&lt; option ...&gt; ...&lt; / select&gt;
选择 T0> ¶ T1>

当表单字段没有choices 属性时,该属性是随意的。 如果字段有choice 属性,当Field的该属性更新时,它将覆盖你在这里的任何设置。

NullBooleanSelect

NullBooleanSelect[source]
  • template_name'django/forms/widgets/select.html'
  • option_template_name'django/forms/widgets/select_option.html'

Select Widget,选项为‘Unknown’、‘Yes’ 和‘No’。

SelectMultiple

SelectMultiple[source]
  • template_name'django/forms/widgets/select.html'
  • option_template_name'django/forms/widgets/select_option.html'

Select类似,但允许多个选择:&lt; select multiple =“multiple”&gt; ...&lt; / select&gt; t5 > T3>

RadioSelect

RadioSelect[source]
  • template_name'django/forms/widgets/radio.html'
  • option_template_name'django/forms/widgets/radio_option.html'

类似Select,但是渲染成<li> 标签中的一个单选按钮列表:

<ul>
  <li><input type="radio" name="..."></li>
  ...
</ul>

你可以迭代模板中的单选按钮来更细致地控制生成的HTML。 假设表单RadioSelect 具有一个字段beatles,它使用myform 作为Widget:

{% for radio in myform.beatles %}
<div class="myradio">
    {{ radio }}
</div>
{% endfor %}

它将生成以下HTML:

<div class="myradio">
    <label for="id_beatles_0"><input id="id_beatles_0" name="beatles" type="radio" value="john" required /> John</label>
</div>
<div class="myradio">
    <label for="id_beatles_1"><input id="id_beatles_1" name="beatles" type="radio" value="paul" required /> Paul</label>
</div>
<div class="myradio">
    <label for="id_beatles_2"><input id="id_beatles_2" name="beatles" type="radio" value="george" required /> George</label>
</div>
<div class="myradio">
    <label for="id_beatles_3"><input id="id_beatles_3" name="beatles" type="radio" value="ringo" required /> Ringo</label>
</div>

这包括<label> 标签。 你可以使用单选按钮的id_for_labelchoice_labeltag 属性进行更细的控制。 例如,这个模板...

{% for radio in myform.beatles %}
    <label for="{{ radio.id_for_label }}">
        {{ radio.choice_label }}
        <span class="radio">{{ radio.tag }}</span>
    </label>
{% endfor %}

...将导致以下HTML:

<label for="id_beatles_0">
    John
    <span class="radio"><input id="id_beatles_0" name="beatles" type="radio" value="john" required /></span>
</label>

<label for="id_beatles_1">
    Paul
    <span class="radio"><input id="id_beatles_1" name="beatles" type="radio" value="paul" required /></span>
</label>

<label for="id_beatles_2">
    George
    <span class="radio"><input id="id_beatles_2" name="beatles" type="radio" value="george" required /></span>
</label>

<label for="id_beatles_3">
    Ringo
    <span class="radio"><input id="id_beatles_3" name="beatles" type="radio" value="ringo" required /></span>
</label>

如果你不迭代单选按钮 —— 例如,你的模板只是简单地包含{{ myform.beatles }} —— 它们将以<ul> 中的<li> 标签输出,就像上面一样。

外部<ul>容器接收小部件的id属性,如果已定义,否则将接收BoundField.auto_id

当迭代单选按钮时,forinput 标签分别包含labelid 属性。 每个单项按钮具有一个id_for_label 属性来输出元素的ID。

CheckboxSelectMultiple

class CheckboxSelectMultiple[source]
  • template_name'django/forms/widgets/checkbox_select.html'
  • option_template_name'django/forms/widgets/checkbox_option.html'

类似SelectMultiple,但是渲染成一个复选框列表:

<ul>
  <li><input type="checkbox" name="..." ></li>
  ...
</ul>

外部<ul>容器接收小部件的id属性,如果已定义,否则将接收BoundField.auto_id

RadioSelect一样,您可以循环查看小部件选择的各个复选框。 RadioSelect不同,复选框将不包含required HTML属性,如果该字段是必需的,因为浏览器验证将需要检查所有复选框,而不是至少检查一个。

当迭代单选按钮时,forinput 标签分别包含labelid 属性。 每个单项按钮具有一个id_for_label 属性来输出元素的ID。

文件上传小部件

FileInput

FileInput[source]
  • template_name'django/forms/widgets/file.html'
  • 呈现为:&lt; input type =“file” ...&gt;

ClearableFileInput

ClearableFileInput[source]
  • template_name'django/forms/widgets/clearable_file_input.html'
  • 呈现为:&lt; input type =“file” ...&gt;清除字段的值,如果该字段不是必需的,并具有初始数据。

复合小部件

MultipleHiddenInput

MultipleHiddenInput[source]
  • template_name'django/forms/widgets/multiple_hidden.html'
  • 呈现为:multiple &lt; input type =“hidden” ...&gt;标签

一个处理多个隐藏的Widget 的Widget,用于值为一个列表的字段。

选择 T0> ¶ T1>

当表单字段没有choices 属性时,该属性是随意的。 如果字段有choice 属性,当Field的该属性更新时,它将覆盖你在这里的任何设置。

SplitDateTimeWidget

SplitDateTimeWidget[source]
  • template_name'django/forms/widgets/splitdatetime.html'

封装(使用MultiWidget)两个Widget:DateInput 用于日期,TimeInput 用于时间。 必须与SplitDateTimeField而不是DateTimeField一起使用。

SplitDateTimeWidget 有两个可选的属性:

DATE_FORMAT T0> ¶ T1>

类似DateInput.format

TIME_FORMAT T0> ¶ T1>

类似TimeInput.format

SplitHiddenDateTimeWidget

SplitHiddenDateTimeWidget[source]
  • template_name'django/forms/widgets/splithiddendatetime.html'

类似SplitDateTimeWidget,但是日期和时间都使用HiddenInput

SelectDateWidget

SelectDateWidget[source]
  • template_name'django/forms/widgets/select_date.html'

封装三个Select Widget:分别用于年、月、日。

有几个可选参数:

年 T0> ¶ T1>

一个可选的列表/元组,用于”年“选择框。 默认为包含当前年份和未来9年的一个列表。

个月 T0> ¶ T1>

一个可选的字典,用于”月“选择框。

字典的键对应于月份的数字(从1开始),值为显示出来的月份:

MONTHS = {
    1:_('jan'), 2:_('feb'), 3:_('mar'), 4:_('apr'),
    5:_('may'), 6:_('jun'), 7:_('jul'), 8:_('aug'),
    9:_('sep'), 10:_('oct'), 11:_('nov'), 12:_('dec')
}
empty_label T0> ¶ T1>

如果DateField 不是必选的,SelectDateWidget 将有一个空的选项位于选项的顶部(默认为---)。 你可以通过empty_label 属性修改这个文本。 list 可以是一个stringempty_labeltuple 当使用字符串时,所有的选择框都带有这个空选项。 如果tuple 为具有3个字符串元素的listempty_label,每个选择框将具有它们自定义的空选项。 空选项应该按这个顺序('year_label', 'month_label', 'day_label')

# A custom empty label with string
field1 = forms.DateField(widget=SelectDateWidget(empty_label="Nothing"))

# A custom empty label with tuple
field1 = forms.DateField(
    widget=SelectDateWidget(
        empty_label=("Choose Year", "Choose Month", "Choose Day"),
    ),
)