翻譯的網(wǎng)站
備注 我只會(huì)翻譯一些關(guān)鍵點(diǎn)。太簡(jiǎn)單的就不翻譯了
Quickstart
一個(gè)小程序可能看起來(lái)會(huì)是這樣的
#hello.py
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'
通過(guò)命令行啟動(dòng)程序有兩種方式
# 1.
export FLASK_APP=hello.py
flask run
#2.
export FLASK_APP=hello.py
python -m flask run
如果想讓你的程序成為可訪問(wèn)的公共服務(wù)器
flask run --host=0.0.0.0
如果啟動(dòng)成功你就可以通過(guò) http://127.0.0.1:5000來(lái)看到你的Hello, World!
失敗的原因可能有多種揭朝，有可能是你的flask版本過(guò)低呢簸，也有可能導(dǎo)入的包名無(wú)效褒链，或者你也可以開(kāi)啟Debug模式
export FLASK_DEBUG=1
在這種模式下阻问，flask能夠提供有用的調(diào)試信息昌简，也能夠自動(dòng)監(jiān)聽(tīng)代碼改動(dòng)而重啟服務(wù)器吟逝。
另外帽蝶，不建議你在開(kāi)發(fā)階段，通過(guò)在代碼中使用如下方法啟動(dòng)服務(wù)器。
if __name__ == '__main__':
app.run()
flask 匹配與生成url的兩個(gè)函數(shù)
@app.route('/user/<username>')
... def profile(username): pass
url_for('profile',username='john deo')
Http（超文本協(xié)議） 傳輸方法
from flask import request
@app.route('/login', methods=['GET', 'POST'])
def login():
if request.method == 'POST':
do_the_login()
else:
show_the_login_form()
http PUT
PUT與POST類似励稳，但服務(wù)器能通過(guò)覆蓋舊值多次激發(fā)存儲(chǔ)程序佃乘，例如傳輸過(guò)程種程序與服務(wù)器斷開(kāi)連接，PUT能夠在不中斷服務(wù)的情況下安全的接受二次請(qǐng)求驹尼，而POST做不到趣避。
靜態(tài)資源
包括css js 圖片等，flask都會(huì)默認(rèn)在static文件中尋找它們新翎。所以你要使用靜態(tài)文件程帕，首先要建立static文件夾。
獲得靜態(tài)文件的地址可以通過(guò)
url_for('static', filename='style.css') # static/style.css
Html模版
默認(rèn)的flask從template文件夾中尋找模版地啰，確保它在你的模塊或包中
flask 封裝了jinja2模版引擎愁拭，模版中你仍然可以使用 request, session and g [1] 這些對(duì)象以及像 get_flashed_messages() 函數(shù).
如果你想了解更多模版繼承的東西，可以查看 Template Inheritance 亏吝，它使得可以把像header, navigation and footer的東西放在一個(gè)頁(yè)面中岭埠。
flask可以自動(dòng)忽略過(guò)濾變量中的html標(biāo)記，所以如果你信任它蔚鸥，可以通過(guò) Markup或者|safe 過(guò)濾器標(biāo)簽來(lái)標(biāo)記它是安全的不用過(guò)濾
>>> from flask import Markup
>>> Markup('<strong>Hello %s!</strong>') % '<blink>hacker</blink>'
Markup(u'<strong>Hello <blink>hacker</blink>!</strong>')
>>> Markup.escape('<blink>hacker</blink>')
Markup(u'<blink>hacker</blink>')
>>> Markup('<em>Marked up</em> » HTML').striptags()
u'Marked up \xbb HTML'
現(xiàn)在自動(dòng)過(guò)濾并不對(duì)全部模版適用了惜论，自動(dòng)過(guò)濾只對(duì)后綴為.html, .htm, .xml, .xhtml. 的文件適用。
請(qǐng)求數(shù)據(jù)?
flask提供了全局對(duì)象request來(lái)解決客戶端到服務(wù)器的數(shù)據(jù)處理反應(yīng)止喷。你可能會(huì)對(duì)flask如何將它變?yōu)槿挚捎们揖S持它的線程安全馆类。答案就是上下文變量。
flask 能夠確保你在多線程環(huán)境中启盛，獲得活動(dòng)線程正確的數(shù)據(jù)
Context Locals 上下文變量
如果你想理解它是如何工作的，并且測(cè)試一下技羔，那么可以讀一下接下來(lái)的部分僵闯。
flask中的全局對(duì)象和我們通常意義上的不同，它們只是某些特定上下文環(huán)境中的菊部變量的代理藤滥。
想象一個(gè)上下文環(huán)境鳖粟，它是一個(gè)正在處理請(qǐng)求的線程。這時(shí)又來(lái)了一個(gè)請(qǐng)求拙绊，web服務(wù)器決定開(kāi)辟一個(gè)新的線程（或者采用協(xié)程的方式）向图，當(dāng)flask開(kāi)始進(jìn)行內(nèi)部處理這個(gè)請(qǐng)求的時(shí)候，flask計(jì)算出當(dāng)前線程是活動(dòng)的上下文環(huán)境标沪，并且把當(dāng)前的應(yīng)用程序與wsgi環(huán)境同這個(gè)線程綁定起來(lái)榄攀。它通過(guò)一種智能的方式完成程序在不中斷情況下的協(xié)同工作。
wow 這對(duì)你意味著什么金句，意味著你可以不用操心當(dāng)前處于什么上下文環(huán)境而放心的使用全局變量檩赢。當(dāng)然如果你要做一些單元測(cè)試，那就行不通了违寞。這時(shí)猴你發(fā)現(xiàn)代碼中以來(lái)的request對(duì)象沒(méi)有了贞瞒，解決方法就是你自己創(chuàng)建一個(gè)并和上下文綁定偶房。最簡(jiǎn)單的方法是使用test_request_context() context manager這個(gè)上下文管理器，通過(guò)使用with語(yǔ)句綁定一個(gè)test request军浆，然后你就可以使用它了棕洋。
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'
或者你也可以傳遞整個(gè)WSGI環(huán)境給 request_context()方法
from flask import request
with app.request_context(environ):
assert request.method == 'POST'
Request 對(duì)象
表單數(shù)據(jù)
關(guān)于 request的詳細(xì)解釋，可以在這找到乒融。我們接下來(lái)只進(jìn)行常用方法的概述掰盘。
首先你要從flask模塊中導(dǎo)入它
from flask import request
最常用的請(qǐng)求方法是通過(guò)method屬性
@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)
通過(guò)request.form來(lái)獲取表單數(shù)據(jù)，如果沒(méi)有這個(gè)屬性簇抵，則拋出 KeyError庆杜，你可以自己捕獲它，或者讓他自動(dòng)使用HTTP 400 錯(cuò)誤頁(yè)面碟摆。
獲取URL中的查詢字符串晃财，可以采用
searchword = request.args.get('key', '')
文件上傳
只要你在你的表單頭中設(shè)置了
enctype="multipart/form-data"
flask可以輕松處理你上傳的文件。上傳的文件被存儲(chǔ)在內(nèi)存或臨時(shí)文件系統(tǒng)中典蜕，你能夠通過(guò)request的files屬性獲取它断盛。所有上傳的文件都被存在這個(gè)屬性字典中，它就像標(biāo)準(zhǔn)的python文件愉舔，并且能夠讓你通過(guò)save方法來(lái)保存它钢猛。下面是個(gè)簡(jiǎn)單示例。
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')
...
通過(guò)filename屬性轩缤，你能夠獲得客戶端上傳文件的文件名命迈，但它能夠被輕易偽造，所以更安全但方法是通過(guò) secure_filename()方法火的。
from flask import request
from werkzeug.utils 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))
...
更多例子壶愤，點(diǎn)擊 Uploading Files.
Cookies
你可以通過(guò)cookies屬性來(lái)獲取cookies，通過(guò)response對(duì)象的set_cookie 方法來(lái)設(shè)置cookie
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
注意到cookies是設(shè)置在response對(duì)象上的馏鹤，當(dāng)你從視圖函數(shù)中返回字符串征椒，F(xiàn)lask會(huì)轉(zhuǎn)化成reponse對(duì)象，你也可以通過(guò) make_response()函數(shù)明確的來(lái)返回它湃累，并且修飾它勃救。
('有時(shí)候需要在返回的時(shí)候設(shè)置headers，這時(shí)候你就需要make_respone函數(shù)來(lái)明確返回一個(gè)response object')
有時(shí)候你想要在response對(duì)象還不存在的時(shí)候創(chuàng)建cookie治力，你就需要利用 Deferred Request Callbacks 模式蒙秒。
Deferred Request Callbacks最重要的關(guān)鍵點(diǎn)是before_request與after_request函數(shù)，這兩個(gè)函數(shù)分別是注冊(cè)一個(gè)函數(shù)在request之前和之后執(zhí)行宵统。before_request被注冊(cè)的函數(shù)沒(méi)有參數(shù)税肪，after_request注冊(cè)的函數(shù)有一個(gè)參數(shù) response_class的實(shí)例乘综，并且返回一個(gè)response 對(duì)象描孟。
from flask import g
#自定義裝飾器首有，通過(guò)g來(lái)傳遞數(shù)據(jù)
def after_this_request(f):
if not hasattr(g, 'after_request_callbacks'):
g.after_request_callbacks = []
g.after_request_callbacks.append(f)
return f
from flask import request
#在處理request前執(zhí)行抖棘，如果沒(méi)有錯(cuò)誤，進(jìn)入視圖函數(shù)執(zhí)行
@app.before_request
def detect_user_language():
language = request.cookies.get('user_lang')
if language is None:
language = guess_language_from_request()
@after_this_request #自定義裝飾器净捅，將下面的函數(shù)放入g對(duì)象屬性中疑枯，此時(shí)response不存在
def remember_language(response):
response.set_cookie('user_lang', language)
g.language = language
#request在視圖函數(shù)處理返回response后執(zhí)行
@app.after_request
def call_after_request_callbacks(response):
for callback in getattr(g, 'after_request_callbacks', ()):
callback(response)
return response
Redirects and Errors 重定向與錯(cuò)誤
記住redirect 與 abort函數(shù)
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()
默認(rèn)的flask提供一套簡(jiǎn)單的error page，如果想自定義蛔六，使用 errorhandler() 裝飾器:
from flask import render_template
@app.errorhandler(404)
def page_not_found(error):
return render_template('page_not_found.html'), 404
調(diào)用 render_template() 后的404告訴 Flask頁(yè)面沒(méi)找到荆永，默認(rèn)是200，表示一切都好国章。
關(guān)于Responses
flask將返回值轉(zhuǎn)化為response對(duì)象的邏輯規(guī)則如下：
1具钥、如果返回正確類型的response對(duì)象，視圖函數(shù)直接返回液兽。
2骂删、如果返回的是字符串，flask將string與一些默認(rèn)參數(shù)轉(zhuǎn)化為response對(duì)象四啰。
3宁玫、如果是一個(gè)元組，那么必須以(response, status, headers) 或 (response, headers)的形式出現(xiàn)柑晒，至少有一項(xiàng)必須存在欧瘪。status value 將會(huì)覆蓋status，headers可以以列表或字典的形式出現(xiàn)匙赞。
如果你想在視圖中控制返回對(duì)象佛掖，使用make_response函數(shù)
@app.errorhandler(404)
def not_found(error):
resp = make_response(render_template('error.html'), 404)
resp.headers['X-Something'] = 'A value'
return resp
Sessions
除request對(duì)象外還有一個(gè)session對(duì)象。session對(duì)象能夠讓你在request之間保存一些對(duì)用戶來(lái)說(shuō)具體的信息涌庭。它是基于cookie的芥被，并為其加密。也就是說(shuō)它只能夠讀脾猛，但不能夠修改撕彤，除非你知道了密碼鱼鸠。
from flask import Flask, session, redirect, url_for, escape, request
app = Flask(__name__)
@app.route('/')
def index():
if 'username' in session:
#Convert the characters &, <, >, ‘, and ” in string s to HTML-safe sequences
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 method="post">
<p><input type=text name=username>
<p><input type=submit value=Login>
</form>
'''
@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'
How to generate good secret keys?
如何產(chǎn)生好用的秘鑰
import os
os.urandom(24)
flask 默認(rèn)的是客戶端session猛拴，如果你想處理服務(wù)端的，可以使用flask擴(kuò)展解決蚀狰。
Message Flashing
flask提供應(yīng)用程序與用戶之間良好交互的方法愉昆。它在一個(gè)請(qǐng)求結(jié)束后記錄message，在下一個(gè)（僅下一個(gè)）請(qǐng)求中獲得它麻蹋。
flash 例子 更多細(xì)節(jié) Message Flashing
from flask import Flask, flash, redirect, render_template, \
request, url_for
app = Flask(__name__)
app.secret_key = 'some_secret'
@app.route('/')
def index():
return render_template('index.html')
@app.route('/login', methods=['GET', 'POST'])
def login():
error = None
if request.method == 'POST':
if request.form['username'] != 'admin' or \
request.form['password'] != 'secret':
error = 'Invalid credentials'
else:
flash('You were successfully logged in') #這里調(diào)用flash函數(shù)
return redirect(url_for('index'))
return render_template('login.html', error=error)
<!doctype html>
<title>My Application</title>
{% with messages = get_flashed_messages() %} #前端調(diào)用該函數(shù)
{% if messages %}
<ul class=flashes>
{% for message in messages %}
<li>{{ message }}</li>
{% endfor %}
</ul>
{% endif %}
{% endwith %}
{% block body %}{% endblock %}
Logging
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)的logging Logger跛溉，可查看官方的 logging documentation獲得更多信息。
WSGI 中間件
不了解wsgi的可看一下我的另一篇文章帶你快速了解WSGI
(middleware需要把自己偽裝成一個(gè)服務(wù)器，接受應(yīng)用程序芳室，調(diào)用它专肪，同時(shí)middleware還需要把自己偽裝成一個(gè)應(yīng)用程序，傳給服務(wù)器程序堪侯。)
如果你想在你的程序中增加一個(gè)wsgi中間件嚎尤，你可以包裝內(nèi)部的wsgi應(yīng)用程序。你可以像下面這樣做來(lái)使用LighttpdCGIRootFix中間件伍宦。
from werkzeug.contrib.fixers import LighttpdCGIRootFix
app.wsgi_app = LighttpdCGIRootFix(app.wsgi_app)
