鍍金池/ 教程/ Python/ 快速上手
應(yīng)用環(huán)境
配置管理
大型應(yīng)用
可插撥視圖
Flask 方案
在 Shell 中使用 Flask
針對高級程序員的前言
使用藍(lán)圖的模塊化應(yīng)用
部署方式
信號
排除應(yīng)用錯誤
模板
請求環(huán)境
掌握應(yīng)用錯誤
測試 Flask 應(yīng)用
前言
教程
安裝
快速上手
Flask 擴(kuò)展

快速上手

等久了吧?本文會給你好好介紹如何上手 Flask 。這里假定你已經(jīng)安裝好了 Flask , 否則請先閱讀《 安裝 》。

一個最小的應(yīng)用

一個最小的 Flask 應(yīng)用如下:

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello World!'

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

把它保存為 hello.py 或其他類似名稱并用你的 Python 解釋器運行這個文件。請不要使用 flask.py 作為應(yīng)用名稱,這會與 Flask 本身發(fā)生沖突。

$ python hello.py
 * Running on http://127.0.0.1:5000/

現(xiàn)在,在瀏覽器中打開 http://127.0.0.1:5000/ ,就可以看到問候頁面了。

那么,這些代碼是什么意思呢?

  1. 首先我們導(dǎo)入了 Flask 類。這個類的實例將會成為我們的 WSGI 應(yīng)用。

  2. 接著我們創(chuàng)建了這個類的實例。第一個參數(shù)是應(yīng)用模塊或者包的名稱。如果你使用一個單一模塊(就像本例),那么應(yīng)當(dāng)使用 __name__ ,因為名稱會根據(jù)這個模塊是按應(yīng)用方式使用還是作為一個模塊導(dǎo)入而發(fā)生變化(可能是 __main__ ,也可能是 實際導(dǎo)入的名稱)。這個參數(shù)是必需的,這樣 Flask 就可以知道在哪里找到模板和靜態(tài)文件等東西。更多內(nèi)容詳見 Flask 文檔。

  3. 然后我們使用 route() 裝飾器來告訴 Flask 觸發(fā)函數(shù)的 URL 。

  4. 函數(shù)名稱可用于生成相關(guān)聯(lián)的 URL ,并返回需要在用戶瀏覽器中顯示的信息。

  5. 最后,使用 run() 函數(shù)來運行本地服務(wù)器和我們的應(yīng)用。 if __name__ == '__main__’: 確保服務(wù)器只會在使用 Python 解釋器運行代碼的 情況下運行,而不會在作為模塊導(dǎo)入時運行。

按 control-C 可以停止服務(wù)器。

外部可見的服務(wù)器。

運行服務(wù)器后,會發(fā)現(xiàn)只有你自己的電腦可以使用服務(wù),而網(wǎng)絡(luò)中的其他電腦卻不行。 缺省設(shè)置就是這樣的,因為在調(diào)試模式下該應(yīng)用的用戶可以執(zhí)行你電腦中的任意 Python 代碼。

如果你關(guān)閉了 調(diào)試 或信任你網(wǎng)絡(luò)中的用戶,那么可以讓服務(wù)器被公開訪問。只要像這樣改變 run() 方法的調(diào)用:

app.run(host='0.0.0.0')

這行代碼告訴你的操作系統(tǒng)監(jiān)聽一個公開的 IP 。

調(diào)試模式

雖然 run() 方法可以方便地啟動一個本地開發(fā)服務(wù)器,但是每次修改應(yīng)用之后都需要手動重啟服務(wù)器。這樣不是很方便, Flask 可以做得更好。如果你打開調(diào)試模式,那么服務(wù)器會在修改應(yīng)用之后自動重啟,并且當(dāng)應(yīng)用出錯時還會提供一個有用的調(diào)試器。

打開調(diào)試模式有兩種方法,一種是在應(yīng)用對象上設(shè)置標(biāo)志:

app.debug = True
app.run()

另一種是作為參數(shù)傳遞給 run 方法:

app.run(debug=True)

兩種方法的效果相同。

注意

雖然交互調(diào)試器不能在分布環(huán)境下工作(這使得它基本不可能用于生產(chǎn)環(huán)境),但是它允許執(zhí)行任意代碼,這樣會成為一個重大安全隱患。因此, 絕對不能在生產(chǎn)環(huán)境中使用調(diào)試器 。

運行的調(diào)試器的截圖:

http://wiki.jikexueyuan.com/project/flask-guide/images/4-1.png" alt="" />

想使用其他調(diào)試器?請參閱使用調(diào)試器 。

路由

現(xiàn)代 web 應(yīng)用都使用漂亮的 URL ,有助于人們記憶,對于使用網(wǎng)速較慢的移動設(shè)備尤其有利。如果用戶可以不通過點擊首頁而直達(dá)所需要的頁面,那么這個網(wǎng)頁會更得到用戶的青睞,提高回頭率。

如前文所述, route() 裝飾器用于把一個函數(shù)綁定到一個 URL 。 下面是一些基本的例子:

@app.route('/')
def index():
    return 'Index Page'

@app.route('/hello')
def hello():
    return 'Hello World'

但是能做的不僅僅是這些!你可以動態(tài)變化 URL 的某些部分,還可以為一個函數(shù)指定多個規(guī)則。

變量規(guī)則

通過把 URL 的一部分標(biāo)記為 就可以在 URL 中添加變量。標(biāo)記的部分會作為關(guān)鍵字參數(shù)傳遞給函數(shù)。通過使用 ,可以 選擇性的加上一個轉(zhuǎn)換器,為變量指定規(guī)則。請看下面的例子:

@app.route('/user/<username>')
def show_user_profile(username):
    # show the user profile for that user
    return 'User %s' % username

@app.route('/post/<int:post_id>')
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return 'Post %d' % post_id

現(xiàn)有的轉(zhuǎn)換器有:

類型 說明
int 接受整數(shù)
float 接受浮點數(shù)
path 和缺省情況相同,但也接受斜杠

唯一的 URL / 重定向行為

Flask 的 URL 規(guī)則都是基于 Werkzeug 的路由模塊的。其背后的理念是保證漂亮的外觀和唯一的 URL 。這個理念來自于 Apache 和更早期的服務(wù)器。

假設(shè)有如下兩條規(guī)則:

@app.route('/projects/')
def projects():
    return 'The project page'

@app.route('/about')
def about():
    return 'The about page'

它們看上去很相近,不同之處在于 URL 定義 中尾部的斜杠。第一個例子中 prjects 的 URL 是中規(guī)中舉的,尾部有一個斜杠,看起來就如同一個文件夾。訪問一個沒有斜杠結(jié)尾的 URL 時 Flask 會自動進(jìn)行重定向,幫你在尾部加上一個斜杠。

但是在第二個例子中, URL 沒有尾部斜杠,因此其行為表現(xiàn)與一個文件類似。如果訪問這個 URL 時添加了尾部斜杠就會得到一個 404 錯誤。

為什么這樣做?因為這樣可以在省略末尾斜杠時仍能繼續(xù)相關(guān)的 URL 。這種重定向行為與 Apache 和其他服務(wù)器一致。同時, URL 仍保持唯一,幫助搜索引擎不重復(fù)索引同一頁面。

URL 構(gòu)建

如果可以匹配 URL ,那么 Flask 也可以生成 URL 嗎?當(dāng)然可以。 url_for() 函數(shù)就是用于構(gòu)建指定函數(shù)的 URL 的。它把函數(shù)名稱作為 第一個參數(shù),其余參數(shù)對應(yīng) URL 中的變量。未知變量將添加到 URL 中作為查詢參數(shù)。 例如:

>>> from flask import Flask, url_for
>>> app = Flask(__name__)
>>> @app.route('/')
... def index(): pass
...
>>> @app.route('/login')
... def login(): pass
...
>>> @app.route('/user/<username>')
... def profile(username): pass
...
>>> with app.test_request_context():
...  print url_for('index')
...  print url_for('login')
...  print url_for('login', next='/')
...  print url_for('profile', username='John Doe')
...
/
/login
/login?next=/
/user/John%20Doe

(例子中還使用下文要講到的 test_request_context() 方法。這個方法的作用是告訴 Flask 我們正在處理一個請求,而實際上也許我們正處在交互 Python shell 之中,并沒有真正的請求。詳見下面的本地環(huán)境 )。

為什么不在把 URL 寫死在模板中,反而要動態(tài)構(gòu)建?有三個很好的理由:

  1. 反向解析通常比硬編碼 URL 更直觀。同時,更重要的是你可以只在一個地方改變 URL ,而不用到處亂找。

  2. URL 創(chuàng)建會為你處理特殊字符的轉(zhuǎn)義和 Unicode 數(shù)據(jù),不用你操心。

  3. 如果你的應(yīng)用是放在 URL 根路徑之外的地方(如在 /myapplication 中,不在 / 中), url_for() 會為你妥善處理。

HTTP 方法

HTTP ( Web 應(yīng)用使用的協(xié)議) 協(xié)議中有訪問 URL 的不同方法。缺省情況下,一個路由 只回應(yīng) GET 請求,但是可以通過 methods 參數(shù)使用不同方法。例如:

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        do_the_login()
    else:
        show_the_login_form()

如果當(dāng)前使用的是 GET 方法,會自動添加 HEAD ,你不必親自操刀。同時還會確保 HEAD 請求按照 HTTP RFC (說明 HTTP 協(xié)議的文檔)的要求來處理,因此你可以 完全忽略這部分 HTTP 規(guī)范。與 Flask 0.6 一樣, OPTIONS 自動為你處理好。

完全不懂 HTTP 方法?沒關(guān)系,這里給你速成培訓(xùn)一下:

HTTP 方法(通常也被稱為“動作”)告訴服務(wù)器一個頁面請求要做 什么。以下是常見的方法:

GET

瀏覽器告訴服務(wù)器只要得到頁面上的信息并發(fā)送這些信息。這可能是最常見的方法。

HEAD

瀏覽器告訴服務(wù)器想要得到信息,但是只要得到信息頭 就行了,頁面內(nèi)容不要。 一個應(yīng)用應(yīng)該像接受到一個 GET 請求一樣運行,但是不傳遞實際的內(nèi)容。在 Flask 中,你根本不必理會這個,下層的 Werkzeug 庫會為你處理好。

POST

瀏覽器告訴服務(wù)器想要向 URL 發(fā)表一些新的信息,服務(wù)器必須確保數(shù)據(jù)被保存好且只保存了一次。 HTML 表單實際上就是使用這個訪求向服務(wù)器傳送數(shù)據(jù)的。

PUT

與 POST 方法類似,不同的是服務(wù)器可能觸發(fā)多次儲存過程而把舊的值覆蓋掉。你 可能會問這樣做有什么用?這樣做是有原因的。假設(shè)在傳輸過程中連接丟失的情況 下,一個處于瀏覽器和服務(wù)器之間的系統(tǒng)可以在不中斷的情況下安全地接收第二次請求。在這種情況下,使用 POST 方法就無法做到了,因為它只被觸發(fā)一次。

DELETE

刪除給定位置的信息。

OPTIONS

為客戶端提供一個查詢 URL 支持哪些方法的捷徑。從 Flask 0.6 開始,自動為你實現(xiàn)了這個方法。 有趣的是在 HTML4 和 XHTML1 中,表單只能使用 GET 和 POST 方法。但是 JavaScript 和未來的 HTML 標(biāo)準(zhǔn)中可以使用其他的方法。此外, HTTP 近來已經(jīng)變得相當(dāng) 流行,瀏覽器不再只是唯一使用 HTTP 的客戶端。比如許多版本控制系統(tǒng)也使用 HTTP 。

靜態(tài)文件

動態(tài)的 Web 應(yīng)用也需要靜態(tài)文件,一般是 CSS 和 JavaScript 文件。理想情況下你的 服務(wù)器已經(jīng)配置好了為你的提供靜態(tài)文件的服務(wù)。在開發(fā)過程中, Flask 也能做好這個工作。只要在你的包或模塊旁邊創(chuàng)建一個名為 static 的文件夾就行了。靜態(tài)文件位于應(yīng)用的 /static 中。

使用選定的 'static' 端點就可以生成相應(yīng)的 URL 。:

url_for('static', filename='style.css')

這個靜態(tài)文件在文件系統(tǒng)中的位置應(yīng)該是 static/style.css

渲染模板

在 Python 內(nèi)部生成 HTML 不好玩,且相當(dāng)笨拙。因為你必須自己負(fù)責(zé) HTML 轉(zhuǎn)義,以確保應(yīng)用的安全。因此, Flask 自動為你配置的 Jinja2 模板引擎。

使用 render_template() 方法可以渲染模板,你只要提供模板名稱和需要 作為參數(shù)傳遞給模板的變量就行了。下面是一個簡單的模板渲染例子:

from flask import render_template

@app.route('/hello/')
@app.route('/hello/<name>')
def hello(name=None):
    return render_template('hello.html', name=name)

Flask 會在 templates 文件夾內(nèi)尋找模板。因此,如果你的應(yīng)用是一個模塊,那么模板 文件夾應(yīng)該在模塊旁邊;如果是一個包,那么就應(yīng)該在包里面:

情形 1: 一個模塊:

/application.py
/templates
    /hello.html

情形 2: 一個包:

/application
    /__init__.py
    /templates
        /hello.html

你可以充分使用 Jinja2 模板引擎的威力。更多內(nèi)容,詳見官方 Jinja2 模板文檔

模板舉例:

<!doctype html>
<title>Hello from Flask</title>
{% if name %}
  <h1>Hello {{ name }}!</h1>
{% else %}
  <h1>Hello World!</h1>
{% endif %}

在模板內(nèi)部你也可以訪問 request 、sessiong [1] 對象,以及 get_flashed_messages() 函數(shù)。

模板在繼承使用的情況下尤其有用,其工作原理 模板繼承 方案 文檔。簡單的說,模板繼承可以使每個頁面的特定元素(如頁頭,導(dǎo)航,頁尾)保持一致。

自動轉(zhuǎn)義默認(rèn)開啟。因此,如果 name 包含 HTML ,那么會被自動轉(zhuǎn)義。如果你可以信任某個變量,且知道它是安全的 HTML (例如變量來自一個把 wiki 標(biāo)記轉(zhuǎn)換為 HTML 的模塊),那么可以使用 Markup 類把它標(biāo)記為安全的。否則請在模板中使用 |safe 過濾器。更多例子參見 Jinja 2 文檔。

下面簡單介紹一下 Markup 類的工作方式:

>>> from flask import Markup
>>> Markup('<strong>Hello %s!</strong>') % '<blink>hacker</blink>'
Markup(u'<strong>Hello &lt;blink&gt;hacker&lt;/blink&gt;!</strong>')
>>> Markup.escape('<blink>hacker</blink>')
Markup(u'&lt;blink&gt;hacker&lt;/blink&gt;')
>>> Markup('<em>Marked up</em> &raquo; HTML').striptags()
u'Marked up \xbb HTML'

Changed in version 0.5: 自動轉(zhuǎn)義不再為所有模板開啟,只為擴(kuò)展名為 .html 、 .htm 、 .xml 和 .xhtml 開啟。從字符串載入的模板將關(guān)閉自動轉(zhuǎn)義。

[1] 不理解什么是 g 對象?它是某個可以根據(jù)需要儲存信息的東西。更多信息參見 g 對象的文檔和在 Flask 中使用 SQLite 3 文檔。

操作請求數(shù)據(jù)

對于 Web 應(yīng)用來說對客戶端向服務(wù)器發(fā)送的數(shù)據(jù)作出響應(yīng)很重要。在 Flask 中由全局對象 request 來提供請求信息。如果你有一些 Python 基礎(chǔ),那么可能 會奇怪:既然這個對象是全局的,怎么還能保持線程安全?答案是本地環(huán)境:

本地環(huán)境

內(nèi)部信息

如果你想了解其工作原理和如何測試,請閱讀本節(jié),否則可以跳過本節(jié)。 某些對象在 Flask 中是全局對象,但是不是通常意義下的全局對象。這些對象實際上是 特定環(huán)境下本地對象的代理。真拗口!但還是很容易理解的。

設(shè)想現(xiàn)在處于處理線程的環(huán)境中。一個請求進(jìn)來了,服務(wù)器決定生成一個新線程(或者 叫其他什么名稱的東西,這個下層的東西能夠處理包括線程在內(nèi)的并發(fā)系統(tǒng))。當(dāng) Flask 開始其內(nèi)部請求處理時會把當(dāng)前線程作為活動環(huán)境,并把當(dāng)前應(yīng)用和 WSGI 環(huán)境 綁定到這個環(huán)境(線程)。它以一種聰明的方式使得一個應(yīng)用可以在不中斷的情況下調(diào)用另一個應(yīng)用。

這對你有什么用?基本上你可以完全不必理會。這個只有在做單元測試時才有用。在測試 時會遇到由于沒有請求對象而導(dǎo)致依賴于請求的代碼會突然崩潰的情況。對策是自己創(chuàng)建 一個請求對象并綁定到環(huán)境。最簡單的單元測試解決方案是使用 test_request_context() 環(huán)境管理器。通過使用 with 語句可以 綁定一個測試請求,以便于交互。例如:

from flask import request

with app.test_request_context('/hello', method='POST'):
    # now you can do something with the request until the
    # end of the with block, such as basic assertions:
    assert request.path == '/hello'
    assert request.method == 'POST'

另一種方式是把整個 WSGI 環(huán)境傳遞給 request_context() 方法:

from flask import request

with app.request_context(environ):
    assert request.method == 'POST'

請求對象

請求對象在 API 一節(jié)中有詳細(xì)說明這里不細(xì)談(參見 request )。 這里簡略地談一下最常見的操作。首先,你必須從 flask 模塊導(dǎo)入請求對象:

from flask import request

通過使用 method 屬性可以操作當(dāng)前請求方法,通過使用 form 屬性處理表單數(shù)據(jù)。以下是使用兩個屬性的例子:

@app.route('/login', methods=['POST', 'GET'])
def login():
    error = None
    if request.method == 'POST':
        if valid_login(request.form['username'],
                       request.form['password']):
            return log_the_user_in(request.form['username'])
        else:
            error = 'Invalid username/password'
    # 如果請求訪求是 GET 或驗證未通過就會執(zhí)行下面的代碼
    return render_template('login.html', error=error)

當(dāng) form 屬性中不存在這個鍵時會發(fā)生什么?會引發(fā)一個 KeyError 。如果你不像捕捉一個標(biāo)準(zhǔn)錯誤一樣捕捉 KeyError ,那么會顯示一個 HTTP 400 Bad Request 錯誤頁面。因此,多數(shù)情況下你不必處理這個問題。

要操作 URL (如 ?key=value )中提交的參數(shù)可以使用 args 屬性:

searchword = request.args.get('key', '')

用戶可能會改變 URL 導(dǎo)致出現(xiàn)一個 400 請求出錯頁面,這樣降低了用戶友好度。因此, 我們推薦使用 get 或通過捕捉 KeyError 來訪問 URL 參數(shù)。

完整的請求對象方法和屬性參見 request 文檔。

文件上傳

用 Flask 處理文件上傳很容易,只要確保不要忘記在你的 HTML 表單中設(shè)置 enctype="multipart/form-data" 屬性就可以了。否則瀏覽器將不會傳送你的文件。

已上傳的文件被儲存在內(nèi)存或文件系統(tǒng)的臨時位置。你可以通過請求對象 files 屬性來訪問上傳的文件。每個上傳的文件都儲存在這個 字典型屬性中。這個屬性基本和標(biāo)準(zhǔn) Python file 對象一樣,另外多出一個用于把上傳文件保存到服務(wù)器的文件系統(tǒng)中的 save() 方法。下例展示其如何運作:

from flask import request

@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        f = request.files['the_file']
        f.save('/var/www/uploads/uploaded_file.txt')
    ...

如果想要知道文件上傳之前其在客戶端系統(tǒng)中的名稱,可以使用 filename 屬性。但是請牢記這個值是 可以偽造的,永遠(yuǎn)不要信任這個值。如果想要把客戶端的文件名作為服務(wù)器上的文件名, 可以通過 Werkzeug 提供的 secure_filename() 函數(shù):

from flask import request
from werkzeug import secure_filename

@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        f = request.files['the_file']
        f.save('/var/www/uploads/' + secure_filename(f.filename))
    ...

更好的例子參見 上傳文件 方案。

Cookies

要訪問 cookies ,可以使用 cookies 屬性??梢允褂谜埱髮ο?的 set_cookie 方法來設(shè)置 cookies 。請求對象的 cookies 屬性是一個包含了客戶端傳輸?shù)乃?cookies 的字典。 在 Flask 中,如果能夠使用 會話 ,那么就不要直接使用 cookies ,因為 會話比較安全一些。

讀取 cookies:

from flask import request

@app.route('/')
def index():
    username = request.cookies.get('username')
    # 使用 cookies.get(key) 來代替 cookies[key] ,
    # 以避免當(dāng) cookie 不存在時引發(fā) KeyError 。

儲存 cookies:

from flask import make_response

@app.route('/')
def index():
    resp = make_response(render_template(...))
    resp.set_cookie('username', 'the username')
    return resp

注意, cookies 設(shè)置在響應(yīng)對象上。通常只是從視圖函數(shù)返回字符串, Flask 會把它們 轉(zhuǎn)換為響應(yīng)對象。如果你想顯式地轉(zhuǎn)換,那么可以使用 make_response() 函數(shù),然后再修改它。

使用延遲的請求回調(diào)方案可以在沒有響應(yīng)對象的情況下設(shè)置一個 cookie 。

同時可以參見關(guān)于響應(yīng) 。

重定向和錯誤

使用 redirect() 函數(shù)可以重定向。使用 abort() 可以更早退出請求,并返回錯誤代碼:

from flask import abort, redirect, url_for

@app.route('/')
def index():
    return redirect(url_for('login'))

@app.route('/login')
def login():
    abort(401)
    this_is_never_executed()

上例實際上是沒有意義的,它讓一個用戶從索引頁重定向到一個無法訪問的頁面(401 表示禁止訪問)。但是上例可以說明重定向和出錯跳出是如何工作的。

缺省情況下每種出錯代碼都會對應(yīng)顯示一個黑白的出錯頁面。使用 errorhandler() 裝飾器可以定制出錯頁面:

from flask import render_template

@app.errorhandler(404)
def page_not_found(error):
    return render_template('page_not_found.html'), 404

注意 render_template() 后面的 404 ,這表示頁面對就的出錯代碼是 404 ,即頁面不存在。缺省情況下 200 表示一切正常。

關(guān)于響應(yīng)

視圖函數(shù)的返回值會自動轉(zhuǎn)換為一個響應(yīng)對象。如果返回值是一個字符串,那么會被轉(zhuǎn)換為一個包含作為響應(yīng)體的字符串、一個 200 OK 出錯代碼 和一個 text/html MIME 類型的響應(yīng)對象。以下是轉(zhuǎn)換的規(guī)則:

  1. 如果視圖要返回的是一個響應(yīng)對象,那么就直接返回它。
  2. 如果要返回的是一個字符串,那么根據(jù)這個字符串和缺省參數(shù)生成一個用于返回的響應(yīng)對象。
  3. 如果要返回的是一個元組,那么元組中的項目可以提供額外的信息。元組中必須至少包含一個項目,且項目應(yīng)當(dāng)由 (response, status, headers) 組成。 status 的值會重載狀態(tài)代碼, headers 是一個由額外頭部值組成的列表或字典。
  4. 如果以上都不是,那么 Flask 會假定返回值是一個有效的 WSGI 應(yīng)用并把它轉(zhuǎn)換為一個響應(yīng)對象。 如果想要在視圖內(nèi)部掌控響應(yīng)對象的結(jié)果,那么可以使用 make_response() 函數(shù)。

設(shè)想有如下視圖:

@app.errorhandler(404)
def not_found(error):
    return render_template('error.html'), 404

可以使用 make_response() 包裹返回表達(dá)式,獲得響應(yīng)對象,并對該對象進(jìn)行修改,然后再返回:

@app.errorhandler(404)
def not_found(error):
    resp = make_response(render_template('error.html'), 404)
    resp.headers['X-Something'] = 'A value'
    return resp

會話

除了請求對象之外還有一種稱為 session 的對象,允許你在不同請求 之間儲存信息。這個對象相當(dāng)于用密鑰簽名加密的 cookie ,即用戶可以查看你的 cookie ,但是如果沒有密鑰就無法修改它。

使用會話之前你必須設(shè)置一個密鑰。舉例說明:

from flask import Flask, session, redirect, url_for, escape, request

app = Flask(__name__)

@app.route('/')
def index():
    if 'username' in session:
        return 'Logged in as %s' % escape(session['username'])
    return 'You are not logged in'

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        session['username'] = request.form['username']
        return redirect(url_for('index'))
    return '''
        <form action="" method="post">
            <p><input type=text name=username>
            <p><input type=submit value=Login>
        </form>
    '''

@app.route('/logout')
def logout():
    # 如果會話中有用戶名就刪除它。
    session.pop('username', None)
    return redirect(url_for('index'))

# 設(shè)置密鑰,復(fù)雜一點:
app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'

這里用到的 escape() 是用來轉(zhuǎn)義的。如果不使用模板引擎就可以像上例 一樣使用這個函數(shù)來轉(zhuǎn)義。

如何生成一個好的密鑰

生成隨機數(shù)的關(guān)鍵在于一個好的隨機種子,困此一個好的密鑰應(yīng)當(dāng)有足夠的隨機性。 你的操作系統(tǒng)可以使用一個隨機生成器來生成一個好的隨機種子:

>>> import os
>>> os.urandom(24)
'\xfd{H\xe5<\x95\xf9\xe3\x96.5\xd1\x01O<!\xd5\xa2\xa0\x9fR"\xa1\xa8'

只要復(fù)制這個隨機種子到你的代碼中就行了。 基于 cookie 的會話的說明: Flask 會把會話對象中的值儲存在 cookie 中。在打開 cookie 的情況下,如果你訪問會話對象中沒有的值,那么會得到模糊的錯誤信息:請檢查 頁面 cookie 的大小是否與網(wǎng)絡(luò)瀏覽器所支持的大小一致。

消息閃現(xiàn)

一個好的應(yīng)用和用戶接口都有良好的反饋,否則到后來用戶就會討厭這個應(yīng)用。 Flask 通過閃現(xiàn)系統(tǒng)來提供了一個易用的反饋方式。閃現(xiàn)系統(tǒng)的基本工作原理是在請求結(jié)束時 記錄一個消息,提供且只提供給下一個請求使用。通常通過一個布局模板來展現(xiàn)閃現(xiàn)的 消息。

flash() 用于閃現(xiàn)一個消息。在模板中,使用 get_flashed_messages() 來操作消息。完整的例子參見 消息閃現(xiàn) 。

日志

New in version 0.3.

有時候可能會遇到數(shù)據(jù)出錯需要糾正的情況。例如因為用戶篡改了數(shù)據(jù)或客戶端代碼出錯 而導(dǎo)致一個客戶端代碼向服務(wù)器發(fā)送了明顯錯誤的 HTTP 請求。多數(shù)時候在類似情況下 返回 400 Bad Request 就沒事了,但也有不會返回的時候,而代碼還得繼續(xù)運行下去。

這時候就需要使用日志來記錄這些不正常的東西了。自從 Flask 0.3 后就已經(jīng)為你配置好了一個日志工具。

以下是一些日志調(diào)用示例:

app.logger.debug('A value for debugging')
app.logger.warning('A warning occurred (%d apples)', 42)
app.logger.error('An error occurred')

logger 是一個標(biāo)準(zhǔn)的 Python Logger 類, 更多信息詳見官方的 logging 文檔 。

集成 WSGI 中間件

如果想要在應(yīng)用中添加一個 WSGI 中間件,那么可以包裝內(nèi)部的 WSGI 應(yīng)用。假設(shè)為了 解決 lighttpd 的錯誤,你要使用一個來自 Werkzeug 包的中間件,那么可以這樣做:

from werkzeug.contrib.fixers import LighttpdCGIRootFix
app.wsgi_app = LighttpdCGIRootFix(app.wsgi_app)

部署到一個網(wǎng)絡(luò)服務(wù)器

準(zhǔn)備好發(fā)布你的新 Flask 應(yīng)用了嗎?作為本文的一個圓滿結(jié)尾,你可以立即把應(yīng)用部署到 一個主機上。下面介紹的是如何把小項目部署到免費主機上。

? Copyright 2013, Armin Ronacher. Created using Sphinx.