Flask的模板功能是基於Jinja2模板引擎來實現的。模板文件存放在當前目前下的子目錄templates(一定要使用這個名字)下。
main.py 代碼如下:
1
2
3
4
5
6
7
8
9
10
11
12
from flask import Flask, render_template
app = Flask(__name__)
@app.route('/hello')
@app.route('/hello/<name>')
def hello(name=None):
return render_template('hello.html', name=name)
if __name__ == '__main__':
app.run(debug=True)
hello.html代碼如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Hello Sample</title>
</head>
<body>
{% if name %}
<h1>Hello {{ name }} !</h1>
{% else %}
<h1>Hello World!</h1>
{% endif %}
</body>
</html>
模板的表達式都是包含在分隔符」{{ }}」內的;控制語句都是包含在分隔符」{% %}」內的;另外,模板也支持注釋,都是包含在分隔符」{# #}」內,支持塊注釋。
表達式
表達式一般有這麼幾種:
最常用的是變量,由Flask渲染模板時傳過來,比如上例中的」name」
也可以是任意一種Python基礎類型,比如字符串{{ 「Hello」 }},用引號括起;或者數值,列表,元祖,字典,布爾值。直接顯示基礎類型沒啥意義,一般配合其他表達式一起用
運算。包括算數運算,如{{ 2 + 3 }};比較運算,如{{ 2 > 1 }};邏輯運算,如{{ False and True }}
過濾器「|」和測試器「is」。這個在後面會介紹
函數調用,如{{ current_time() }};數組下標操作,如{{ arr[1] }}
「in」操作符,如{{ 1 in [1,2,3] }}
字符串連接符」~」,作用同Python中的」+」一樣,如{{ 「Hello 」 ~ name ~ 「!」 }}
「if」關鍵字,如{{ 『Hi, %s' % name if name }}。這裡的」if」不是條件控制語句。
控制語句
Jinja2的控制語句主要就是條件控制語句if,和循環控制語句for,語法類似於Python。我們可以改動下上節的模板代碼:
1
2
3
4
5
6
7
{% if name and name == 'admin' %}
<h1>This is admin console</h1>
{% elif name %}
<h1>Welcome {{ name }}!</h1>
{% else %}
<h1>Please login</h1>
{% endif %}
上面是一個條件控制語句的例子,注意if控制語句要用」{% endif %}」來結束。模板中無法像代碼中一樣靠縮進來判斷代碼塊的結束。再來看個循環的例子,我們先改下Python代碼中的」hello」函數,讓其傳兩個列表進模板。
1
2
3
4
5
6
def hello(name=None):
return render_template('hello.html', name=name, digits=[1,2,3,4,5],
users=[{'name':'John'},
{'name':'Tom', 'hidden':True},
{'name':'Lisa'}
{'name':'Bob'}])
模板如下:
1
2
3
4
5
6
7
8
9
10
11
{% if name and name == 'admin' %}
<h1>Helle admin</h1>
{% elif name %}
<h1>"Hello" ~ {{ name }} ~ "!"</h1>
{% else %}
<h1>Hello World!</h1>
{% endif %}
{% for digit in digits %}
{{ digit }}
{% endfor %}
同if語句一樣,for控制語句要用」{% endfor %}」來結束。頁面上,每個元素之間會有空格,如果你不希望有空格,就要在」for」語句的最後,和」endfor」語句的最前面各加上一個」-「號。如:
1
2
3
{% for digit in digits -%}
{{ digit }}
{%- endfor %}
你可以看到數字」12345″被一起顯示出來了。我們再來看個複雜的循環例子:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<dl>
{% for user in users if not user.hidden %}
{% if loop.first %}
<div>User List:</div>
{% endif %}
<div class="{{ loop.cycle('odd', 'even') }}">
<dt>User No. {{ loop.index }}</dt>
<dd>{{ user.name }}</dd>
</div>
{% if loop.last %}
<dir>Total Users: {{ loop.length }}</dir>
{% endif %}
{% else %}
<li>No users found</li>
{% endfor %}
</dl>
這裡有三個知識點。首先for循環支持else語句,當待遍歷的列表」users」為空或者為None時,就進入else語句。
其次,在for語句後使用if關鍵字,可以對循環中的項作過濾。本例中,所有hidden屬性為True的user都會被過濾掉。
另外,for循環中可以訪問Jinja2的循環內置變量。本例中,我們會在第一項前顯示標題,最後一項後顯示總數,每一項顯示序號。另外,奇偶項的HTML div元素會有不同的class。如果我們加入下面的CSS style,就能看到斑馬線。
1
2
3
4
5
<style type="text/css">
.odd {
background-color: #BDF;
}
</style>
Jinja2的循環內置變量主要有以下幾個:
1
2
3
4
5
6
7
8
9
10
11
12
from flask import Flask, render_template
app = Flask(__name__)
@app.route('/hello')
@app.route('/hello/<name>')
def hello(name=None):
return render_template('hello.html', name=name)
if __name__ == '__main__':
app.run(debug=True)
另外,如果你啟用了」jinja2.ext.loopcontrols」擴展的話,你還可以在循環中使用」{% break %}」和」{% continue %}」來控制循環執行。
其它常用語句:
忽略模板語法
有時候,我們在頁面上就是要顯示」{{ }}」這樣的符號怎麼辦?Jinja2提供了」raw」語句來忽略所有模板語法。
1
2
3
4
5
6
7
{% raw %}
<ul>
{% for item in items %}
<li>{{ item }}</li>
{% endfor %}
</ul>
{% endraw %}
自動轉義
我們將本文一開始的Flask代碼」hello()」方法改動下:
1
2
3
4
5
6
@app.route('/hello')
@app.route('/hello/<name>')
def hello(name=None):
if name is None:
name = '<em>World</em>'
return render_template('hello.html', name=name)
此時,訪問」http://localhost:5000/hello」,頁面上會顯示」Welcome <em>World</em>!」,也就是這個HTML標籤」<em>」被自動轉義了。Flask會對」.html」, 「.htm」, 「.xml」, 「.xhtml」這四種類型的模板文件開啟HTML格式自動轉義。這樣也可以防止HTML語法注入。如果我們不想被轉義怎麼辦?
1
2
3
{% autoescape false %}
<h1>Hello {{ name }}!</h1>
{% endautoescape %}
將」autoescape」開關設為」false」即可,反之,設為」true」即開啟自動轉義。使用」autoescape」開關前要啟用」jinja2.ext.autoescape」擴展,在Flask框架中,這個擴展默認已啟用。
賦值
使用」set」關鍵字給變量賦值:
1
{% set items = [[1,2],[3,4,5]] %}
with語句
類似於Python中的」with」關鍵字,它可以限制with語句塊內對象的作用域:
1
2
3
4
5
{% with foo = 1 %}
{% set bar = 2 %}
{{ foo + bar }}
{% endwith %}
{
使用」with」關鍵字前要啟用」jinja2.ext.with_」擴展,在Flask框架中,這個擴展默認已啟用。
執行表達式
1
2
3
4
{% with arr = ['Sunny'] %}
{{ arr.append('Rainy') }}
{{ arr }}
{% endwith %}
看上面這段代碼,我們想執行列表的」append」操作,這時使用」{{ arr.append(『Rainy') }}」頁面會輸出」None」,換成」{% %}」來執行,程序會報錯,因為這是個表達式,不是語句。那怎麼辦?我們可以啟用」jinja2.ext.do」擴展。然後在模板中執行」do」語句即可:
1
2
3
4
{% with arr = ['Sunny'] %}
{% do arr.append('Rainy') %}
{{ arr }}
{% endwith %}
上下文環境
Flask每個請求都有生命周期,在生命周期內請求有其上下文環境Request Context。作為在請求中渲染的模板,自然也在請求的生命周期內,所以Flask應用中的模板可以使用到請求上下文中的環境變量,及一些輔助函數。本文就會介紹下這些變量和函數。
標準上下文變量和函數
請求對象request
request對象可以用來獲取請求的方法」request.method」,表單」request.form」,請求的參數」request.args」,請求地址」request.url」等。它本身是一個字典。在模板中,你一樣可以獲取這些內容,只要用表達式符號」{{ }}」括起來即可。
1
<p>{{ request.url }}</p>
在沒有請求上下文的環境中,這個對象不可用。
會話對象session
session對象可以用來獲取當前會話中保存的狀態,它本身是一個字典。在模板中,你可以用表達式符號」{{ }}」來獲取這個對象。
Flask代碼如下,別忘了設置會話密鑰哦:
1
2
3
4
5
6
@app.route('/')
def index():
session['user'] = 'guest'
return render_template('hello.html')
app.secret_key = '123456'
模板代碼:
1
<p>User: {{ session.user }}</p>
在沒有請求上下文的環境中,這個對象不可用。
全局對象g
全局變量g,用來保存請求中會用到全局內容,比如資料庫連接。模板中也可以訪問。
Flask代碼:
1
2
3
4
@app.route('/')
def index():
g.db = 'mysql'
return render_template('hello.html')
模板代碼:
g對象是保存在應用上下文環境中的,也只在一個請求生命周期內有效。在沒有應用上下文的環境中,這個對象不可用。
Flask配置對象config
導入的配置信息,就保存在」app.config」對象中。這個配置對象在模板中也可以訪問。
1
<p>Host: {{ config.DEBUG }}</p>
「config」是全局對象,離開了請求生命周期也可以訪問。
url_for()函數
url_for()函數可以用來快速獲取及構建URL,Flask也將此函數引入到了模板中,比如下面的代碼,就可以獲取靜態目錄下的」style.css」文件。
1
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
該函數是全局的,離開了請求生命周期也可以調用。
get_flashed_messages()函數
get_flashed_messages()函數是用來獲取消息閃現的。這也是一個全局可使用的函數。
自定義上下文變量和函數
自定義變量
除了Flask提供的標準上下文變量和函數,我們還可以自己定義。下面我們就來先定義一個上下文變量,在Flask應用代碼中,加入下面的函數:
1
2
3
4
5
from flask import current_app
@app.context_processor
def appinfo():
return dict(appname=current_app.name)
函數返回的是一個字典,裡面有一個屬性」appname」,值為當前應用的名稱。我們曾經介紹過,這裡的」current_app」對象是一個定義在應用上下文中的代理。函數用」@app.context_processor」裝飾器修飾,它是一個上下文處理器,它的作用是在模板被渲染前運行其所修飾的函數,並將函數返回的字典導入到模板上下文環境中,與模板上下文合併。然後,在模板中」appname」就如同上節介紹的」request」, 「session」一樣,成為了可訪問的上下文對象。我們可以在模板中將其輸出:
1
<p>Current App is: {{ appname }}</p>
自定義函數
同理我們可以自定義上下文函數,只需將上例中返回字典的屬性指向一個函數即可,下面我們就來定義一個上下文函數來獲取系統當前時間:
1
2
3
4
5
6
7
import time
@app.context_processor
def get_current_time():
def get_time(timeFormat="%b %d, %Y - %H:%M:%S"):
return time.strftime(timeFormat)
return dict(current_time=get_time)
我們可以試下在模板中將其輸出:
1
2
<p>Current Time is: {{ current_time() }}</p>
<p>Current Day is: {{ current_time("%Y-%m-%d") }}</p>
上下文處理器可以修飾多個函數,也就是我們可以定義多個上下文環境變量和函數。
完整實例:
flask代碼:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
from flask import Flask, render_template, session, g, current_app
import time
app = Flask(__name__)
@app.route('/')
def index():
session['user'] = 'guest'
g.db = 'mysql'
return render_template('hello-2.html')
@app.context_processor
def appinfo():
return dict(appname=current_app.name)
@app.context_processor
def get_current_time():
def get_time(timeFormat="%b %d, %Y - %H:%M:%S"):
return time.strftime(timeFormat)
return dict(current_time=get_time)
app.secret_key = '123456'
if __name__ == '__main__':
app.run(debug=True)
模板代碼:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<!doctype html>
<title>Hello Sample</title>
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
<h1>Hello World!</h1>
<p>Request URL: {{ request.url }}</p>
<p>User: {{ session.user }}</p>
<p>DB: {{ g.db }}</p>
<p>Host: {{ config.DEBUG }}</p>
<p>Current App is: {{ appname }}</p>
<p>Current Time is: {{ current_time() }}</p>
<p>Current Day is: {{ current_time("%Y-%m-%d") }}</p>
{% with messages = get_flashed_messages() %}
{% if messages %}
{% for message in messages %}
Flash Message: {{ message }}</li>
{% endfor %}
{% endif %}
{% endwith %}
python學習資料交流群:516107834