碼上歡樂
相關內容    簡體    繁體

Python Flask Web 框架入門

本文轉載自   查看原文   2019-06-15 18:30   794    Python

Flask是一個輕量級的基於Python的web框架。

本文適合有一定HTML、Python、網絡基礎的同學閱讀。

1. 簡介

這份文檔中的代碼使用 Python 3 運行。
是的，所以讀者需要自己在電腦上安裝Python 3 和 pip3。建議安裝最新版本，我使用的是Python 3.6.4。
安裝方法，可以自行谷歌或者百度。
建議在 linux 下實踐本教程中命令行操作、執行代碼。

2. 安裝

通過pip3安裝Flask即可：

$ sudo pip3 install Flask

進入python交互模式看下Flask的介紹和版本：

  1. $ python3
  2.  
  3. >>> import flask
  4. >>> print(flask.__doc__)
  5.  
  6. flask
  7. ~~~~~
  8.  
  9. A microframework based on Werkzeug. It's extensively documented
  10. and follows best practice patterns.
  11.  
  12. :copyright: © 2010 by the Pallets team.
  13. :license: BSD, see LICENSE for more details.
  14.  
  15. >>> print(flask.__version__)
  16. 1.0.2

3. 從 Hello World 開始

本節主要內容：使用Flask寫一個顯示”Hello World!”的web程序，如何配置、調試Flask。

3.1 Hello World

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

static和templates目錄是默認配置，其中static用來存放靜態資源，例如圖片、js、css文件等。templates存放模板文件。
我們的網站邏輯基本在server.py文件中，當然，也可以給這個文件起其他的名字。

在server.py中加入以下內容：

  1. from flask import Flask
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. return 'Hello World!'
  8.  
  9. if __name__ == '__main__':
  10. app.run()

運行server.py：

  1. $ python3 server.py
  2. * Running on http://127.0.0.1:5000/

打開瀏覽器訪問http://127.0.0.1:5000/，瀏覽頁面上將出現Hello World!。
終端里會顯示下面的信息：

127.0.0.1 - - [16/May/2014 10:29:08] "GET / HTTP/1.1" 200 -

變量app是一個Flask實例，通過下面的方式：

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

當客戶端訪問/時，將響應hello_world()函數返回的內容。注意，這不是返回Hello World!這么簡單，Hello World!只是HTTP響應報文的實體部分，狀態碼等信息既可以由Flask自動處理，也可以通過編程來制定。

3.2 修改Flask的配置

app = Flask(__name__)

上面的代碼中，python內置變量__name__的值是字符串__main__ 。Flask類將這個參數作為程序名稱。當然這個是可以自定義的，比如app = Flask("my-app")。

Flask默認使用static目錄存放靜態資源，templates目錄存放模板，這是可以通過設置參數更改的：

app = Flask("my-app", static_folder="path1", template_folder="path2")

更多參數請參考__doc__：

  1. from flask import Flask
  2. print(Flask.__doc__)

3.3 調試模式

上面的server.py中以app.run()方式運行，這種方式下，如果服務器端出現錯誤是不會在客戶端顯示的。但是在開發環境中，顯示錯誤信息是很有必要的，要顯示錯誤信息，應該以下面的方式運行Flask：

app.run(debug=True)

將debug設置為True的另一個好處是，程序啟動后，會自動檢測源碼是否發生變化，若有變化則自動重啟程序。這可以幫我們省下很多時間。

3.4 綁定IP和端口

默認情況下，Flask綁定IP為127.0.0.1，端口為5000。我們也可以通過下面的方式自定義：

app.run(host='0.0.0.0', port=80, debug=True)

0.0.0.0代表電腦所有的IP。80是HTTP網站服務的默認端口。什么是默認？比如，我們訪問網站http://www.example.com，其實是訪問的http://www.example.com:80，只不過:80可以省略不寫。

由於綁定了80端口，需要使用root權限運行server.py。也就是：

$ sudo python3 server.py

3.5 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-001

4. 獲取 URL 參數

URL參數是出現在url中的鍵值對，例如http://127.0.0.1:5000/?disp=3中的url參數是{'disp':3}。

4.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

4.2 列出所有的url參數

在server.py中添加以下內容：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return request.args.__str__()
  9.  
  10.  
  11. if __name__ == '__main__':
  12. 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中輸入中文（最新的火狐瀏覽器內部會幫忙將中文轉換成符合URL規范的數據），在瀏覽器中訪問http://127.0.0.1:5000/?info=這是愛，，將顯示：

ImmutableMultiDict([('info', '這是愛，')])

瀏覽器傳給我們的Flask服務的數據長什么樣子呢？可以通過request.full_path和request.path來看一下：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. print(request.path)
  9. print(request.full_path)
  10. return request.args.__str__()
  11.  
  12.  
  13. if __name__ == '__main__':
  14. app.run(port= 5000, debug=True)

瀏覽器訪問http://127.0.0.1:5000/?info=這是愛，，運行server.py的終端會輸出：

  1. /
  2. /?info=%E8%BF%99%E6%98%AF%E7%88%B1%EF%BC%8C

4.3 獲取某個指定的參數

例如，要獲取鍵info對應的值，如下修改server.py：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. return request.args.get('info')
  8.  
  9. if __name__ == '__main__':
  10. app.run(port= 5000)

運行server.py，在瀏覽器中訪問http://127.0.0.1:5000/?info=hello，瀏覽器將顯示：

hello

不過，當我們訪問http://127.0.0.1:5000/時候卻出現了500錯誤，瀏覽器顯示：

如果開啟了Debug模式，會顯示：

為什么為這樣？

這是因為沒有在URL參數中找到info。所以request.args.get('info')返回Python內置的None，而Flask不允許返回None。

解決方法很簡單，我們先判斷下它是不是None：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. r = request.args.get( 'info')
  8. if r==None:
  9. # do something
  10. return ''
  11. return r
  12.  
  13. if __name__ == '__main__':
  14. app.run(port= 5000, debug=True)
  15.  

另外一個方法是，設置默認值，也就是取不到數據時用這個值：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. r = request.args.get( 'info', 'hi')
  8. return r
  9.  
  10. if __name__ == '__main__':
  11. app.run(port= 5000, debug=True)

函數request.args.get的第二個參數用來設置默認值。此時在瀏覽器訪問http://127.0.0.1:5000/，將顯示：

hi

4.4 如何處理多值

還記得上面有一次請求是這樣的嗎？ http://127.0.0.1:5000/?user=Flask&time&p=7&p=8，仔細看下，p有兩個值。

如果我們的代碼是：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. r = request.args.get( 'p')
  8. return r
  9.  
  10. if __name__ == '__main__':
  11. app.run(port= 5000, debug=True)

在瀏覽器中請求時，我們只會看到7。如果我們需要把p的所有值都獲取到，該怎么辦？

不用get，用getlist：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. r = request.args.getlist( 'p') # 返回一個list
  9. return str(r)
  10.  
  11.  
  12. if __name__ == '__main__':
  13. app.run(port= 5000, debug=True)

瀏覽器輸入 http://127.0.0.1:5000/?user=Flask&time&p=7&p=8，我們會看到['7', '8']。

4.5 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-002

5. 獲取POST方法傳送的數據

作為一種HTTP請求方法，POST用於向指定的資源提交要被處理的數據。我們在某網站注冊用戶、寫文章等時候，需要將數據傳遞到網站服務器中。並不適合將數據放到URL參數中，密碼放到URL參數中容易被看到，文章數據又太多，瀏覽器不一定支持太長長度的URL。這時，一般使用POST方法。

本文使用python的requests庫模擬瀏覽器。

安裝方法：

$ sudo pip3 install requests

5.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

5.2 查看POST數據內容

以用戶注冊為例子，我們需要向服務器/register傳送用戶名name和密碼password。如下編寫HelloWorld/server.py。

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/register', methods=['POST'])
  12. def register():
  13. print(request.headers)
  14. print(request.stream.read())
  15. return 'welcome'
  16.  
  17.  
  18. if __name__ == '__main__':
  19. app.run(port= 5000, debug=True)

`@app.route(‘/register’, methods=[‘POST’])是指url/register只接受POST方法。可以根據需要修改methods`參數，例如如果想要讓它同時支持GET和POST，這樣寫：

@app.route('/register', methods=['GET', 'POST'])

瀏覽器模擬工具client.py內容如下：

  1. import requests
  2.  
  3. user_info = { 'name': 'letian', 'password': '123'}
  4. r = requests.post( "http://127.0.0.1:5000/register", data=user_info)
  5.  
  6. print(r.text)

運行HelloWorld/server.py，然后運行client.py。client.py將輸出：

welcome

而HelloWorld/server.py在終端中輸出以下調試信息（通過print輸出）：

  1. Host: 127.0.0.1:5000
  2. User-Agent: python-requests/ 2.19.1
  3. Accept-Encoding: gzip, deflate
  4. Accept: */*
  5. Connection: keep-alive
  6. Content-Length: 24
  7. Content-Type: application/x-www-form-urlencoded
  8.  
  9.  
  10. b'name=letian&password=123'

前6行是client.py生成的HTTP請求頭，由print(request.headers)輸出。

請求體的數據，我們通過print(request.stream.read())輸出，結果是：

b'name=letian&password=123'

5.3 解析POST數據

上面，我們看到post的數據內容是：

b'name=letian&password=123'

我們要想辦法把我們要的name、password提取出來，怎么做呢？自己寫？不用，Flask已經內置了解析器request.form。

我們將服務代碼改成：

  1. from flask import Flask, request
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. return 'hello world'
  8.  
  9.  
  10. @app.route('/register', methods=['POST'])
  11. def register():
  12. print(request.headers)
  13. # print(request.stream.read()) # 不要用，否則下面的form取不到數據
  14. print(request.form)
  15. print(request.form[ 'name'])
  16. print(request.form.get( 'name'))
  17. print(request.form.getlist( 'name'))
  18. print(request.form.get( 'nickname', default='little apple'))
  19. return 'welcome'
  20.  
  21.  
  22. if __name__ == '__main__':
  23. app.run(port= 5000, debug=True)

執行client.py請求數據，服務器代碼會在終端輸出：

  1. Host: 127.0.0.1:5000
  2. User-Agent: python-requests/ 2.19.1
  3. Accept-Encoding: gzip, deflate
  4. Accept: */*
  5. Connection: keep-alive
  6. Content-Length: 24
  7. Content-Type: application/x-www-form-urlencoded
  8.  
  9.  
  10. ImmutableMultiDict([( 'name', 'letian'), ('password', '123')])
  11. letian
  12. letian
  13. [ 'letian']
  14. little apple

request.form會自動解析數據。

request.form['name']和request.form.get('name')都可以獲取name對應的值。對於request.form.get()可以為參數default指定值以作為默認值。所以：

print(request.form.get('nickname', default='little apple'))

輸出的是默認值

little apple

如果name有多個值，可以使用request.form.getlist('name')，該方法將返回一個列表。我們將client.py改一下：

  1. import requests
  2.  
  3. user_info = { 'name': ['letian', 'letian2'], 'password': '123'}
  4. r = requests.post( "http://127.0.0.1:5000/register", data=user_info)
  5.  
  6. print(r.text)

此時運行client.py，print(request.form.getlist('name'))將輸出：

[u'letian', u'letian2']

5.4 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-003

6. 處理和響應JSON數據

使用 HTTP POST 方法傳到網站服務器的數據格式可以有很多種，比如「5. 獲取POST方法傳送的數據」講到的name=letian&password=123這種用過&符號分割的key-value鍵值對格式。我們也可以用JSON格式、XML格式。相比XML的重量、規范繁瑣，JSON顯得非常小巧和易用。

6.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

6.2 處理JSON格式的請求數據

如果POST的數據是JSON格式，request.json會自動將json數據轉換成Python類型（字典或者列表）。

編寫server.py:

  1. from flask import Flask, request
  2.  
  3. app = Flask( "my-app")
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'Hello World!'
  9.  
  10.  
  11. @app.route('/add', methods=['POST'])
  12. def add():
  13. print(request.headers)
  14. print(type(request.json))
  15. print(request.json)
  16. result = request.json[ 'a'] + request.json['b']
  17. return str(result)
  18.  
  19.  
  20. if __name__ == '__main__':
  21. app.run(host= '127.0.0.1', port=5000, debug=True)

編寫client.py模擬瀏覽器請求：

  1. import requests
  2.  
  3. json_data = { 'a': 1, 'b': 2}
  4.  
  5. r = requests.post( "http://127.0.0.1:5000/add", json=json_data)
  6.  
  7. print(r.text)

運行server.py，然后運行client.py，client.py 會在終端輸出：

3

server.py 會在終端輸出：

  1. Host: 127.0.0.1:5000
  2. User-Agent: python-requests/ 2.19.1
  3. Accept-Encoding: gzip, deflate
  4. Accept: * /*
  5. Connection: keep-alive
  6. Content-Length: 16
  7. Content-Type: application/json
  8.  
  9.  
  10. <class 'dict'>
  11. { 'a': 1, 'b': 2}

注意，請求頭中Content-Type的值是application/json。

6.3 響應JSON-方案1

響應JSON時，除了要把響應體改成JSON格式，響應頭的Content-Type也要設置為application/json。

編寫server2.py：

  1. from flask import Flask, request, Response
  2. import json
  3.  
  4. app = Flask( "my-app")
  5.  
  6.  
  7. @app.route('/')
  8. def hello_world():
  9. return 'Hello World!'
  10.  
  11.  
  12. @app.route('/add', methods=['POST'])
  13. def add():
  14. result = { 'sum': request.json['a'] + request.json['b']}
  15. return Response(json.dumps(result), mimetype='application/json')
  16.  
  17.  
  18. if __name__ == '__main__':
  19. app.run(host= '127.0.0.1', port=5000, debug=True)

修改后運行。

編寫client2.py：

  1. import requests
  2.  
  3. json_data = { 'a': 1, 'b': 2}
  4.  
  5. r = requests.post( "http://127.0.0.1:5000/add", json=json_data)
  6.  
  7. print(r.headers)
  8. print(r.text)

運行client.py，將顯示：

  1. { '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'}
  2. { "sum": 3}

上面第一段內容是服務器的響應頭，第二段內容是響應體，也就是服務器返回的JSON格式數據。

另外，如果需要服務器的HTTP響應頭具有更好的可定制性，比如自定義Server，可以如下修改add()函數：

  1. @app.route( '/add', methods=['POST'])
  2. def add():
  3. result = { 'sum': request.json['a'] + request.json['b']}
  4. resp = Response(json.dumps(result), mimetype= 'application/json')
  5. resp.headers.add( 'Server', 'python flask')
  6. return resp

client2.py運行后會輸出：

  1. { 'Content-Type': 'application/json', 'Content-Length': '10', 'Server': 'python flask', 'Date': 'Sat, 07 Jul 2018 05:26:40 GMT'}
  2. { "sum": 3}

6.4 響應JSON-方案2

使用 jsonify 工具函數即可。

  1. from flask import Flask, request, jsonify
  2.  
  3. app = Flask( "my-app")
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'Hello World!'
  9.  
  10.  
  11. @app.route('/add', methods=['POST'])
  12. def add():
  13. result = { 'sum': request.json['a'] + request.json['b']}
  14. return jsonify(result)
  15.  
  16.  
  17. if __name__ == '__main__':
  18. app.run(host= '127.0.0.1', port=5000, debug=True)

6.5 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-004

7. 上傳文件

上傳文件，一般也是用POST方法。

7.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

7.2 上傳文件

這一部分的代碼參考自How to upload a file to the server in Flask。

我們以上傳圖片為例：
假設將上傳的圖片只允許’png’、’jpg’、’jpeg’、’gif’這四種格式，通過url/upload使用POST上傳，上傳的圖片存放在服務器端的static/uploads目錄下。

首先在項目HelloWorld中創建目錄static/uploads：

mkdir HelloWorld/static/uploads

werkzeug庫可以判斷文件名是否安全，例如防止文件名是../../../a.png，安裝這個庫：

$ sudo pip3 install werkzeug

server.py代碼：

  1. from flask import Flask, request
  2.  
  3. from werkzeug.utils import secure_filename
  4. import os
  5.  
  6. app = Flask(__name__)
  7.  
  8. # 文件上傳目錄
  9. app.config[ 'UPLOAD_FOLDER'] = 'static/uploads/'
  10. # 支持的文件格式
  11. app.config[ 'ALLOWED_EXTENSIONS'] = {'png', 'jpg', 'jpeg', 'gif'} # 集合類型
  12.  
  13.  
  14. # 判斷文件名是否是我們支持的格式
  15. def allowed_file(filename):
  16. return '.' in filename and \
  17. filename.rsplit( '.', 1)[1] in app.config['ALLOWED_EXTENSIONS']
  18.  
  19.  
  20. @app.route('/')
  21. def hello_world():
  22. return 'hello world'
  23.  
  24.  
  25. @app.route('/upload', methods=['POST'])
  26. def upload():
  27. upload_file = request.files[ 'image']
  28. if upload_file and allowed_file(upload_file.filename):
  29. filename = secure_filename(upload_file.filename)
  30. # 將文件保存到 static/uploads 目錄，文件名同上傳時使用的文件名
  31. upload_file.save(os.path.join(app.root_path, app.config[ 'UPLOAD_FOLDER'], filename))
  32. return 'info is '+request.form.get('info', '')+'. success'
  33. else:
  34. return 'failed'
  35.  
  36.  
  37. if __name__ == '__main__':
  38. app.run(port= 5000, debug=True)

app.config中的config是字典的子類，可以用來設置自有的配置信息，也可以設置自己的配置信息。函數allowed_file(filename)用來判斷filename是否有后綴以及后綴是否在app.config['ALLOWED_EXTENSIONS']中。

客戶端上傳的圖片必須以image01標識。upload_file是上傳文件對應的對象。app.root_path獲取server.py所在目錄在文件系統中的絕對路徑。upload_file.save(path)用來將upload_file保存在服務器的文件系統中，參數最好是絕對路徑，否則會報錯（網上很多代碼都是使用相對路徑，但是筆者在使用相對路徑時總是報錯，說找不到路徑）。函數os.path.join()用來將使用合適的路徑分隔符將路徑組合起來。

好了，定制客戶端client.py：

  1. import requests
  2.  
  3. file_data = { 'image': open('Lenna.jpg', 'rb')}
  4.  
  5. user_info = { 'info': 'Lenna'}
  6.  
  7. r = requests.post( "http://127.0.0.1:5000/upload", data=user_info, files=file_data)
  8.  
  9. print(r.text)

運行client.py，當前目錄下的Lenna.jpg將上傳到服務器。

然后，我們可以在static/uploads中看到文件Lenna.jpg。

要控制上產文件的大小，可以設置請求實體的大小，例如：

app.config['MAX_CONTENT_LENGTH'] = 16 * 1024 * 1024 #16MB

不過，在處理上傳文件時候，需要使用try:...except:...。

如果要獲取上傳文件的內容可以：

file_content = request.files['image'].stream.read()

7.3 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-005

8. Restful URL

簡單來說，Restful URL可以看做是對 URL 參數的替代。

8.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

8.2 編寫代碼

編輯server.py：

  1. from flask import Flask
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/user/<username>')
  12. def user(username):
  13. print(username)
  14. print(type(username))
  15. return 'hello ' + username
  16.  
  17.  
  18. @app.route('/user/<username>/friends')
  19. def user_friends(username):
  20. print(username)
  21. print(type(username))
  22. return 'hello ' + username
  23.  
  24.  
  25. if __name__ == '__main__':
  26. app.run(port= 5000, debug=True)

運行HelloWorld/server.py。使用瀏覽器訪問http://127.0.0.1:5000/user/letian，HelloWorld/server.py將輸出：

  1. letian
  2. < class 'str'>

而訪問http://127.0.0.1:5000/user/letian/，響應為404 Not Found。

瀏覽器訪問http://127.0.0.1:5000/user/letian/friends，可以看到：

Hello letian. They are your friends.

HelloWorld/server.py輸出：

  1. letian
  2. < class 'str'>

8.3 轉換類型

由上面的示例可以看出，使用 Restful URL 得到的變量默認為str對象。如果我們需要通過分頁顯示查詢結果，那么需要在url中有數字來指定頁數。按照上面方法，可以在獲取str類型頁數變量后，將其轉換為int類型。不過，還有更方便的方法，就是用flask內置的轉換機制，即在route中指定該如何轉換。

新的服務器代碼：

  1. from flask import Flask
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/page/<int:num>')
  12. def page(num):
  13. print(num)
  14. print(type(num))
  15. return 'hello world'
  16.  
  17.  
  18. if __name__ == '__main__':
  19. app.run(port= 5000, debug=True)

`@app.route(‘/page/int:num‘)`會將num變量自動轉換成int類型。

運行上面的程序，在瀏覽器中訪問http://127.0.0.1:5000/page/1，HelloWorld/server.py將輸出如下內容：

  1. 1
  2. < class 'int'>

如果訪問的是http://127.0.0.1:5000/page/asd，我們會得到404響應。

在官方資料中，說是有3個默認的轉換器：

  1. int accepts integers
  2. float like int but for floating point values
  3. path like the default but also accepts slashes

看起來夠用了。

8.4 一個有趣的用法

如下編寫服務器代碼：

  1. from flask import Flask
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/page/<int:num1>-<int:num2>')
  12. def page(num1, num2):
  13. print(num1)
  14. print(num2)
  15. return 'hello world'
  16.  
  17.  
  18. if __name__ == '__main__':
  19. app.run(port= 5000, debug=True)

在瀏覽器中訪問http://127.0.0.1:5000/page/11-22，HelloWorld/server.py會輸出：

  1. 11
  2. 22

8.5 編寫轉換器

自定義的轉換器是一個繼承werkzeug.routing.BaseConverter的類，修改to_python和to_url方法即可。to_python方法用於將url中的變量轉換后供被`@app.route包裝的函數使用，to_url方法用於flask.url_for`中的參數轉換。

下面是一個示例，將HelloWorld/server.py修改如下：

  1. from flask import Flask, url_for
  2.  
  3. from werkzeug.routing import BaseConverter
  4.  
  5.  
  6. class MyIntConverter(BaseConverter):
  7.  
  8. def __init__(self, url_map):
  9. super(MyIntConverter, self).__init__(url_map)
  10.  
  11. def to_python(self, value):
  12. return int(value)
  13.  
  14. def to_url(self, value):
  15. return value * 2
  16.  
  17.  
  18. app = Flask(__name__)
  19. app.url_map.converters[ 'my_int'] = MyIntConverter
  20.  
  21.  
  22. @app.route('/')
  23. def hello_world():
  24. return 'hello world'
  25.  
  26.  
  27. @app.route('/page/<my_int:num>')
  28. def page(num):
  29. print(num)
  30. print(url_for( 'page', num=123)) # page 對應的是 page函數 ，num 對應對應`/page/<my_int:num>`中的num，必須是str
  31. return 'hello world'
  32.  
  33.  
  34. if __name__ == '__main__':
  35. app.run(port= 5000, debug=True)

瀏覽器訪問http://127.0.0.1:5000/page/123后，HelloWorld/server.py的輸出信息是：

  1. 123
  2. /page/123123

8.6 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-006

8.7 值得讀

理解RESTful架構。

9. 使用url_for生成鏈接

工具函數url_for可以讓你以軟編碼的形式生成url，提供開發效率。

9.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

9.2 編寫代碼

編輯HelloWorld/server.py：

  1. from flask import Flask, url_for
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. pass
  8.  
  9. @app.route('/user/<name>')
  10. def user(name):
  11. pass
  12.  
  13. @app.route('/page/<int:num>')
  14. def page(num):
  15. pass
  16.  
  17. @app.route('/test')
  18. def test():
  19. print(url_for( 'hello_world'))
  20. print(url_for( 'user', name='letian'))
  21. print(url_for( 'page', num=1, q='hadoop mapreduce 10%3'))
  22. print(url_for( 'static', filename='uploads/01.jpg'))
  23. return 'Hello'
  24.  
  25. if __name__ == '__main__':
  26. app.run(debug= True)

運行HelloWorld/server.py。然后在瀏覽器中訪問http://127.0.0.1:5000/test，HelloWorld/server.py將輸出以下信息：

  1. /
  2. /user/letian
  3. /page/ 1?q=hadoop+mapreduce+10%253
  4. / static/uploads/01.jpg

9.3 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-007

10. 使用redirect重定向網址

redirect函數用於重定向，實現機制很簡單，就是向客戶端（瀏覽器）發送一個重定向的HTTP報文，瀏覽器會去訪問報文中指定的url。

10.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

10.2 編寫代碼

使用redirect時，給它一個字符串類型的參數就行了。

編輯HelloWorld/server.py：

  1. from flask import Flask, url_for, redirect
  2.  
  3. app = Flask(__name__)
  4.  
  5. @app.route('/')
  6. def hello_world():
  7. return 'hello world'
  8.  
  9. @app.route('/test1')
  10. def test1():
  11. print( 'this is test1')
  12. return redirect(url_for('test2'))
  13.  
  14. @app.route('/test2')
  15. def test2():
  16. print( 'this is test2')
  17. return 'this is test2'
  18.  
  19. if __name__ == '__main__':
  20. 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

10.3 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-008

11. 使用Jinja2模板引擎

模板引擎負責MVC中的V（view，視圖）這一部分。Flask默認使用Jinja2模板引擎。

Flask與模板相關的函數有：

  • flask.render_template(template_name_or_list, **context)
    Renders a template from the template folder with the given context.
  • flask.render_template_string(source, **context)
    Renders a template from the given template source string with the given context.
  • flask.get_template_attribute(template_name, attribute)
    Loads a macro (or variable) a template exports. This can be used to invoke a macro from within Python code.

這其中常用的就是前兩個函數。

這個實例中使用了模板繼承、if判斷、for循環。

11.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

11.2 創建並編輯HelloWorld/templates/default.html

內容如下：

  1. <html>
  2. <head>
  3. <title>
  4. {% if page_title %}
  5. {{ page_title }}
  6. {% endif %}
  7. </title>
  8. </head>
  9.  
  10. <body>
  11. {% block body %}{% endblock %}
  12.  
  13.  
  14. ```
  15.  
  16. 可以看到，在``標簽中使用了if判斷，如果給模板傳遞了`page_title`變量，顯示之，否則，不顯示。
  17.  
  18. ``標簽中定義了一個名為`body`的block，用來被其他模板文件繼承。
  19.  
  20. ### 11.3 創建並編輯HelloWorld/templates/user_info.html
  21. 內容如下：
  22.  
  23. ```
  24. {% extends "default.html" %}
  25.  
  26. {% block body %}
  27. {% for key in user_info %}
  28.  
  29. {{ key }}: {{ user_info[key] }}
  30.  
  31.  
  32. {% endfor %}
  33. {% endblock %}

變量user_info應該是一個字典，for循環用來循環輸出鍵值對。

11.4 編輯HelloWorld/server.py

內容如下：

  1. from flask import Flask, render_template
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/user')
  12. def user():
  13. user_info = {
  14. 'name': 'letian',
  15. 'email': '123@aa.com',
  16. 'age':0,
  17. 'github': 'https://github.com/letiantian'
  18. }
  19. return render_template('user_info.html', page_title='letian\'s info', user_info=user_info)
  20.  
  21.  
  22. if __name__ == '__main__':
  23. app.run(port= 5000, debug=True)

render_template()函數的第一個參數指定模板文件，后面的參數是要傳遞的數據。

11.5 運行與測試

運行HelloWorld/server.py：

$ python3 HelloWorld/server.py

在瀏覽器中訪問http://127.0.0.1:5000/user，效果圖如下：

查看網頁源碼：

  1. <html>
  2. <head>
  3. <title>
  4. letian&#39;s info
  5. </title>
  6. </head>
  7. <body>
  8. name: letian <br/>
  9. email: 123@aa.com <br/>
  10. age: 0 <br/>
  11. github: https://github.com/letiantian <br/>
  12. </body>
  13. </html>

11.6 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-009

12. 自定義404等錯誤的響應

要處理HTTP錯誤，可以使用flask.abort函數。

12.1 示例1：簡單入門

建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

代碼

編輯HelloWorld/server.py：

  1. from flask import Flask, render_template_string, abort
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/user')
  12. def user():
  13. abort( 401) # Unauthorized 未授權
  14. print( 'Unauthorized, 請先登錄')
  15.  
  16.  
  17. if __name__ == '__main__':
  18. app.run(port= 5000, debug=True)

效果

運行HelloWorld/server.py，瀏覽器訪問http://127.0.0.1:5000/user，效果如下：

要注意的是，HelloWorld/server.py中abort(401)后的print並沒有執行。

12.2 示例2：自定義錯誤頁面

代碼

將服務器代碼改為：

  1. from flask import Flask, render_template_string, abort
  2.  
  3. app = Flask(__name__)
  4.  
  5.  
  6. @app.route('/')
  7. def hello_world():
  8. return 'hello world'
  9.  
  10.  
  11. @app.route('/user')
  12. def user():
  13. abort( 401) # Unauthorized
  14.  
  15.  
  16. @app.errorhandler(401)
  17. def page_unauthorized(error):
  18. return render_template_string('<h1> Unauthorized </h1><h2>{{ error_info }}</h2>', error_info=error), 401
  19.  
  20.  
  21. if __name__ == '__main__':
  22. app.run(port= 5000, debug=True)

page_unauthorized函數返回的是一個元組，401 代表HTTP 響應狀態碼。如果省略401，則響應狀態碼會變成默認的 200。

效果

運行HelloWorld/server.py，瀏覽器訪問http://127.0.0.1:5000/user，效果如下：

12.3 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-010

13. 用戶會話

session用來記錄用戶的登錄狀態，一般基於cookie實現。

下面是一個簡單的示例。

13.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

13.2 編輯HelloWorld/server.py

內容如下：

  1. from flask import Flask, render_template_string, \
  2. session, request, redirect, url_for
  3.  
  4. app = Flask(__name__)
  5.  
  6. app.secret_key = 'F12Zr47j\3yX R~X@H!jLwf/T'
  7.  
  8.  
  9. @app.route('/')
  10. def hello_world():
  11. return 'hello world'
  12.  
  13.  
  14. @app.route('/login')
  15. def login():
  16. page = '''
  17. <form action="{{ url_for('do_login') }}" method="post">
  18. <p>name: <input type="text" name="user_name" /></p>
  19. <input type="submit" value="Submit" />
  20. </form>
  21. '''
  22. return render_template_string(page)
  23.  
  24.  
  25. @app.route('/do_login', methods=['POST'])
  26. def do_login():
  27. name = request.form.get( 'user_name')
  28. session[ 'user_name'] = name
  29. return 'success'
  30.  
  31.  
  32. @app.route('/show')
  33. def show():
  34. return session['user_name']
  35.  
  36.  
  37. @app.route('/logout')
  38. def logout():
  39. session.pop( 'user_name', None)
  40. return redirect(url_for('login'))
  41.  
  42.  
  43. if __name__ == '__main__':
  44. app.run(port= 5000, debug=True)

13.3 代碼的含義

app.secret_key用於給session加密。

在/login中將向用戶展示一個表單，要求輸入一個名字，submit后將數據以post的方式傳遞給/do_login，/do_login將名字存放在session中。

如果用戶成功登錄，訪問/show時會顯示用戶的名字。此時，打開firebug等調試工具，選擇session面板，會看到有一個cookie的名稱為session。

/logout用於登出，通過將session中的user_name字段pop即可。Flask中的session基於字典類型實現，調用pop方法時會返回pop的鍵對應的值；如果要pop的鍵並不存在，那么返回值是pop()的第二個參數。

另外，使用redirect()重定向時，一定要在前面加上return。

13.4 效果

進入http://127.0.0.1:5000/login，輸入name，點擊submit：

進入http://127.0.0.1:5000/show查看session中存儲的name：

13.5 設置sessin的有效時間

下面這段代碼來自Is there an easy way to make sessions timeout in flask?：

  1. from datetime import timedelta
  2. from flask import session, app
  3.  
  4. session.permanent = True
  5. app.permanent_session_lifetime = timedelta(minutes= 5)

這段代碼將session的有效時間設置為5分鍾。

13.6 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-011

14. 使用Cookie

Cookie是存儲在客戶端的記錄訪問者狀態的數據。具體原理，請見 http://zh.wikipedia.org/wiki/Cookie 。 常用的用於記錄用戶登錄狀態的session大多是基於cookie實現的。

cookie可以借助flask.Response來實現。下面是一個示例。

14.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

14.2 代碼

修改HelloWorld/server.py：

  1. from flask import Flask, request, Response, make_response
  2. import time
  3.  
  4. app = Flask(__name__)
  5.  
  6.  
  7. @app.route('/')
  8. def hello_world():
  9. return 'hello world'
  10.  
  11.  
  12. @app.route('/add')
  13. def login():
  14. res = Response( 'add cookies')
  15. res.set_cookie(key= 'name', value='letian', expires=time.time()+6*60)
  16. return res
  17.  
  18.  
  19. @app.route('/show')
  20. def show():
  21. return request.cookies.__str__()
  22.  
  23.  
  24. @app.route('/del')
  25. def del_cookie():
  26. res = Response( 'delete cookies')
  27. res.set_cookie( 'name', '', expires=0)
  28. return res
  29.  
  30.  
  31. if __name__ == '__main__':
  32. app.run(port= 5000, debug=True)

由上可以看到，可以使用Response.set_cookie添加和刪除cookie。expires參數用來設置cookie有效時間，它的值可以是datetime對象或者unix時間戳，筆者使用的是unix時間戳。

res.set_cookie(key='name', value='letian', expires=time.time()+6*60)

上面的expire參數的值表示cookie在從現在開始的6分鍾內都是有效的。

要刪除cookie，將expire參數的值設為0即可：

res.set_cookie('name', '', expires=0)

set_cookie()函數的原型如下：

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.

14.3 運行與測試

運行HelloWorld/server.py：

$ python3 HelloWorld/server.py

使用瀏覽器打開http://127.0.0.1:5000/add，瀏覽器界面會顯示

add cookies

下面查看一下cookie，如果使用firefox瀏覽器，可以用firebug插件查看。打開firebug，選擇Cookies選項，刷新頁面，可以看到名為name的cookie，其值為letian。

在“網絡”選項中，可以查看響應頭中類似下面內容的設置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'}

14.4 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-012

15. 閃存系統 flashing system

Flask的閃存系統（flashing system）用於向用戶提供反饋信息，這些反饋信息一般是對用戶上一次操作的反饋。反饋信息是存儲在服務器端的，當服務器向客戶端返回反饋信息后，這些反饋信息會被服務器端刪除。

下面是一個示例。

15.1 建立Flask項目

按照以下命令建立Flask項目HelloWorld:

  1. mkdir HelloWorld
  2. mkdir HelloWorld/static
  3. mkdir HelloWorld/templates
  4. touch HelloWorld/server.py

15.2 編寫HelloWorld/server.py

內容如下：

  1. from flask import Flask, flash, get_flashed_messages
  2. import time
  3.  
  4. app = Flask(__name__)
  5. app.secret_key = 'some_secret'
  6.  
  7.  
  8. @app.route('/')
  9. def index():
  10. return 'hi'
  11.  
  12.  
  13. @app.route('/gen')
  14. def gen():
  15. info = 'access at '+ time.time().__str__()
  16. flash(info)
  17. return info
  18.  
  19.  
  20. @app.route('/show1')
  21. def show1():
  22. return get_flashed_messages().__str__()
  23.  
  24.  
  25. @app.route('/show2')
  26. def show2():
  27. return get_flashed_messages().__str__()
  28.  
  29.  
  30. if __name__ == "__main__":
  31. app.run(port= 5000, debug=True)

15.3 效果

運行服務器：

$ python3 HelloWorld/server.py

打開瀏覽器，訪問http://127.0.0.1:5000/gen，瀏覽器界面顯示（注意，時間戳是動態生成的，每次都會不一樣，除非並行訪問）：

access at 1404020982.83

查看瀏覽器的cookie，可以看到session，其對應的內容是：

.eJyrVopPy0kszkgtVrKKrlZSKIFQSUpWSknhYVXJRm55UYG2tkq1OlDRyHC_rKgIvypPdzcDTxdXA1-XwHLfLEdTfxfPUn8XX6DKWCAEAJKBGq8.BpE6dg.F1VURZa7VqU9bvbC4XIBO9-3Y4Y

再一次訪問http://127.0.0.1:5000/gen，瀏覽器界面顯示：

access at 1404021130.32

cookie中session發生了變化，新的內容是：

.eJyrVopPy0kszkgtVrKKrlZSKIFQSUpWSknhYVXJRm55UYG2tkq1OlDRyHC_rKgIvypPdzcDTxdXA1-XwHLfLEdTfxfPUn8XX6DKWLBaMg1yrfCtciz1rfIEGxRbCwAhGjC5.BpE7Cg.Cb_B_k2otqczhknGnpNjQ5u4dqw

然后使用瀏覽器訪問http://127.0.0.1:5000/show1，瀏覽器界面顯示：

['access at 1404020982.83', 'access at 1404021130.32']

這個列表中的內容也就是上面的兩次訪問http://127.0.0.1:5000/gen得到的內容。此時，cookie中已經沒有session了。

如果使用瀏覽器訪問http://127.0.0.1:5000/show1或者http://127.0.0.1:5000/show2，只會得到：

[]

15.4 高級用法

flash系統也支持對flash的內容進行分類。修改HelloWorld/server.py內容：

  1. from flask import Flask, flash, get_flashed_messages
  2. import time
  3.  
  4. app = Flask(__name__)
  5. app.secret_key = 'some_secret'
  6.  
  7.  
  8. @app.route('/')
  9. def index():
  10. return 'hi'
  11.  
  12.  
  13. @app.route('/gen')
  14. def gen():
  15. info = 'access at '+ time.time().__str__()
  16. flash( 'show1 '+info, category='show1')
  17. flash( 'show2 '+info, category='show2')
  18. return info
  19.  
  20.  
  21. @app.route('/show1')
  22. def show1():
  23. return get_flashed_messages(category_filter='show1').__str__()
  24.  
  25. @app.route('/show2')
  26. def show2():
  27. return get_flashed_messages(category_filter='show2').__str__()
  28.  
  29.  
  30. if __name__ == "__main__":
  31. 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，得到如下內容：

['1 access at 1404022326.39']

而繼續訪問http://127.0.0.1:5000/show2，得到的內容為空：

[]

15.5 在模板文件中獲取flash的內容

在Flask中，get_flashed_messages()默認已經集成到Jinja2模板引擎中，易用性很強。下面是來自官方的一個示例：

15.6 本節源碼

https://github.com/letiantian/Learn-Flask/tree/master/flask-demo-013


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 Python Flask Web 框架入門 Python Flask Web 框架入門 Python學習筆記之Scrapy框架入門 [Python] Django框架入門2——深入模型 Python 【web框架】之Flask Unity框架入門 Hibernate框架入門 qiling框架入門 Python Flask web入門例子 CI框架入門筆記
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM