Python模板引擎——jinja2的基本用法集錦

本文講述的核心庫:jinja2
官方文檔:http://jinja.pocoo.org/docs/2.10/

安裝

pip install jinja2

基本用法demo

直接渲染字符串

# coding:utf-8
from jinja2 import Template

def main():
    tpl = Template('hell, {{name}}!')
    print tpl.render(name = 'world')
    
if __name__ == '__main__':
    main()

運行上述代碼輸出:

hell, world!

從文件內容渲染

假如當前文件夾下有一個名為page_template.txt的文件,其內容如下:

hello, {{name}}!

下面在當前文件夾創建一個demo.py腳本文件:

# coding:utf-8
from jinja2 import Environment,FileSystemLoader

def main():
    env = Environment(loader = FileSystemLoader('./'))
    tpl = env.get_template('page_template.txt')
    
    with open('page.txt','w+') as fout:
        render_content = tpl.render(name = 'world')
        fout.write(render_content)
        
if __name__ == '__main__':
    main()

運行demo.py,在當前目錄下生成了一個page.txt文件,其內容為:

hello, world!

模板控制語句

判斷語句

page_template.txt內容:

{# 這是一段注釋,不會顯示在結果中。下面展示if控制語句的用法: #}
{% if age > 80 %}
too old.
{% elif age < 10 %}
too young.
{% else %}
it's good.
{% endif %}

demo.py內容:

# coding:utf-8
from jinja2 import Environment,FileSystemLoader

def main():
    env = Environment(loader = FileSystemLoader('./'))
    tpl = env.get_template('page_template.txt')
    
    with open('page.txt','w+') as fout:
        render_content = tpl.render(age = 10)
        fout.write(render_content)
        
if __name__ == '__main__':
    main()

運行demo.py,生成的page.txt文件內容:



it's good.

可以看到在page.txt的一開始有兩個空白行,怎么去掉這兩個空白行呢?只需在模板文件中的控制語句的%符號前面或后面加-即可,比如修改page_template.txt如下:

{# 這是一段注釋,不會顯示在結果中。下面展示if控制語句的用法: #}
{%- if age > 80 -%}
too old.
{%- elif age < 10 -%}
too young.
{%- else -%}
it's good.
{%- endif -%}

再次運行demo.py,生成的page.txt文件內容如下:

it's good.

可以看到空白行已經沒有了。

循環語句

page_template.txt內容:

{%- for n in nums -%}
number: {{n}}
{% endfor %}

demo.py內容:

# coding:utf-8
from jinja2 import Environment,FileSystemLoader

def main():
    env = Environment(loader = FileSystemLoader('./'))
    tpl = env.get_template('page_template.txt')
    
    with open('page.txt','w+') as fout:
        render_content = tpl.render(nums = [1,2,3])
        fout.write(render_content)
        
if __name__ == '__main__':
    main()

運行demo.py,生成的page.txt文件內容:

number: 1
number: 2
number: 3

在模板中操作對象

在jinja2模板中是可以直接操作Python對象的,比如如下示例。
page_template.txt內容:

name: {{person.name}}
age: {{person.age}}
info: {{person.get_info()}}

demo.py內容:

# coding:utf-8
from jinja2 import Environment,FileSystemLoader

class Person(object):
    def __init__(self,name,age):
        self.name = name
        self.age = age
    
    def get_info(self):
        return self.name + ',' + str(self.age)

def main():
    env = Environment(loader = FileSystemLoader('./'))
    tpl = env.get_template('page_template.txt')
    
    with open('page.txt','w+') as fout:
        render_content = tpl.render(person = Person('Tom',20))
        fout.write(render_content)
        
if __name__ == '__main__':
    main()

運行demo.py,生成的page.txt文件內容:

name: Tom
age: 20
info: Tom,20

在模板中調用自定義函數

page_template.txt內容:

len of {{test_str}} = {{test_str|get_len}}
sum = {{num|get_sum(2,3)}}

demo.py內容:

# coding:utf-8
from jinja2 import Environment,FileSystemLoader

# 可以在模板中調用的函數,第一個參數必須是模板中的操作對象,在模板中用"{{操作對象名|函數名}}"的形式調用
def get_len(string):
    '''
    獲取字符串的長度
    :param string: 字符串
    :return: 字符串的長度
    '''
    return len(string)

def get_sum(value,b,c):
    '''
    求1個數和另外2個數的和
    :param value: 一個數
    :param b: 另一個數
    :param c: 第3個數
    '''
    return value + b + c

def main():
    env = Environment(loader = FileSystemLoader('./'))
    env.filters['get_len'] = get_len
    env.filters['get_sum'] = get_sum
    tpl = env.get_template('page_template.txt')
    
    with open('page.txt','w+') as fout:
        render_content = tpl.render(test_str = 'abc',num = 1)
        fout.write(render_content)
        
if __name__ == '__main__':
    main()

運行demo.py,生成的page.txt文件內容:

len of abc = 3
sum = 6

模板繼承

base_template.txt內容:

This is my website.
{% block head %}  
    {% block title %}{% endblock %}
{% endblock %}  

{% block content%}
{% endblock %}  

Copyright by me.
{% block footer %}  
{% endblock %}  

page_template.txt內容:

{% extends "base_template.txt" %}  
  
{% block head %}  
{% block title %}{{my_title}}{% endblock %}
這里是頁面頭部。
{% endblock %}  

{% block content %}  
這里是頁面內容。
{% endblock content%}  

{% block footer %}  
這里是頁面底部。
{% endblock %}  

demo.py內容:

# coding:utf-8
from jinja2 import Environment,FileSystemLoader
import sys
reload(sys)
sys.setdefaultencoding('utf-8')

def main():
    env = Environment(loader = FileSystemLoader('./'))
    tpl = env.get_template('page_template.txt')
    
    with open('page.txt','w+') as fout:
        render_content = tpl.render(my_title = 'My Index Page')
        fout.write(render_content)
        
if __name__ == '__main__':
    main()

運行demo.py,生成的page.txt文件內容:

This is my website.
  
My Index Page
這里是頁面頭部。
  

  
這里是頁面內容。
  

Copyright by me.
  
這里是頁面底部。
  
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380

推薦閱讀更多精彩內容