Flask 使用 WTForms 進行表單驗證

2021-08-11 10:11 更新

如果您不得不跟瀏覽器提交的表單數(shù)據(jù)打交道,視圖函數(shù)里的代碼將會很快變得 難以閱讀。有不少的代碼庫被開發(fā)用來簡化這個過程的操作。其中一個就是 WTForms , 這也是我們今天主要討論的。如果您發(fā)現(xiàn)您自己陷入處理很多表單的境地,那您也許 應(yīng)該嘗試一下他。

要使用 WTForms ,您需要先將您的表單定義為類。我建議您將應(yīng)用分割為多個模塊 (大型應(yīng)用) ,這樣的話您僅需為表單添加一個獨立的模塊。

挖掘 WTForms 的最大潛力

Flask-WTF 擴展在這個模式的基礎(chǔ)上擴展并添加了一些隨手即得的精巧 的幫助函數(shù),這些函數(shù)將會使在 Flask 里使用表單更加有趣,您可以通過 PyPI 獲取它。

表單

以下是一個典型的注冊頁面的例子:

from wtforms import Form, BooleanField, TextField, PasswordField, validators

class RegistrationForm(Form):
    username = TextField('Username', [validators.Length(min=4, max=25)])
    email = TextField('Email Address', [validators.Length(min=6, max=35)])
    password = PasswordField('New Password', [
        validators.Required(),
        validators.EqualTo('confirm', message='Passwords must match')
    ])
    confirm = PasswordField('Repeat Password')
    accept_tos = BooleanField('I accept the TOS', [validators.Required()])

在視圖里

在視圖函數(shù)中,表單的使用是像下面這個樣子的:

@app.route('/register', methods=['GET', 'POST'])
def register():
    form = RegistrationForm(request.form)
    if request.method == 'POST' and form.validate():
        user = User(form.username.data, form.email.data,
                    form.password.data)
        db_session.add(user)
        flash('Thanks for registering')
        return redirect(url_for('login'))
    return render_template('register.html', form=form)

注意到我們視圖中使用了 SQLAlchemy (參考 在 Flask 中使用 SQLAlchemy )。但是 這并非必要的,請按照您的需要修正代碼。

備忘表:

  1. 如果數(shù)據(jù)是以 POST 方式提交的,那么基于請求的 form 屬性的值創(chuàng)建表單。反過來,如果是使用 GET 提交的,就從 args 屬性創(chuàng)建。
  2. 驗證表單數(shù)據(jù),調(diào)用 validate() 方法。如果數(shù)據(jù)驗證 通過,此方法將會返回 True ,否則返回 False 。
  3. 訪問表單的單個值,使用 form.<NAME>.data 。

在模板中使用表單

在模板這邊,如果您將表單傳遞給模板,您可以很容易地渲染他們。參看如下代碼, 您就會發(fā)現(xiàn)這有多么簡單了。WTForms 已經(jīng)為我們完成了一半的表單生成工作。更 棒的是,我們可以編寫一個宏來渲染表單的字段,讓這個字段包含一個標簽,如果 存在驗證錯誤,則列出列表來。

以下是一個使用這種宏的 _formhelpers.html 模板的例子:

{% macro render_field(field) %}
  <dt>{{ field.label }}
  <dd>{{ field(**kwargs)|safe }}
  {% if field.errors %}
    <ul class=errors>
    {% for error in field.errors %}
      <li>{{ error }}</li>
    {% endfor %}
    </ul>
  {% endif %}
  </dd>
{% endmacro %}

這些宏接受一對鍵值對,WTForms 的字段函數(shù)接收這個宏然后為我們渲染他們。 鍵值對參數(shù)將會被轉(zhuǎn)化為 HTML 屬性,所以在這個例子里,您可以調(diào)用 render_field(form.username,class="username") 來將一個類添加到這個 輸入框元素中。請注意 WTForms 返回標準 Python unicode 字符串,所以我們 使用 |safe 告訴 Jinjan2 這些數(shù)據(jù)已經(jīng)是經(jīng)過 HTML 過濾處理的了。

以下是 register.html 模板,它對應(yīng)于上面我們使用過的函數(shù),同時也利用 了 _formhelpers.html 模板:

{% from "_formhelpers.html" import render_field %}
<form method=post action="/register">
  <dl>
    {{ render_field(form.username) }}
    {{ render_field(form.email) }}
    {{ render_field(form.password) }}
    {{ render_field(form.confirm) }}
    {{ render_field(form.accept_tos) }}
  </dl>
  <p><input type=submit value=Register>
</form>

關(guān)于 WTForms 的更多信息,請訪問 WTForms 網(wǎng)站 。


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號