Python的Flask框架中的Jinja2模板引擎學習教程

2021-03-02 python

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

相關焦點

  • 第21天:Web開發 Jinja2模板引擎
    ,現在我們目標更靠近一些 —— 學習下Jinja2模板。Jinja2模板引擎Jinja2是Flask框架默認支持的模板引擎,並不是唯一也不是最好(因人而異,沒有最好)模板引擎,不同的Web框架,比如Django、Nodejs等都有自己的模板引擎,甚至一些程式設計師自己實現的模板引擎(我就這麼幹過),但大體思路是一樣的,都是要將數據替換或者轉換到,用特殊格式標記了位置的模板中,以合成動態的html,這種技術不新鮮,在之前的列印模板,如水晶報表裡就有
  • 基於《Flask Web開發:基於Python的Web應用開發實戰》最全總結
    3 模板 template業務邏輯和表現邏輯 要分開按功能分(模板不需要重用時),或按Division分(大部分模板需要重用時)Jinja2模板引擎模板是一個包含響應文本的文件,其中包含用佔位變量{{...}}表示的動態部分
  • 入門Python, 看這些資料就夠了
    目錄:第一部分: Python入門&進階教程第二部分: Python Web框架第三部分: Python擴展資料推薦的學習路徑: 1. 使用實驗樓的開箱即用環境快速刷完Python3簡明教程,django基礎教程;2.
  • Flask 入門系列教程(一)
    ↑↑↑關注後"星標"簡說PythonOne old watch, like brief python大家好,我是老表~今天和大家分享的內容是Flask入門系列的第一篇文章,學習了記得點讚、留言、轉發,三連哦~今天我們正式開始 Flask 的學習之旅,Flask 作為一個輕量級的 Python
  • Github標星5.6k的《Python進階》中文版下載
    它是《Intermediate Python》的中文譯本,內容精練,難度差不多相當於學完本教室入門教程的程度。適合已經學完基礎的同學。Awesome系列項目Github上有這麼一系列項目:它們搜羅並整理某一領域的優秀項目,便於對此領域感興趣的學習者或開發者在學習和使用時參考,被稱為 awesome 系列。
  • python web學習路線知識點分享!
    教程」關注我們,一起學習成長喲!>結構python: 內置庫,爬蟲庫,web框架,資料庫接口等。markdown/sphinx/docstring/readthedoc等(使用vim的話推薦python-mode插件,或者直接用IDE工具pycharm)相關框架(庫):django/flask/tornado/requests/sqlalchemy/unittest/celery等等資料庫:
  • VS Code + Python + Flask(Windows)
    1.安裝vscodea.在vscode官網(https://code.visualstudio.com/)下載軟體b.根據提醒點擊next,根據自己的需求進行個性化設計c.在vscode的擴展中搜素python並安裝,重載窗口2.安裝Pythona.在python官網(https://www.python.org/)
  • Python Web 開發哪家強?
    Django 框架的一個顯著優勢是提供了一個活躍的社區,旨在幫助您擴展應用程式的解決方案或使用有用的內容使您的工作更輕鬆。Flask 社區目前沒那麼大,因此找到有用的信息並不容易。模板引擎和系統所有 Web 應用程式都有一個支持用戶交互的前端(用戶界面)。由於 Web 應用程式不是靜態的,因此它們採用不同的方法動態生成 HTML。Django 和 Flask 提供令人興奮的模板引擎。
  • 零基礎學Python,應該知道的學習路徑和經驗
    在這個階段你肯定會遇到非常多問題,這是好事啊,說明你在慢慢的進步;遇到問題你可以通過搜索或者去python社區提問,關於python社區我這裡推薦一個:python開發者日常https://www.beibq.cn/group/1這個時候你對python應該有一定的基礎了,可以試著做些項目,大部分人會選擇做個網站,python做網站常用的框架有三種:tornado、flask
  • 10道題教你使用python Django框架來實現web應用,值得收藏
    出於比賽需要,要解釋一個 Django框架裡的軟體,本人學java,沒接觸過 Python的框架?求入口在哪兒?怎麼運行啊?這個操作我的教程「Python Django帶你構建Web應用」裡有。進入django項目根目錄。python manage.py runserver運行內置的Web伺服器。預設提供服務的IP位址是127.0.0.1,埠是8000。
  • python語言在全球廣泛應用
    比如說同樣是logistic回歸,這麼多基礎的框架,如果用python來實現,你還得去看一堆代碼,然後再自己手寫一遍代碼。那麼在日常的實際工作中,到底需要哪些簡單的工具和代碼來解決實際的問題呢?下面就跟大家一起詳細聊聊,如何搭建一個實用的python編程環境,做到從零開始從linux到jupyternotebook來進行機器學習項目的學習。一、python初步了解先來談談python吧。
  • Python每日3題-Django、Flask、Tornado的對比?
    它的MTV框架,自帶的ORM,admin後臺管理,自帶的sqlite資料庫和開發測試用的伺服器,給開發者提高了超高的開發效率。重量級web框架,功能齊全,提供一站式解決的思路,能讓開發者不用在選擇上花費大量時間。 自帶ORM和模板引擎,支持jinja等非官方模板引擎。
  • Python常用庫大全
    caniusepython3 – 判斷是哪個項目妨礙你你移植到 Python 3。 cookiecutter – 從 cookiecutters(項目模板)創建項目的一個命令行工具。 doitlive – 一個用來在終端中進行現場演示的工具。
  • Python 資源大全中文版
    awesome-python 是 vinta 發起維護的 Python 資源列表,內容包括:Web框架、網絡爬蟲、網絡內容提取、模板引擎、資料庫、數據可視化、圖片處理、文本處理、自然語言處理、機器學習、日誌、代碼分析等。
  • 性能是Flask的3倍!比PHP7還快!這個Python框架你值得擁有!
    在軟體開發中更是如此,「快」能從多方面提升用戶體驗。談到Python,它似乎天生就和速度無關,你可能很熟悉Django、Flask這些框架,雖然開發效率的確不錯,但是速度就一言難盡。那麼在前後端分離開發的時代,有沒有能拿得出手的Python Web框架呢?當然是有的,FastApi它來了。一、為什麼是FastApi?
  • 淺談flask ssti 繞過原理
    文章轉自先知社區:https://xz.aliyun.com/t/8029關於flask的中ssti的繞過文章還是很多的,
  • 細說Jinja2之SSTI&bypass
    前言SSTI(Server-Side Template Injection)服務端模板注入在CTF中並不是一個新穎的考點了,之前略微學習過,但是最近的大小比賽比如說安洵杯,祥雲杯,太湖杯,南郵CTF,上海大學生安全競賽等等比賽都頻頻出現,而且賽後看到師傅們各種眼花繚亂的payload,無法知曉其中的原理,促使我寫了這篇文章來總結各種
  • 什麼是python虛擬環境?吃貨們都能懂的教程,走起
    d盤下新建第二個項目D:\py_work\demo2那麼在demo2中用到flask這個項目框架使用pip install flask安裝那麼flask這個框架也是安裝到默認項目文件夾C:\Python38下的那麼我們在d盤下新建第三個項目D:\py_work\demo3那麼在demo2中用到django這個項目框架
  • 基於 Flask 部署 Keras 深度學習模型
    文 | 風玲兒出處 | 掘金本文主要記錄在進行Flask部署過程中所使用的流程,遇到的問題以及相應的解決方案。1、項目簡介該部分簡要介紹一下前一段時間所做的工作:這是第一次進行深度學習模型的 web 應用部署,在整個過程中,進一步折射出以前知識面之窄,在不斷的入坑、解坑中實現一版。
  • 關於零基礎學習Python有什麼好的建議?
    Python下有許多款不同的 Web 框架。Django是重量級選手中最有代表性的一位。許多成功的網站和APP都基於Django。Django 是一個開放原始碼的 Web 應用框架,遵守 BSD 版權。