DAY83-Django框架(十三) Forms组件

一、forms组件

基本使用

视图层

#第一步:导入forms
from django import forms
from django.forms import widgets
#第二步:定义的类
class User_form(forms.Form):
#第三步:设置字段与相对应的对象
    name = forms.CharField(max_length=10,min_length=3)
    pwd = forms.CharField(max_length=10,min_length=3,widget=widgets.PasswordInput())
    re_pwd = forms.CharField(max_length=10,min_length=3,widget=widgets.PasswordInput())
    email = forms.EmailField()
    
def index(request):
    if request.method == 'GET':
        return render(request,'index.html')
    if request.method == 'POST':
        #第四步:实例化产生对象
        form = User_form(request.POST)
        # is_valid如果是true表示校验成功,反之,校验失败
        if form.is_valid():
            print(form.cleaned_data)
        else:
            # ErrorDict : {"校验错误的字段":["错误信息",]}
            print(form.errors)
            # ErrorList ["错误信息",]
            print(form.errors.get("name"))
        return render(request, 'index.html',locals())

模型层

<form action="" method="post">
    <div>
        <label for="user">用户名</label>
        <p><input type="text" name="name" id="name"></p>
    </div>
    <div>
        <label for="pwd">密码</label>
        <p><input type="password" name="pwd" id="pwd"></p>
    </div>
    <div>
        <label for="r_pwd">确认密码</label>
        <p><input type="password" name="re_pwd" id="re_pwd"></p>
    </div>
     <div>
        <label for="email">邮箱</label>
        <p><input type="text" name="email" id="email"></p>
    </div>
    <input type="submit">
</form>

注:

#第二步:
	定义的类必须继承forms.Form,forms类定义过的属性默认非空。

#第四步:
	需要注意的是给对象传入字典就可以做一个个值的校验。
	但是我们需要的是form表单属性与forms组件字段的校验,因此需要把request.POST传入forms对象。
	form表单的name属性值应该与forms组件的字段名称一致,不一致的键值不会去做校验。
    
#form.cleaned_data
	字段值符合要求的放在cleaned_data中。字典数据类型。

#form.errors
	字段不符合要求的对应的键作为键,错误信息作为值。虽然返回结果比较复杂,但依然是字典数据类型,
    可以通过form.errors.get(“不符合的键”)来拿到键值,键值为列表数据类型。
    因此可以通过form.errors.get("不符合键")[0]拿到错误信息。

语法

常用字段:
	Charfield
	RegexField
	IntegerField
	EmailField
常用参数:
	max_length,
	min_length,
	error_messages={
      	'required':'用户名不能为空',
      	'max_length':'太长了',
      	'min_length':'太短了',
        'invalid': '不符合邮箱格式' # 凡是遇到格式错误的,都用 invalid
	},
    widget=widgets.插件(attrs={})),# 插件,可以设置类名,attrs={'class':'form-control'}
	label='用户名',  # obj.t1.label
	required=True,	# 默认为True,在前端就要求必须填写,空会提示
	disabled=False, # 是否可以编辑

内置字段

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类型
    ...

二、模型层渲染

方式一

​ 灵活性最高,但比较low

<form action="" method="post">
    <div>
        <label for="user">用户名:</label>
        {{ form.name }}
    </div>
    <div>
        <label for="pwd">密码:</label>
        {{ form.pwd }}
    </div>
    <div>
        <label for="r_pwd">确认密码:</label>
        {{ form.re_pwd }}
    </div>
     <div>
        <label for="email">邮箱:</label>
        {{ form.email }}
    </div>
    <input type="submit">
</form>

方式二

​ 推荐使用

视图层

#首先要添加每个字段的label属性
class User_form(forms.Form):
    name = forms.CharField(label='用户名:',max_length=10,min_length=3)
    pwd = forms.CharField(label='密码:',max_length=10,min_length=3,widget=widgets.PasswordInput())
    re_pwd = forms.CharField(label='确认密码:',max_length=10,min_length=3,widget=widgets.PasswordInput())
    email = forms.EmailField(label='邮箱:',)

模版层

<form action="" method="post">
    {% for foo in form %}
        <div>
            <label>{{ foo.label }}</label>
            {{ foo }}
        </div>
    {% endfor %}
    <input type="submit">
</form>

方式三

​ 写死了,不推荐使用

视图层

#首先要添加每个字段的label属性
class User_form(forms.Form):
    name = forms.CharField(label='用户名',max_length=10,min_length=3)
    pwd = forms.CharField(label='密码',max_length=10,min_length=3,widget=widgets.PasswordInput())
    re_pwd = forms.CharField(label='确认密码',max_length=10,min_length=3,widget=widgets.PasswordInput())
    email = forms.EmailField(label='邮箱',)

模版层

<form action="" method="post">
     {{ form.as_p }}
    <!--相当于在循环form的字段,每循环一次,获得相对应的html标签
	<p>
		<label for="id_name">
			用户名:
		</label> 
		<input type="text" name="name" maxlength="10" minlength="3" required id="id_name" />
	</p>
-->
    {{ form.as_li }}
    <!--相当于在循环form的字段,每循环一次,获得相对应的html标签
	<li>
		<label for="id_name">
			用户名:
		</label> 
		<input type="text" name="name" maxlength="10" minlength="3" required id="id_name" />
	</li>
-->
    {{ form.as_table }}
    <!--相当于在循环form的字段,每循环一次,获得相对应的html标签
	<tr>
		<th>
			<label for="id_name">
				用户名:
			</label>
		</th>
		<td>
			<input type="text" name="name" maxlength="10" minlength="3" required id="id_name" />
		</td>
	</tr>
-->
    <input type="submit">
</form>

四、渲染错误信息

<form action="" method="post" novalidate>
    {% for foo in form %}
        <div>
            <label >{{ foo.label }}</label>
            {{ foo }}
        <!--渲染错误信息:foo.errors.0-->
        <span>{{ foo.errors.0 }}</span>
        </div>
    {% endfor %}
    <input type="submit">
</form>

自定义错误信息

class User_form(forms.Form):
    name = forms.CharField(label='用户名', max_length=10, min_length=3,error_messages={'max_length': '最长是8', 'min_length': '最短是3', 'required': '这个必须填'})
    pwd = forms.CharField(label='密码', max_length=10, min_length=3, widget=widgets.PasswordInput(),error_messages={'max_length': '最长是8', 'min_length': '最短是3', 'required': '这个必须填'})
    re_pwd = forms.CharField(label='确认密码', max_length=10, min_length=3, widget=widgets.PasswordInput(), error_messages={'max_length': '最长是8', 'min_length': '最短是3', 'required': '这个必须填'})
    email = forms.EmailField(label='邮箱', error_messages={'required': '这个必须填','invalid': '不符合邮箱格式'})

五、局部钩子

​ 局部钩子可以对单个字段进行自定义的验证,只有当所有的内部验证都通过后,才会进行自定义验证

​ 在Form类中自定义一个方法,方法名称有固定格式:clean_字段名称。Django内部会自动执行该方法对字段进行验证,这个方法必须将验证正确的值返回。验证错误需要抛出ValidationError错误。

from django.core.exceptions import ValidationError
def clean_name(self):
    name = self.cleaned_data.get('name')
    if not name[0].isalpha():
        raise ValidationError('必须以字母开头')
    return name

六、全局钩子

需求:在注册账号时,填写密码后,还要再次填写确认密码,然后比较两次密码是否一致,一致后才能正常注册。

对所有字段做整体验证,django预留了clean钩子方法,可以自定制处理逻辑代码,但是clean方法必须返回self.cleaned_data,如下列示例代码

from django.core.exceptions import ValidationError
def clean(self):
    print(self.cleaned_data)
    pwd = self.cleaned_data.get('pwd')
    re_pwd = self.cleaned_data.get('re_pwd')
    if pwd !=re_pwd:
        raise ValidationError('两次密码不一致')
    return self.cleaned_data
原文地址:https://www.cnblogs.com/xvchengqi/p/9996240.html