forms组件简单使用

Forms组件

1 能够帮我们生成HTML标签

2 标签中保留之前用户输入的数据

3 数据校验

 

forms组件的使用流程

1 创建一个自定义的form类,代码如下

from django import forms

class RegisterForm(forms.Form):
    phone = forms.CharField()
    username = forms.CharField()
    password = forms.CharField()
    # 可以将label显示为中文
    phone = forms.CharField(label='手机号')
    username = forms.CharField(label='用户名')
    password = forms.CharField(label='密码')

2 视图函数

def register(request):

    if request.method == 'GET':
        form = RegisterForm()  #将上面的form类进行实例化
        return render(request, 'register.html', {'form': form})
    else:
        print(request.POST)
        return HttpResponse('ok')

生成标签的功能

3 创建一个html文件,比如叫做register.html,内容如下

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>注册页面</h1>
<form action="/register/" method="post" novalidate>
    {% csrf_token %}
    <div>
        <label for="{{ form.phone.id_for_label }}">{{ form.phone.label }}</label>
        {{ form.phone }}
    </div>
    <div>
        <label for="{{ form.username.id_for_label }}">{{ form.username.label }}</label>
        {{ form.username }}
    </div>
    <div>
        <label for="{{ form.password.id_for_label }}">{{ form.password.label }}</label>
        {{ form.password }}
    </div>
    <button>提交</button>
</form>

</body>
</html>

保留原数据和校验功能

简单登录案例

forms组件代码

class RegisterForms(forms.Form):
    # 每个字段,默认都有一个required=True的参数,表示该字段数据不能为空
    # phone = forms.CharField(label='手机号', required=True)
    phone = forms.CharField(
        label="手机号",
        error_messages={
            "required":"不能为空哦",
        }
    )
    username = forms.CharField(
        label="用户名",
        error_messages={
            "required": "不能为空哦",
        }
    )
    password = forms.CharField(
        label="密码",
        error_messages={
            "required": "不能为空哦",
        }
    )

views.py内容如下

def register(request):
    if request.method == "GET":
        form = RegisterForms()
        return render(request,"register.html",{"form":form})
    else:
        print(request.POST)
        # <QueryDict: {'csrfmiddlewaretoken': ['mlb6Zfu7ARWYC2qwOGVYiVEHhA0EaK4vOzLsQNcOTkB2DMvwDjWLrYvHMEkcIZvs'], 
      'phone': ['23'], 'username': [''], 'password': ['33333']}>
form = RegisterForms(data=request.POST) # 把数据交给了RegisterForm,那么在通过form来渲染标签时,就将原来的数据以默认值的形式(value='值')生成在了对应标签上 if form.is_valid(): # 执行校验,如果所有数据都校验通过了,返回True,但凡有一个数据,没有通过校验,返回False print('通过校验的数据', form.cleaned_data) # 通过校验的数据 {'phone': '123', 'username': '111', 'password': '333'} return HttpResponse("OK") print("没有通过校验",form.errors) # 没有通过校验 <ul class="errorlist"><li>username<ul class="errorlist"><li>不能为空哦</li></ul></li></ul> return render(request,"register.html",{"form":form})

register.html内容

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
        .err_msg {
            font-size: 12px;
            color: red;
        }
    </style>
</head>
<body>
<h1>注册页面</h1>
<!-- form标签的这个novalidate属性,就是告诉浏览器,别多管闲事儿,也就去掉了浏览器的那个必须填的提示信息 -->
<form action="/register/" method="post" novalidate>
    {% csrf_token %}
    <div>
        <label for="{{ form.phone.id_for_label }}">{{ form.phone.label }}</label>
        {{ form.phone }}
        <span class="err_msg">{{ form.phone.errors.0 }}</span>
        <!-- 展示一个字段的错误信息 -->
    </div>
    <div>
        <label for="{{ form.username.id_for_label }}">{{ form.username.label }}</label>
        {{ form.username }}
        <span class="err_msg">{{ form.username.errors.0 }}</span>
    </div>
    <div>
        <label for="{{ form.password.id_for_label }}">{{ form.password.label }}</label>
        {{ form.password }}
        <span class="err_msg">{{ form.password.errors.0 }}</span>
    </div>
    <button>提交</button>

    <div>
        <span>整体错误信息展示: </span>
        {{ form.errors }}
        <!-- form.errors是存放着我们所有字段的错误信息 -->
    </div>
</form>

</body>
</html>

Form常用字段属性与插件

initial: 初始值

username = forms.CharField(label='用户名',initial='张三')
# 生成input标签有个默认值

widget: 插件,能够定制我们的标签显示效果

示例1 密文输入框
password = forms.CharField(
        label='密码',
        # type = 'password'
        # widget=forms.widgets.PasswordInput,
        # 简写,不需要写widgets.
        widget=forms.PasswordInput,  # 密文输入框
        # CharField默认的插件是TextInput
        # widget=forms.widgets.TextInput,  # 默认是明文输入框
    )

示例2 给标签加上一些其他属性
password = forms.CharField(
        label='密码',
        #attrs={'标签属性':'属性值'}
        #widget=forms.TextInput(attrs={'class':'c1 c2',})
              #widget=forms.PasswordInput(attrs={'class':'c1',})
              widget=forms.TextInput(attrs={'class':'c1 c2','placeholder':'请输入密码'}),
    )

生成单选下拉框

 #gender = forms.fields.ChoiceField() fields可以不用写  
  gender = forms.ChoiceField(
        choices=((1,''), (2,'')),
          #(1,'女') 生成一个option标签,value值为1,文本内容为女
        label='性别',
        # initial=2,  #初始值
    )

单选radio框

gender = forms.ChoiceField(
        choices=((1,''), (2,'')),
        label='性别',
        # initial=2,
        
        # widget=forms.Select, #ChoiceField的默认插件
        
        # input,type='radio'的单选框
        # widget=forms.RadioSelect,
        widget=forms.RadioSelect(attrs={'class': 'c1'}),
    )

多选下拉框

hobby = forms.MultipleChoiceField(
        label="爱好",
        choices=((1,"run"),(2,"walk"),(3,"swimming"))
    )

单选功能的复选框形式

hobby = forms.MultipleChoiceField(
        label="爱好",
        choices=((1,"run"),(2,"walk"),(3,"swimming")),
        widget=forms.CheckboxInput  # 做单选功能的复(多)选框形式
    )

date类型

birthday = forms.CharField(
        widget=forms.TextInput(attrs={"type":"date"}),
        label="生日"
    )

单选或者多选框使用数据库中的数据

方式1

models中的模型类
  class Publish(models.Model):

    name = models.CharField(max_length=32)

    def __str__(self):
        return self.name
  
  form类中的字段写法
  # 生成选择框,并使用数据库中的数据
    publish = forms.ModelChoiceField(
        queryset=models.Publish.objects.all(),

    )
  会自动生成单选下拉框,并且option标签value属性对应的值,是queryset参数对应的queryset集合里面的models模型类对象的id值,
  option标签的文本内容是每个models模型类对象

方式2

publish = forms.ChoiceField(
        choices=models.Publish.objects.all().values_list('id','name')  #queryset[(1,xasdf),]
    )

帮助信息: help_text='',  显示在标签旁边

birthday = forms.CharField(
        widget=forms.TextInput(attrs={"type":"date"}),
        label="生日",
        help_text="按实填写哦"
    )
<div>
        <label for="{{ form.birthday.id_for_label }}">{{ form.birthday.label }}</label>
        {{ form.birthday }}
        {{ form.birthday.help_text }}
        <span class="err_msg">{{ form.birthday.errors.0 }}</span>
    </div>

Form所有内置字段

Field
    required=True,               是否允许为空
    widget=None,                 HTML插件
    label=None,                  用于生成Label标签或显示内容
    initial=None,                初始值
    help_text='',                帮助信息(在标签旁边显示)
    # {{ form.字段名称.help_text }}
    error_messages=None,         错误信息 {'required': '不能为空', 'invalid': '格式错误'}
    validators=[],               自定义验证规则
    
    disabled=False,              是否可以编辑
    
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类型
复制代码

简单校验示例

class DataForm(forms.Form):
    # 不能为空,长度不能超过10位,不能短于4位
    username = forms.CharField(
        label='用户名',
        max_length=10,
        min_length=4,
        error_messages={
            'required':'不能为空',
            "max_length": "用户名过长,存不下",
            "min_length": "用户名过短,没有辨识度",

        }
    )

    # 可以为空
    phone = forms.CharField(
        label='手机号',
        required=False,
    )
    # 要满足邮箱格式,不能为空
    email = forms.EmailField(  #input,type='email'和input,type='text'是一样的,都是普通文本输入框

        label='邮箱',
        error_messages={
            'invalid': '邮箱格式不对',
        }
    )
    # 提交的数据不能超出选项
    gender = forms.ChoiceField(
        label='性别',
        choices=((1,''),(2,'')),
        widget=forms.RadioSelect,
    )

    #form只校验类中写的属性对应的那些数据,form中没有字段不会被自动检测
    # {'aa':'bb'}
    # csrfmiddlewaretoken = forms.CharField()

RegexValidator验证器

from django.core.validators import RegexValidator

class DataForm(forms.Form):
    username = forms.CharField(
                ....
        # RegexValidator('正则','不符合规则时的错误信息')
        validators=[RegexValidator(r'^a', '用户名必须以a开头'),RegexValidator(r'b$', '用户名必须以b结尾')],

校验函数

import re
from django.core.validators import RegexValidator
from django.core.exceptions import ValidationError
# ValidationError是django提供的一个数据检验失败的一个错误类型

# 先定义一个函数,函数中我们可以做数据的校验,如果数据校验失败,我们可以raise ValidationError('错误信息')
def mobile_match(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('手机号格式有误!')

使用

phone = forms.CharField(
        label='手机号',
        # required=False,
        validators=[mobile_match, ],
    )

局部钩子

class DataForm(forms.Form):
    # 不能为空,长度不能超过10位,不能短于4位
    username = forms.CharField(
        label='用户名',
        max_length=10,
        min_length=4,
    )

    # 可以为空
    phone = forms.CharField(
        validators=[mobile_match, ],
    )
        ...

    # 局部钩子,能够对username这个字段的数据进行一个更高级的校验
    # 语法 clean_字段名称
    def clean_username(self):
        uname = self.cleaned_data.get('username')
        if '666' in uname:
            raise ValidationError('不能光喊6,没有用!')

        # 如果校验通过,需要return这个值
        return uname
    
    def clean_phone(self):
        phone = self.cleaned_data.get("phone")
        if "666" in phone:
            raise ValidationError("这个号不是你的")
        return phone

全局钩子

class DataForm(forms.Form):
  
      # 密码
    password = forms.CharField()
    # 确认密码
    confirm_password = forms.CharField()
    
  # 多个字段进行比较时,一般都是用全局钩子
    def clean(self):
        p1 = self.cleaned_data.get('password')
        p2 = self.cleaned_data.get('confirm_password')
        if p1 != p2:
            # 直接raise错误,这个错误信息保存到了全局错误信息里面
            # 也就是self.errors里面
            # raise ValidationError('两次密码不一致,你恐怕是个sz吧')
            # 这样写可以在标签旁边显示错误信息
            self.add_error('confirm_password', '抱歉,两次密码不一致,请核对!')
            self.add_error('password', '抱歉,两次密码不一致,请核对!')

        # 如果校验通过,必须return self.cleaned_data
        return self.cleaned_data

forms组件检查数据源码部分

def _clean_fields(self):
        for name, field in self.fields.items():
            # print(name, field)
            # name属性名称,field是CharField()类的实例化对象
            # value_from_datadict() gets the data from the data dictionaries.
            # Each widget type knows how to retrieve its own data, because some
            # widgets split data over several HTML fields.
            if field.disabled:
                value = self.get_initial_for_field(field, name)
            else:
                value = field.widget.value_from_datadict(self.data, self.files, self.add_prefix(name))
            try:
                if isinstance(field, FileField):
                    initial = self.get_initial_for_field(field, name)
                    value = field.clean(value, initial)
                else:
                    # 将CharField中的max_length,required..
                    value = field.clean(value)
                # 将属性对应的CharField里面的简单校验规则进行了校验
                self.cleaned_data[name] = value
                #self.cleaned_data['username'] = 'abc'
                if hasattr(self, 'clean_%s' % name): #clean_username
                    value = getattr(self, 'clean_%s' % name)()
                    self.cleaned_data[name] = value
            except ValidationError as e:
                self.add_error(name, e)

简单总结

首先对所有的我们自己定义的类中的属性进行了循环,self.fields能够获取到所有的属性
循环过程中先对属性,比如username = form.Charfield(max_length=12),里面的参数校验规则进行了校验,这个校验完成之后。
给self.clean_data这个字典进行了赋值self.clean_data['username'] = 'asdf' 然后对该字段的局部钩子进行了校验,在局部钩子中我们可以拿到self.clean_data['username'] 这个数据进行处理,别忘了局部钩子校验成功之后,
要return 这个字段的值,然后才进入下一次循环,处理下一个属性 当上面的所有循环执行完之后,才执行我们的全局够子,全局钩子中校验成功之后别忘了return self.clean_data

猜你喜欢

转载自www.cnblogs.com/fdsimin/p/13399821.html