Django之form表單詳解
構建一個表單
假設你想在你的網站上建立一個簡單的表單，以獲得使用者的名字。你需要類似這樣的模板：
<form action="/your-name/" method="post">
<label for="your_name">Your name: </label>
<input id="your_name" type="text" name="your_name">
<input type="submit" value="OK">
</form>
這是一個非常簡單的表單。實際應用中，一個表單可能包含幾十上百個欄位，其中大部分需要預填充，而且我們預料到使用者將來回編輯-提交幾次才能完成操作。
我們可能需要在表單提交之前，在瀏覽器端作一些驗證。我們可能想使用非常複雜的欄位，以允許使用者做類似從日曆中挑選日期這樣的事情，等等。
這個時候，讓Django 來為我們完成大部分工作是很容易的。
so,兩個突出優點：
1 form表單提交時，資料出現錯誤，返回的頁面中仍可以保留之前輸入的資料。
2 方便地限制欄位條件
在Django 中構建一個表單
Form 類
我們已經計劃好了我們的 HTML 表單應該呈現的樣子。在Django 中，我們的起始點是這裡：
#forms.py
from django import forms
class NameForm(forms.Form):
your_name = forms.CharField(label='Your name', max_length=100)
它定義一個Form 類，只帶有一個欄位（your_name）。
欄位允許的最大長度通過max_length 定義。它完成兩件事情。首先，它在HTML 的<input> 上放置一個maxlength="100"（這樣瀏覽器將在第一時間阻止使用者輸入多於這個數目的字元）。它還意味著當Django 收到瀏覽器傳送過來的表單時，它將驗證資料的長度。
Form 的例項具有一個is_valid() 方法，它為所有的欄位執行驗證的程式。當呼叫這個方法時，如果所有的欄位都包含合法的資料，它將：
- 返回
True - 將表單的資料放到
cleaned_data屬性中。
完整的表單，第一次渲染時，看上去將像：
<label for="your_name">Your name: </label> <input id="your_name" type="text" name="your_name" maxlength="100">
注意它不包含 <form> 標籤和提交按鈕。我們必須自己在模板中提供它們。
檢視
傳送給Django 網站的表單資料通過一個檢視處理，一般和釋出這個表單的是同一個檢視。這允許我們重用一些相同的邏輯。
當處理表單時，我們需要在檢視中例項化它：
#views.py
from django.shortcuts import render
from django.http import HttpResponseRedirect
from .forms import NameForm
def get_name(request):
# if this is a POST request we need to process the form data
if request.method == 'POST':
# create a form instance and populate it with data from the request:
form = NameForm(request.POST)
# check whether it's valid:
if form.is_valid():
# process the data in form.cleaned_data as required
# ...
# redirect to a new URL:
return HttpResponseRedirect('/thanks/')
# if a GET (or any other method) we'll create a blank form
else:
form = NameForm()
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 action="/your-name/" method="post">
{% csrf_token %}
{{ form }}
<input type="submit" value="Submit" />
</form>
根據{{ form }}，所有的表單欄位和它們的屬性將通過Django 的模板語言拆分成HTML 標記 。
注：Django 原生支援一個簡單易用的跨站請求偽造的防護。當提交一個啟用CSRF 防護的POST 表單時，你必須使用上面例子中的csrf_token 模板標籤。
現在我們有了一個可以工作的網頁表單，它通過Django Form 描述、通過檢視處理並渲染成一個HTML <form>。
Django Form 類詳解
繫結的和未繫結的表單例項
繫結的和未繫結的表單 之間的區別非常重要：
- 未繫結的表單沒有關聯的資料。當渲染給使用者時，它將為空或包含預設的值。
- 繫結的表單具有提交的資料，因此可以用來檢驗資料是否合法。如果渲染一個不合法的繫結的表單，它將包含內聯的錯誤資訊，告訴使用者如何糾正資料。
欄位詳解
考慮一個比上面的迷你示例更有用的一個表單，我們完成一個更加有用的登錄檔單：
#forms.py
from django import forms
class RegisterForm(forms.Form):
username = forms.CharField(max_length=100,
error_messages={"min_length":"最短為5個字元","required":"該欄位不能為空"},
)
password = forms.CharField(max_length=100,
widget=widgets.PasswordInput(attrs={"placeholder":"password"})
)
telephone=forms.IntegerField(
error_messages={
"invalid":"格式錯誤"
}
)
gender=forms.CharField(
initial=2,
widget=widgets.Select(choices=((1,'上海'),(2,'北京'),))
)
email = forms.EmailField()
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 }}會渲染如下：
<form action="">
<p>
<label for="id_username">Username:</label>
<input id="id_username" maxlength="100" name="username" type="text" required="">
</p>
<p>
<label for="id_password">Password:</label>
<input id="id_password" maxlength="100" name="password" placeholder="password" type="password" required="">
</p>
<p>
<label for="id_telephone">Telephone:</label> <input id="id_telephone" name="telephone" type="number" required="">
</p>
<p>
<label for="id_email">Email:</label> <input id="id_email" name="email" type="email" required="">
</p>
<p>
<label for="id_is_married">Is married:</label> <input id="id_is_married" name="is_married" type="checkbox">
</p>
<input type="submit" value="註冊">
</form>
手工渲染欄位
我們沒有必要非要讓Django 來分拆表單的欄位；如果我們喜歡，我們可以手工來做（例如，這樣允許重新對欄位排序）。每個欄位都是表單的一個屬性，可以使用{{ form.name_of_field }} 訪問，並將在Django 模板中正確地渲染。例如：
<div class="fieldWrapper">
{{ form.Username.errors }}
{{ form.Username.label_tag }}
{{ form.Username }}
</div>
渲染表單的錯誤資訊
1、
registerForm=RegisterForm(request.POST) print(type(registerForm.errors)) #<class 'django.forms.utils.ErrorDict'> print(type(registerForm.errors["username"])) #<class 'django.forms.utils.ErrorList'>
2、
使用{{ form.name_of_field.errors }} 顯示錶單錯誤的一個清單，並渲染成一個ul。看上去可能像：
<ul class="errorlist">
<li>Sender is required.</li>
</ul>
form元件的鉤子
def foo(request):
if request.method=="POST":
regForm=RegForm(request.POST)
if regForm.is_valid():
pass
# 可用資料: regForm.cleaned_data,
# 將資料插入資料庫表中
else:
pass
# 可用資料: regForm.errors
# 可以利用模板渲染講errors巢狀到頁面中返回
# 也可以打包到一個字典中,用於ajax返回
else:
regForm=RegForm()
return render(request,"register.html",{"regForm":regForm})
'''
例項化時:
self.fields={
"username":"欄位規則物件",
"password":"欄位規則物件",
}
is_valid時:
self._errors = {}
self.cleaned_data = {}
#區域性鉤子:
for name, field in self.fields.items():
try:
value = field.clean(value)
self.cleaned_data[name] = value
if hasattr(self, 'clean_%s' % name):
value = getattr(self, 'clean_%s' % name)()
self.cleaned_data[name] = value
except ValidationError as e:
self.add_error(name, e)
# 全域性鉤子:
self.clean() # def self.clean():return self.cleaned_data
return not self.errors # True或者False
'''
form元件補充
1、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型別
...
2、Django內建外掛：
View Code
3、常用選擇外掛：
View Code