flask 知識點總結

============================
request對象的常用屬性
============================
具體使用方法如下:
request.headers, request.headers.get('If-None-Match')
request.json, request.json['value'] 或 request.json.get('detail_msg', "")
request.args, request.args.get('limit', 10)來獲取query parameters
request.form, request.form['username'], 來獲取POST/PUT request的form attribute
request.cookies, request.cookies.get('username') 另,response.set_cookie('username', 'the username')
request.method
request.request.path
flash(), 寫flash字符串, 模板中可以使用get_flashed_messages()拿到寫入的字符串.
   flash() 可以加上catergory參數, 對應的get_flashed_messages()加上category_filter來獲取不同的flash字符串.

 
form 元素值的獲取示例:
<input name="my_date" type="date" class="form-control" placeholder="date (like 20141231)" required autofocus>

form上元素比如input, 必須設置name屬性, 在view python中, request.form['my_date']獲取input的值, 這里的my_date是input元素的name, 而不是id屬性.
另外,推薦使用 my_date=request.form.get('my_date',''),  而不是直接用my_date=request.form['my_date'], 后者一直取不到值, 直接跑出python 異常.  


   

============================   
request、g 和 session 對象
============================
flask的 flask._app_ctx_stack  和 request、 g、 session 都是 context 對象, 而且都是stack, 都是建在 Werkzeug 的 Thread Local 對象之上的, 可以用threading.local()來理解這樣的對象, 針對每個web請求, server端即有一個線程對應, 因為是 thread local 架構, 即保證了線程安全. 這種實現的好處非常明顯, 在所有的函數內部, 都可以直接使用這些全局對象, 也可以使用這些對象在不同函數之間傳遞數據.


應用上下文flask._app_ctx_stack 和 flask.g 差不多, 可以在這兩個對象內部保存一些特定的數據, 當然這些數據只在"一個請求"的生命周期中有效. 不過flask._app_ctx_stack 推薦給extension的開發者使用, flask.g 留給web 開發使用. 如果要"跨請求"來共享數據, 需要使用 session 對象.  


在模板內部, 可以使用config, request、g 和 session 對象, 以及 get_flashed_messages()和url_for() 函數。
在視圖函數中, 可以使用request、g 和 session 對象
 

 
============================   
視圖函數返回值
============================
flask視圖函數返回值, 原則上應該是一個response對象, 但也允許有其他類型的返回值, flask會自動將這些類型轉成 response 對象, 轉換的規則是:
1. 如果返回的是一個response對象, (我們可使用 make_response() 生成 response 對象), 那么flask直接返回它
2. 如果返回的是一個字符串, 將被轉換為一個包含作為響應體的字符串、一個 "200 OK" 出錯代碼、一個 text/html MIME 類型的響應對象
3. 如果返回的是一個元組, 元祖的格式應該是(response,)或 (response, status), 或 (response, headers) 或 (response, status, headers) 形式.  flask 將會自動將status和headers更新到最終的response中.
4。如果以上都不是, 那么 Flask 會假定返回值是一個有效的 WSGI application, 並把它轉換為一個響應對象, 比如一個json數據包即為一個有效的WSGI application.



-----------------------------
API視圖常用的返回值為
-----------------------------
return jsonify({'item': check_itm_code, 'echo_msg': 'successful'}), 201

-----------------------------
網頁視圖函數常用的返回值為:
-----------------------------
return render_template('show_entries.html', entries=entries) #缺省status為200, OK
return render_template('page_not_found.html'), 404
return make_response(render_template('index.html', foo=42))



============================
session對象的使用
============================
session['logged_in'] = True #為session設置logged_in flag
session.pop('logged_in', None) #清空session中的logged_in flag



============================
cookies的使用
============================

讀取 cookies:
from flask import request
@app.route('/')
def index():
    username = request.cookies.get('username')
    # 使用 cookies.get(key) 來代替 cookies[key] ，
    # 以避免當 cookie 不存在時引發 KeyError
    
儲存 cookies:
from flask import make_response
@app.route('/')
def index():
    resp = make_response(render_template(...))
    resp.set_cookie('username', 'the username')
    return resp



    

============================
日志
============================
flask 已經為我們准備好了 logger 對象, app.logger 即為該logger對象, 和一般的console程序一樣, 我們只需在web啟動腳本中, 為root logger設置handler, 無需為flask logger專門再設置handler.  記log直接使用app.logger.info()等方法即可.  

如下代碼, 記錄出錯log
@app.errorhandler(500)
def internal_error(exception): #這里exception是一個對象
    app.logger.exception(exception)
    return render_template('500.html'), 500
    

    

============================
Request的中斷和ErrorHandler
============================    
在view函數中, 如果需要中斷request, 可以使用abort(500)或者直接raise exception. 當然我們還需要顯示一個出錯頁面給用戶看. 所以需要定制一下ErrorHandler,  一般只需要2個handler即可, 一個是404錯誤, 一個是500一類的服務器端錯誤.
@app.errorhandler(404)
# 這個handler可以catch住所有的 abort(404) 以及找不到對應router的處理請求
def page_not_found(error):
    target = request.path + "?" + request.query_string
    app.logger.error("404 error for link: "+target)
    # app.logger.exception(error)
    return render_template('404.html', link=target), 404


@app.errorhandler(Exception)
# 這個handler可以catch住所有的 abort(500) 和 raise exeception.
# traceback.html 頁面取自 airflow 項目
def show_traceback(error):
    return render_template(
        'traceback.html',
        hostname=socket.gethostname(),
        nukular=ascii_.nukular,
        info=traceback.format_exc()), 500

 
    
    
============================
blueprint
============================    
blueprint視圖函數和普通視圖函數一樣, 可以使用flask.g, flask.request, flask.session, 但使用application級別的對象(比如config和logger),不能直接用app.logger, 必須通過current_app對象, 比如 current_app.logger, current_app.config,  subject=current_app.config['MAIL_SUBJECT']   
 
另外, blueprint 也可以有 before_request, teardown_request, errorhandler 裝飾器, 但我覺得一般不必增加blueprint級別裝飾函數, 直接共用app的對等函數即可, 除非一定非要將blueprint做成純粹的 plug&play.

url_for('blueprint123.index')

 

 

 
Blueprint 是組織module的一個很好的方式, 通常我們會為不同的 Blueprint 設置不同的url prefix.
在設置了url prefix后, html 模板中與這個blueprint相關的link 字符串, 都需要加上url prefix, 否則路由地址就不對了.

當然這樣的寫法其實很是很糟糕的, hard code 的url prefix一多, 哪一天要調整這個url prefix就麻煩了.

最好的作法, 當然不是到處hard code 鏈接地址了, 推薦使用url_for()函數.  
但加了url prefix之后, 使用 url_for() 函數時, 需要為view函數加一個命名空間, 到底這個命名空間取什么,  結論是 Blueprint的名稱, 不是Blueprint對象的名稱, 也不是python 模塊的名稱. 這是我花了很長時間才試驗出來, 見下面的示例:


#views.py
mod = Blueprint('myReport', __name__, url_prefix='/reports')  #Blueprint的名稱是 myReport


@mod.route("/csv_data/<report_name>/<time_id>")
def download_csv_view(report_name, time_id):
    return 'a,b,c,d,e'

    
def redirect_sample():
    return redirect(url_for('myReport.download_csv', report_name='report_1', time_id='201406' ))
    
 
模板上的寫法也是一樣,   
 <a href="{{ url_for('myReport.download_csv', report_name='report_1', time_id='201406')}}">
    download csv of report_1(201406)  
</a>

 

 

 

============================
flask 內建的renderer,
============================    
mine_types{'json_renderer':('application/json',),
           'xml_renderer':('application/xml','text/xml','application/x-xml',)
          }
          
除了內建的json和xml兩個renderer外, 使用 flask-mimerender 擴展, 可以很容易增加其他的renderer, 比如excel和csv輸出.
 

 
============================    
關閉模板中的轉義
============================   
方法1, 在Python文件中進行轉義, 先在 Markup 對象中進行轉義，然后將它傳送給模版。一般推薦使用這個方式。
from flask import Markup
result=Markup(result(params))
return render_template('xxx.html', result=result)

方法2, 在模版文件中進行轉義. 通過 |safe 過濾器來表示字符串是安全的({{result|safe}})
渲染的時候 {{ result|safe }}

方法3, 暫時禁用全局的自動轉義功能。
{% autoescaping false %}
<p>autoescaping is disableed here
<p>{{ will_not_be_escaped }}
{% endautoescape %}

 
 

知識點:
1. API 的url最好包含/api/v1.0 這樣的字符串, 加上版本號, 有利於版本控制.
2. api函數的app.route裝飾器, methods參數要么缺省, 要么POST/GET都要加, 如果只加一個, request會報HTTP Error 405, METHOD NOT ALLOWED
3. api函數返回類型最好都是json格式, 推薦使用flask的jsonify()作為返回值, 它可以將dict轉成json
4. api的消費端, 發起POST請求, 可使用標准庫urllib2.Request()方法, 需要指定data和headers參數, 這樣才是POST.
如, urllib2.Request(url, data=data_json, headers={'Content-Type': 'application/json'})
5. api的消費端, 發起POST請求, 往往需要傳json數據進去, 可使用json庫的json.dumps()將dict轉成json.
6. api的消費端得到的response, 其類型是str, 可使用json庫的json.loads() 轉成json格式



@app.route('/user/<username>')
@app.route('/user/<converter:variable_name> ')
flask內建的converter可以有:
@app.route('/user/<int:user_id> ')
@app.route('/user/<float:salary> ')
@app.route('/user/<path:full_dept> ')

如果有one和two都是可選參數, 就不能使用myapp/api/getDetails/<one>/<two>形式的url了, 推薦使用?和kv結合的形式.
比如: http://localhost:5003/myapp/api/getDetails?one=abc&two=123&three=xxx

@mod.route("/myapp/api/getDetails", methods=('GET', 'POST'))             
def getPrStatusDetail():
    one=request.args.get('one', '')
    two=request.args.get('two', '')
    three=request.args.get('three', '')
    grid_data=SomeObject.getDetail(one,two,three)
    return JsonConverter.ObjListToJson(grid_data),201  



API 模塊
@mod.route("/api/v1.0/test/simple", methods=('POST','GET'))

def test_simple_view():
    return jsonify({'request.method': request.method, 'echo_msg': 'successful' } ), 201   


測試代碼    
#request for test/simple, method is GET
import json
import urllib2
url = "http://localhost:5000/api/v1.0/test/simple"
req = urllib2.Request(url)
f = urllib2.urlopen(req)
httpCodes=f.getcode()
responseStr = f.read()
f.close()
json_data=json.loads(responseStr)
echo_msg=json_data['echo_msg']




--------------------------------------------------------
API 模塊
url有一個動態參數, 沒有指定類型, 則表示為str型
@mod.route("/api/v1.0/test/str_arg/<check_itm_code>", methods=('POST','GET'))
def test_str_argument_view(check_itm_code):
    return jsonify({'request.method': request.method,'item': check_itm_code, 'echo_msg': 'successful'}), 201
    
    
測試代碼  
#request for test/str_arg/<check_itm_code>, method is GET
import json
import urllib2
url = "http://localhost:5000/api/v1.0/test/str_arg/abc"
req = urllib2.Request(url)
f = urllib2.urlopen(req)
httpCodes=f.getcode()
responseStr = f.read()
f.close()
json_data=json.loads(responseStr)
echo_msg=json_data['echo_msg']





--------------------------------------------------------
API 模塊
url有一個動態參數, 指定為int型, 還可以指定成float型
@mod.route("/api/v1.0/test/int_arg/<int:seq_no>", methods=('POST','GET'))
def test_int_argument_view(seq_no):
    return jsonify({'request.method': request.method,'seq_no': seq_no, 'echo_msg': 'successful'}), 201  
    
    
測試代碼     
#request for test/int_arg/<int:seq_no>, method is GET
import json
import urllib2
url = "http://localhost:5000/api/v1.0/test/int_arg/123"
req = urllib2.Request(url)
f = urllib2.urlopen(req)
httpCodes=f.getcode()
responseStr = f.read()
f.close()
json_data=json.loads(responseStr)
echo_msg=json_data['echo_msg']


 


除了str/int/float這樣常用的url參數, 還支持regex, 比如app.route('/regex("[\w]*[Ss]"):collection')


--------------------------------------------------------
API 模塊
接受request 包含json格式的數據
@mod.route("/api/v1.0/test/json_post/<check_itm_code>", methods=('POST','GET'))
def test_json_post_view(check_itm_code):
    if not request.json:
        abort(400)  # bad request    
        
    if not 'value' in request.json:
            abort(400)  # bad request    
                 
    value=request.json['value']     
    detail_msg=request.json.get('detail_msg', "")  # if detail_msg is not set, use empty  
    return jsonify({'request.method': request.method,'value': value,'detail_msg':detail_msg, 'echo_msg': 'successful'}), 201    
            
            
    
測試代碼
#request for test/json_post/<check_itm_code>, method is POST
#需要在urllib2.Request()中指定data和headers參數, 這樣才是POST
import json
import urllib2
data = {'value': '100',
        'detail_msg': 'SOMETHING HERE'
}
data_json = json.dumps(data)
url = "http://localhost:5000/api/v1.0/test/json_post/hang_check"
req = urllib2.Request(url, data=data_json, headers={'Content-Type': 'application/json'})
f = urllib2.urlopen(req)
httpCodes=f.getcode()
responseStr = f.read()
f.close()
json_data=json.loads(responseStr)
echo_msg=json_data['echo_msg']

 


 

=====================================================
WTF 相關
=====================================================

WTF 常用的 field 類型
'BooleanField', 'TextAreaField', 'PasswordField', 'FileField',
'HiddenField', 'SubmitField', 'TextField'


常用的驗證方式有:
'DataRequired', 'data_required', 'Email', 'email', 'EqualTo', 'equal_to',
'IPAddress', 'ip_address', 'InputRequired', 'input_required', 'Length',
'length', 'NumberRange', 'number_range', 'Optional', 'optional',
'Required', 'required', 'Regexp', 'regexp', 'URL', 'url', 'AnyOf',
'any_of', 'NoneOf', 'none_of', 'MacAddress', 'mac_address', 'UUID'


=====================================================
jinja2 相關
=====================================================

使用 {# ... #}注釋代碼
使用 {% set var='' %} 進行賦值,  {% set key, value = call_something() %}
使用 {{…}} 調用變量
使用 {% if … %}，{% elif otherthing %} ,｛% else %｝，{% endif %} 控制流程
使用 {% for … in … %}，{% endfor %} 定義循環
使用 {% block …%}，{% endblock %} 定義繼承內容塊
使用 {% extends “FILENAME” %}，{% block …%}，{% endblock %} 引入模版繼承的內容