Flask是一個輕量級的基于Python的web框架。
本文適合有一定HTML、Python、網(wǎng)絡(luò)基礎(chǔ)的同學(xué)閱讀。
這份文檔中的代碼使用 Python 3 運行。
是的,所以讀者需要自己在電腦上安裝Python 3 和 pip3。建議安裝最新版本,我使用的是Python 3.6.4
。
安裝方法,可以自行谷歌或者百度。
建議在 linux 下實踐本教程中命令行操作、執(zhí)行代碼。
通過pip3安裝Flask即可:
$ sudo pip3 install Flask
進入python交互模式看下Flask的介紹和版本:
- $ python3
- >>> import flask
- >>> print(flask.__doc__)
- flask
- ~~~~~
- A microframework based on Werkzeug. It's extensively documented
- and follows best practice patterns.
- :copyright: ? 2010 by the Pallets team.
- :license: BSD, see LICENSE for more details.
- >>> print(flask.__version__)
- 1.0.2
本節(jié)主要內(nèi)容:使用Flask寫一個顯示”Hello World!”的web程序,如何配置、調(diào)試Flask。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
static
和templates
目錄是默認(rèn)配置,其中static
用來存放靜態(tài)資源,例如圖片、js、css文件等。templates
存放模板文件。
我們的網(wǎng)站邏輯基本在server.py
文件中,當(dāng)然,也可以給這個文件起其他的名字。
在server.py
中加入以下內(nèi)容:
- from flask import Flask
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'Hello World!'
- if __name__ == '__main__':
- app.run()
運行server.py
:
- $ python3 server.py
- * Running on http://127.0.0.1:5000/
打開瀏覽器訪問http://127.0.0.1:5000/
,瀏覽頁面上將出現(xiàn)Hello World!
。
終端里會顯示下面的信息:
127.0.0.1 - - [16/May/2014 10:29:08] "GET / HTTP/1.1" 200 -
變量app是一個Flask實例,通過下面的方式:
- @app.route('/')
- def hello_world():
- return 'Hello World!'
當(dāng)客戶端訪問/
時,將響應(yīng)hello_world()
函數(shù)返回的內(nèi)容。注意,這不是返回Hello World!
這么簡單,Hello World!
只是HTTP響應(yīng)報文的實體部分,狀態(tài)碼等信息既可以由Flask自動處理,也可以通過編程來制定。
app = Flask(__name__)
上面的代碼中,python內(nèi)置變量__name__
的值是字符串__main__
。Flask類將這個參數(shù)作為程序名稱。當(dāng)然這個是可以自定義的,比如app = Flask("my-app")
。
Flask默認(rèn)使用static
目錄存放靜態(tài)資源,templates
目錄存放模板,這是可以通過設(shè)置參數(shù)更改的:
app = Flask("my-app", static_folder="path1", template_folder="path2")
更多參數(shù)請參考__doc__
:
- from flask import Flask
- print(Flask.__doc__)
上面的server.py中以app.run()
方式運行,這種方式下,如果服務(wù)器端出現(xiàn)錯誤是不會在客戶端顯示的。但是在開發(fā)環(huán)境中,顯示錯誤信息是很有必要的,要顯示錯誤信息,應(yīng)該以下面的方式運行Flask:
app.run(debug=True)
將debug
設(shè)置為True
的另一個好處是,程序啟動后,會自動檢測源碼是否發(fā)生變化,若有變化則自動重啟程序。這可以幫我們省下很多時間。
默認(rèn)情況下,F(xiàn)lask綁定IP為127.0.0.1
,端口為5000
。我們也可以通過下面的方式自定義:
app.run(host='0.0.0.0', port=80, debug=True)
0.0.0.0
代表電腦所有的IP。80
是HTTP網(wǎng)站服務(wù)的默認(rèn)端口。什么是默認(rèn)?比如,我們訪問網(wǎng)站http://www.example.com
,其實是訪問的http://www.example.com:80
,只不過:80
可以省略不寫。
由于綁定了80端口,需要使用root權(quán)限運行server.py
。也就是:
$ sudo python3 server.py
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-001
URL參數(shù)是出現(xiàn)在url中的鍵值對,例如http://127.0.0.1:5000/?disp=3
中的url參數(shù)是{'disp':3}
。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
在server.py中添加以下內(nèi)容:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return request.args.__str__()
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
在瀏覽器中訪問http://127.0.0.1:5000/?user=Flask&time&p=7&p=8
,將顯示:
ImmutableMultiDict([('user', 'Flask'), ('time', ''), ('p', '7'), ('p', '8')])
較新的瀏覽器也支持直接在url中輸入中文(最新的火狐瀏覽器內(nèi)部會幫忙將中文轉(zhuǎn)換成符合URL規(guī)范的數(shù)據(jù)),在瀏覽器中訪問http://127.0.0.1:5000/?info=這是愛,
,將顯示:
ImmutableMultiDict([('info', '這是愛,')])
瀏覽器傳給我們的Flask服務(wù)的數(shù)據(jù)長什么樣子呢?可以通過request.full_path
和request.path
來看一下:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- print(request.path)
- print(request.full_path)
- return request.args.__str__()
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
瀏覽器訪問http://127.0.0.1:5000/?info=這是愛,
,運行server.py
的終端會輸出:
- /
- /?info=%E8%BF%99%E6%98%AF%E7%88%B1%EF%BC%8C
例如,要獲取鍵info
對應(yīng)的值,如下修改server.py
:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return request.args.get('info')
- if __name__ == '__main__':
- app.run(port=5000)
運行server.py
,在瀏覽器中訪問http://127.0.0.1:5000/?info=hello
,瀏覽器將顯示:
hello
不過,當(dāng)我們訪問http://127.0.0.1:5000/
時候卻出現(xiàn)了500錯誤,瀏覽器顯示:
為什么為這樣?
這是因為沒有在URL參數(shù)中找到info
。所以request.args.get('info')
返回Python內(nèi)置的None,而Flask不允許返回None。
解決方法很簡單,我們先判斷下它是不是None:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- r = request.args.get('info')
- if r==None:
- # do something
- return ''
- return r
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
另外一個方法是,設(shè)置默認(rèn)值,也就是取不到數(shù)據(jù)時用這個值:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- r = request.args.get('info', 'hi')
- return r
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
函數(shù)request.args.get
的第二個參數(shù)用來設(shè)置默認(rèn)值。此時在瀏覽器訪問http://127.0.0.1:5000/
,將顯示:
hi
還記得上面有一次請求是這樣的嗎? http://127.0.0.1:5000/?user=Flask&time&p=7&p=8
,仔細(xì)看下,p
有兩個值。
如果我們的代碼是:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- r = request.args.get('p')
- return r
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
在瀏覽器中請求時,我們只會看到7
。如果我們需要把p
的所有值都獲取到,該怎么辦?
不用get
,用getlist
:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- r = request.args.getlist('p') # 返回一個list
- return str(r)
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
瀏覽器輸入 http://127.0.0.1:5000/?user=Flask&time&p=7&p=8
,我們會看到['7', '8']
。
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-002
作為一種HTTP請求方法,POST用于向指定的資源提交要被處理的數(shù)據(jù)。我們在某網(wǎng)站注冊用戶、寫文章等時候,需要將數(shù)據(jù)傳遞到網(wǎng)站服務(wù)器中。并不適合將數(shù)據(jù)放到URL參數(shù)中,密碼放到URL參數(shù)中容易被看到,文章數(shù)據(jù)又太多,瀏覽器不一定支持太長長度的URL。這時,一般使用POST方法。
本文使用python的requests庫模擬瀏覽器。
安裝方法:
$ sudo pip3 install requests
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
以用戶注冊為例子,我們需要向服務(wù)器/register
傳送用戶名name
和密碼password
。如下編寫HelloWorld/server.py
。
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/register', methods=['POST'])
- def register():
- print(request.headers)
- print(request.stream.read())
- return 'welcome'
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
`@app.route(‘/register’, methods=[‘POST’])是指url
/register只接受POST方法??梢愿鶕?jù)需要修改
methods`參數(shù),例如如果想要讓它同時支持GET和POST,這樣寫:
@app.route('/register', methods=['GET', 'POST'])
瀏覽器模擬工具client.py
內(nèi)容如下:
- import requests
- user_info = {'name': 'letian', 'password': '123'}
- r = requests.post("http://127.0.0.1:5000/register", data=user_info)
- print(r.text)
運行HelloWorld/server.py
,然后運行client.py
。client.py
將輸出:
welcome
而HelloWorld/server.py
在終端中輸出以下調(diào)試信息(通過print
輸出):
- Host: 127.0.0.1:5000
- User-Agent: python-requests/2.19.1
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Content-Length: 24
- Content-Type: application/x-www-form-urlencoded
- b'name=letian&password=123'
前6行是client.py生成的HTTP請求頭,由print(request.headers)
輸出。
請求體的數(shù)據(jù),我們通過print(request.stream.read())
輸出,結(jié)果是:
b'name=letian&password=123'
上面,我們看到post的數(shù)據(jù)內(nèi)容是:
b'name=letian&password=123'
我們要想辦法把我們要的name、password提取出來,怎么做呢?自己寫?不用,F(xiàn)lask已經(jīng)內(nèi)置了解析器request.form
。
我們將服務(wù)代碼改成:
- from flask import Flask, request
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/register', methods=['POST'])
- def register():
- print(request.headers)
- # print(request.stream.read()) # 不要用,否則下面的form取不到數(shù)據(jù)
- print(request.form)
- print(request.form['name'])
- print(request.form.get('name'))
- print(request.form.getlist('name'))
- print(request.form.get('nickname', default='little apple'))
- return 'welcome'
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
執(zhí)行client.py
請求數(shù)據(jù),服務(wù)器代碼會在終端輸出:
- Host: 127.0.0.1:5000
- User-Agent: python-requests/2.19.1
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Content-Length: 24
- Content-Type: application/x-www-form-urlencoded
- ImmutableMultiDict([('name', 'letian'), ('password', '123')])
- letian
- letian
- ['letian']
- little apple
request.form
會自動解析數(shù)據(jù)。
request.form['name']
和request.form.get('name')
都可以獲取name
對應(yīng)的值。對于request.form.get()
可以為參數(shù)default
指定值以作為默認(rèn)值。所以:
print(request.form.get('nickname', default='little apple'))
輸出的是默認(rèn)值
little apple
如果name
有多個值,可以使用request.form.getlist('name')
,該方法將返回一個列表。我們將client.py改一下:
- import requests
- user_info = {'name': ['letian', 'letian2'], 'password': '123'}
- r = requests.post("http://127.0.0.1:5000/register", data=user_info)
- print(r.text)
此時運行client.py
,print(request.form.getlist('name'))
將輸出:
[u'letian', u'letian2']
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-003
使用 HTTP POST 方法傳到網(wǎng)站服務(wù)器的數(shù)據(jù)格式可以有很多種,比如「5. 獲取POST方法傳送的數(shù)據(jù)」講到的name=letian&password=123
這種用過&
符號分割的key-value鍵值對格式。我們也可以用JSON格式、XML格式。相比XML的重量、規(guī)范繁瑣,JSON顯得非常小巧和易用。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
如果POST的數(shù)據(jù)是JSON格式,request.json
會自動將json數(shù)據(jù)轉(zhuǎn)換成Python類型(字典或者列表)。
編寫server.py
:
- from flask import Flask, request
- app = Flask("my-app")
- @app.route('/')
- def hello_world():
- return 'Hello World!'
- @app.route('/add', methods=['POST'])
- def add():
- print(request.headers)
- print(type(request.json))
- print(request.json)
- result = request.json['a'] + request.json['b']
- return str(result)
- if __name__ == '__main__':
- app.run(host='127.0.0.1', port=5000, debug=True)
編寫client.py
模擬瀏覽器請求:
- import requests
- json_data = {'a': 1, 'b': 2}
- r = requests.post("http://127.0.0.1:5000/add", json=json_data)
- print(r.text)
運行server.py
,然后運行client.py
,client.py
會在終端輸出:
3
server.py
會在終端輸出:
- Host: 127.0.0.1:5000
- User-Agent: python-requests/2.19.1
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Content-Length: 16
- Content-Type: application/json
- <class 'dict'>
- {'a': 1, 'b': 2}
注意,請求頭中Content-Type
的值是application/json
。
響應(yīng)JSON時,除了要把響應(yīng)體改成JSON格式,響應(yīng)頭的Content-Type
也要設(shè)置為application/json
。
編寫server2.py
:
- from flask import Flask, request, Response
- import json
- app = Flask("my-app")
- @app.route('/')
- def hello_world():
- return 'Hello World!'
- @app.route('/add', methods=['POST'])
- def add():
- result = {'sum': request.json['a'] + request.json['b']}
- return Response(json.dumps(result), mimetype='application/json')
- if __name__ == '__main__':
- app.run(host='127.0.0.1', port=5000, debug=True)
修改后運行。
編寫client2.py
:
- import requests
- json_data = {'a': 1, 'b': 2}
- r = requests.post("http://127.0.0.1:5000/add", json=json_data)
- print(r.headers)
- print(r.text)
運行client.py
,將顯示:
- {'Content-Type': 'application/json', 'Content-Length': '10', 'Server': 'Werkzeug/0.14.1 Python/3.6.4', 'Date': 'Sat, 07 Jul 2018 05:23:00 GMT'}
- {"sum": 3}
上面第一段內(nèi)容是服務(wù)器的響應(yīng)頭,第二段內(nèi)容是響應(yīng)體,也就是服務(wù)器返回的JSON格式數(shù)據(jù)。
另外,如果需要服務(wù)器的HTTP響應(yīng)頭具有更好的可定制性,比如自定義Server
,可以如下修改add()
函數(shù):
- @app.route('/add', methods=['POST'])
- def add():
- result = {'sum': request.json['a'] + request.json['b']}
- resp = Response(json.dumps(result), mimetype='application/json')
- resp.headers.add('Server', 'python flask')
- return resp
client2.py
運行后會輸出:
- {'Content-Type': 'application/json', 'Content-Length': '10', 'Server': 'python flask', 'Date': 'Sat, 07 Jul 2018 05:26:40 GMT'}
- {"sum": 3}
使用 jsonify 工具函數(shù)即可。
- from flask import Flask, request, jsonify
- app = Flask("my-app")
- @app.route('/')
- def hello_world():
- return 'Hello World!'
- @app.route('/add', methods=['POST'])
- def add():
- result = {'sum': request.json['a'] + request.json['b']}
- return jsonify(result)
- if __name__ == '__main__':
- app.run(host='127.0.0.1', port=5000, debug=True)
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-004
上傳文件,一般也是用POST方法。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
這一部分的代碼參考自How to upload a file to the server in Flask。
我們以上傳圖片為例:
假設(shè)將上傳的圖片只允許’png’、’jpg’、’jpeg’、’gif’這四種格式,通過url/upload
使用POST上傳,上傳的圖片存放在服務(wù)器端的static/uploads
目錄下。
首先在項目HelloWorld
中創(chuàng)建目錄static/uploads
:
mkdir HelloWorld/static/uploads
werkzeug
庫可以判斷文件名是否安全,例如防止文件名是../../../a.png
,安裝這個庫:
$ sudo pip3 install werkzeug
server.py
代碼:
- from flask import Flask, request
- from werkzeug.utils import secure_filename
- import os
- app = Flask(__name__)
- # 文件上傳目錄
- app.config['UPLOAD_FOLDER'] = 'static/uploads/'
- # 支持的文件格式
- app.config['ALLOWED_EXTENSIONS'] = {'png', 'jpg', 'jpeg', 'gif'} # 集合類型
- # 判斷文件名是否是我們支持的格式
- def allowed_file(filename):
- return '.' in filename and \
- filename.rsplit('.', 1)[1] in app.config['ALLOWED_EXTENSIONS']
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/upload', methods=['POST'])
- def upload():
- upload_file = request.files['image']
- if upload_file and allowed_file(upload_file.filename):
- filename = secure_filename(upload_file.filename)
- # 將文件保存到 static/uploads 目錄,文件名同上傳時使用的文件名
- upload_file.save(os.path.join(app.root_path, app.config['UPLOAD_FOLDER'], filename))
- return 'info is '+request.form.get('info', '')+'. success'
- else:
- return 'failed'
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
app.config
中的config是字典的子類,可以用來設(shè)置自有的配置信息,也可以設(shè)置自己的配置信息。函數(shù)allowed_file(filename)
用來判斷filename
是否有后綴以及后綴是否在app.config['ALLOWED_EXTENSIONS']
中。
客戶端上傳的圖片必須以image01
標(biāo)識。upload_file
是上傳文件對應(yīng)的對象。app.root_path
獲取server.py
所在目錄在文件系統(tǒng)中的絕對路徑。upload_file.save(path)
用來將upload_file
保存在服務(wù)器的文件系統(tǒng)中,參數(shù)最好是絕對路徑,否則會報錯(網(wǎng)上很多代碼都是使用相對路徑,但是筆者在使用相對路徑時總是報錯,說找不到路徑)。函數(shù)os.path.join()
用來將使用合適的路徑分隔符將路徑組合起來。
好了,定制客戶端client.py
:
- import requests
- file_data = {'image': open('Lenna.jpg', 'rb')}
- user_info = {'info': 'Lenna'}
- r = requests.post("http://127.0.0.1:5000/upload", data=user_info, files=file_data)
- print(r.text)
運行client.py
,當(dāng)前目錄下的Lenna.jpg
將上傳到服務(wù)器。
然后,我們可以在static/uploads
中看到文件Lenna.jpg
。
要控制上產(chǎn)文件的大小,可以設(shè)置請求實體的大小,例如:
app.config['MAX_CONTENT_LENGTH'] = 16 * 1024 * 1024 #16MB
不過,在處理上傳文件時候,需要使用try:...except:...
。
如果要獲取上傳文件的內(nèi)容可以:
file_content = request.files['image'].stream.read()
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-005
簡單來說,Restful URL可以看做是對 URL 參數(shù)的替代。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
編輯server.py:
- from flask import Flask
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/user/<username>')
- def user(username):
- print(username)
- print(type(username))
- return 'hello ' + username
- @app.route('/user/<username>/friends')
- def user_friends(username):
- print(username)
- print(type(username))
- return 'hello ' + username
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
運行HelloWorld/server.py
。使用瀏覽器訪問http://127.0.0.1:5000/user/letian
,HelloWorld/server.py將輸出:
- letian
- <class 'str'>
而訪問http://127.0.0.1:5000/user/letian/
,響應(yīng)為404 Not Found。
瀏覽器訪問http://127.0.0.1:5000/user/letian/friends
,可以看到:
Hello letian. They are your friends.
HelloWorld/server.py
輸出:
- letian
- <class 'str'>
由上面的示例可以看出,使用 Restful URL 得到的變量默認(rèn)為str對象。如果我們需要通過分頁顯示查詢結(jié)果,那么需要在url中有數(shù)字來指定頁數(shù)。按照上面方法,可以在獲取str類型頁數(shù)變量后,將其轉(zhuǎn)換為int類型。不過,還有更方便的方法,就是用flask內(nèi)置的轉(zhuǎn)換機制,即在route中指定該如何轉(zhuǎn)換。
新的服務(wù)器代碼:
- from flask import Flask
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/page/<int:num>')
- def page(num):
- print(num)
- print(type(num))
- return 'hello world'
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
`@app.route(‘/page/int:num‘)`會將num變量自動轉(zhuǎn)換成int類型。
運行上面的程序,在瀏覽器中訪問http://127.0.0.1:5000/page/1
,HelloWorld/server.py將輸出如下內(nèi)容:
- 1
- <class 'int'>
如果訪問的是http://127.0.0.1:5000/page/asd
,我們會得到404響應(yīng)。
在官方資料中,說是有3個默認(rèn)的轉(zhuǎn)換器:
- int accepts integers
- float like int but for floating point values
- path like the default but also accepts slashes
看起來夠用了。
如下編寫服務(wù)器代碼:
- from flask import Flask
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/page/<int:num1>-<int:num2>')
- def page(num1, num2):
- print(num1)
- print(num2)
- return 'hello world'
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
在瀏覽器中訪問http://127.0.0.1:5000/page/11-22
,HelloWorld/server.py
會輸出:
- 11
- 22
自定義的轉(zhuǎn)換器是一個繼承werkzeug.routing.BaseConverter
的類,修改to_python
和to_url
方法即可。to_python
方法用于將url中的變量轉(zhuǎn)換后供被`@app.route包裝的函數(shù)使用,
to_url方法用于
flask.url_for`中的參數(shù)轉(zhuǎn)換。
下面是一個示例,將HelloWorld/server.py
修改如下:
- from flask import Flask, url_for
- from werkzeug.routing import BaseConverter
- class MyIntConverter(BaseConverter):
- def __init__(self, url_map):
- super(MyIntConverter, self).__init__(url_map)
- def to_python(self, value):
- return int(value)
- def to_url(self, value):
- return value * 2
- app = Flask(__name__)
- app.url_map.converters['my_int'] = MyIntConverter
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/page/<my_int:num>')
- def page(num):
- print(num)
- print(url_for('page', num=123)) # page 對應(yīng)的是 page函數(shù) ,num 對應(yīng)對應(yīng)`/page/<my_int:num>`中的num,必須是str
- return 'hello world'
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
瀏覽器訪問http://127.0.0.1:5000/page/123
后,HelloWorld/server.py
的輸出信息是:
- 123
- /page/123123
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-006
url_for
生成鏈接工具函數(shù)url_for
可以讓你以軟編碼的形式生成url,提供開發(fā)效率。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
編輯HelloWorld/server.py
:
- from flask import Flask, url_for
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- pass
- @app.route('/user/<name>')
- def user(name):
- pass
- @app.route('/page/<int:num>')
- def page(num):
- pass
- @app.route('/test')
- def test():
- print(url_for('hello_world'))
- print(url_for('user', name='letian'))
- print(url_for('page', num=1, q='hadoop mapreduce 10%3'))
- print(url_for('static', filename='uploads/01.jpg'))
- return 'Hello'
- if __name__ == '__main__':
- app.run(debug=True)
運行HelloWorld/server.py
。然后在瀏覽器中訪問http://127.0.0.1:5000/test
,HelloWorld/server.py
將輸出以下信息:
- /
- /user/letian
- /page/1?q=hadoop+mapreduce+10%253
- /static/uploads/01.jpg
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-007
redirect
函數(shù)用于重定向,實現(xiàn)機制很簡單,就是向客戶端(瀏覽器)發(fā)送一個重定向的HTTP報文,瀏覽器會去訪問報文中指定的url。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
使用redirect
時,給它一個字符串類型的參數(shù)就行了。
編輯HelloWorld/server.py
:
- from flask import Flask, url_for, redirect
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/test1')
- def test1():
- print('this is test1')
- return redirect(url_for('test2'))
- @app.route('/test2')
- def test2():
- print('this is test2')
- return 'this is test2'
- if __name__ == '__main__':
- app.run(debug=True)
運行HelloWorld/server.py
,在瀏覽器中訪問http://127.0.0.1:5000/test1
,瀏覽器的url會變成http://127.0.0.1:5000/test2
,并顯示:
this is test2
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-008
模板引擎負(fù)責(zé)MVC中的V(view,視圖)這一部分。Flask默認(rèn)使用Jinja2模板引擎。
Flask與模板相關(guān)的函數(shù)有:
這其中常用的就是前兩個函數(shù)。
這個實例中使用了模板繼承、if判斷、for循環(huán)。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
內(nèi)容如下:
- <html>
- <head>
- <title>
- {% if page_title %}
- {{ page_title }}
- {% endif %}
- </title>
- </head>
- <body>
- {% block body %}{% endblock %}
- ```
- 可以看到,在``標(biāo)簽中使用了if判斷,如果給模板傳遞了`page_title`變量,顯示之,否則,不顯示。
- ``標(biāo)簽中定義了一個名為`body`的block,用來被其他模板文件繼承。
- ### 11.3 創(chuàng)建并編輯HelloWorld/templates/user_info.html
- 內(nèi)容如下:
- ```
- {% extends "default.html" %}
- {% block body %}
- {% for key in user_info %}
- {{ key }}: {{ user_info[key] }}
- {% endfor %}
- {% endblock %}
變量user_info
應(yīng)該是一個字典,for循環(huán)用來循環(huán)輸出鍵值對。
內(nèi)容如下:
- from flask import Flask, render_template
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/user')
- def user():
- user_info = {
- 'name': 'letian',
- 'email': '123@aa.com',
- 'age':0,
- 'github': 'https://github.com/letiantian'
- }
- return render_template('user_info.html', page_title='letian\'s info', user_info=user_info)
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
render_template()
函數(shù)的第一個參數(shù)指定模板文件,后面的參數(shù)是要傳遞的數(shù)據(jù)。
運行HelloWorld/server.py:
$ python3 HelloWorld/server.py
在瀏覽器中訪問http://127.0.0.1:5000/user
,效果圖如下:
查看網(wǎng)頁源碼:
- <html>
- <head>
- <title>
- letian's info
- </title>
- </head>
- <body>
- name: letian <br/>
- email: 123@aa.com <br/>
- age: 0 <br/>
- github: https://github.com/letiantian <br/>
- </body>
- </html>
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-009
要處理HTTP錯誤,可以使用flask.abort
函數(shù)。
建立Flask項目
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
代碼
編輯HelloWorld/server.py
:
- from flask import Flask, render_template_string, abort
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/user')
- def user():
- abort(401) # Unauthorized 未授權(quán)
- print('Unauthorized, 請先登錄')
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
效果
運行HelloWorld/server.py
,瀏覽器訪問http://127.0.0.1:5000/user
,效果如下:
要注意的是,HelloWorld/server.py
中abort(401)
后的print
并沒有執(zhí)行。
代碼
將服務(wù)器代碼改為:
- from flask import Flask, render_template_string, abort
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/user')
- def user():
- abort(401) # Unauthorized
- @app.errorhandler(401)
- def page_unauthorized(error):
- return render_template_string('<h1> Unauthorized </h1><h2>{{ error_info }}</h2>', error_info=error), 401
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
page_unauthorized
函數(shù)返回的是一個元組,401 代表HTTP 響應(yīng)狀態(tài)碼。如果省略401,則響應(yīng)狀態(tài)碼會變成默認(rèn)的 200。
效果
運行HelloWorld/server.py
,瀏覽器訪問http://127.0.0.1:5000/user
,效果如下:
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-010
session用來記錄用戶的登錄狀態(tài),一般基于cookie實現(xiàn)。
下面是一個簡單的示例。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
HelloWorld/server.py
內(nèi)容如下:
- from flask import Flask, render_template_string, \
- session, request, redirect, url_for
- app = Flask(__name__)
- app.secret_key = 'F12Zr47j\3yX R~X@H!jLwf/T'
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/login')
- def login():
- page = '''
- <form action="{{ url_for('do_login') }}" method="post">
- <p>name: <input type="text" name="user_name" /></p>
- <input type="submit" value="Submit" />
- </form>
- '''
- return render_template_string(page)
- @app.route('/do_login', methods=['POST'])
- def do_login():
- name = request.form.get('user_name')
- session['user_name'] = name
- return 'success'
- @app.route('/show')
- def show():
- return session['user_name']
- @app.route('/logout')
- def logout():
- session.pop('user_name', None)
- return redirect(url_for('login'))
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
app.secret_key
用于給session加密。
在/login
中將向用戶展示一個表單,要求輸入一個名字,submit后將數(shù)據(jù)以post的方式傳遞給/do_login
,/do_login
將名字存放在session中。
如果用戶成功登錄,訪問/show
時會顯示用戶的名字。此時,打開firebug等調(diào)試工具,選擇session面板,會看到有一個cookie的名稱為session
。
/logout
用于登出,通過將session
中的user_name
字段pop即可。Flask中的session基于字典類型實現(xiàn),調(diào)用pop方法時會返回pop的鍵對應(yīng)的值;如果要pop的鍵并不存在,那么返回值是pop()
的第二個參數(shù)。
另外,使用redirect()
重定向時,一定要在前面加上return
。
進入http://127.0.0.1:5000/login
,輸入name,點擊submit:
進入http://127.0.0.1:5000/show
查看session中存儲的name:
下面這段代碼來自Is there an easy way to make sessions timeout in flask?:
- from datetime import timedelta
- from flask import session, app
- session.permanent = True
- app.permanent_session_lifetime = timedelta(minutes=5)
這段代碼將session的有效時間設(shè)置為5分鐘。
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-011
Cookie是存儲在客戶端的記錄訪問者狀態(tài)的數(shù)據(jù)。具體原理,請見 http://zh.wikipedia.org/wiki/Cookie 。 常用的用于記錄用戶登錄狀態(tài)的session大多是基于cookie實現(xiàn)的。
cookie可以借助flask.Response
來實現(xiàn)。下面是一個示例。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
修改HelloWorld/server.py
:
- from flask import Flask, request, Response, make_response
- import time
- app = Flask(__name__)
- @app.route('/')
- def hello_world():
- return 'hello world'
- @app.route('/add')
- def login():
- res = Response('add cookies')
- res.set_cookie(key='name', value='letian', expires=time.time()+6*60)
- return res
- @app.route('/show')
- def show():
- return request.cookies.__str__()
- @app.route('/del')
- def del_cookie():
- res = Response('delete cookies')
- res.set_cookie('name', '', expires=0)
- return res
- if __name__ == '__main__':
- app.run(port=5000, debug=True)
由上可以看到,可以使用Response.set_cookie
添加和刪除cookie。expires
參數(shù)用來設(shè)置cookie有效時間,它的值可以是datetime
對象或者unix時間戳,筆者使用的是unix時間戳。
res.set_cookie(key='name', value='letian', expires=time.time()+6*60)
上面的expire參數(shù)的值表示cookie在從現(xiàn)在開始的6分鐘內(nèi)都是有效的。
要刪除cookie,將expire參數(shù)的值設(shè)為0即可:
res.set_cookie('name', '', expires=0)
set_cookie()
函數(shù)的原型如下:
set_cookie(key, value=’’, max_age=None, expires=None, path=’/‘, domain=None, secure=None, httponly=False)
Sets a cookie. The parameters are the same as in the cookie Morsel object in the Python standard library but it accepts unicode data, too.
Parameters:
key – the key (name) of the cookie to be set.
value – the value of the cookie.
max_age – should be a number of seconds, or None (default) if the cookie should last only as long as the client’s browser session.
expires – should be a datetime object or UNIX timestamp.
domain – if you want to set a cross-domain cookie. For example, domain=”.example.com” will set a cookie that is readable by the domain www.example.com, foo.example.com etc. Otherwise, a cookie will only be readable by the domain that set it.
path – limits the cookie to a given path, per default it will span the whole domain.
運行HelloWorld/server.py
:
$ python3 HelloWorld/server.py
使用瀏覽器打開http://127.0.0.1:5000/add
,瀏覽器界面會顯示
add cookies
下面查看一下cookie,如果使用firefox瀏覽器,可以用firebug插件查看。打開firebug,選擇Cookies
選項,刷新頁面,可以看到名為name
的cookie,其值為letian
。
在“網(wǎng)絡(luò)”選項中,可以查看響應(yīng)頭中類似下面內(nèi)容的設(shè)置cookie的HTTP「指令」:
Set-Cookie: name=letian; Expires=Sun, 29-Jun-2014 05:16:27 GMT; Path=/
在cookie有效期間,使用瀏覽器訪問http://127.0.0.1:5000/show
,可以看到:
{'name': 'letian'}
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-012
Flask的閃存系統(tǒng)(flashing system)用于向用戶提供反饋信息,這些反饋信息一般是對用戶上一次操作的反饋。反饋信息是存儲在服務(wù)器端的,當(dāng)服務(wù)器向客戶端返回反饋信息后,這些反饋信息會被服務(wù)器端刪除。
下面是一個示例。
按照以下命令建立Flask項目HelloWorld:
- mkdir HelloWorld
- mkdir HelloWorld/static
- mkdir HelloWorld/templates
- touch HelloWorld/server.py
內(nèi)容如下:
- from flask import Flask, flash, get_flashed_messages
- import time
- app = Flask(__name__)
- app.secret_key = 'some_secret'
- @app.route('/')
- def index():
- return 'hi'
- @app.route('/gen')
- def gen():
- info = 'access at '+ time.time().__str__()
- flash(info)
- return info
- @app.route('/show1')
- def show1():
- return get_flashed_messages().__str__()
- @app.route('/show2')
- def show2():
- return get_flashed_messages().__str__()
- if __name__ == "__main__":
- app.run(port=5000, debug=True)
運行服務(wù)器:
$ python3 HelloWorld/server.py
打開瀏覽器,訪問http://127.0.0.1:5000/gen
,瀏覽器界面顯示(注意,時間戳是動態(tài)生成的,每次都會不一樣,除非并行訪問):
access at 1404020982.83
查看瀏覽器的cookie,可以看到session
,其對應(yīng)的內(nèi)容是:
.eJyrVopPy0kszkgtVrKKrlZSKIFQSUpWSknhYVXJRm55UYG2tkq1OlDRyHC_rKgIvypPdzcDTxdXA1-XwHLfLEdTfxfPUn8XX6DKWCAEAJKBGq8.BpE6dg.F1VURZa7VqU9bvbC4XIBO9-3Y4Y
再一次訪問http://127.0.0.1:5000/gen
,瀏覽器界面顯示:
access at 1404021130.32
cookie中session
發(fā)生了變化,新的內(nèi)容是:
.eJyrVopPy0kszkgtVrKKrlZSKIFQSUpWSknhYVXJRm55UYG2tkq1OlDRyHC_rKgIvypPdzcDTxdXA1-XwHLfLEdTfxfPUn8XX6DKWLBaMg1yrfCtciz1rfIEGxRbCwAhGjC5.BpE7Cg.Cb_B_k2otqczhknGnpNjQ5u4dqw
然后使用瀏覽器訪問http://127.0.0.1:5000/show1
,瀏覽器界面顯示:
['access at 1404020982.83', 'access at 1404021130.32']
這個列表中的內(nèi)容也就是上面的兩次訪問http://127.0.0.1:5000/gen
得到的內(nèi)容。此時,cookie中已經(jīng)沒有session
了。
如果使用瀏覽器訪問http://127.0.0.1:5000/show1
或者http://127.0.0.1:5000/show2
,只會得到:
[]
flash系統(tǒng)也支持對flash的內(nèi)容進行分類。修改HelloWorld/server.py
內(nèi)容:
- from flask import Flask, flash, get_flashed_messages
- import time
- app = Flask(__name__)
- app.secret_key = 'some_secret'
- @app.route('/')
- def index():
- return 'hi'
- @app.route('/gen')
- def gen():
- info = 'access at '+ time.time().__str__()
- flash('show1 '+info, category='show1')
- flash('show2 '+info, category='show2')
- return info
- @app.route('/show1')
- def show1():
- return get_flashed_messages(category_filter='show1').__str__()
- @app.route('/show2')
- def show2():
- return get_flashed_messages(category_filter='show2').__str__()
- if __name__ == "__main__":
- app.run(port=5000, debug=True)
某一時刻,瀏覽器訪問http://127.0.0.1:5000/gen
,瀏覽器界面顯示:
access at 1404022326.39
不過,由上面的代碼可以知道,此時生成了兩個flash信息,但分類(category)不同。
使用瀏覽器訪問http://127.0.0.1:5000/show1
,得到如下內(nèi)容:
['1 access at 1404022326.39']
而繼續(xù)訪問http://127.0.0.1:5000/show2
,得到的內(nèi)容為空:
[]
在Flask中,get_flashed_messages()
默認(rèn)已經(jīng)集成到Jinja2
模板引擎中,易用性很強。下面是來自官方的一個示例:
https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-013