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

一個(gè)最小的 Flask 應(yīng)用看起來(lái)會(huì)是這樣:

from flask import Flaskapp = Flask(__name__)@app.route('/')def hello_world():    return 'Hello World!'if __name__ == '__main__':    app.run()

把它保存為 hello.py （或是類似的），然后用 Python 解釋器來(lái)運(yùn)行。確保你的應(yīng)用文件名不是 flask.py ，因?yàn)檫@將與 Flask 本身沖突。

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

現(xiàn)在訪問(wèn) http://127.0.0.1:5000/ ，你會(huì)看見(jiàn) Hello World 問(wèn)候。

那么，這段代碼做了什么？

1. 首先，我們導(dǎo)入了 Flask 類。這個(gè)類的實(shí)例將會(huì)是我們的 WSGI 應(yīng)用程序。
2. 接下來(lái)，我們創(chuàng)建一個(gè)該類的實(shí)例，第一個(gè)參數(shù)是應(yīng)用模塊或者包的名稱。如果你使用單一的模塊（如本例），你應(yīng)該使用 __name__ ，因?yàn)槟K的名稱將會(huì)因其作為單獨(dú)應(yīng)用啟動(dòng)還是作為模塊導(dǎo)入而有不同（也即是 '__main__' 或?qū)嶋H的導(dǎo)入名）。這是必須的，這樣 Flask才知道到哪去找模板、靜態(tài)文件等等。詳情見(jiàn) Flask的文檔。
3. 然后，我們使用 route() 裝飾器告訴 Flask 什么樣的URL 能觸發(fā)我們的函數(shù)。
4. 這個(gè)函數(shù)的名字也在生成 URL 時(shí)被特定的函數(shù)采用，這個(gè)函數(shù)返回我們想要顯示在用戶瀏覽器中的信息。
5. 最后我們用 run() 函數(shù)來(lái)讓?xiě)?yīng)用運(yùn)行在本地服務(wù)器上。其中 if __name__ == '__main__': 確保服務(wù)器只會(huì)在該腳本被Python 解釋器直接執(zhí)行的時(shí)候才會(huì)運(yùn)行，而不是作為模塊導(dǎo)入的時(shí)候。

欲關(guān)閉服務(wù)器，按 Ctrl+C。

app.run(host='0.0.0.0')

調(diào)試模式?

雖然 run() 方法適用于啟動(dòng)本地的開(kāi)發(fā)服務(wù)器，但是你每次修改代碼后都要手動(dòng)重啟它。這樣并不夠優(yōu)雅，而且 Flask 可以做到更好。如果你啟用了調(diào)試支持，服務(wù)器會(huì)在代碼修改后自動(dòng)重新載入，并在發(fā)生錯(cuò)誤時(shí)提供一個(gè)相當(dāng)有用的調(diào)試器。

有兩種途徑來(lái)啟用調(diào)試模式。一種是直接在應(yīng)用對(duì)象上設(shè)置:

app.debug = Trueapp.run()

另一種是作為 run 方法的一個(gè)參數(shù)傳入:

app.run(debug=True)

兩種方法的效果完全相同。

運(yùn)行中的調(diào)試器截圖：

想用其它的調(diào)試器？ 參見(jiàn) 調(diào)試器操作 。

路由?

現(xiàn)代 Web 應(yīng)用的 URL 十分優(yōu)雅，易于人們辨識(shí)記憶，這一點(diǎn)對(duì)于那些面向使用低速網(wǎng)絡(luò)連接移動(dòng)設(shè)備訪問(wèn)的應(yīng)用特別有用。如果可以不訪問(wèn)索引頁(yè)，而是直接訪問(wèn)想要的那個(gè)頁(yè)面，他們多半會(huì)笑逐顏開(kāi)而再度光顧。

如上所見(jiàn)， route() 裝飾器把一個(gè)函數(shù)綁定到對(duì)應(yīng)的URL 上。

這里是一些基本的例子:

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

但是，不僅如此！你可以構(gòu)造含有動(dòng)態(tài)部分的 URL，也可以在一個(gè)函數(shù)上附著多個(gè)規(guī)則。

@app.route('/user/')def show_user_profile(username):    # show the user profile for that user    return 'User %s' % username@app.route('/post/')def show_post(post_id):    # show the post with the given id, the id is an integer    return 'Post %d' % post_id

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

>>> from flask import Flask, url_for>>> app = Flask(__name__)>>> @app.route('/')... def index(): pass...>>> @app.route('/login')... def login(): pass...>>> @app.route('/user/')... 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 Doe

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

靜態(tài)文件?

動(dòng)態(tài) web 應(yīng)用也會(huì)需要靜態(tài)文件，通常是 CSS 和 JavaScript 文件。理想狀況下，你已經(jīng)配置好 Web 服務(wù)器來(lái)提供靜態(tài)文件，但是在開(kāi)發(fā)中，F(xiàn)lask 也可以做到。只要在你的包中或是模塊的所在目錄中創(chuàng)建一個(gè)名為 static 的文件夾，在應(yīng)用中使用 /static 即可訪問(wèn)。

給靜態(tài)文件生成 URL ，使用特殊的 'static' 端點(diǎn)名:

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

這個(gè)文件應(yīng)該存儲(chǔ)在文件系統(tǒng)上的 static/style.css 。

模板渲染?

用 Python 生成 HTML 十分無(wú)趣，而且相當(dāng)繁瑣，因?yàn)槟惚仨毷謩?dòng)對(duì) HTML 做轉(zhuǎn)義來(lái)保證應(yīng)用的安全。為此，F(xiàn)lask 配備了Jinja2 模板引擎。

你可以使用 render_template() 方法來(lái)渲染模板。你需要做的一切就是將模板名和你想作為關(guān)鍵字的參數(shù)傳入模板的變量。這里有一個(gè)展示如何渲染模板的簡(jiǎn)例:

from flask import render_template@app.route('/hello/')@app.route('/hello/')def hello(name=None):    return render_template('hello.html', name=name)

Flask 會(huì)在 templates 文件夾里尋找模板。所以，如果你的應(yīng)用是個(gè)模塊，這個(gè)文件夾應(yīng)該與模塊同級(jí)；如果它是一個(gè)包，那么這個(gè)文件夾作為包的子目錄:

情況 1: 模塊:

/application.py/templates    /hello.html

情況 2: 包:

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

關(guān)于模板，你可以發(fā)揮 Jinja2 模板的全部實(shí)例。更多信息請(qǐng)見(jiàn)Jinja2 模板文檔 。

這里有一個(gè)模板實(shí)例：

{% if name %}  
Hello {{ name }}!
{% else %}  
Hello World!
{% endif %}

在模板里，你也可以訪問(wèn) request 、session 和 g [1] 對(duì)象，以及 get_flashed_messages() 函數(shù)。

模板繼承讓模板用起來(lái)相當(dāng)順手。如欲了解繼承的工作機(jī)理，請(qǐng)?zhí)D(zhuǎn)到模板繼承 模式的文檔。最起碼，模板繼承能使特定元素（比如頁(yè)眉、導(dǎo)航欄和頁(yè)腳）可以出現(xiàn)在所有的頁(yè)面。

自動(dòng)轉(zhuǎn)義功能默認(rèn)是開(kāi)啟的，所以如果 name 包含 HTML ，它將會(huì)被自動(dòng)轉(zhuǎn)義。如果你能信任一個(gè)變量，并且你知道它是安全的（例如一個(gè)模塊把 Wiki 標(biāo)記轉(zhuǎn)換為 HTML），你可以用 Markup 類或 |safe 過(guò)濾器在模板中把它標(biāo)記為安全的。在 Jinja 2 文檔中，你會(huì)看到更多的例子。

這里是一個(gè) Markup 類如何使用的簡(jiǎn)單介紹:

>>> from flask import Markup>>> Markup('Hello %s!') % 'hacker'Markup(u'Hello <blink>hacker</blink>!')>>> Markup.escape('hacker')Markup(u'<blink>hacker</blink>')>>> Markup('Marked up ? HTML').striptags()u'Marked up \xbb HTML'

訪問(wèn)請(qǐng)求數(shù)據(jù)?

對(duì)于 Web 應(yīng)用，與客戶端發(fā)送給服務(wù)器的數(shù)據(jù)交互至關(guān)重要。在 Flask 中由全局的 request 對(duì)象來(lái)提供這些信息。如果你有一定的Python 經(jīng)驗(yàn)，你會(huì)好奇，為什么這個(gè)對(duì)象是全局的，為什么 Flask 還能保證線程安全。答案是環(huán)境作用域：

from flask import requestwith 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'

from flask import requestwith app.request_context(environ):    assert request.method == 'POST'

from flask import request

@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'    # the code below is executed if the request method    # was GET or the credentials were invalid    return render_template('login.html', error=error)

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

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')    ...

from flask import requestfrom 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))    ...

from flask import request@app.route('/')def index():    username = request.cookies.get('username')    # use cookies.get(key) instead of cookies[key] to not get a    # KeyError if the cookie is missing.

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

重定向和錯(cuò)誤?

你可以用 redirect() 函數(shù)把用戶重定向到其它地方。放棄請(qǐng)求并返回錯(cuò)誤代碼，用 abort() 函數(shù)。這里是一個(gè)它們?nèi)绾问褂玫睦?

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()

這是一個(gè)相當(dāng)無(wú)意義的例子因?yàn)橛脩魰?huì)從主頁(yè)重定向到一個(gè)不能訪問(wèn)的頁(yè)面（401 意味著禁止訪問(wèn)），但是它展示了重定向是如何工作的。

默認(rèn)情況下，錯(cuò)誤代碼會(huì)顯示一個(gè)黑白的錯(cuò)誤頁(yè)面。如果你要定制錯(cuò)誤頁(yè)面，可以使用 errorhandler() 裝飾器:

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

注意 render_template() 調(diào)用之后的 404 。這告訴Flask，該頁(yè)的錯(cuò)誤代碼是 404 ，即沒(méi)有找到。默認(rèn)為 200，也就是一切正常。

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

視圖函數(shù)的返回值會(huì)被自動(dòng)轉(zhuǎn)換為一個(gè)響應(yīng)對(duì)象。如果返回值是一個(gè)字符串，它被轉(zhuǎn)換為該字符串為主體的、狀態(tài)碼為 200 OK``的 、 MIME 類型是``text/html 的響應(yīng)對(duì)象。Flask 把返回值轉(zhuǎn)換為響應(yīng)對(duì)象的邏輯是這樣：

1. 如果返回的是一個(gè)合法的響應(yīng)對(duì)象，它會(huì)從視圖直接返回。
2. 如果返回的是一個(gè)字符串，響應(yīng)對(duì)象會(huì)用字符串?dāng)?shù)據(jù)和默認(rèn)參數(shù)創(chuàng)建。
3. 如果返回的是一個(gè)元組，且元組中的元素可以提供額外的信息。這樣的元組必須是 (response, status, headers) 的形式，且至少包含一個(gè)元素。 status 值會(huì)覆蓋狀態(tài)代碼， headers 可以是一個(gè)列表或字典，作為額外的消息標(biāo)頭值。
4. 如果上述條件均不滿足， Flask 會(huì)假設(shè)返回值是一個(gè)合法的 WSGI 應(yīng)用程序，并轉(zhuǎn)換為一個(gè)請(qǐng)求對(duì)象。

如果你想在視圖里操縱上述步驟結(jié)果的響應(yīng)對(duì)象，可以使用make_response() 函數(shù)。

譬如你有這樣一個(gè)視圖:

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

你只需要把返回值表達(dá)式傳遞給 make_response() ，獲取結(jié)果對(duì)象并修改，然后再返回它:

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

會(huì)話?

除請(qǐng)求對(duì)象之外，還有一個(gè) session 對(duì)象。它允許你在不同請(qǐng)求間存儲(chǔ)特定用戶的信息。它是在 Cookies 的基礎(chǔ)上實(shí)現(xiàn)的，并且對(duì)Cookies 進(jìn)行密鑰簽名。這意味著用戶可以查看你 Cookie 的內(nèi)容，但卻不能修改它，除非用戶知道簽名的密鑰。

要使用會(huì)話，你需要設(shè)置一個(gè)密鑰。這里介紹會(huì)話如何工作:

from flask import Flask, session, redirect, url_for, escape, requestapp = 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 '''        
            
            
        
    '''@app.route('/logout')def logout():    # remove the username from the session if it's there    session.pop('username', None)    return redirect(url_for('index'))# set the secret key.  keep this really secret:app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'

這里提到的 escape() 可以在你模板引擎外做轉(zhuǎn)義（如同本例）。

>>> import os>>> os.urandom(24)'\xfd{H\xe5<\x95\xf9\xe3\x96.5\xd1\x01O

使用基于 cookie 的會(huì)話需注意: Flask 會(huì)將你放進(jìn)會(huì)話對(duì)象的值序列化至Cookies。如果你發(fā)現(xiàn)某些值在請(qǐng)求之間并沒(méi)有持久存在，然而確實(shí)已經(jīng)啟用了Cookies，但也沒(méi)有得到明確的錯(cuò)誤信息。這時(shí)，請(qǐng)檢查你的頁(yè)面響應(yīng)中的Cookies 的大小，并與 Web 瀏覽器所支持的大小對(duì)比。

消息閃現(xiàn)?

反饋，是良好的應(yīng)用和用戶界面的重要構(gòu)成。如果用戶得不到足夠的反饋，他們很可能開(kāi)始厭惡這個(gè)應(yīng)用。 Flask 提供了消息閃現(xiàn)系統(tǒng)，可以簡(jiǎn)單地給用戶反饋。消息閃現(xiàn)系統(tǒng)通常會(huì)在請(qǐng)求結(jié)束時(shí)記錄信息，并在下一個(gè)（且僅在下一個(gè)）請(qǐng)求中訪問(wèn)記錄的信息。展現(xiàn)這些消息通常結(jié)合要模板布局。

使用 flash() 方法可以閃現(xiàn)一條消息。要操作消息本身，請(qǐng)使用get_flashed_messages() 函數(shù)，并且在模板中也可以使用。完整的例子見(jiàn) 消息閃現(xiàn) 部分。

日志記錄?

有時(shí)候你會(huì)處于這樣一種境地，你處理的數(shù)據(jù)本應(yīng)該是正確的，但實(shí)際上不是。比如，你會(huì)有一些向服務(wù)器發(fā)送請(qǐng)求的客戶端代碼，但請(qǐng)求顯然是畸形的。這可能是用戶篡改了數(shù)據(jù)，或是客戶端代碼的粗制濫造。大多數(shù)情況下，正常地返回400 Bad Request 就可以了，但是有時(shí)候不能這么做，并且要讓代碼繼續(xù)運(yùn)行。

你可能依然想要記錄下，是什么不對(duì)勁。這時(shí)日志記錄就派上了用場(chǎng)。從Flask 0.3 開(kāi)始，F(xiàn)lask 就已經(jīng)預(yù)置了日志系統(tǒ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 是一個(gè)標(biāo)準(zhǔn)日志類Logger ，所以更多信息請(qǐng)查閱 logging的文檔 。

整合 WSGI 中間件?

如果你想給你的應(yīng)用添加 WSGI 中間件，你可以封裝內(nèi)部 WSGI 應(yīng)用。例如若是你想用 Werkzeug 包中的某個(gè)中間件來(lái)應(yīng)付 lighttpd 中的 bugs ，可以這樣做:

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

部署到 Web 服務(wù)器?

準(zhǔn)備好部署你的 Flask 應(yīng)用了？你可以立即部署到托管平臺(tái)來(lái)圓滿完成快速入門(mén)，以下廠商均向小項(xiàng)目提供免費(fèi)的方案:

• 在 Heroku 上部署 Flask
• 在 dotCloud 上部署 Flask附 Flask 的具體說(shuō)明