1. 程式人生 > >Django-form表單

Django-form表單

gist 第一個 例子 構建 ole 最短 輸入 his 用戶


構建一個表單

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

?
1 2 3 4 5 <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 來為我們完成大部分工作是很容易的。

在Django 中構建一個表單

Form 類

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

?
1 2 3 4 5 6 #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屬性中。

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

?
1 2 <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 模板中做很多工作。最簡單的例子是:

?
1 2 3 4 5 <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()
    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將是一個布爾值。類似地,IntegerFieldFloatField 字段分別將值轉換為Python 的intfloat

使用表單模板

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

表單渲染的選項

對於<label>/<input> 對,還有幾個輸出選項:

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

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

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

+ View Code?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 <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 模板中正確地渲染。例如:

?
1 2 3 4 5 <div class="fieldWrapper"> {{ form.Username.errors }} {{ form.Username.label_tag }} {{ form.Username }} </div>

渲染表單的錯誤信息

1、

?
1 2 3 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。看上去可能像:

?
1 2 3 <ul class="errorlist"> <li>Sender is required.</li> </ul>

Django-form表單