一,調(diào)試模式
如果你啟用了調(diào)試支持,服務(wù)器會(huì)在代碼修改后自動(dòng)重新載入,并在發(fā)生錯(cuò)誤時(shí)提供一個(gè)相當(dāng)有用的調(diào)試器。
有兩種途徑來啟用調(diào)試模式。一種是直接在應(yīng)用對(duì)象上設(shè)置:
app.debug = True
app.run()
另一種是作為 run 方法的一個(gè)參數(shù)傳入:
app.run(debug=True)
兩種方法的效果完全相同。
默認(rèn)是開啟的。
二,route
route()裝飾器把一個(gè)函數(shù)綁定到對(duì)應(yīng)的 URL 上
如:
@app.route('/')
def index():
return 'Index Page'
@app.route('/hello')
def hello():
return 'Hello World'
三,變量規(guī)則
要給 URL 添加變量部分,你可以把這些特殊的字段標(biāo)記為 <variable_name> , 這個(gè)部分將會(huì)作為命名參數(shù)傳遞到你的函數(shù)。規(guī)則可以用 <converter:variable_name> 指定一個(gè)可選的轉(zhuǎn)換器。
@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
轉(zhuǎn)換器有下面幾種:
int 接受整數(shù)
float 同 int ,但是接受浮點(diǎn)數(shù)
path 和默認(rèn)的相似,但也接受斜線
四,唯一 URL / 重定向行為
@app.route('/projects/')
def projects():
return 'The project page'
@app.route('/about')
def about():
return 'The about page'
第一種情況中,指向 projects 的規(guī)范 URL 尾端有一個(gè)斜線。這種感覺很像在文件系統(tǒng)中的文件夾。訪問一個(gè)結(jié)尾不帶斜線的 URL 會(huì)被 Flask 重定向到帶斜線的規(guī)范 URL 去。
然而,第二種情況的 URL 結(jié)尾不帶斜線,類似 UNIX-like 系統(tǒng)下的文件的路徑名。訪問結(jié)尾帶斜線的 URL 會(huì)產(chǎn)生一個(gè) 404 “Not Found” 錯(cuò)誤。
八,構(gòu)造 URL
可以用 url_for()來給指定的函數(shù)構(gòu)造 URL。它接受函數(shù)名作為第一個(gè)參數(shù),也接受對(duì)應(yīng) URL 規(guī)則的變量部分的命名參數(shù)。未知變量部分會(huì)添加到 URL 末尾作為查詢參數(shù)。
九,HTTP 方法
HTTP (與 Web 應(yīng)用會(huì)話的協(xié)議)有許多不同的訪問 URL 方法。默認(rèn)情況下,路由只回應(yīng) GET請(qǐng)求,但是通過route()裝飾器傳遞 methods參數(shù)可以改變這個(gè)行為。
@app.route('/login', methods=['GET', 'POST'])
def login():
if request.method == 'POST':
do_the_login()
else:
show_the_login_form()
HTTP 方法(也經(jīng)常被叫做“謂詞”)告知服務(wù)器,客戶端想對(duì)請(qǐng)求的頁(yè)面 做 些什么。下面的都是非常常見的方法:
GET
瀏覽器告知服務(wù)器:只 獲取 頁(yè)面上的信息并發(fā)給我。這是最常用的方法。
HEAD
瀏覽器告訴服務(wù)器:欲獲取信息,但是只關(guān)心 消息頭 。應(yīng)用應(yīng)像處理 GET 請(qǐng)求一樣來處理它,但是不分發(fā)實(shí)際內(nèi)容。在 Flask 中你完全無需 人工 干預(yù),底層的 Werkzeug 庫(kù)已經(jīng)替你打點(diǎn)好了。
POST
瀏覽器告訴服務(wù)器:想在 URL 上 發(fā)布 新信息。并且,服務(wù)器必須確保 數(shù)據(jù)已存儲(chǔ)且僅存儲(chǔ)一次。這是 HTML 表單通常發(fā)送數(shù)據(jù)到服務(wù)器的方法。
PUT
類似 POST 但是服務(wù)器可能觸發(fā)了存儲(chǔ)過程多次,多次覆蓋掉舊值。你可 能會(huì)問這有什么用,當(dāng)然這是有原因的??紤]到傳輸中連接可能會(huì)丟失,在 這種 情況下瀏覽器和服務(wù)器之間的系統(tǒng)可能安全地第二次接收請(qǐng)求,而 不破壞其它東西。因?yàn)?POST 它只觸發(fā)一次,所以用 POST 是不可能的。
DELETE
刪除給定位置的信息。
OPTIONS
給客戶端提供一個(gè)敏捷的途徑來弄清這個(gè) URL 支持哪些 HTTP 方法。 從 Flask 0.6 開始,實(shí)現(xiàn)了自動(dòng)處理。
在 HTML4 和 XHTML1 中,表單只能以 GET 和 POST 方法提交到服務(wù)器。但是 JavaScript 和未來的 HTML 標(biāo)準(zhǔn)允許你使用其它所有的方法。
五,靜態(tài)文件
動(dòng)態(tài) web 應(yīng)用也會(huì)需要靜態(tài)文件,通常是 CSS 和 JavaScript 文件。
只要在你的包中或是模塊的所在目錄中創(chuàng)建一個(gè)名為 static 的文件夾,在應(yīng)用中使用 /static 即可訪問。
給靜態(tài)文件生成 URL ,使用特殊的 'static' 端點(diǎn)名:
url_for('static', filename='style.css')
這個(gè)文件應(yīng)該存儲(chǔ)在文件系統(tǒng)上的 static/style.css 。
六,模板渲染
Flask 配備了 Jinja2模板引擎。
你可以使用 render_template()方法來渲染模板。你需要做的一切就是將模板名和你想作為關(guān)鍵字的參數(shù)傳入模板的變量。這里有一個(gè)展示如何渲染模板的簡(jiǎn)例:
from flask import render_template
@app.route('/hello/')
@app.route('/hello/<name>')
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
Jinja2模板實(shí)例:
更多訪問http://docs.jinkan.org/docs/jinja2
<!doctype html>
<title>Hello from Flask</title>
{% if name %}
<h1>Hello {{ name }}!</h1>
{% else %}
<h1>Hello World!</h1>
{% endif %}
在模板里,你也可以訪問 request、session和 g對(duì)象, 以及 get_flashed_messages函數(shù)。
最起碼,模板繼承能使特定元素 (比如頁(yè)眉、導(dǎo)航欄和頁(yè)腳)可以出現(xiàn)在所有的頁(yè)面。
七,訪問請(qǐng)求數(shù)據(jù)
對(duì)于 Web 應(yīng)用,與客戶端發(fā)送給服務(wù)器的數(shù)據(jù)交互至關(guān)重要。在 Flask 中由全局的 request
對(duì)象來提供這些信息。如果你有一定的 Python 經(jīng)驗(yàn),你會(huì)好奇,為什么這個(gè)對(duì)象是全局的,為什么 Flask 還能保證線程安全。答案是環(huán)境作用域
八,環(huán)境局部變量
單元測(cè)試的最簡(jiǎn)單的解決方案是:用 test_request_context環(huán)境管理器。結(jié)合 with聲明,綁定一個(gè)測(cè)試請(qǐng)求,這樣你才能與之交互。下面是一個(gè)例子:
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'
九,請(qǐng)求對(duì)象
首先從 flask 模塊里導(dǎo)入它:
from flask import request
當(dāng)前請(qǐng)求的 HTTP 方法可通過 method 屬性來訪問。通過:attr:~flask.request.form 屬性來訪問表單數(shù)據(jù)( POST 或 PUT 請(qǐng)求提交的數(shù)據(jù))。這里有一個(gè)用到上面提到的那兩個(gè)屬性的完整實(shí)例:
@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)
當(dāng)訪問 form屬性中的不存在的鍵會(huì)發(fā)生什么?會(huì)拋出一個(gè)特殊的 KeyError異常。你可以像捕獲標(biāo)準(zhǔn)的 KeyError 一樣來捕獲它。 如果你不這么做,它會(huì)顯示一個(gè) HTTP 400 Bad Request 錯(cuò)誤頁(yè)面。所以,多數(shù)情況下你并不需要干預(yù)這個(gè)行為。
你可以通過 args屬性來訪問 URL 中提交的參數(shù) ( ?key=value):
searchword = request.args.get('q', '')
推薦用 get 來訪問 URL 參數(shù)或捕獲 KeyError ,因?yàn)橛脩艨赡軙?huì)修改 URL,向他們展現(xiàn)一個(gè) 400 bad request 頁(yè)面會(huì)影響用戶體驗(yàn)。
十一,文件上傳
用 Flask 處理文件上傳很簡(jiǎn)單。只要確保你沒忘記在 HTML 表單中設(shè)置 enctype="multipart/form-data" 屬性,不然你的瀏覽器根本不會(huì)發(fā)送文件。
已上傳的文件存儲(chǔ)在內(nèi)存或是文件系統(tǒng)中一個(gè)臨時(shí)的位置。你可以通過請(qǐng)求對(duì)象的 files
屬性訪問它們。每個(gè)上傳的文件都會(huì)存儲(chǔ)在這個(gè)字典里。它表現(xiàn)近乎為一個(gè)標(biāo)準(zhǔn)的 Python file
對(duì)象,但它還有一個(gè)save()方法,這個(gè)方法允許你把文件保存到服務(wù)器的文件系統(tǒng)上。這里是一個(gè)用它保存文件的例子:
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')
...
如果你要把文件按客戶端提供的文件名存儲(chǔ)在服務(wù)器上,那么請(qǐng)把它傳遞給 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,用響應(yīng)對(duì)象的set_cookie方法來設(shè)置 Cookies。請(qǐng)求對(duì)象的 cookies 屬性是一個(gè)內(nèi)容為客戶端提交的所有 Cookies 的字典。如果你想使用會(huì)話,請(qǐng)不要直接使用 Cookies。在 Flask 中,已經(jīng)注意處理了一些 Cookies 安全細(xì)節(jié)。
讀取 cookies:
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.
存儲(chǔ) 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)對(duì)象上的。由于通常視圖函數(shù)只是返回字符串,之后 Flask 將字符串轉(zhuǎn)換為響應(yīng)對(duì)象。如果你要顯式地轉(zhuǎn)換,你可以使用 make_response函數(shù)然后再進(jìn)行修改。