django form组件

功能介绍

  • 验证用户输入的数据
  • 打包正确信息
  • 生成错误信息
  • 生成HTML标签,初始化页面显示内容
  • 输入错误时保留上次提交内容

使用步骤

1 创建规则

类 - 继承Form,属性 - 和前台name同名

from django.forms import Form,fields,widgets

class DiyForm(Form):
    # 类中创建字段  例如 IntegerField,EmailField包含了正则表达式
    user = fields.CharField(
        required=True,#表示此项必填
        max_length=18,
        min_length=6,
        required=True,
        error_messages={#出现错误时对应的提示信息
            'max_length': '用户名过长',
            'min_length': '用户名过短',
            'required': '用户名不能为空',
            'invalid': '输入类型错误'
        }
    )
    pwd = fields.CharField(
        required=True,
        min_length=8,
        error_messages={
            'required': '密码不可为空',
            'min_length': '密码至少为8位'
        }
    )
    age = fields.IntegerField(
        required=True,
        error_messages={
            'required': '年龄不可为空',
            'invalid': '年龄必须为数字'
        }
    )
    email = fields.EmailField(
        required=True,
        min_length=8,
        error_messages={
            'required': '邮箱不可为空',
            'min_length': '邮箱长度不匹配',
            'invalid': '邮箱规则不符合'
        }
    )

2 使用规则,将数据和规则进行匹配

from django.shortcuts import render,HttpResponse,redirect
 
def f1(request):
    if request.method == 'GET':
        obj = DiyForm()  # 实例化  传参可进行模板渲染 生成Html代码
        return render(request, 'f1.html', {'obj':obj})
    else:
        obj = DiyForm(request.POST)
        # 判断是否全部验证成功 逐一交给类字段里面一一进行验证、像一层滤网
        if obj.is_valid():
            # 用户提交的数据   验证成功的信息
            print('验证成功', obj.cleaned_data)
            return redirect('http://www.baidu.com')
        else:
            print('验证失败', obj.errors)  # 封装的错误信息
            return render(request, 'f1.html', {'obj': obj})

3 渲染到前端页面




    
    DjangoForm


{{ obj.user }}{{ obj.errors.user.0 }}

{{ obj.pwd }}{{ obj.errors.pwd.0 }}

{{ obj.age }}{{ obj.errors.age.0 }}

{{ obj.email }}{{ obj.errors.email.0 }}

基本属性介绍

创建Form类时,主要涉及到 【字段】 和 【插件】,字段用于对用户请求数据的验证,插件用于自动生成HTML;

Form类内置字段介绍

常用字段

用于保存正则表达式
ChoiceField *****
MultipleChoiceField
CharField
IntegerField
DecimalField
DateField
DateTimeField
EmailField
GenericIPAddressField
FileField
 
RegexField

详细字段

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

Django内置插件

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
# )

单选&多选

单选或者多选时、数据源是否可以实时更新、、、

在使用选择标签时,需要注意choices的选项可以从数据库中获取,但是由于是静态字段 获取的值无法实时更新,那么需要自定义构造方法从而达到此目的。

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.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')

方式二、

使用django提供的ModelChoiceField和ModelMultipleChoiceField字段来实现

from django import forms
from django.forms import fields
from django.forms import widgets
from django.forms import models as form_model
from django.core.exceptions import ValidationError
from django.core.validators import RegexValidator
  
class FInfo(forms.Form):
    authors = form_model.ModelMultipleChoiceField(queryset=models.NNewType.objects.all())
    # authors = form_model.ModelChoiceField(queryset=models.NNewType.objects.all())

进阶

通过上述,Django的Form组件提供验证用户提交的数据并可以显示错误信息(或自定制),更能可以生成相应的Html代码。更是猜想到,仅仅根据Form组件的验证或许满足不了一些需求,于是建立再Form的验证功能上使其有很强的扩展性

一、基于Form组件的字段上的简单扩展

方式A

from django.forms import Form
from django.forms import widgets
from django.forms import fields
from django.core.validators import RegexValidator

class MyForm(Form):
    phone = fields.CharField(
        validators=[RegexValidator(r'^[0-9]+$', '请输入数字'), RegexValidator(r'^188[0-9]+$', '数字必须以188开头')],

方式B

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'邮箱'}))

二、基于源码执行的流程上进行扩展

方式A

例如在注册一个账号时、通过Form的验证其账号符合规则时,还将要判断该账号是否存在于数据库,如存在则肯定是注册不通过的

自定义方法、单一字段逐个再次验证

from Formtest import models
from django import forms
from django.forms import fields
from django.forms import widgets
from django.core.exceptions import ValidationError,NON_FIELD_ERRORS
from django.core.validators import RegexValidator
 
 
class AjaxForm(forms.Form):
    user=fields.CharField(
        max_length=10,
        required=False,
        validators=[RegexValidator(r'^[a-z]+$', 'Enter a valid extension.', 'invalid')],
    )
    email=fields.EmailField()
 
    def clean_user(self):
        """
        Form中字段中定义的格式匹配完之后,执行此方法进行验证
        :return:
        """
        v = self.cleaned_data['user']
        if models.UserInfo.objects.filter(user=v).count():
            raise ValidationError('此用户名已经存在')
        return v
 
    def clean_email(self):
        """
        email验证过之后、可以自定义验证该邮箱是否被使用...
        :return:
        """
        pass

方式B

from django.core.exceptions import NON_FIELD_ERRORS, ValidationError
class AjaxForm(forms.Form):
    username = fields.CharField()
    user_id = fields.IntegerField(
        widget=widgets.Select(choices=[(0,'alex'),(1,'马小跳'),(2,'egon'),])
    )
    # 自定义方法 clean_字段名,设置一个字段整体验证
    # 必须返回值self.cleaned_data['username']
    # 如果出错:raise ValidationError('用户名已存在')
    def clean_username(self):
        v = self.cleaned_data['username']
        #数据库中如果有这用户
        if UsersF.objects.filter(username=v).count():
            # 整体错了
            # 自己详细错误信息
            raise ValidationError('用户名已存在')
        return v

    def clean_user_id(self):
        return self.cleaned_data['user_id']

    #设置整体错误,可以用来设置多个字段整体验证
    def clean(self):
        value_dict=self.cleaned_data
        v1 = value_dict.get('username')
        v2 = value_dict.get('user_id')
        if v1=='root' and v2==0:
            raise ValidationError('整体错误信息')
        return self.cleaned_data


def ajax(request):
    if request.method == 'GET':
        obj = AjaxForm()
        return render(request,'ajax.html',{'obj':obj})
    else:
        ret = {'status':'tom','message':None}
        import json
        obj = AjaxForm(request.POST)
        if obj.is_valid():
            # 跳转到百度
            # return redirect('http://www.baidu.com')
            # if ....
            #     obj.errors['username'] = ['用户名已经存在',]
            # if ....
            #     obj.errors['email'] = ['用户名已经存在',]

            ret['status'] = '钱'
            return HttpResponse(json.dumps(ret))
        else:
            # print(type(obj.errors))
            # print(obj.errors)
            from django.forms.utils import ErrorDict
            # print(obj.errors.as_ul())
            # print(obj.errors.as_json())
            # print(obj.errors.as_data())


            ret['message'] = obj.errors
            # 错误信息显示在页面上
            return HttpResponse(json.dumps(ret))

小例子

from django.shortcuts import render
from django import forms
from django.forms import fields
from django.forms import widgets
class TestForm(forms.Form):
    user = fields.CharField(
        required=True, # 是否必填
        max_length=12, # 最大长度
        min_length=3,  # 最小长度
        error_messages={}, # 错误提示
        #widget = widgets.Select(), # 定制HTML插件
        label='用户名',
        initial='请输入用户',
        help_text='asdfasdf',
        show_hidden_initial=False,
        # validators=[]
        disabled=True,
        label_suffix='->'
    )
    age = fields.IntegerField(
        label='年龄',
        max_value= 12,
        min_value=5,
        error_messages={
            'max_value':'太大了'
        }
    )

    email = fields.EmailField(
        label='邮箱'
    )

    img = fields.FileField()

    city = fields.TypedChoiceField(
        coerce=lambda x: int(x),
        choices=[(1,'上海',),(2,'北京'),(3,'沙河'),],
        initial=2
    )

    xoo = fields.FilePathField(
        path='app01'
    )


    #多选checkbox
    c = fields.MultipleChoiceField(
        choices=[(1, '刚娘'), (2, '铁娘'), (3, '钢弹')],
        initial=[1,3],
        widget=widgets.CheckboxSelectMultiple


    )


    #多选select
    bobby = fields.MultipleChoiceField(
        choices=[(1, '刚娘'), (2, '铁娘'), (3, '钢弹')],
        initial=[1, 2],
        widget=widgets.SelectMultiple
    )

    #单选select
    t = fields.CharField(
        widget = widgets.Select(choices=[(1,'上海',),(2,'北京'),(3,'沙河'),]),
        initial=2

    )



    #**********重要*****
    u = fields.CharField(
        widget= widgets.Select()
    )
    def __init__(self,*args,**kwargs):
        #实时更新,拷贝所有的静态字段,复制给self.fields
        super(TestForm,self).__init__(*args,**kwargs)
        self.fields['u'].widget.choices=UsersF.objects.values_list('id','username')

def test(request):
    if request.method == 'GET':
        obj = TestForm()
        return render(request,'test.html',{'obj':obj})
    elif request.method=='POST':
        obj = TestForm(request.POST,request.FILES)

        if obj.is_valid():
            print('成功',obj.cleaned_data)
            return render(request, 'test.html', {'obj': obj})
        else:
            pass

页面写法

# 这是第一种写法,在
    显示表单 # 这是第二种写法,在

    显示表单 # 这是第三种写法,在

显示表单 {% for field in form %} # 这是第四种写法,以循环形式显示表单 {{ field.label_tag }}:{{ field }} {{ field.errors }} {% endfor %}

你可能感兴趣的:(django form组件)