Form介绍

我们之前在HTML页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。

与此同时我们在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确。如果用户输入的内容有错误就需要在页面上相应的位置显示显示对应的错误信息.。

Django form组件就实现了上面所述的功能。

总结一下，其实form组件的主要功能如下:

生成页面可用的HTML标签
对用户提交的数据进行校验
保留上次输入内容

普通的登录

views.py

def login(request):

    error_msg = ""

    if request.method == "POST":

        username = request.POST.get("username")

        pwd = request.POST.get("pwd")

        if username == "Q1mi" and pwd == "123456":

            return HttpResponse("OK")

        else:

            error_msg = "用户名或密码错误"

    return render(request, "login.html", {"error_msg": error_msg})

login.html

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <meta http-equiv="x-ua-compatible" content="IE=edge">

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <title>login</title>

  <style>

    .error {

      color: red;

    }

  </style>

</head>

<body>

<form action="/login/" method="post">

  {% csrf_token %}

  <p>

    <label for="username">用户名</label>

    <input type="text" name="username" id="username">

  </p>

  <p>

    <label for="pwd">密码</label>

    <input type="password" name="pwd" id="pwd">

    <span class="error"></span>

  </p>

  <p>

    <input type="submit">

    <span class="error">{{ error_msg }}</span>

  </p>

</form>

</body>

</html>

使用form组件

views.py

先定义好一个LoginForm类。

class LoginForm(forms.Form):

    username = forms.CharField(min_length=8, label="用户名")

    pwd = forms.CharField(min_length=6, label="密码")

def login2(request):

    error_msg = ""

    form_obj = LoginForm()

    if request.method == "POST":

        form_obj = LoginForm(request.POST)

        if form_obj.is_valid():

            username = form_obj.cleaned_data.get("username")

            pwd = form_obj.cleaned_data.get("pwd")

            if username == "Q1mi" and pwd == "123456":

                return HttpResponse("OK")

            else:

                error_msg = "用户名或密码错误"

    return render(request, "login2.html", {"form_obj": form_obj, "error_msg": error_msg})

login2.html

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <meta http-equiv="x-ua-compatible" content="IE=edge">

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <title>login</title>

  <style>

    .error {

      color: red;

    }

  </style>

</head>

<body>

<form action="/login2/" method="post" novalidate>

  {% csrf_token %}

  <p>

    {{ form_obj.username.label }}

    {{ form_obj.username }}

    <span class="error">{{ form_obj.username.errors.0 }}</span>

  </p>

  <p>

    {{ form_obj.pwd.label }}

    {{ form_obj.pwd }}

    <span class="error">{{ form_obj.pwd.errors.0 }}</span>

  </p>

  <p>

    <input type="submit">

    <span class="error">{{ error_msg }}</span>

  </p>

</form>

</body>

</html>

看网页效果发现也验证了form的功能：
• 前端页面是form类的对象生成的 -->生成HTML标签功能
• 当用户名和密码输入为空或输错之后页面都会提示 -->用户提交校验功能
• 当用户输错之后再次输入上次的内容还保留在input框 -->保留上次输入内容

Form那些事儿

常用字段演示

initial

初始值，input框里面的初始值。initial 表示默认值

class LoginForm(forms.Form):

    username = forms.CharField(

        min_length=8,

        label="用户名",

        initial="张三"  # 设置默认值

    )

    pwd = forms.CharField(min_length=6, label="密码")

error_messages

重写错误信息。

class LoginForm(forms.Form):

    username = forms.CharField(

        min_length=8,

        label="用户名",

        initial="张三",

        error_messages={

            "required": "不能为空",   #当该字段设置为非空时，不填就会返回，用于重写为空时的提示

            "invalid": "格式错误",    #常用于email输入的格式不正确时的提示信息

            "min_length": "用户名最短8位"

        }

    )

    pwd = forms.CharField(min_length=6, label="密码")    #label 用于重写该字段的名字

password

class LoginForm(forms.Form):

    ...

    pwd = forms.CharField(

        min_length=6,

        label="密码",

        widget=forms.widgets.PasswordInput(attrs={'class': 'c1'}, render_value=True)

    )　　　　　　　　　　　　　　　　　　　　　　　　　　#render_value=True 表示输入框校验不通过时，保留当前输入值

radioSelect

单radio值为字符串

class LoginForm(forms.Form):

    username = forms.CharField(

        min_length=8,

        label="用户名",

        initial="张三",

        error_messages={

            "required": "不能为空",

            "invalid": "格式错误",

            "min_length": "用户名最短8位"

        }

    )

    pwd = forms.CharField(min_length=6, label="密码")

    gender = forms.fields.ChoiceField(

        choices=((1, "男"), (2, "女"), (3, "保密")),

        label="性别",

        initial=3,

        widget=forms.widgets.RadioSelect

    )

单选Select

class LoginForm(forms.Form):

    ...

    hobby = forms.fields.ChoiceField(

        choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),

        label="爱好",

        initial=3,

        widget=forms.widgets.Select

    )

多选Select

class LoginForm(forms.Form):

    ...

    hobby = forms.fields.MultipleChoiceField(

        choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),

        label="爱好",

        initial=[1, 3],

        widget=forms.widgets.SelectMultiple

    )

单选checkbox

class LoginForm(forms.Form):

    ...

    keep = forms.fields.ChoiceField(

        label="是否记住密码",

        initial="checked",

        widget=forms.widgets.CheckboxInput

    )

多选checkbox

class LoginForm(forms.Form):

    ...

    hobby = forms.fields.MultipleChoiceField(

        choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),

        label="爱好",

        initial=[1, 3],

        widget=forms.widgets.CheckboxSelectMultiple

    )

关于choice的注意事项：

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

方式一：

from django.forms import Form

from django.forms import widgets

from django.forms import fields

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().values_list('id','caption')

方式二：

from django import forms

from django.forms import fields

from django.forms import models as form_model

class FInfo(forms.Form):

    authors = form_model.ModelMultipleChoiceField(queryset=models.NNewType.objects.all())

    # authors = form_model.ModelChoiceField(queryset=models.NNewType.objects.all())

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 form内置字段

备注：UUID是根据MAC以及当前时间等创建的不重复的随机字符串

>>> import uuid

    # make a UUID based on the host ID and current time

    >>> uuid.uuid1()    # doctest: +SKIP

    UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

    # make a UUID using an MD5 hash of a namespace UUID and a name

    >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')

    UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

    # make a random UUID

    >>> uuid.uuid4()    # doctest: +SKIP

    UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

    # make a UUID using a SHA-1 hash of a namespace UUID and a name

    >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')

    UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')

    # make a UUID from a string of hex digits (braces and hyphens ignored)

    >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')

    # convert a UUID to a string of hex digits in standard form

    >>> str(x)

    '00010203-0405-0607-0809-0a0b0c0d0e0f'

    # get the raw 16 bytes of the UUID

    >>> x.bytes

    b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'

    # make a UUID from a 16-byte string

    >>> uuid.UUID(bytes=x.bytes)

    UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')

UUID的使用

备注：在Django中要区分开models.Model、forms.Form、ModelForm，这三个中，model.Model是django中的模型表，自定义一个类，类的属性就是字段的属性，包括一些普通的字段属性（比如：CharField、DecimalField等）和一些特殊的字段属性（比如：一对多ForeignKey，多对多字段ManyToLMany和一对一字段OneToOne（特殊的Foreignkey））。forms.Form使用于校验字段，生成HTML标签，展示错误信息，常用于注册和一些校验页面比如：添加页面和编辑页面。同样的，在forms.Form中也有一些特殊的字段属性，它也是自定义一个类，类的属性就是每一个字段的属性，不同的是：models.Model是数据库的模型类，而forms.Form则和数据库没有任何的关系。他也有普通的字段（比如：CharField等），但是在forms.Form中没有ForeignKey、ManyToMany等这些字段，相对应的，他有一个ChoiceField，生成对应的select标签，但是有一个弊端，无法及时更新数据，每次数据库发生变动，不能及时的做出反应，针对于此，继承ChoiceField类生成了两个对应models.Model中ForeignKey和ManyToMany，一个是ModelChoiceField（ChoiceField）继承ChoiceField，对应ForeignKey，另外一个是ModelMuiltChoiceField(ModelChoiceField),继承ModelChoiceField，对应ManyToMany。这两个字段避免了数据的无法实时更新。最后一个ModelForm，是一个特殊的，它是连接数据库models.Model和forms.Form之间的一个特殊的中间的东西，它是将models.Model中的字段全部转化为forms.Form中的字段，然后自动生成HTMl和校验字段。

#forms.widgets字段

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

widget字段

校验

方式一：

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开头')],

    )

方式二：

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

方法三：自定义方法

from django import forms

from django.forms import fields

from django.forms import widgets

from django.core.exceptions import ValidationError

from django.core.validators import RegexValidator

class FInfo(forms.Form):

username = fields.CharField(max_length=5,

validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid extension.', 'invalid')], )

email = fields.EmailField()

def clean_username(self):

"""

Form中字段中定义的格式匹配完之后，执行此方法进行验证

:return:

"""

value = self.cleaned_data['username']

if "666" in value:

raise ValidationError('666已经被玩烂了...', 'invalid')

return value

方式四：同时生成多个标签进行验证

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

############## 自定义插件 ##############

class SplitPhoneWidget(widgets.MultiWidget):

def __init__(self):

ws = (

widgets.TextInput(),

)

super(SplitPhoneWidget, self).__init__(ws)

def decompress(self, value):

"""

处理初始值，当初始值initial不是列表时，调用该方法

:param value:

:return:

"""

if value:

return value.split(',')

return [None, None, None]

补充进阶

应用Bootstrap样式

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <meta http-equiv="x-ua-compatible" content="IE=edge">

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <link rel="stylesheet" href="/static/bootstrap/css/bootstrap.min.css">

  <title>login</title>

</head>

<body>

<div class="container">

  <div class="row">

    <form action="/login2/" method="post" novalidate class="form-horizontal">

      {% csrf_token %}

      <div class="form-group">

        <label for="{{ form_obj.username.id_for_label }}"

               class="col-md-2 control-label">{{ form_obj.username.label }}</label>

        <div class="col-md-10">

          {{ form_obj.username }}

          <span class="help-block">{{ form_obj.username.errors.0 }}</span>

        </div>

      </div>

      <div class="form-group">

        <label for="{{ form_obj.pwd.id_for_label }}" class="col-md-2 control-label">{{ form_obj.pwd.label }}</label>

        <div class="col-md-10">

          {{ form_obj.pwd }}

          <span class="help-block">{{ form_obj.pwd.errors.0 }}</span>

        </div>

      </div>

      <div class="form-group">

      <label class="col-md-2 control-label">{{ form_obj.gender.label }}</label>

        <div class="col-md-10">

          <div class="radio">

            {% for radio in form_obj.gender %}

              <label for="{{ radio.id_for_label }}">

                {{ radio.tag }}{{ radio.choice_label }}

              </label>

            {% endfor %}

          </div>

        </div>

      </div>

      <div class="form-group">

        <div class="col-md-offset-2 col-md-10">

          <button type="submit" class="btn btn-default">注册</button>

        </div>

      </div>

    </form>

  </div>

</div>

<script src="/static/jquery-3.2.1.min.js"></script>

<script src="/static/bootstrap/js/bootstrap.min.js"></script>

</body>

</html>

Django form应用Bootstrap样式简单示例

批量添加样式

可通过重写form类的init方法来实现。

class LoginForm(forms.Form):

    username = forms.CharField(

        min_length=8,

        label="用户名",

        initial="张三",

        error_messages={

            "required": "不能为空",

            "invalid": "格式错误",

            "min_length": "用户名最短8位"

        }

    ...

    def __init__(self, *args, **kwargs):

        super(LoginForm, self).__init__(*args, **kwargs)

        for field in iter(self.fields):

            self.fields[field].widget.attrs.update({

                'class': 'form-control'

            })

批量添加样式

在template模板中的使用

1.实例化一个form_obj 我们可以对我们创建的类进行实例化，将这个对象传到前端比如：form_obj = RegForm()

这个form_obj是一个包含所有对象和字段属性的对象，我们可以在模板HTML中，使用三种方式去生成html代码

1，直接form_obj.as_p(或者as_table\as_li等) 直接帮我们生成一个包含label和对应input的p标签

2，我们可以逐个的生成每一个HTML

 <div class="form-group {% if form_obj.password.errors.0 %}has-error{% endif %}">

    <div class="col-sm-2 control-label">{{ form_obj.password.label }}</div>

    <div class="col-sm-10 input-group">

      {{ form_obj.password }}

        <span class="help-block">{{ form_obj.password.errors.0 }}</span>

    </div>

 </div>

3.我们也可以for循环这个form_obj对象，批量的生成HTML代码

循环这个form_obj.fields，可以取出当中的每一个字段。

{% for foo in form_obj %}

                    <div class="form-group {% if foo.errors.0 %}has-error{% endif %}">

                        <label for="{{ foo.id_for_label }}" class="col-md-2 control-label">{{ foo.label }}</label>

                    <div class="col-md-8">

                        {{ foo }}

                    </div>

                    <span class="help-block">{{ foo.errors.0 }}</span>

                    </div>

{% endfor %}

我们也可以使用for循环整体的取出

{% for field in form_obj %}

{{ field.label }}

{{ field }}

{{ field.errors.0 }}

{% endfor %}

使用post请求提交数据时，我们可以通过将这个request.POST 当成参数传到实例化这个对象中，比如：form_obj=RegForm(request.POST)。然后我们通过form_obj.is_valid()这个方法对用户提交的数据进行校验，得到一个bool值，我们可以通过这个bool值，进行相应的操作，我们可以在校验通过后通过form_obj.cleaned_data这个属性方法，按照字典的key进行取值。

备注：在给form_obj=RegForm()，括号中传参时，传的是一个字典类型的数据，由于request.POST、request.FILES等这些输出为一个字典，所以可以直接将其作为参数传给form_obj。is_valid校验时，从这个数据字典中取RegForm这个类中的字段，取不到，直接添加error给form_obj.errors这个ErrorDict。

巴特西

Django基础之form组件

Form介绍

普通的登录

views.py

login.html

使用form组件

views.py

login2.html

Form那些事儿

常用字段演示

initial

error_messages

password

radioSelect

单选Select

多选Select

单选checkbox

多选checkbox

校验

补充进阶

应用Bootstrap样式

批量添加样式

最新文章

热门文章