构建一个表单
假设你想在你的网站上创建一个简单的表单,以获得用户的名字。你需要类似这样的模板:
1
2
3
4
5
|
<form action = "/your-name/" method= "post" > <label for = "your_name" >Your name : </label> <input id= "your_name" type= "text" name = "your_name" > <input type= "submit" value= "OK" > </form> |
这是一个非常简单的表单。实际应用中,一个表单可能包含几十上百个字段,其中大部分需要预填充,而且我们预料到用户将来回编辑-提交几次才能完成操作。
我们可能需要在表单提交之前,在浏览器端作一些验证。我们可能想使用非常复杂的字段,以允许用户做类似从日历中挑选日期这样的事情,等等。
这个时候,让Django 来为我们完成大部分工作是很容易的。
so,两个突出优点:
1 form表单提交时,数据出现错误,返回的页面中仍可以保留之前输入的数据。
2 方便地限制字段条件
在Django 中构建一个表单
Form 类
我们已经计划好了我们的 html 表单应该呈现的样子。在Django 中,我们的起始点是这里:
1
2
3
4
5
6
|
#forms.py from django import forms class NameForm(forms.Form): your_name = forms.CharField(label= ‘Your name‘ , max_length=100) |
它定义一个Form
类,只带有一个字段(your_name
)。
字段允许的最大长度通过max_length
定义。它完成两件事情。首先,它在HTML 的<input>
上放置一个maxlength="100"
(这样浏览器将在第一时间阻止用户输入多于这个数目的字符)。它还意味着当Django 收到浏览器发送过来的表单时,它将验证数据的长度。
Form
的实例具有一个is_valid()
方法,它为所有的字段运行验证的程序。当调用这个方法时,如果所有的字段都包含合法的数据,它将:
- 返回
True
- 将表单的数据放到
cleaned_data
属性中。
完整的表单,第一次渲染时,看上去将像:
1
2
|
<label for = "your_name" >Your name : </label> <input id= "your_name" type= "text" name = "your_name" maxlength= "100" > |
注意它不包含 <form>
标签和提交按钮。我们必须自己在模板中提供它们。
视图
发送给Django 网站的表单数据通过一个视图处理,一般和发布这个表单的是同一个视图。这允许我们重用一些相同的逻辑。
当处理表单时,我们需要在视图中实例化它:
1 #views.py 2 3 from django.shortcuts import render 4 from django.http import HttpResponseRedirect 5 6 from .forms import NameForm 7 8 def get_name(request): 9 # if this is a POST request we need to process the form data 10 if request.method == ‘POST‘: 11 # create a form instance and populate it with data from the request: 12 form = NameForm(request.POST) 13 # check whether it‘s valid: 14 if form.is_valid(): 15 # process the data in form.cleaned_data as required 16 # ... 17 # redirect to a new URL: 18 return HttpResponseRedirect(‘/thanks/‘) 19 20 # if a GET (or any other method) we‘ll create a blank form 21 else: 22 form = NameForm() 23 24 return render(request, ‘name.html‘, {‘form‘: form})
如果访问视图的是一个GET
请求,它将创建一个空的表单实例并将它放置到要渲染的模板的上下文中。这是我们在第一个访问该URL 时预期发生的情况。
如果表单的提交使用POST
请求,那么视图将再次创建一个表单实例并使用请求中的数据填充它:form = NameForm(request.POST)
。这叫做”绑定数据至表单“(它现在是一个绑定的表单)。
我们调用表单的is_valid()
方法;如果它不为True
,我们将带着这个表单返回到模板。这时表单不再为空(未绑定),所以HTML 表单将用之前提交的数据填充,然后可以根据要求编辑并改正它。
如果is_valid()
为True
,我们将能够在cleaned_data
属性中找到所有合法的表单数据。在发送HTTP 重定向给浏览器告诉它下一步的去向之前,我们可以用这个数据来更新数据库或者做其它处理。
模板
我们不需要在name.html 模板中做很多工作。最简单的例子是:
1
2
3
4
5
|
<form action = "/your-name/" method= "post" > {% csrf_token %} {{ form }} <input type= "submit" value= "Submit" /> </form> |
根据{{ form }}
,所有的表单字段和它们的属性将通过Django 的模板语言拆分成HTML 标记 。
注:Django 原生支持一个简单易用的跨站请求伪造的防护。当提交一个启用CSRF 防护的POST
表单时,你必须使用上面例子中的csrf_token
模板标签。
现在我们有了一个可以工作的网页表单,它通过Django Form 描述、通过视图处理并渲染成一个HTML <form>
。
Django Form 类详解
绑定的和未绑定的表单实例
绑定的和未绑定的表单 之间的区别非常重要:
- 未绑定的表单没有关联的数据。当渲染给用户时,它将为空或包含默认的值。
- 绑定的表单具有提交的数据,因此可以用来检验数据是否合法。如果渲染一个不合法的绑定的表单,它将包含内联的错误信息,告诉用户如何纠正数据。
字段详解
考虑一个比上面的迷你示例更有用的一个表单,我们完成一个更加有用的注册表单:
1 #forms.py 2 3 from django import forms 4 5 class RegisterForm(forms.Form): 6 username = forms.CharField(max_length=100, 7 error_messages={"min_length":"最短为5个字符","required":"该字段不能为空"}, 8 ) 9 password = forms.CharField(max_length=100, 10 widget=widgets.PasswordInput(attrs={"placeholder":"password"}) 11 ) 12 13 telephone=forms.IntegerField( 14 error_messages={ 15 "invalid":"格式错误" 16 } 17 18 ) 19 20 21 gender=forms.CharField( 22 initial=2, 23 widget=widgets.Select(choices=((1,‘上海‘),(2,‘北京‘),)) 24 ) 25 26 email = forms.EmailField() 27 is_married = forms.BooleanField(required=False)
Widgets
每个表单字段都有一个对应的Widget
类,它对应一个HTML 表单Widget
,例如<input type="text">
。
在大部分情况下,字段都具有一个合理的默认Widget。例如,默认情况下,CharField
具有一个TextInput Widget
,它在HTML 中生成一个<input type="text">
。
字段的数据
不管表单提交的是什么数据,一旦通过调用is_valid()
成功验证(is_valid()
返回True
),验证后的表单数据将位于form.cleaned_data
字典中。这些数据已经为你转换好为Python 的类型。
注:此时,你依然可以从request.POST
中直接访问到未验证的数据,但是访问验证后的数据更好一些。
在上面的联系表单示例中,is_married将是一个布尔值。类似地,IntegerField
和FloatField
字段分别将值转换为Python 的int
和float
。
使用表单模板
你需要做的就是将表单实例放进模板的上下文。如果你的表单在Contex
t 中叫做form
,那么{{ form }}
将正确地渲染它的<label>
和 <input>
元素。
表单渲染的选项
对于<label>/<input>
对,还有几个输出选项:
{{ form.as_table }}
以表格的形式将它们渲染在<tr>
标签中{{ form.as_p }}
将它们渲染在<p>
标签中{{ form.as_ul }}
将它们渲染在<li>
标签中
注意,你必须自己提供<table>
或<ul>
元素。
{{ form.as_p }}
会渲染如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
< form action=""> < p > < label for="id_username">Username:</ label > < input id="id_username" maxlength="100" name="username" type="text" required=""> </ p > < p > < label for="id_password">Password:</ label > < input id="id_password" maxlength="100" name="password" placeholder="password" type="password" required=""> </ p > < p > < label for="id_telephone">Telephone:</ label > < input id="id_telephone" name="telephone" type="number" required=""> </ p > < p > < label for="id_email">Email:</ label > < input id="id_email" name="email" type="email" required=""> </ p > < p > < label for="id_is_married">Is married:</ label > < input id="id_is_married" name="is_married" type="checkbox"> </ p > < input type="submit" value="注册"> </ form > |
手工渲染字段
我们没有必要非要让Django 来分拆表单的字段;如果我们喜欢,我们可以手工来做(例如,这样允许重新对字段排序)。每个字段都是表单的一个属性,可以使用{{ form.name_of_field }}
访问,并将在Django 模板中正确地渲染。例如:
1
2
3
4
5
|
< div class="fieldWrapper"> {{ form.Username.errors }} {{ form.Username.label_tag }} {{ form.Username }} </ div > |
渲染表单的错误信息
1、
1
2
3
|
registerForm=RegisterForm(request.POST) print(type(registerForm.errors)) #< class ‘django.forms.utils.ErrorDict‘> print(type(registerForm.errors["username"])) #< class ‘django.forms.utils.ErrorList‘> |
2、
使用{{ form.name_of_field.errors }}
显示表单错误的一个清单,并渲染成一个ul
。看上去可能像:
1
2
3
|
< ul class="errorlist"> < li >Sender is required.</ li > </ ul > |
form组件的钩子
1 def foo(request): 2 3 4 if request.method=="POST": 5 6 regForm=RegForm(request.POST) 7 8 if regForm.is_valid(): 9 pass 10 # 可用数据: regForm.cleaned_data, 11 # 将数据插入数据库表中 12 13 14 else: 15 pass 16 # 可用数据: regForm.errors 17 # 可以利用模板渲染讲errors嵌套到页面中返回 18 # 也可以打包到一个字典中,用于ajax返回 19 20 else: 21 regForm=RegForm() 22 return render(request,"register.html",{"regForm":regForm}) 23 24 25 26 ‘‘‘ 27 实例化时: 28 29 self.fields={ 30 "username":"字段规则对象", 31 "password":"字段规则对象", 32 33 } 34 35 36 is_valid时: 37 38 self._errors = {} 39 self.cleaned_data = {} 40 41 42 #局部钩子: 43 44 for name, field in self.fields.items(): 45 try: 46 47 value = field.clean(value) 48 self.cleaned_data[name] = value 49 if hasattr(self, ‘clean_%s‘ % name): 50 value = getattr(self, ‘clean_%s‘ % name)() 51 self.cleaned_data[name] = value 52 except ValidationError as e: 53 self.add_error(name, e) 54 55 # 全局钩子: 56 57 self.clean() # def self.clean():return self.cleaned_data 58 59 return not self.errors # True或者False 60 61 62 ‘‘‘
form组件补充
1、Django内置字段如下:
1 Field 2 required=True, 是否允许为空 3 widget=None, HTML插件 4 label=None, 用于生成Label标签或显示内容 5 initial=None, 初始值 6 help_text=‘‘, 帮助信息(在标签旁边显示) 7 error_messages=None, 错误信息 {‘required‘: ‘不能为空‘, ‘invalid‘: ‘格式错误‘} 8 show_hidden_initial=False, 是否在当前插件后面再加一个隐藏的且具有默认值的插件(可用于检验两次输入是否一直) 9 validators=[], 自定义验证规则 10 localize=False, 是否支持本地化 11 disabled=False, 是否可以编辑 12 label_suffix=None Label内容后缀 13 14 15 CharField(Field) 16 max_length=None, 最大长度 17 min_length=None, 最小长度 18 strip=True 是否移除用户输入空白 19 20 IntegerField(Field) 21 max_value=None, 最大值 22 min_value=None, 最小值 23 24 FloatField(IntegerField) 25 ... 26 27 DecimalField(IntegerField) 28 max_value=None, 最大值 29 min_value=None, 最小值 30 max_digits=None, 总长度 31 decimal_places=None, 小数位长度 32 33 BaseTemporalField(Field) 34 input_formats=None 时间格式化 35 36 DateField(BaseTemporalField) 格式:2015-09-01 37 TimeField(BaseTemporalField) 格式:11:12 38 DateTimeField(BaseTemporalField)格式:2015-09-01 11:12 39 40 DurationField(Field) 时间间隔:%d %H:%M:%S.%f 41 ... 42 43 RegexField(CharField) 44 regex, 自定制正则表达式 45 max_length=None, 最大长度 46 min_length=None, 最小长度 47 error_message=None, 忽略,错误信息使用 error_messages={‘invalid‘: ‘...‘} 48 49 EmailField(CharField) 50 ... 51 52 FileField(Field) 53 allow_empty_file=False 是否允许空文件 54 55 ImageField(FileField) 56 ... 57 注:需要PIL模块,pip3 install Pillow 58 以上两个字典使用时,需要注意两点: 59 - form表单中 enctype="multipart/form-data" 60 - view函数中 obj = MyForm(request.POST, request.FILES) 61 62 URLField(Field) 63 ... 64 65 66 BooleanField(Field) 67 ... 68 69 NullBooleanField(BooleanField) 70 ... 71 72 ChoiceField(Field) 73 ... 74 choices=(), 选项,如:choices = ((0,‘上海‘),(1,‘北京‘),) 75 required=True, 是否必填 76 widget=None, 插件,默认select插件 77 label=None, Label内容 78 initial=None, 初始值 79 help_text=‘‘, 帮助提示 80 81 82 ModelChoiceField(ChoiceField) 83 ... django.forms.models.ModelChoiceField 84 queryset, # 查询数据库中的数据 85 empty_label="---------", # 默认空显示内容 86 to_field_name=None, # HTML中value的值对应的字段 87 limit_choices_to=None # ModelForm中对queryset二次筛选 88 89 ModelMultipleChoiceField(ModelChoiceField) 90 ... django.forms.models.ModelMultipleChoiceField 91 92 93 94 TypedChoiceField(ChoiceField) 95 coerce = lambda val: val 对选中的值进行一次转换 96 empty_value= ‘‘ 空值的默认值 97 98 MultipleChoiceField(ChoiceField) 99 ... 100 101 TypedMultipleChoiceField(MultipleChoiceField) 102 coerce = lambda val: val 对选中的每一个值进行一次转换 103 empty_value= ‘‘ 空值的默认值 104 105 ComboField(Field) 106 fields=() 使用多个验证,如下:即验证最大长度20,又验证邮箱格式 107 fields.ComboField(fields=[fields.CharField(max_length=20), fields.EmailField(),]) 108 109 MultiValueField(Field) 110 PS: 抽象类,子类中可以实现聚合多个字典去匹配一个值,要配合MultiWidget使用 111 112 SplitDateTimeField(MultiValueField) 113 input_date_formats=None, 格式列表:[‘%Y--%m--%d‘, ‘%m%d/%Y‘, ‘%m/%d/%y‘] 114 input_time_formats=None 格式列表:[‘%H:%M:%S‘, ‘%H:%M:%S.%f‘, ‘%H:%M‘] 115 116 FilePathField(ChoiceField) 文件选项,目录下文件显示在页面中 117 path, 文件夹路径 118 match=None, 正则匹配 119 recursive=False, 递归下面的文件夹 120 allow_files=True, 允许文件 121 allow_folders=False, 允许文件夹 122 required=True, 123 widget=None, 124 label=None, 125 initial=None, 126 help_text=‘‘ 127 128 GenericIPAddressField 129 protocol=‘both‘, both,ipv4,ipv6支持的IP格式 130 unpack_ipv4=False 解析ipv4地址,如果是::ffff:192.0.2.1时候,可解析为192.0.2.1, PS:protocol必须为both才能启用 131 132 SlugField(CharField) 数字,字母,下划线,减号(连字符) 133 ... 134 135 UUIDField(CharField) uuid类型 136 ...
2、Django内置插件:
1 TextInput(Input) 2 NumberInput(TextInput) 3 EmailInput(TextInput) 4 URLInput(TextInput) 5 PasswordInput(TextInput) 6 HiddenInput(TextInput) 7 Textarea(Widget) 8 DateInput(DateTimeBaseInput) 9 DateTimeInput(DateTimeBaseInput) 10 TimeInput(DateTimeBaseInput) 11 CheckboxInput 12 Select 13 NullBooleanSelect 14 SelectMultiple 15 Radioselect 16 CheckboxSelectMultiple 17 FileInput 18 ClearableFileInput 19 MultipleHiddenInput 20 SplitDateTimeWidget 21 SplitHiddenDateTimeWidget 22 SelectDateWidget
3、常用选择插件:
1 # 单radio,值为字符串 2 # user = fields.CharField( 3 # initial=2, 4 # widget=widgets.RadioSelect(choices=((1,‘上海‘),(2,‘北京‘),)) 5 # ) 6 7 # 单radio,值为字符串 8 # user = fields.ChoiceField( 9 # choices=((1, ‘上海‘), (2, ‘北京‘),), 10 # initial=2, 11 # widget=widgets.RadioSelect 12 # ) 13 14 # 单select,值为字符串 15 # user = fields.CharField( 16 # initial=2, 17 # widget=widgets.Select(choices=((1,‘上海‘),(2,‘北京‘),)) 18 # ) 19 20 # 单select,值为字符串 21 # user = fields.ChoiceField( 22 # choices=((1, ‘上海‘), (2, ‘北京‘),), 23 # initial=2, 24 # widget=widgets.Select 25 # ) 26 27 # 多选select,值为列表 28 # user = fields.MultipleChoiceField( 29 # choices=((1,‘上海‘),(2,‘北京‘),), 30 # initial=[1,], 31 # widget=widgets.SelectMultiple 32 # ) 33 34 35 # 单checkbox 36 # user = fields.CharField( 37 # widget=widgets.CheckboxInput() 38 # ) 39 40 41 # 多选checkbox,值为列表 42 # user = fields.MultipleChoiceField( 43 # initial=[2, ], 44 # choices=((1, ‘上海‘), (2, ‘北京‘),), 45 # widget=widgets.CheckboxSelectMultiple 46 # )