Django之Form
1. Form的简单使用
Form具有的功能：
- 生成HTML标签
- 验证用户数据（显示错误信息）
- HTML Form提交保留上次提交数据
- 初始化页面显示内容
1.1 创建Form类
from django.forms import Form from django.forms import widgets from django.forms import fields class MyForm(Form): user = fields.CharField( widget=widgets.TextInput(attrs={'id': 'i1', 'class': 'c1'}) ) gender = fields.ChoiceField( choices=((1, '男'), (2, '女'),), initial=2, widget=widgets.RadioSelect ) city = fields.CharField( initial=2, widget=widgets.Select(choices=((1,'上海'),(2,'北京'),)) ) pwd = fields.CharField( widget=widgets.PasswordInput(attrs={'class': 'c1'}, render_value=True) )
1.2 函数处理
from django.shortcuts import render, redirect from .forms import MyForm def index(request): if request.method == "GET": obj = MyForm() return render(request, 'index.html', {'form': obj}) elif request.method == "POST": obj = MyForm(request.POST, request.FILES) if obj.is_valid(): values = obj.clean() print(values) else: errors = obj.errors print(errors) return render(request, 'index.html', {'form': obj}) else: return redirect('http://www.google.com')
1.3 生成HTML
<form action="/" method="POST" enctype="multipart/form-data"> <p>{{ form.user }} {{ form.user.errors }}</p> <p>{{ form.gender }} {{ form.gender.errors }}</p> <p>{{ form.city }} {{ form.city.errors }}</p> <p>{{ form.pwd }} {{ form.pwd.errors }}</p> <input type="submit"/> </form>
1.4 其他标签
<form method="POST" enctype="multipart/form-data"> {% csrf_token %} {{ form.xxoo.label }} {{ form.xxoo.id_for_label }} {{ form.xxoo.label_tag }} {{ form.xxoo.errors }} <p>{{ form.user }} {{ form.user.errors }}</p> <input type="submit" /> </form>
2. Form类详解
创建Form类时，主要涉及到“字段”和“插件”
- 字段用于对用户请求数据的验证
- 插件用于自动生成HTML
2.1 内置字段
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 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) BooleanField(Field) ... NullBooleanField(BooleanField) ... ChoiceField(Field) ... choices=(), 选项，如：choices = ((0,'上海'),(1,'北京'),) required=True, 是否必填 widget=None, 插件，默认select插件 label=None, Label内容 initial=None, 初始值 help_text='', 帮助提示 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类型 ...
2.2 内置插件
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
3. 常用的选择插件
3.1 radio选择插件
# 单radio，值为字符串 user = fields.CharField( initial=2, widget=widgets.RadioSelect(choices=((1,'上海'),(2,'北京'),)) ) # 单radio，值为字符串 user = fields.ChoiceField( choices=((1, '上海'), (2, '北京'),), initial=2, widget=widgets.RadioSelect )
3.2 select选择插件
# 单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 )
3.3 checkbox插件
# 单checkbox user = fields.CharField( widget=widgets.CheckboxInput() ) # 多选checkbox,值为列表 user = fields.MultipleChoiceField( initial=[2, ], choices=((1, '上海'), (2, '北京'),), widget=widgets.CheckboxSelectMultiple )
3.4 自定义构造方法
使用选择标签时，choices的选项可以从数据库获取，
但是由于是静态字段，获取的值无法实时更新，所以就需要自定义构造方法达到此目的。
from django.forms import Form from django.forms import widgets from django.forms import fieldsclass MyForm(Form): user = fields.ChoiceField( # choices=((1, '上海'), (2, '北京'),), initial=2, widget=widgets.Select ) def __init__(self, *args, **kwargs): super(MyForm,self).__init__(*args, **kwargs) # self.fields['user'].widget.choices = ((1, '上海'), (2, '北京'),) self.fields['user'].widget.choices = models.Classes.objects.all().value_list('id','caption')
4. 自定义验证规则
4.1 使用RegexValidator验证
from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.validators import RegexValidator class MyForm(Form): user = fields.CharField( # 要同时满足下面的两个规则 validators=[RegexValidator(r'^[0-9]+$', '请输入数字'), RegexValidator(r'^159[0-9]+$', '数字必须以159开头') ], )
4.2 自定义re正则表达式验证
import re from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.exceptions import ValidationError # 自定义验证规则 def mobile_validate(value): mobile_re = re.compile(r'^(13[0-9]|15[012356789]|17[678]|18[0-9]|14[57])[0-9]{8}$') if not mobile_re.match(value): raise ValidationError('手机号码格式错误') class PublishForm(Form): title = fields.CharField(max_length=20, min_length=5, error_messages={'required': '标题不能为空', 'min_length': '标题最少为5个字符', 'max_length': '标题最多为20个字符'}, widget=widgets.TextInput(attrs={'class': "form-control", 'placeholder': '标题5-20个字符'})) # 使用自定义验证规则 phone = fields.CharField(validators=[mobile_validate, ], error_messages={'required': '手机不能为空'}, widget=widgets.TextInput(attrs={'class': "form-control", 'placeholder': u'手机号码'})) email = fields.EmailField(required=False, error_messages={'required': u'邮箱不能为空','invalid': u'邮箱格式错误'}, widget=widgets.TextInput(attrs={'class': "form-control", 'placeholder': u'邮箱'}))
4.3 自定义方法验证
自定义验证方式有三个自定义方法：
- 单独某个字段：clean_字段名
- 整体信息的验证：clean
- 额外的验证：post_clean
class TestForm(forms.Form): username = fields.CharField() user_id = fields.IntegerField( widget=forms.Select(choices=models.UserInfo.objects.values_list('id', 'username')), # widget=forms.Select(), ) # 单独字段的错误信息 # 自定义方法, clean_字段名 # 必须有返回值: self.cleaned_data['username'] # 如果出错, raise ValidationError('用户名已存在') def clean_username(self): v = self.cleaned_data['username'] if models.UserInfo.objects.filter(username=v).count(): raise ValidationError('用户名已存在') return v def clean_user_id(self): return self.cleaned_data['user_id'] # 整体的错误信息 # 自定义方法，clean def clean(self): value_dict = self.cleaned_data v1 = value_dict.get('username') v2 = value_dict.get('user_id') if v1 == 'root' and v2 == 1: raise ValidationError('整体错误信息') return self.cleaned_data # 还有一个post_clean方法
4.4 自定义错误方法
from django.shortcuts import render, redirect, HttpResponse from django import forms from django.forms import fields class F1Form(forms.Form): user = fields.CharField( max_length=18, min_length=3, required=True, error_messages={ 'required': '用户名不能为空', 'max_length': 'sorry,太长了', 'min_length': 'sorry,太短了', 'invalid': '请输入字符', } ) pwd = fields.CharField(required=True, min_length=6) age = fields.IntegerField(required=True, error_messages={ 'required': '年龄不能为空', 'invalid': '请输入数字', } ) email = fields.EmailField(required=True,)
4.5 同时生成多个标签进行验证
1）自定义字段
from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.validators import RegexValidator ############## 自定义字段 ############## class PhoneField(fields.MultiValueField): def __init__(self, *args, **kwargs): # Define one message for all fields. error_messages = { 'incomplete': 'Enter a country calling code and a phone number.', } # Or define a different message for each field. f = ( fields.CharField( error_messages={'incomplete': 'Enter a country calling code.'}, validators=[ RegexValidator(r'^[0-9]+$', 'Enter a valid country calling code.'), ], ), fields.CharField( error_messages={'incomplete': 'Enter a phone number.'}, validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid phone number.')], ), fields.CharField( validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid extension.')], required=False, ), ) super(PhoneField, self).__init__(error_messages=error_messages, fields=f, require_all_fields=False, *args, **kwargs) def compress(self, data_list): """ 当用户验证都通过后，该值返回给用户 :param data_list: :return: """ return data_list
2）自定义插件
############## 自定义插件 ############## class SplitPhoneWidget(widgets.MultiWidget): def __init__(self): ws = ( widgets.TextInput(), widgets.TextInput(), widgets.TextInput(), ) super(SplitPhoneWidget, self).__init__(ws) def decompress(self, value): """ 处理初始值，当初始值initial不是列表时，调用该方法 :param value: :return: """ if value: return value.split(',') return [None, None, None]
5. 初始化数据
5.1 Form
from django import forms from django.forms import fields class TestForm(forms.Form): user = fields.CharField( widget=forms.TextInput(attrs={'n': 123}), # 可以通过attrs来添加自定义属性 required=True, max_length=10, min_length=3, error_messages={}, label='用户名', initial='请输入用户名', # validators=[] # disabled=True, label_suffix='-->' ) age = fields.IntegerField( required=True, label='年龄', max_value=200, min_value=1, error_messages={ 'max_value': '太大了', } ) email = fields.EmailField() img = fields.FileField() # city = fields.ChoiceField( # choices=[(1, '上海'), (2, '北京'), (3, '杭州'), ], # initial=1, # ) city = fields.TypedChoiceField( coerce=lambda x: int(x), choices=[(1, '上海'), (2, '北京'), (3, '杭州'), ], initial=1, ) hobby = fields.MultipleChoiceField( choices=[(1, 'fuck'), (2, 'shit'), (3, 'cao')], initial=[1, 2, ], ) xxoo = fields.IntegerField( widget=forms.SelectMultiple(choices=[(1, '欧美'), (2, '日韩'), (3, '亚洲'), ]), initial=[2, 3], )
5.2 Views
def test(request): if request.method == 'GET': # obj = TestForm({'city': 3}) obj = TestForm() return render(request, 'test.html', {'obj': obj, }) else: obj = TestForm(request.POST, request.FILES) if obj.is_valid(): print("验证成功", obj.cleaned_data) # 用户输入的信息 else: print('验证失败', obj.errors) # 验证失败的错误信息 return render(request, 'test.html', {'obj': obj, })
5.3 HTML
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form action="/test/" method="post" novalidate enctype="multipart/form-data"> <p>{{ obj.user.label }}{{ obj.user }}{{ obj.errors.user.0 }}</p> <p>{{ obj.age.label }}{{ obj.age }}{{ obj.errors.age.0 }}</p> <p>{{ obj.email.label }}{{ obj.email }}{{ obj.errors.email.0 }}</p> <p>{{ obj.img.label }}{{ obj.img }}{{ obj.errors.img.0 }}</p> <p>{{ obj.city.label }}{{ obj.city }}{{ obj.errors.city.0 }}</p> <p>{{ obj.hobby.label }}{{ obj.hobby }}{{ obj.errors.hobby.0 }}</p> <p>{{ obj.xxoo.label }}{{ obj.xxoo }}{{ obj.errors.xxoo.0 }}</p> <input type="submit" value="提交"> </form> {#{{ obj.as_p }}#} </body> </html>
