Django - Form和ModelForm

[TOC]

一. form介绍

　　1.生成页面可用的HTML标签

　　2. 提供input可以提交数据

　　3. 对用户提交的数据进行校验

　　4. 保留上次输入内容

　　5. 提供错误信息

二. 普通方式书写注册功能

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8">

    <title>注册页面</title>

</head>

<body>

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

    {% csrf_token %}

    <p>

        用户名:

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

    </p>

    <p>

        密码：

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

    </p>

    <p>

        <input type="submit" value="注册">

        <p style="color: red">{{ error_msg }}</p>

    </p>

</form>

</body>

</html>

# 注册

def register(request):

    error_msg = ""

    if request.method == "POST":

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

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

        # 对注册信息做校验

        if len(username) < 6:

            # 用户长度小于6位

            error_msg = "用户名长度不能小于6位"

        else:

            # 将用户名和密码存到数据库

            return HttpResponse("注册成功")

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

views.py

三. 使用form组件实现注册功能,自动创建表单

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8">

    <title>注册2</title>

</head>

<body>

    <form action="/reg2/" method="post" novalidate autocomplete="off">

        {% csrf_token %}

        <div>

            <label for="{{ form_obj.name.id_for_label }}">{{ form_obj.name.label }}</label>

            {{ form_obj.name }} {{ form_obj.name.errors.0 }}

        </div>

        <div>

            <label for="{{ form_obj.pwd.id_for_label }}">{{ form_obj.pwd.label }}</label>

            {{ form_obj.pwd }} {{ form_obj.pwd.errors.0 }}

        </div>

        <div>

            <input type="submit" class="btn btn-success" value="注册">

        </div>

    </form>

</body>

</html>

login2.html

先定义好一个RegForm类：

from django import forms

# 按照Django form组件的要求自己写一个类

class RegForm(forms.Form):

    name = forms.CharField(label="用户名")

    pwd = forms.CharField(label="密码")

再写一个视图函数:

# 使用form组件实现注册方式

def register2(request):

    form_obj = RegForm()

    if request.method == "POST":

        # 实例化form对象的时候，把post提交过来的数据直接传进去

        form_obj = RegForm(request.POST)

        # 调用form_obj校验数据的方法

        if form_obj.is_valid():

            return HttpResponse("注册成功")

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

views.py

四. form常用的字段和与插件

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

　　1. 组件　　

　　　　　视图中:

form_obj = RegForm()   # 实例化form对象

return render(request, 'reg2.html', {'form_obj': form_obj})

　　　　　模板中:

　　　　　　　　form标签加上novalidate 前段不进行校验

{{ form_obj.as_p }}   ——》  生成所有的p标签   label  input

{{ form_obj.errors }}   ——》所有字段的错误

{{ form_obj.user }}   ——》 该字段的input框

{{ form_obj.user.label }}   ——》 该字段的label  中文提示

{{ form_obj.user.id_for_label }}   ——》 该字段的id

{{ form_obj.user.errors }}   ——》 该字段的所有的错误信息

{{ form_obj.user.errors.0 }} ——》 该字段的第一个的错误信息

　　2. 字段

initial:　　初始值, input框里面的初始值,默认值

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": "格式错误",

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

        }

    )

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

　　passwod:　　密码

class LoginForm(forms.Form):

    ...

    pwd = forms.CharField(

        min_length=6,

        label="密码",

        widget=forms.widgets.PasswordInput(attrs={'class': 'c1'}, 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()

    )

多选select

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

    )

多选checkbox

　　关于choise的注意事项:

　　在使用选择标签时，需要注意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'].choices = ((1, '上海'), (2, '北京'),)

        # 或

        self.fields['user'].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())  # 单选

　　3. Django Form所有内置字段

Field

    required=True,               是否允许为空

    widget=None,                 HTML插件

    label=None,                  用于生成Label标签或显示内容

    initial=None,                初始值

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

    error_messages=None,         错误信息 {'required': '不能为空', 'invalid': '格式错误'}

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

五. 校验

　　1. 内置校验

　　　　required=True,min_length=8,max_length=12,

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

    )

　　2. 自定义校验器

　　　　定义函数

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.core.exceptions import ValidationError

def check(value):

    if 'alex' in value:

        raise ValidationError('敏感词汇，不符合社会职业核心价值观')

validators=[check]

　　3. 局部钩子

　　　　定义一个放法 clean_字段名（self,）的方法，如果不通过校验规则，要抛出异常ValidationError，如果通过校验规则，返回通过校验的值

def clean_user(self):

    value = self.cleaned_data.get('user')

    if 'alex' in value:

        raise ValidationError('敏感词汇，不符合社会职业核心价值观')

    return value

　　4. 全局钩子

　　　　定义一个放法 clean（self）的方法，如果不通过校验规则，要抛出异常ValidationError，还可以自己使用self.add_error('re_pwd', '两次密码不一致!!@!')添加错误信息。如果通过校验规则，返回所有通过校验的值

ef clean(self):

    pwd = self.cleaned_data.get('pwd')

    re_pwd = self.cleaned_data.get('re_pwd')

    if pwd != re_pwd:

        self.add_error('re_pwd', '两次密码不一致!!@!')

        raise ValidationError('两次密码不一致')

    return self.cleaned_data

ModeForm

通常在Django项目中，我们编写的大部分都是与Django 的模型紧密映射的表单。举个例子，你也许会有个Book 模型，并且你还想创建一个form表单用来添加和编辑书籍信息到这个模型中。在这种情况下，在form表单中定义字段将是冗余的，因为我们已经在模型中定义了那些字段。

基于这个原因，Django 提供一个辅助类来让我们可以从Django 的模型创建Form，这就是ModelForm。

modelForm定义

form与model的终极结合。

class BookForm(forms.ModelForm):

    class Meta:

        model = models.Book

        fields = "__all__"

        labels = {

            "title": "书名",

            "price": "价格"

        }

        widgets = {

            "password": forms.widgets.PasswordInput(attrs={"class": "c1"}),

        }

class Meta下常用参数：

model = models.Book  # 对应的Model中的类

fields = "__all__"  # 字段，如果是__all__,就是表示列出所有的字段

exclude = None  # 排除的字段

labels = None  # 提示信息

help_texts = None  # 帮助提示信息

widgets = None  # 自定义插件

error_messages = None  # 自定义错误信息

ModelForm的验证

与普通的Form表单验证类型类似，ModelForm表单的验证在调用is_valid() 或访问errors 属性时隐式调用。

我们可以像使用Form类一样自定义局部钩子方法和全局钩子方法来实现自定义的校验规则。

如果我们不重写具体字段并设置validators属性的化，ModelForm是按照模型中字段的validators来校验的。

save()方法

每个ModelForm还具有一个save()方法。这个方法根据表单绑定的数据创建并保存数据库对象。 ModelForm的子类可以接受现有的模型实例作为关键字参数instance；如果提供此功能，则save()将更新该实例。如果没有提供，save() 将创建模型的一个新实例：

>>> from myapp.models import Book

>>> from myapp.forms import BookForm

# 根据POST数据创建一个新的form对象

>>> form_obj = BookForm(request.POST)

# 创建书籍对象

>>> new_ book = form_obj.save()

# 基于一个书籍对象创建form对象

>>> edit_obj = Book.objects.get(id=1)

# 使用POST提交的数据更新书籍对象

>>> form_obj = BookForm(request.POST, instance=edit_obj)

>>> form_obj.save()