構建一個表單

假設你想在你的網站上創建一個簡單的表單，以獲得用戶的名字。你需要類似這樣的模板：

這是一個非常簡單的表單。實際應用中，一個表單可能包含幾十上百個字段，其中大部分需要預填充，而且我們預料到用戶將來回編輯-提交幾次才能完成操作。

我們可能需要在表單提交之前，在瀏覽器端作一些驗證。我們可能想使用非常復雜的字段，以允許用戶做類似從日歷中挑選日期這樣的事情，等等。

這個時候，讓Django 來為我們完成大部分工作是很容易的。

so,兩個突出優點：

1 form表單提交時，數據出現錯誤，返回的頁面中仍可以保留之前輸入的數據。

2 方便地限制字段條件

在Django 中構建一個表單

Form 類

我們已經計劃好了我們的 HTML 表單應該呈現的樣子。在Django 中，我們的起始點是這裏：

它定義一個Form 類，只帶有一個字段（your_name）。

字段允許的最大長度通過max_length 定義。它完成兩件事情。首先，它在HTML 的<input> 上放置一個maxlength="100"（這樣瀏覽器將在第一時間阻止用戶輸入多於這個數目的字符）。它還意味著當Django 收到瀏覽器發送過來的表單時，它將驗證數據的長度。

Form 的實例具有一個is_valid() 方法，它為所有的字段運行驗證的程序。當調用這個方法時，如果所有的字段都包含合法的數據，它將：

• 返回True
• 將表單的數據放到cleaned_data屬性中。

完整的表單，第一次渲染時，看上去將像：

註意它不包含 <form> 標簽和提交按鈕。我們必須自己在模板中提供它們。

視圖

發送給Django 網站的表單數據通過一個視圖處理，一般和發布這個表單的是同一個視圖。這允許我們重用一些相同的邏輯。

當處理表單時，我們需要在視圖中實例化它：

 1 #views.py
 2 
 3 from django.shortcuts import render
 4 from django.http import HttpResponseRedirect
 5 
 6 from .forms import NameForm
 7 
 8 def get_name(request):
 9     # if this is a POST request we need to process the form data
10     if request.method == ‘POST‘:
11         # create a form instance and populate it with data from the request:
12         form = NameForm(request.POST)
13         # check whether it‘s valid:
14         if form.is_valid():
15             # process the data in form.cleaned_data as required
16             # ...
17             # redirect to a new URL:
18             return HttpResponseRedirect(‘/thanks/‘)
19 
20     # if a GET (or any other method) we‘ll create a blank form
21     else:
22         form = NameForm()
23 
24     return render(request, ‘name.html‘, {‘form‘: form})

如果訪問視圖的是一個GET 請求，它將創建一個空的表單實例並將它放置到要渲染的模板的上下文中。這是我們在第一個訪問該URL 時預期發生的情況。

如果表單的提交使用POST 請求，那麽視圖將再次創建一個表單實例並使用請求中的數據填充它：form = NameForm(request.POST)。這叫做”綁定數據至表單“（它現在是一個綁定的表單）。

我們調用表單的is_valid()方法；如果它不為True，我們將帶著這個表單返回到模板。這時表單不再為空（未綁定），所以HTML 表單將用之前提交的數據填充，然後可以根據要求編輯並改正它。

如果is_valid()為True，我們將能夠在cleaned_data 屬性中找到所有合法的表單數據。在發送HTTP 重定向給瀏覽器告訴它下一步的去向之前，我們可以用這個數據來更新數據庫或者做其它處理。

模板

我們不需要在name.html 模板中做很多工作。最簡單的例子是：

根據{{ form }}，所有的表單字段和它們的屬性將通過Django 的模板語言拆分成HTML 標記 。

註：Django 原生支持一個簡單易用的跨站請求偽造的防護。當提交一個啟用CSRF 防護的POST 表單時，你必須使用上面例子中的csrf_token 模板標簽。

現在我們有了一個可以工作的網頁表單，它通過Django Form 描述、通過視圖處理並渲染成一個HTML <form>。

Django Form 類詳解

綁定的和未綁定的表單實例

綁定的和未綁定的表單 之間的區別非常重要：

• 未綁定的表單沒有關聯的數據。當渲染給用戶時，它將為空或包含默認的值。
• 綁定的表單具有提交的數據，因此可以用來檢驗數據是否合法。如果渲染一個不合法的綁定的表單，它將包含內聯的錯誤信息，告訴用戶如何糾正數據。

字段詳解

考慮一個比上面的迷你示例更有用的一個表單，我們完成一個更加有用的註冊表單：

 1 #forms.py
 2 
 3 from django import forms
 4 
 5 class RegisterForm(forms.Form):
 6     username = forms.CharField(max_length=100,
 7                                error_messages={"min_length":"最短為5個字符","required":"該字段不能為空"},
 8                                )
 9     password = forms.CharField(max_length=100,
10                                widget=widgets.PasswordInput(attrs={"placeholder":"password"})
11                                 )
12 
13     telephone=forms.IntegerField(
14         error_messages={
15             "invalid":"格式錯誤"
16         }
17 
18                                 )
19 
20 
21     gender=forms.CharField(
22           initial=2,
23           widget=widgets.Select(choices=((1,‘上海‘),(2,‘北京‘),))
24              )
25 
26     email = forms.EmailField()
27     is_married = forms.BooleanField(required=False)

Widgets

每個表單字段都有一個對應的Widget 類，它對應一個HTML 表單Widget，例如<input type="text">。

在大部分情況下，字段都具有一個合理的默認Widget。例如，默認情況下，CharField 具有一個TextInput Widget，它在HTML 中生成一個<input type="text">。

字段的數據

不管表單提交的是什麽數據，一旦通過調用is_valid() 成功驗證（is_valid() 返回True），驗證後的表單數據將位於form.cleaned_data 字典中。這些數據已經為你轉換好為Python 的類型。

註：此時，你依然可以從request.POST 中直接訪問到未驗證的數據，但是訪問驗證後的數據更好一些。

在上面的聯系表單示例中，is_married將是一個布爾值。類似地，IntegerField 和FloatField 字段分別將值轉換為Python 的int 和float。

使用表單模板

你需要做的就是將表單實例放進模板的上下文。如果你的表單在Context 中叫做form，那麽{{ form }}將正確地渲染它的<label> 和 <input>元素。

表單渲染的選項

對於<label>/<input> 對，還有幾個輸出選項：

• {{ form.as_table }} 以表格的形式將它們渲染在<tr> 標簽中
• {{ form.as_p }} 將它們渲染在<p> 標簽中
• {{ form.as_ul }} 將它們渲染在<li> 標簽中

註意，你必須自己提供<table> 或<ul> 元素。

{{ form.as_p }}會渲染如下：

手工渲染字段

我們沒有必要非要讓Django 來分拆表單的字段；如果我們喜歡，我們可以手工來做（例如，這樣允許重新對字段排序）。每個字段都是表單的一個屬性，可以使用{{ form.name_of_field }} 訪問，並將在Django 模板中正確地渲染。例如：

渲染表單的錯誤信息

1、

2、

使用{{ form.name_of_field.errors }} 顯示表單錯誤的一個清單，並渲染成一個ul。看上去可能像：

form組件的鉤子

 1 def foo(request):
 2 
 3 
 4     if request.method=="POST":
 5 
 6         regForm=RegForm(request.POST)
 7 
 8         if regForm.is_valid():
 9             pass
10             # 可用數據: regForm.cleaned_data,
11             # 將數據插入數據庫表中
12 
13 
14         else:
15             pass
16             # 可用數據: regForm.errors
17             # 可以利用模板渲染講errors嵌套到頁面中返回
18             # 也可以打包到一個字典中,用於ajax返回
19 
20     else:
21         regForm=RegForm()
22     return render(request,"register.html",{"regForm":regForm})
23 
24     
25 
26     ‘‘‘
27     實例化時:
28 
29         self.fields={
30             "username":"字段規則對象",
31             "password":"字段規則對象",
32 
33         }
34 
35 
36     is_valid時:
37 
38         self._errors = {}
39         self.cleaned_data = {}
40 
41 
42         #局部鉤子:
43 
44         for name, field in self.fields.items():
45               try:
46 
47                     value = field.clean(value)
48                     self.cleaned_data[name] = value
49                     if hasattr(self, ‘clean_%s‘ % name):
50                         value = getattr(self, ‘clean_%s‘ % name)()
51                         self.cleaned_data[name] = value
52               except ValidationError as e:
53                     self.add_error(name, e)
54 
55         # 全局鉤子:
56 
57         self.clean()     # def self.clean():return self.cleaned_data
58 
59         return  not self.errors    # True或者False
60 
61 
62     ‘‘‘

form組件補充

1、Django內置字段如下：

  1 Field
  2     required=True,               是否允許為空
  3     widget=None,                 HTML插件
  4     label=None,                  用於生成Label標簽或顯示內容
  5     initial=None,                初始值
  6     help_text=‘‘,                幫助信息(在標簽旁邊顯示)
  7     error_messages=None,         錯誤信息 {‘required‘: ‘不能為空‘, ‘invalid‘: ‘格式錯誤‘}
  8     show_hidden_initial=False,   是否在當前插件後面再加一個隱藏的且具有默認值的插件（可用於檢驗兩次輸入是否一直）
  9     validators=[],               自定義驗證規則
 10     localize=False,              是否支持本地化
 11     disabled=False,              是否可以編輯
 12     label_suffix=None            Label內容後綴
 13  
 14  
 15 CharField(Field)
 16     max_length=None,             最大長度
 17     min_length=None,             最小長度
 18     strip=True                   是否移除用戶輸入空白
 19  
 20 IntegerField(Field)
 21     max_value=None,              最大值
 22     min_value=None,              最小值
 23  
 24 FloatField(IntegerField)
 25     ...
 26  
 27 DecimalField(IntegerField)
 28     max_value=None,              最大值
 29     min_value=None,              最小值
 30     max_digits=None,             總長度
 31     decimal_places=None,         小數位長度
 32  
 33 BaseTemporalField(Field)
 34     input_formats=None          時間格式化   
 35  
 36 DateField(BaseTemporalField)    格式：2015-09-01
 37 TimeField(BaseTemporalField)    格式：11:12
 38 DateTimeField(BaseTemporalField)格式：2015-09-01 11:12
 39  
 40 DurationField(Field)            時間間隔：%d %H:%M:%S.%f
 41     ...
 42  
 43 RegexField(CharField)
 44     regex,                      自定制正則表達式
 45     max_length=None,            最大長度
 46     min_length=None,            最小長度
 47     error_message=None,         忽略，錯誤信息使用 error_messages={‘invalid‘: ‘...‘}
 48  
 49 EmailField(CharField)      
 50     ...
 51  
 52 FileField(Field)
 53     allow_empty_file=False     是否允許空文件
 54  
 55 ImageField(FileField)      
 56     ...
 57     註：需要PIL模塊，pip3 install Pillow
 58     以上兩個字典使用時，需要註意兩點：
 59         - form表單中 enctype="multipart/form-data"
 60         - view函數中 obj = MyForm(request.POST, request.FILES)
 61  
 62 URLField(Field)
 63     ...
 64  
 65  
 66 BooleanField(Field)  
 67     ...
 68  
 69 NullBooleanField(BooleanField)
 70     ...
 71  
 72 ChoiceField(Field)
 73     ...
 74     choices=(),                選項，如：choices = ((0,‘上海‘),(1,‘北京‘),)
 75     required=True,             是否必填
 76     widget=None,               插件，默認select插件
 77     label=None,                Label內容
 78     initial=None,              初始值
 79     help_text=‘‘,              幫助提示
 80  
 81  
 82 ModelChoiceField(ChoiceField)
 83     ...                        django.forms.models.ModelChoiceField
 84     queryset,                  # 查詢數據庫中的數據
 85     empty_label="---------",   # 默認空顯示內容
 86     to_field_name=None,        # HTML中value的值對應的字段
 87     limit_choices_to=None      # ModelForm中對queryset二次篩選
 88      
 89 ModelMultipleChoiceField(ModelChoiceField)
 90     ...                        django.forms.models.ModelMultipleChoiceField
 91  
 92  
 93      
 94 TypedChoiceField(ChoiceField)
 95     coerce = lambda val: val   對選中的值進行一次轉換
 96     empty_value= ‘‘            空值的默認值
 97  
 98 MultipleChoiceField(ChoiceField)
 99     ...
100  
101 TypedMultipleChoiceField(MultipleChoiceField)
102     coerce = lambda val: val   對選中的每一個值進行一次轉換
103     empty_value= ‘‘            空值的默認值
104  
105 ComboField(Field)
106     fields=()                  使用多個驗證，如下：即驗證最大長度20，又驗證郵箱格式
107                                fields.ComboField(fields=[fields.CharField(max_length=20), fields.EmailField(),])
108  
109 MultiValueField(Field)
110     PS: 抽象類，子類中可以實現聚合多個字典去匹配一個值，要配合MultiWidget使用
111  
112 SplitDateTimeField(MultiValueField)
113     input_date_formats=None,   格式列表：[‘%Y--%m--%d‘, ‘%m%d/%Y‘, ‘%m/%d/%y‘]
114     input_time_formats=None    格式列表：[‘%H:%M:%S‘, ‘%H:%M:%S.%f‘, ‘%H:%M‘]
115  
116 FilePathField(ChoiceField)     文件選項，目錄下文件顯示在頁面中
117     path,                      文件夾路徑
118     match=None,                正則匹配
119     recursive=False,           遞歸下面的文件夾
120     allow_files=True,          允許文件
121     allow_folders=False,       允許文件夾
122     required=True,
123     widget=None,
124     label=None,
125     initial=None,
126     help_text=‘‘
127  
128 GenericIPAddressField
129     protocol=‘both‘,           both,ipv4,ipv6支持的IP格式
130     unpack_ipv4=False          解析ipv4地址，如果是::ffff:192.0.2.1時候，可解析為192.0.2.1， PS：protocol必須為both才能啟用
131  
132 SlugField(CharField)           數字，字母，下劃線，減號（連字符）
133     ...
134  
135 UUIDField(CharField)           uuid類型
136     ...

2、Django內置插件：

 1 TextInput(Input)
 2 NumberInput(TextInput)
 3 EmailInput(TextInput)
 4 URLInput(TextInput)
 5 PasswordInput(TextInput)
 6 HiddenInput(TextInput)
 7 Textarea(Widget)
 8 DateInput(DateTimeBaseInput)
 9 DateTimeInput(DateTimeBaseInput)
10 TimeInput(DateTimeBaseInput)
11 CheckboxInput
12 Select
13 NullBooleanSelect
14 SelectMultiple
15 RadioSelect
16 CheckboxSelectMultiple
17 FileInput
18 ClearableFileInput
19 MultipleHiddenInput
20 SplitDateTimeWidget
21 SplitHiddenDateTimeWidget
22 SelectDateWidget

3、常用選擇插件：

 1 # 單radio，值為字符串
 2 # user = fields.CharField(
 3 #     initial=2,
 4 #     widget=widgets.RadioSelect(choices=((1,‘上海‘),(2,‘北京‘),))
 5 # )
 6  
 7 # 單radio，值為字符串
 8 # user = fields.ChoiceField(
 9 #     choices=((1, ‘上海‘), (2, ‘北京‘),),
10 #     initial=2,
11 #     widget=widgets.RadioSelect
12 # )
13  
14 # 單select，值為字符串
15 # user = fields.CharField(
16 #     initial=2,
17 #     widget=widgets.Select(choices=((1,‘上海‘),(2,‘北京‘),))
18 # )
19  
20 # 單select，值為字符串
21 # user = fields.ChoiceField(
22 #     choices=((1, ‘上海‘), (2, ‘北京‘),),
23 #     initial=2,
24 #     widget=widgets.Select
25 # )
26  
27 # 多選select，值為列表
28 # user = fields.MultipleChoiceField(
29 #     choices=((1,‘上海‘),(2,‘北京‘),),
30 #     initial=[1,],
31 #     widget=widgets.SelectMultiple
32 # )
33  
34  
35 # 單checkbox
36 # user = fields.CharField(
37 #     widget=widgets.CheckboxInput()
38 # )
39  
40  
41 # 多選checkbox,值為列表
42 # user = fields.MultipleChoiceField(
43 #     initial=[2, ],
44 #     choices=((1, ‘上海‘), (2, ‘北京‘),),
45 #     widget=widgets.CheckboxSelectMultiple
46 # )

from表單詳細介紹