盡管Flask的request對象提供的支持足以處理web表單，但依然有許多任務會變得單調(diào)且重復。表單的HTML代碼生成和驗證提交的表單數(shù)據(jù)就是兩個很好的例子。

Flask-WTF擴展使得處理web表單能獲得更愉快的體驗。該擴展是一個封裝了與框架無關的WTForms包的Flask集成。

Flask-WTF和它的依賴集可以通過pip來安裝：

(venv) $ pip install flask-wtf

1、跨站請求偽造（CSRF）保護
默認情況下，F(xiàn)lask-WTF保護各種形式對跨站請求偽造（CSRF）攻擊。一個CSRF攻擊發(fā)生在一個惡意網(wǎng)站發(fā)送請求給受害者登錄的其他網(wǎng)站。

為了實現(xiàn)CSRF保護，F(xiàn)lask-WTF需要應用程序去配置一個加密密鑰。Flask-WTF使用這個密鑰去生成加密令牌用于驗證請求表單數(shù)據(jù)的真實性。下面將展示如何配置加密密鑰。

示例hello.py：Flask-WTF配置

app = Flask(__name__)
app.config['SECRET_KEY'] = 'hard to guess string'

app.config字典通常是框架、擴展或應用程序自身存放配置變量的地方，可以使用標準字典語法添加配置值到app.config中。配置對象提供方法來從文件或環(huán)境導入配置值。

SECRET_KEY配置變量作為Flask和一些第三方擴展的通用加密密鑰。加密的強度取決于這個變量的值。給你構建的每個應用程序選擇不同的密鑰，并確保這個字符串不被其他任何人知道。

注：為了提高安全性，密鑰應該存儲在一個環(huán)境變量中，而不是嵌入到代碼中。這個會在第7章中描述。

2、表單類
使用Flask-WTF時，每個web表單是由繼承自Form類的子類來展現(xiàn)的。該類在表單中定義了一組表單域，每個都表示為一個對象。每個表單域都可以連接到一個或多個validators；validators是一個用于檢查用戶提交的輸入是否合法的函數(shù)。

下面的示例展示了一個擁有文本框和提交按鈕的簡單web表單。

示例hello.py：表單類定義

from flask.ext.wtf import Form
from wtforms import StringField, SubmitField 
from wtforms.validators import Required

class NameForm(Form):
 name = StringField('What is your name?', validators=[Required()]) 
 submit = SubmitField('Submit')

表單中的域被定義為類的變量，且每個類的變量都指定一個表單域類型對象。在上一個示例中，NameForm表單有一個name文本框和submit提交按鈕。StringField類表示一個type="text"屬性的<input>標簽。SubmitField類表示一個type="submit"屬性的<input>標簽。表單域構造函數(shù)的第一個參數(shù)是一個label，在渲染表單到HTML時會使用。

StringField構造函數(shù)包含可選參數(shù)validators，它定義了一組檢查來驗證用戶提交的數(shù)據(jù)。Required()驗證確保提交的表單域不為空。

注：Flask-WTF擴展定義了表單基類，所以它從flask.ext.wtf導入。表單域、驗證都是直接從WTForms包中導入。
下面的表格展示了一組WTForms支持的標準表單域。
表格WTForms標準HTML表單域

下面則展示了一組WTForms內(nèi)建驗證。
 WTForms驗證

3、HTML渲染的表單
表單域是可調(diào)用的，調(diào)用時從模板渲染它們到HTML。假設視圖函數(shù)傳遞一個參數(shù)名為form的NameForm實例給模板，模板就會生成一個簡單的HTML表單，如下所示：

<form method="POST">
 {{ form.name.label }} {{ form.name() }} 
 {{ form.submit() }}
</form>

當然，結果是什么都沒有。為了改變表單的外觀顯示，任何發(fā)送給該表單域的參數(shù)會被轉換為HTML表單域屬性；例如，你可以給定表單域id或class屬性，然后定義CSS樣式：

<form method="POST">
 {{ form.name.label }} {{ form.name(id='my-text-field') }} 
 {{ form.submit() }}
</form>

即使有HTML屬性，努力用這種方式渲染表單是非常重要的，所以最好是盡可能的使用Bootstrap自帶的一系列表單樣式。Flask-Bootstrap使用Bootstrap的預定義表單樣式來提供高級的幫助函數(shù)來渲染整個Flask-WTF表單，這些操作都只需要一個調(diào)用即可完成。使用Flask-Bootstrap，上一個表單可以像下面這樣來渲染：

{% import "bootstrap/wtf.html" as wtf %}
{{ wtf.quick_form(form) }}

import指令和常規(guī)的Python腳本一樣的作用并且允許模板元素被導入并在許多模板中使用。被導入的bootstrap/wtf.html文件，定義了幫助函數(shù)使用Bootstrap來渲染Flask-WTF表單。wtf.quick_form()函數(shù)傳入Flask-WTF表單對象并使用默認Bootstrap樣式渲染它。示例4-3展示了完整的hello.py模板。

示例 templates/index.html：使用Flask-WTF和Flask-Bootstrap渲染表單

{% extends "base.html" %}
{% import "bootstrap/wtf.html" as wtf %}

{% block title %}Flasky{% endblock %}

{% block page_content %}


<div class="page-header">
 <h1>Hello, {% if name %}{{ name }}{% else %}Stranger{% endif %}!</h1>
</div>


{{ wtf.quick_form(form) }}
{% endblock %}

目前模板的內(nèi)容區(qū)有兩塊。第一塊是類為page-header的div輸出一個問候語。這里使用了模板條件判斷語句。在Jinja2中格式為{% if variable %}...{% else %}...{% endif %}。如果判斷條件為True則渲染if和else之間的內(nèi)容。如果判斷條件為False則渲染else和endif之間的內(nèi)容。示例模板會渲染字符串“Hello, Stranger!”當name模板參數(shù)未定義的時候。第二塊內(nèi)容使用wtf.quick_form()函數(shù)渲染NameForm對象。

4、啟動腳本
頂層目錄中的manage.py文件用于啟動應用。這個腳本會在示例7-8中展示。

示例 manage.py：啟動腳本

#!/usr/bin/env python
import os
from app import create_app, db
from app.models import User, Role
from flask.ext.script import Manager, Shell
from flask.ext.migrate import Migrate, MigrateCommand

app = create_app(os.getenv('FLASK_CONFIG') or 'default') 
manager = Manager(app)
migrate = Migrate(app, db)

def make_shell_context():
 return dict(app=app, db=db, User=User, Role=Role)

manager.add_command("shell", Shell(make_context=make_shell_context))
manager.add_command('db', MigrateCommand)

if __name__ == '__main__': 
 manager.run()

這個腳本開始于創(chuàng)建應用程序。使用環(huán)境變量FLASK_CONFIG，若它已經(jīng)定義了則從中獲取配置；如果沒有，則是用默認配置。然后用于Python shell的Flask-Script、Flask-Migrate以及自定義上下文會被初始化。

為了方便，會增加一行執(zhí)行環(huán)境，這樣在基于Unix的操作系統(tǒng)上可以通過./manage.py來執(zhí)行腳本來替代冗長的python manage.py。

5、需求文件
應用程序必須包含requirements.txt文件來記錄所有依賴包，包括精確的版本號。這很重要，因為可以在不同的機器上重新生成虛擬環(huán)境，例如在生產(chǎn)環(huán)境的機器上部署應用程序。這個文件可以通過下面的pip命令自動生成：

(venv) $ pip freeze >requirements.txt

當安裝或更新一個包之后最好再更新一下這個文件。以下展示了一個需求文件示例：

Flask==0.10.1
Flask-Bootstrap==3.0.3.1
Flask-Mail==0.9.0
Flask-Migrate==1.1.0
Flask-Moment==0.2.0
Flask-SQLAlchemy==1.0
Flask-Script==0.6.6
Flask-WTF==0.9.4
Jinja2==2.7.1
Mako==0.9.1
MarkupSafe==0.18
SQLAlchemy==0.8.4
WTForms==1.0.5
Werkzeug==0.9.4
alembic==0.6.2
blinker==1.3
itsdangerous==0.23

當你需要完美復制一個虛擬環(huán)境的時候，你可以運行以下命令創(chuàng)建一個新的虛擬環(huán)境：

(venv) $ pip install -r requirements.txt

當你讀到這時，示例requirements.txt文件中的版本號可能已經(jīng)過時了。如果喜歡你可以嘗試用最近發(fā)布的包。如果遇到任何問題，你可以隨時回退到需求文件中與應用兼容的指定版本。

6、單元測試
這個應用非常小以至于不需要太多的測試，但是作為示例會在示例7-9中展示兩個簡單的測試定義。

示例 tests/test_basics.py：單元測試

import unittest
from flask import current_app 
from app import create_app, db

class BasicsTestCase(unittest.TestCase): 
 def setUp(self):
  self.app = create_app('testing')
  self.app_context = self.app.app_context()
  self.app_context.push()
  db.create_all()

 def tearDown(self): 
  db.session.remove() 
  db.drop_all() 
  self.app_context.pop()

 def test_app_exists(self): 
  self.assertFalse(current_app is None)

 def test_app_is_testing(self): 
  self.assertTrue(current_app.config['TESTING'])

編寫好的測試使用的是來自于Python標準庫中標準的unittest包。setUp()和tearDown()方法在每個測試之前和之后運行，且任何一個方法必須以test_開頭作為測試來執(zhí)行。

建議：如果你想要學習更多使用Python的unittest包來寫單元測試的內(nèi)容，請參閱官方文檔。
setUp()方法嘗試創(chuàng)建一個測試環(huán)境，類似于運行應用程序。首先它創(chuàng)建應用程序配置用于測試并激活上下文。這一步確保測試可以和常規(guī)請求一樣訪問current_app。然后，當需要的時候，可以創(chuàng)建一個供測試使用的全新數(shù)據(jù)庫。數(shù)據(jù)庫和應用程序上下文會在tearDown()方法中被移除。

第一個測試確保應用程序實例存在。第二個測試確保應用程序在測試配置下運行。為了確保tests目錄有效，需要在tests目錄下增加__init__.py文件，不過該文件可以為空，這樣unittest包可以掃描所有模塊并定位測試。

建議：如果你有克隆在GitHub上的應用程序，你現(xiàn)在可以運行git checkout 7a來切換到這個版本的應用程序。為了確保你已經(jīng)安裝了所有依賴集，需要運行pip install -r requirements.txt。
為了運行單元測試，可以在manage.py腳本中增加一個自定義的命令。

下面的例子展示如何添加測試命令。

示例 manage.pyt：單元測試啟動腳本

@manager.command
def test():
 """Run the unit tests."""
 import unittest
 tests = unittest.TestLoader().discover('tests') 
 unittest.TextTestRunner(verbosity=2).run(tests)

manager.command裝飾器使得它可以很容易的實現(xiàn)自定義命令。被裝飾的函數(shù)名可以被當做命令名使用，且函數(shù)的文檔字符串會顯示幫助信息。test()函數(shù)的執(zhí)行會調(diào)用unittest包中的測試運行器。

單元測試可以像下面這樣執(zhí)行：

(venv) $ python manage.py test

test_app_exists (test_basics.BasicsTestCase) ... ok
test_app_is_testing (test_basics.BasicsTestCase) ... ok

.----------------------------------------------------------------------
Ran 2 tests in 0.001s

OK

7、數(shù)據(jù)庫啟動
與單腳本的應用相比，重構后的應用使用不同數(shù)據(jù)庫。

從環(huán)境變量中獲取的數(shù)據(jù)庫URL作為首選，默認SQLite數(shù)據(jù)庫作為可選。三個配置中的環(huán)境變量和SQLite數(shù)據(jù)庫文件名是不一樣的。例如，開發(fā)配置的URL是從DEV_DATABASE_URL環(huán)境變量中獲取，如果沒有定義則會使用名為data-dev.sqlite的SQLite數(shù)據(jù)庫。

無論數(shù)據(jù)庫URL源的是哪一個，都必須為新的數(shù)據(jù)庫創(chuàng)建數(shù)據(jù)庫表。如果使用了Flask-Migrate來保持遷移跟蹤，數(shù)據(jù)庫表可以被創(chuàng)建或更新到最近的版本通過下面的命令：

(venv) $ python manage.py db upgrade

相信與否，已經(jīng)到了第一部分結束的地方。你現(xiàn)在已經(jīng)學到了Flask必要的基本要素，但是你不確定如何將這些零散的知識組合在一起形成一個真正的應用程序。第二部分的目的是通過開發(fā)一個完整的應用程序來帶領你繼續(xù)前行。

最新評論