Django組件——forms組件

時間 2019-11-16

標籤 django 組件 forms 欄目 Python 简体版

原文原文鏈接

1、校驗字段功能

　　經過註冊用戶這個實例來學習校驗字段功能。javascript

一、模型：models.py

from django.db import models

# Create your models here.

class UserInfo(models.Model):
    name = models.CharField(max_length=32)
    pwd = models.CharField(max_length=32)
    email = models.EmailField()
    tel = models.CharField(max_length=32)

　　修改配置後，完成數據庫遷移操做，能夠查看到UserInfo表已經建立完成。css

二、模板：reg.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<form action="" method="post">
    {% csrf_token %}
    <p>用戶名<input type="text" name="name"></p>
    <p>密碼<input type="text" name="pwd"></p>
    <p>確認密碼<input type="text" name="r_pwd"></p>
    <p>郵箱<input type="text" name="email"></p>
    <p>手機號<input type="text" name="tel"></p>
    <input type="submit">
</form>
</body>
</html>

三、視圖函數：views.py

from django.shortcuts import render,HttpResponse
# Create your views here.
from django import forms   # 引入forms組件

class UserForm(forms.Form):   # 必須繼承forms.Form
    name = forms.CharField(min_length=4)
    pwd = forms.CharField(min_length=4)
    r_pwd = forms.CharField(min_length=4)
    email = forms.EmailField()
    tel = forms.CharField()

def reg(request):
    if request.method=="POST":
        print(request.POST)
        # 生成forms對象後，傳入字典就能夠作一個個值的校驗
        # form = UserForm({"name": "yuan", "email": "123@qq.com", "xxx":"alex"})
        form = UserForm(request.POST)   # form表單的name屬性值應該與forms組件的字段名稱一致，不一致的鍵值不會去作校驗
        print(form.is_valid())     # 返回True/False
        # 幫忙校驗
        if form.is_valid():  # 注意：form.is_valid是幫忙校驗返回布爾值的,true或false（全部都經過才返回true）
            # 類定義的字段均符合要求，返回true，有多的字段直接忽略
            print(form.cleaned_data)   # {'name': 'yuan', 'pwd': '1234', 'r_pwd': '1234', 'email': '1234@163.com', 'tel': '123123'}
        else:
            # 有正確也有錯誤信息也是返回false
            print(form.cleaned_data)   # 字段值符合要求的放在cleaned_data    {'name': 'yuan', 'pwd': '123456', 'tel': '123123'}
            print(form.errors)         # 字段不符合要求的對應的鍵做爲鍵，錯誤信息做爲值   <ul class="errorlist"><li>r_pwd<ul class="errorlist">...
            print(type(form.errors))   # <class 'django.forms.utils.ErrorDict'>  仍是一個字段類型
            print(form.errors.get("r_pwd"))     # <ul class="errorlist"><li>This field is required.</li></ul>
            print(type(form.errors.get("r_pwd")))    # <class 'django.forms.utils.ErrorList'> 用列表存放錯誤信息
            print(form.errors.get("r_pwd")[0])   # 獲取到報錯信息：This field is required.
        """
        form.is_valid()  校驗返回布爾值
        if 全部的字段校驗成功，則form.cleaned_data:{"name": "yuan", "email": "123@qq.com"}
        若是校驗失敗，則form.errors放入全部錯誤的字段。
        """
        return HttpResponse("OK")
    return render(request, "reg.html")

注意：html

（1）引入forms組件，定義的類必須繼承forms.Form，forms類定義過的屬性默認非空。java

from django import forms   # 引入forms組件

class UserForm(forms.Form):   # 必須繼承forms.Form
    name = forms.CharField(min_length=4)
    pwd = forms.CharField(min_length=4)
    r_pwd = forms.CharField(min_length=4)
    email = forms.EmailField()
    tel = forms.CharField()

（2）生成forms對象，須要注意的是給對象傳入字典就能夠作一個個值的校驗：python

form = UserForm({"name": "yuan", "email": "123@qq.com", "xxx":"alex"})

　　可是咱們須要的是form表單屬性與forms組件字段的校驗，所以須要把request.POST傳入forms對象：git

form = UserForm(request.POST)

　　form表單的name屬性值應該與forms組件的字段名稱一致，不一致的鍵值不會去作校驗。正則表達式

（3）form.is_valid() ：作校驗返回布爾值的,全部都經過才返回True，不然返回False。與forms組件字段無關的鍵值不影響返回結果。數據庫

if form.is_valid():  # 注意：form.is_valid是幫忙校驗返回布爾值的,true或false（全部都經過才返回true）
    # 類定義的字段均符合要求，返回true，有多的字段直接忽略
    print(form.cleaned_data)   # {'name': 'yuan', 'pwd': '1234', 'r_pwd': '1234', 'email': '1234@163.com', 'tel': '123123'}
else:
    # 有正確也有錯誤信息也是返回false
    print(form.cleaned_data)   # 字段值符合要求的放在cleaned_data    {'name': 'yuan', 'pwd': '123456', 'tel': '123123'}
    print(form.errors)         # 字段不符合要求的對應的鍵做爲鍵，錯誤信息做爲值   <ul class="errorlist"><li>r_pwd<ul class="errorlist">...

（4）form.cleaned_data：字段值符合要求的放在cleaned_data中。字典數據類型。django

（5）form.errors：字段不符合要求的對應的鍵做爲鍵，錯誤信息做爲值。雖然返回結果比較複雜，但依然是字典數據類型，能夠經過form.errors.get(「不符合的鍵」)來拿到鍵值，鍵值爲列表數據類型。所以能夠經過form.errors.get("不符合鍵")[0]拿到錯誤信息。bootstrap

2、渲染標籤功能

一、渲染方式一：

視圖函數：將forms空對象傳給模板

from django import forms   # 引入forms組件

class UserForm(forms.Form):   # 必須繼承forms.Form
    # forms.CharField和forms.EmailField會渲染爲input標籤
    name = forms.CharField(min_length=4)    # 默認label是字段名
    pwd = forms.CharField(min_length=4, label="密碼")   # 若是須要中文label能夠手動設置
    r_pwd = forms.CharField(min_length=4, label="確認密碼")
    email = forms.EmailField(label="郵箱")
    tel = forms.CharField(label="手機")

def reg(request):
    form = UserForm()
    return render(request, "reg.html", locals())

模板：

<h3>form組件渲染方式1</h3>
<form action="" method="post">
    {% csrf_token %}
    <p>{{ form.name.label }}
        {{ form.name }}
    </p>
    <p>{{ form.pwd.label }}
        {{ form.pwd }}
    </p>
    <p>{{ form.r_pwd.label }}
        {{ form.r_pwd }}
    </p>
    <p>{{ form.email.label }}
        {{ form.email }}
    </p>
    <p>{{ form.tel.label }}
        {{ form.tel }}
    </p>
    <input type="submit">
</form>

渲染效果：

二、渲染方式二

　　其餘與方式一同理，可是用for循環獲取forms對象內字段。

<h3>forms組件渲染方式2</h3>
<form action="" method="post">
    {% csrf_token %}
    {% for field in form %}
        <p>
            <label for="">{{ field.label }}</label>
            {{ field }}
        </p>
    {% endfor %}
    <input type="submit">
</form>

　　渲染效果：

三、渲染方式三

　　調用form對象的組件：as_p，即完成渲染。缺點是結構固定。(還有一種是as_ul)

<hr>
<h3>forms組件渲染方式3</h3>
<form action="" method="post">
    {% csrf_token %}
    {{ form.as_p }}
</form>

　　渲染效果：

3、顯示錯誤與重置輸入信息功能

一、視圖

def reg(request):
    if request.method=="POST":
        form = UserForm(request.POST)   # 綁定數據的form表單
        print(form.is_valid())     # 返回True/False
        if form.is_valid():
            # 類定義的字段均符合要求，返回true，有多的字段直接忽略
            print(form.cleaned_data)     #全部乾淨字段及對應的值 
        else:
            # 有正確也有錯誤信息也是返回false
            print(form.cleaned_data) 
            # print(form.errors)                 # ErrorDict : {"校驗錯誤的字段":["錯誤信息",]}      
            # print(form.errors.get("name"))     # ErrorList ["錯誤信息",]
        return render(request, "reg.html", locals())

    form = UserForm()   # 未綁定數據的form表單
    return render(request, "reg.html", locals())

二、模板

<h3>顯示錯誤與重置輸入信息</h3>
<form action="" method="post">
    {% csrf_token %}
    <p>{{ form.name.label }}
        {{ form.name }} <span>{{ form.name.errors.0 }}</span>
    </p>
    <p>{{ form.pwd.label }}
        {{ form.pwd }} <span>{{ form.pwd.errors.0 }}</span>
    </p>
    <p>{{ form.r_pwd.label }}
        {{ form.r_pwd }} <span>{{ form.r_pwd.errors.0 }}</span>
    </p>
    <p>{{ form.email.label }}
        {{ form.email }} <span>{{ form.email.errors.0 }}</span>
    </p>
    <p>{{ form.tel.label }}
        {{ form.tel }} <span>{{ form.tel.errors.0 }}</span>
    </p>
    <input type="submit">
</form>

4、forms組件的參數配置

　　上面完成的註冊頁面，顯示效果比較糟糕。所以須要引入widgets模塊來調整組件參數配置，優化小時效果。

一、reg.html引入樣式

　　模板引入bootstrap，並僅保留渲染方式一輩子成的註冊登陸頁面。

<head>
    <link rel="stylesheet" href="/static/bootstrap-3.3.7/css/bootstrap.css">
</head>

<div class="container">
    <div class="row">
        <div class="col-md-6 col-lg-offset-3">
            <hr>
            <h3>form組件渲染方式1</h3>
            <form action="" method="post">
                {% csrf_token %}
                <p>{{ form.name.label }}
                    {{ form.name }} <span>{{ form.name.errors.0 }}</span>
                </p>
                <p>{{ form.pwd.label }}
                    {{ form.pwd }} <span>{{ form.pwd.errors.0 }}</span>
                </p>
                <p>{{ form.r_pwd.label }}
                    {{ form.r_pwd }} <span>{{ form.r_pwd.errors.0 }}</span>
                </p>
                <p>{{ form.email.label }}
                    {{ form.email }} <span>{{ form.email.errors.0 }}</span>
                </p>
                <p>{{ form.tel.label }}
                    {{ form.tel }} <span>{{ form.tel.errors.0 }}</span>
                </p>
                <input type="submit">
            </form>

二、在視圖層引入widgets模塊，配置修改forms類參數

from django.shortcuts import render,HttpResponse
# Create your views here.
from django import forms   # 引入forms組件
from django.forms import widgets

class UserForm(forms.Form):   # 必須繼承forms.Form
    # forms.CharField和forms.EmailField會渲染爲input標籤
    name = forms.CharField(min_length=4, label="用戶名", error_messages={"requried": "該字段不能爲空"},
                           widget=widgets.TextInput(attrs={"class": "form-control"})
                           )
    pwd = forms.CharField(min_length=4, label="密碼",   # 若是須要中文label能夠手動設置
                          widget=widgets.PasswordInput(attrs={"class": "form-control"})  # 生成密文文本輸入框
                          )
    r_pwd = forms.CharField(min_length=4, label="確認密碼",
                            widget=widgets.TextInput(attrs={"class": "form-control"}))
    email = forms.EmailField(label="郵箱", error_messages={"requried": "該字段不能爲空", "invalid": "格式錯誤"},
                             widget=widgets.EmailInput(attrs={"class": "form-control"})
                             )  # invalid修改格式錯誤提示
    tel = forms.CharField(label="手機",error_messages={"requried": "該字段不能爲空"},
                          widget=widgets.TextInput(attrs={"class": "form-control"})

注意：

　　（1）在字段構造參數中設置"error_messages"修改字段錯誤提示消息：其中"requried"負責字段不能爲空消息提示；"invalid"負責格式錯誤消息提示等。

　　（2）在字段構造函數中配置input類型:設置爲文本域、密碼域、單選框、複選框等等類型。

widget=widgets.TextInput()
widget=widgets.PasswordInput()
widget=widgets.EmailInput()

　　（2）給字段構造函數中配置修改屬性。好比給type="text"的input標籤設置bootstrap樣式，給input標籤添加類"form-control"。

顯示效果：

5、局部鉤子和全局鉤子

　　爲了將代碼解耦能夠選擇本身建立一個文件好比app01/myform.py存放鉤子。

一、myform.py:

# forms組件
from django.forms import widgets

wid_01=widgets.TextInput(attrs={"class":"form-control"})
wid_02=widgets.PasswordInput(attrs={"class":"form-control"})

from django.core.exceptions import ValidationError
class UserForm(forms.Form):
    name=forms.CharField(max_length=32,
                         widget=wid_01
                         )
    pwd=forms.CharField(max_length=32,widget=wid_02)
    r_pwd=forms.CharField(max_length=32,widget=wid_02)
    email=forms.EmailField(widget=wid_01)
    tel=forms.CharField(max_length=32,widget=wid_01)


    # 局部鉤子
    def clean_name(self):
        val=self.cleaned_data.get("name")
        if not val.isdigit():
            return val
        else:
            raise ValidationError("用戶名不能是純數字!")

    # 全局鉤子
    def clean(self):
        pwd=self.cleaned_data.get("pwd")
        r_pwd=self.cleaned_data.get("r_pwd")

        if pwd==r_pwd:
            return self.cleaned_data
        else:
            raise ValidationError('兩次密碼不一致!')

views.py:

from django.shortcuts import render,HttpResponse
# Create your views here.
from app01.myforms import *

def reg(request):
    if request.method=="POST":
        form = UserForm(request.POST)   # 綁定數據的form表單
        if form.is_valid(): 
            # 類定義的字段均符合要求，返回true，有多的字段直接忽略
            print(form.cleaned_data) 
        else:
            print(form.cleaned_data)   # 字段值符合要求的放在cleaned_data    {'name': 'yuan', 'pwd': '123456', 'tel': '123123'}

            # 全局鉤子錯誤
            # print("error", form.errors.get("__all__")[0])
            errors = form.errors.get("__all__")

            return render(request, "reg.html", locals())

    form = UserForm()   # 未綁定數據的form表單
    return render(request, "reg.html", locals())

reg.html:

 <form action="" method="post" novalidate>
            {% csrf_token %}

            {% for field in form %}
                <div>
                    <label for="">{{ field.label }}</label>
                    {{ field }}
                    <span class="pull-right" style="color: red">
                          {% if field.label == 'R pwd' %}
                          <span>{{ clean_error.0 }}</span>
                          {% endif %}
                          {{ field.errors.0 }}
                    </span>
                </div>
            {% endfor %}
            <input type="submit" class="btn btn-default">

</form>

6、Forms組件歸類及補充

Django的Form主要具備一下幾大功能：

生成HTML標籤
驗證用戶數據（顯示錯誤信息）
HTML Form提交保留上次提交數據
初始化頁面顯示內容

一、Django內置字段：

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