django[六] 表单form
概述
通常情况下，我们需要自己手动在HTML页面中，编写form标签和其内的其它元素。但这费时费力，而且有可能写得不太恰当，数据验证也比较麻烦。有鉴于此，Django在内部集成了一个表单模块，专门帮助我们快速处理表单相关的内容。Django的表单模块给我们提供了下面三个主要功能：
- 准备和重构数据用于页面渲染
- 为数据创建HTML表单元素
- 接收和处理用户从表单发送过来的数据
编写Django的form表单，非常类似我们在模型系统里编写一个模型。在模型中，一个字段代表数据表的一列，而form表单中的一个字段代表<form>中的一个<input>元素。
使用表单
使用的模型
class ImageFile(models.Model):
image = models.ImageField(upload_to='static/images/%Y/%m/%d')
class UserType(models.Model):
caption = models.CharField(max_length=32)
class UserInfo(models.Model):
username = models.CharField(max_length=32)
pwd = models.CharField(max_length=100)
email = models.EmailField()
user_type = models.ForeignKey(to="UserType", to_field='id', on_delete=models.DO_NOTHING)
编写一个form.py文件
from django import forms
class UserInfoForm(forms.Form):
# 字段本身自己只做验证
username = fields.CharField(error_messages={'required':"必须要输入用户名哦"}, \
widget=widgets.Textarea(attrs={'class':'c1'}), # 自定制属性
label="用户名")
pwd = fields.CharField(max_length=12,min_length=6,
label_suffix=" | ",
widget=widgets.PasswordInput,
error_messages={'required':'用户名密码不能为空', 'max_length':"密码长度不能超过12", 'min_length':"密码不能小于6"})
email = fields.EmailField(
initial="123@huored.com",
error_messages={'required':"邮箱不能为空",'invalid':"邮箱信息不合法"})
view处理函数
def index(request):
if request.method == 'POST':
obj = UserInfoForm(request.POST)
if obj.is_valid():
models.UserInfo.objects.create(**obj.cleaned_data)
else:
# print(obj.errors.as_json()) # 转化成json类型
# print(obj.errors['username'][0]) # 第一个错误信息
print(obj.errors)
return render(request, 'fm.html', {"obj":obj})
else:
# u1 = models.UserInfo.objects.get(id=24)
obj = UserInfoForm()
return render(request, 'fm.html', {"obj":obj})
一般我们编写一个简单的HTML页面
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<form action="/fm/" method="POST" enctype="multipart/form-data">
{% csrf_token %}
{# <input type="text" name="username"> #}
{# <input type="text" name="pwd">#}
{# <input type="text" name="email">#}
{# <input type="text" name="username"> {{ obj.errors.username.0 }}#}
{# 建议用这种,可以自己控制错误信息#}
{# <p>{{ obj.username }}</p>#}
{# <p>{{ obj.pwd }}</p>#}
{# <p>{{ obj.email }} {{ obj.errors.email.0 }}</p>#}
{# <p>{{ obj.user_type }}</p>#}
{# <p>{{ obj.as_ul }}</p>#}
{# <p>{{ obj.as_table }}</p>#}
<p>{{ obj.as_p }}</p>
<input type="submit" name="提交">
</form>
</body>
</html>
表单API
# 表单的绑定属性
>>> f = ContactForm()
>>> f.is_bound
False
>>> f = ContactForm({'subject': 'hello'})
>>> f.is_bound
True
# 使用表单验证数据
1. Form.clean()
如果你要自定义验证功能，那么你需要重新实现这个clean方法。
2. Form.is_valid()
调用is_valid()方法来执行绑定表单的数据验证工作，并返回一个表示数据是否合法的布尔值
3.Form.errors
表单的errors属性保存了错误信息字典
4. Form.errors.as_data()
返回一个字典，它将字段映射到原始的ValidationError实例
5. Form.errors.as_json(escape_html=False)
返回JSON序列化后的错误信息字典。
6. Form.add_error(field, error)
向表单特定字段添加错误信息。
field参数为字段的名称。如果值为None，error将作为Form.non_field_errors()的一个非字段错误。
7. Form.has_error(field, code=None)
判断某个字段是否具有指定code的错误。当code为None时，如果字段有任何错误它都将返回True。
8. Form.non_field_errors()
返回Form.errors中不是与特定字段相关联的错误。
检查表单数据是否被修改
1. Form.has_changed() 当你需要检查表单的数据是否从初始数据发生改变时，可以使用has_changed()方法。 2. Form.changed_data 返回有变化的字段的列表。
访问表单中的字段
# 通过fileds属性访问表单的字段
>>> for row in f.fields.values(): print(row)
...
<django.forms.fields.CharField object at 0x7ffaac632510>
<django.forms.fields.URLField object at 0x7ffaac632f90>
# 可以修改Form实例的字段来改变字段在表单中的表示
>>> f.as_table().split('\n')[0]
'<tr><th>Name:</th><td><input name="name" type="text" value="instance" required /></td></tr>'
>>> f.fields['name'].label = "Username"
>>> f.as_table().split('\n')[0]
'<tr><th>Username:</th><td><input name="name" type="text" value="instance" required /></td></tr>'
# 注意不要改变base_fields属性，因为一旦修改将影响同一个Python进程中接下来所有的ContactForm实例
访问cleaned_data
一旦你创建一个Form实例并通过验证后，你就可以通过它的cleaned_data属性访问干净的数据
>>> f = ContactForm(data)
>>> f.is_valid()
True
>>> f.cleaned_data
{'cc_myself': True, 'message': 'Hi there', 'sender': 'foo@example.com', 'subject': 'hello'}
表单的HTML生成方式
渲染成文字段落as_p() 该方法将form渲染成一系列<p>标签，每个<p>标签包含一个字段 渲染成无序列表as_ul() 该方法将form渲染成一系列<li>标签，每个<li>标签包含一个字段。但不会自动生成</ul>和<ul>，所以你可以自己指定<ul>的任何HTML属性 渲染成表格as_table() 渲染成HTML表格
为错误信息添加CSS样式 Form.error_css_class Form.required_css_class
将上传的文件绑定到表单
处理带有FileField和ImageField字段的表单比普通的表单要稍微复杂一点。
首先，为了上传文件，你需要确保你的<form>元素定义enctype为"multipart/form-data"
<form enctype="multipart/form-data" method="post" action="/foo/">
其次，当你使用表单时，你需要绑定文件数据。
具体使用方法请看 django view
Form类
Django内置字段
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类型
...
创建多对多数据
form.save_m2m # 利用form保存基本信息表，然后保存m2m的键值 form.save(commit=False) # 首先保存基本信息，且不提交 form.save_m2m() # 最后保存
