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阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容