Python学习（三十九）—— Django之Form组件
一、构建一个表单
假设你想在你的网站上创建一个简单的表单，以获得用户的名字。你需要类似这样的模板：
<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 来为我们完成大部分工作是很容易的。
form组件的两个突出优点：
1 form表单提交时，数据出现错误，返回的页面中仍可以保留之前输入的数据。
2 校验规则，返回错误信息
二、在Django 中构建一个表单
Form 类
先定义一个form类，必须继承forms.Form
from . import models from django import forms from django.forms import widgets from django.core.exceptions import NON_FIELD_ERRORS, ValidationError import re class RegisterForm(forms.Form): user = forms.CharField(min_length=4, max_length=12, # 设置校验规则 error_messages={ # 更改错误信息 'required': '必填', 'min_length': '用户名长度不能少于4位', 'max_length': '用户名长度不能超过12位', }, widget=widgets.TextInput(attrs={'class': 'form-control'}) #设置类型，更改属性 ) pwd = forms.CharField(min_length=6, max_length=15, error_messages={ 'required': '必填', 'min_length': '用户名长度不能少于6位', 'max_length': '用户名长度不能超过15位', }, widget=widgets.PasswordInput(attrs={'class': 'form-control'}) ) repeat_pwd = forms.CharField(min_length=6, max_length=15, error_messages={ 'required': '必填', 'min_length': '用户名长度不能少于6位', 'max_length': '用户名长度不能超过15位', }, widget=widgets.PasswordInput(attrs={'class': 'form-control'}) ) email = forms.EmailField( error_messages={'required': '必填', 'invalid': '邮箱格式错误'}, widget=widgets.EmailInput(attrs={'class': 'form-control'}) ) phone = forms.CharField( error_messages={'required': '必填', 'invalid': '手机号格式错误'}, widget=widgets.TextInput(attrs={'class': 'form-control'}) ) def clean_user(self): #自定义局部钩子 val = self.cleaned_data.get('user') user = models.Userinfo.objects.filter(user=val) if user: raise ValidationError('用户名已经注册') else: return val def clean_phone(self): val = self.cleaned_data.get('phone') ret = re.search('^1[345678][0-9]{9}',val) if ret: return val else: raise ValidationError('手机号码格式错误') def clean(self): #自定义全局钩子 pwd = self.cleaned_data.get('pwd') repeat_pwd = self.cleaned_data.get('repeat_pwd') if pwd == repeat_pwd: return self.cleaned_data else: raise ValidationError('两次密码不一致')
视图views
如果访问视图的是一个GET 请求，它将创建一个空的表单实例并将它放置到要渲染的模板的上下文中。这是我们在第一个访问该URL 时预期发生的情况。
如果表单的提交使用POST 请求，那么视图将再次创建一个表单实例并使用请求中的数据填充它：form = NameForm(request.POST)。这叫做”绑定数据至表单“（它现在是一个绑定的表单）。
我们调用表单的is_valid()方法；如果它不为True，我们将带着这个表单返回到模板。这时表单不再为空（未绑定），所以HTML 表单将用之前提交的数据填充，然后可以根据要求编辑并改正它。
如果is_valid()为True，我们将能够在cleaned_data 属性中找到所有合法的表单数据。在发送HTTP 重定向给浏览器告诉它下一步的去向之前，我们可以用这个数据来更新数据库或者做其它处理。
from django.shortcuts import HttpResponse, render, redirect from . import models from .registerforms import * def register(request): if request.method == 'POST': form_obj = RegisterForm(request.POST) # 实例化一个带数据的form类对象 if form_obj.is_valid(): # 如果所有校验通过，返回True,否则走else代码 form_obj.cleaned_data.pop('repeat_pwd') models.Userinfo.objects.create(**form_obj.cleaned_data) return HttpResponse('success') else: form_obj.errors['all'] = form_obj.errors.get('__all__') return render(request, 'register.html', {'form_obj': form_obj}) form_obj = RegisterForm() # 实例化一个form类的对象 return render(request, 'register.html', {'form_obj': form_obj})
模板templates
三种渲染方式
方式一： <form action="" novalidate method="post"> {% csrf_token %} {{ form_obj.as_p }} <input type="submit"> </form> 方式二： <form action="" novalidate method="post"> {% csrf_token %} <div> <label for="">用户名</label> {{ form_obj.user }} <span>{{ form_obj.errors.user.0 }}</span> </div> <div> <label for="">密码</label> {{ form_obj.pwd }}<span>{{ form_obj.errors.pwd.0 }}</span> </div> <input type="submit"> </form> 方式三： <form action="" novalidate method="post"> {% csrf_token %} {% for field in form_obj %} <div> <label for="">{{ field.label }}</label> {{ field }} <span>{{ field.errors.0 }}</span> </div> {% endfor %} <input type="submit"> </form>
三、Django Form 类详解
绑定的和未绑定的表单实例
绑定的和未绑定的表单 之间的区别非常重要：
- 未绑定的表单没有关联的数据。当渲染给用户时，它将为空或包含默认的值。
- 绑定的表单具有提交的数据，因此可以用来检验数据是否合法。如果渲染一个不合法的绑定的表单，它将包含内联的错误信息，告诉用户如何纠正数据。
字段详解
Field
required=True, 是否允许为空
widget=None, HTML插件
label=None, 用于生成Label标签或显示内容
initial=None, 初始值
help_text='', 帮助信息(在标签旁边显示)
error_messages=None, 错误信息 {'required': '不能为空', 'invalid': '格式错误'}
show_hidden_initial=False, 是否在当前插件后面再加一个隐藏的且具有默认值的插件（可用于检验两次输入是否一直）
validators=[], 自定义验证规则
localize=False, 是否支持本地化
disabled=False, 是否可以编辑
label_suffix=None Label内容后缀
CharField(Field)
max_length=None, 最大长度
min_length=None, 最小长度
strip=True 是否移除用户输入空白
IntegerField(Field)
max_value=None, 最大值
min_value=None, 最小值
FloatField(IntegerField)
...
DecimalField(IntegerField)
max_value=None, 最大值
min_value=None, 最小值
max_digits=None, 总长度
decimal_places=None, 小数位长度
BaseTemporalField(Field)
input_formats=None 时间格式化
DateField(BaseTemporalField) 格式：2015-09-01
TimeField(BaseTemporalField) 格式：11:12
DateTimeField(BaseTemporalField)格式：2015-09-01 11:12
DurationField(Field) 时间间隔：%d %H:%M:%S.%f
...
RegexField(CharField)
regex, 自定制正则表达式
max_length=None, 最大长度
min_length=None, 最小长度
error_message=None, 忽略，错误信息使用 error_messages={'invalid': '...'}
EmailField(CharField)
...
FileField(Field)
allow_empty_file=False 是否允许空文件
ImageField(FileField)
...
注：需要PIL模块，pip3 install Pillow
以上两个字典使用时，需要注意两点：
- form表单中 enctype="multipart/form-data"
- view函数中 obj = MyForm(request.POST, request.FILES)
URLField(Field)
...
BooleanField(Field)
...
NullBooleanField(BooleanField)
...
ChoiceField(Field)
...
choices=(), 选项，如：choices = ((0,'上海'),(1,'北京'),)
required=True, 是否必填
widget=None, 插件，默认select插件
label=None, Label内容
initial=None, 初始值
help_text='', 帮助提示
ModelChoiceField(ChoiceField)
... django.forms.models.ModelChoiceField
queryset, # 查询数据库中的数据
empty_label="---------", # 默认空显示内容
to_field_name=None, # HTML中value的值对应的字段
limit_choices_to=None # ModelForm中对queryset二次筛选
ModelMultipleChoiceField(ModelChoiceField)
... django.forms.models.ModelMultipleChoiceField
TypedChoiceField(ChoiceField)
coerce = lambda val: val 对选中的值进行一次转换
empty_value= '' 空值的默认值
MultipleChoiceField(ChoiceField)
...
TypedMultipleChoiceField(MultipleChoiceField)
coerce = lambda val: val 对选中的每一个值进行一次转换
empty_value= '' 空值的默认值
ComboField(Field)
fields=() 使用多个验证，如下：即验证最大长度20，又验证邮箱格式
fields.ComboField(fields=[fields.CharField(max_length=20), fields.EmailField(),])
MultiValueField(Field)
PS: 抽象类，子类中可以实现聚合多个字典去匹配一个值，要配合MultiWidget使用
SplitDateTimeField(MultiValueField)
input_date_formats=None, 格式列表：['%Y--%m--%d', '%m%d/%Y', '%m/%d/%y']
input_time_formats=None 格式列表：['%H:%M:%S', '%H:%M:%S.%f', '%H:%M']
FilePathField(ChoiceField) 文件选项，目录下文件显示在页面中
path, 文件夹路径
match=None, 正则匹配
recursive=False, 递归下面的文件夹
allow_files=True, 允许文件
allow_folders=False, 允许文件夹
required=True,
widget=None,
label=None,
initial=None,
help_text=''
GenericIPAddressField
protocol='both', both,ipv4,ipv6支持的IP格式
unpack_ipv4=False 解析ipv4地址，如果是::ffff:192.0.2.1时候，可解析为192.0.2.1， PS：protocol必须为both才能启用
SlugField(CharField) 数字，字母，下划线，减号（连字符）
...
UUIDField(CharField) uuid类型
...
Widgets
每个表单字段都有一个对应的Widget 类，它对应一个HTML 表单Widget，例如<input type="text">。
在大部分情况下，字段都具有一个合理的默认Widget。例如，默认情况下，CharField 具有一个TextInput Widget，它在HTML 中生成一个<input type="text">。
TextInput(Input)
NumberInput(TextInput)
EmailInput(TextInput)
URLInput(TextInput)
PasswordInput(TextInput)
HiddenInput(TextInput)
Textarea(Widget)
DateInput(DateTimeBaseInput)
DateTimeInput(DateTimeBaseInput)
TimeInput(DateTimeBaseInput)
CheckboxInput
Select
NullBooleanSelect
SelectMultiple
RadioSelect
CheckboxSelectMultiple
FileInput
ClearableFileInput
MultipleHiddenInput
SplitDateTimeWidget
SplitHiddenDateTimeWidget
SelectDateWidget
常用选择插件
# 单radio，值为字符串
# user = fields.CharField(
# initial=2,
# widget=widgets.RadioSelect(choices=((1,'上海'),(2,'北京'),))
# )
# 单radio，值为字符串
# user = fields.ChoiceField(
# choices=((1, '上海'), (2, '北京'),),
# initial=2,
# widget=widgets.RadioSelect
# )
# 单select，值为字符串
# user = fields.CharField(
# initial=2,
# widget=widgets.Select(choices=((1,'上海'),(2,'北京'),))
# )
# 单select，值为字符串
# user = fields.ChoiceField(
# choices=((1, '上海'), (2, '北京'),),
# initial=2,
# widget=widgets.Select
# )
# 多选select，值为列表
# user = fields.MultipleChoiceField(
# choices=((1,'上海'),(2,'北京'),),
# initial=[1,],
# widget=widgets.SelectMultiple
# )
# 单checkbox
# user = fields.CharField(
# widget=widgets.CheckboxInput()
# )
# 多选checkbox,值为列表
# user = fields.MultipleChoiceField(
# initial=[2, ],
# choices=((1, '上海'), (2, '北京'),),
# widget=widgets.CheckboxSelectMultiple
# )
四、使用表单模板
你需要做的就是将表单实例放进模板的上下文。如果你的表单在Context 中叫做form，那么{{ form }}将正确地渲染它的<label> 和 <input>元素。
表单渲染的选项
对于<label>/<input> 对，还有几个输出选项：
{{ form.as_table }}以表格的形式将它们渲染在<tr>标签中{{ form.as_p }}将它们渲染在<p>标签中{{ form.as_ul }}将它们渲染在<li>标签中
注意，你必须自己提供<table> 或<ul> 元素。
手工渲染字段
我们没有必要非要让Django 来分拆表单的字段；如果我们喜欢，我们可以手工来做（例如，这样允许重新对字段排序）。每个字段都是表单的一个属性，可以使用{{ form.name_of_field }} 访问，并将在Django 模板中正确地渲染。例如：
<div class="fieldWrapper"> {{ form.Username.errors }} {{ form.Username.label_tag }} {{ form.Username }} </div>
渲染表单的错误信息
registerForm=RegisterForm(request.POST) print(type(registerForm.errors)) #<class 'django.forms.utils.ErrorDict'> print(type(registerForm.errors["username"])) #<class 'django.forms.utils.ErrorList'>
使用{{ form.name_of_field.errors }} 显示表单错误的一个清单，并渲染成一个ul。看上去可能像：
<ul class="errorlist"> <li>Sender is required.</li> </ul>
对于全局钩子设置的错误信息，保存在form_obj.errors.__all__里面，如果想要在模板里面使用这个错误信息，无法直接取到，有两种方法：
方法一：
在views函数里面设置：form_obj.errors['all'] = form_obj.errors.get('__all__')，这样在模板里面直接使用{{ form_obj.errors.all.0 }}就能取到
方法二：
在模板里面直接使用{{ form_obj.non_field_errors.0 }}就能取到
form组件的钩子
def foo(request): if request.method=="POST": regForm=RegForm(request.POST) if regForm.is_valid(): pass # 可用数据: regForm.cleaned_data, # 将数据插入数据库表中 else: pass # 可用数据: regForm.errors # 可以利用模板渲染讲errors嵌套到页面中返回 # 也可以打包到一个字典中,用于ajax返回 else: regForm=RegForm() return render(request,"register.html",{"regForm":regForm}) ''' 实例化时: self.fields={ "username":"字段规则对象", "password":"字段规则对象", } is_valid时: self._errors = {} self.cleaned_data = {} #局部钩子: for name, field in self.fields.items(): try: value = field.clean(value) self.cleaned_data[name] = value if hasattr(self, 'clean_%s' % name): value = getattr(self, 'clean_%s' % name)() self.cleaned_data[name] = value except ValidationError as e: self.add_error(name, e) # 全局钩子: self.clean() # def self.clean():return self.cleaned_data return not self.errors # True或者False '''
