python-jinja2模块学习

0x00 前言

上次总结了python flask模板,flask模板是一个包含响应文本的文件,其中包含用占位变量表示的动态部分,其具体指只在请求的上下文中才能知道。使用真是只替换变量,再返回最终得到的响应字符串,这一过程称为渲染。为了渲染模板,Flask使用了一个名为Jinja2的强大模板引擎。这次记录一下jinja2模块的学习,用作笔记。

0x01 jinja2

Jinja2是基于python的模板引擎,功能比较类似于于PHP的smarty,J2ee的Freemarker和velocity。 它能完全支持unicode,并具有集成的沙箱执行环境。jinja2使用BSD授权。起初是Flask作者模仿django模板的一个模板引擎,为Flask提供模板支持,由于其灵活,快速和安全等优点被广泛使用。

0x02 安装

python库的安装都十分方便,jinja2也不例外,我们直接在命令行输入

1
pip install jinja2

即可安装。

0x03 基本语法

在jinja2中,存在三种语法:

1
2
3
控制结构 {% %}
变量取值 {{ }}
注释 {# #}

0x04 变量

jinja2模板中使用两个花括号嵌套 语法表示一个变量,它是一种特殊的占位符。当利用jinja2进行渲染的时候,它会把这些特殊的占位符进行填充/替换,jinja2支持python中所有的Python数据类型比如列表、字段、对象等。


1
2
3
<p>this is a dicectory:{{ mydict['key'] }} </p>
<p>this is a list:{{ mylist[3] }} </p>
<p>this is a object:{{ myobject.something() }} </p>

0x05 过滤器

花括号中的变量传输进来时,我们要对其进行一些对字符串的常规操作或者提升安全性的操作,这个时候可以使用jinja2自带的过滤器。

常用的过滤器:

过滤器 说明
safe 渲染时值不转义
capitialize 把值的首字母转换成大写,其他子母转换为小写
lower 把值转换成小写形式
upper 把值转换成大写形式
title 把值中每个单词的首字母都转换成大写
trim 把值的首尾空格去掉
striptags 渲染之前把值中所有的HTML标签都删掉
join 拼接多个值为字符串
replace 替换字符串的值
round 默认对数字进行四舍五入,也可以用参数进行控制
int 把值转换成整型

过滤器的用法是在变量后面使用管道(|)分割,多个过滤器可以链式调用,前一个过滤器的输出会作为后一个过滤器的输入。

如:

1
2
3
4
5
6
{{ 'abc' | upper }}
# ABC
{{ 'hello world' | title }}
# Hello World
{{ 18.18 | round | int }}
# 18

0x06 分支

jinja2中的if语句类似与Python的if语句,它也具有单分支,多分支等多种结构,不同的是,条件语句不需要使用冒号结尾,而结束控制语句,需要使用endif关键字。

如:

1
2
3
4
5
6
7
{% if grade>=90 %}
excellent
{% elif grade>=60 %}
great
{% else %}
bad
{% endif %}

0x07 循环

jinja2中的for循环用于迭代Python的数据类型,包括列表,元组和字典。在jinja2中不存在while循环。

迭代列表

1
2
3
4
5
<ul>
{% for user in users %}
<li>{{ user.username|title }}</li>
{% endfor %}
</ul>

迭代字典

1
2
3
4
5
6
<dl>
{% for key, value in my_dict.iteritems() %}
<dt>{{ key }}</dt>
<dd>{{ value}}</dd>
{% endfor %}
</dl>

在for循环中,jinja2还提供了一些特殊的变量,用以来获取当前的遍历状态:

变量 作用
loop.index 当前迭代的索引(从1开始)
loop.index0 当前迭代的索引(从0开始)
loop.first 是否是第一次迭代,返回bool
loop.last 是否是最后一次迭代,返回bool
loop.length 序列中的项目数量
loop.revindex 到循环结束的次数(从1开始)
loop.revindex0 到循环结束的次数(从0开始)

0x08 宏

宏类似于Python中的函数(其实就是函数的用法),我们在宏中定义行为,还可以进行传递参数。

1
2
3
{% macro input(name,age=18) %}
<input type='text' name="{{ name }}" value="{{ age }}" >
{% endmacro %}

调用:

1
2
<p>{{ input('daxin') }} </p>
<p>{{ input('daxin',age=20) }} </p>

0x09 继承

jinja2中最强大的部分就是模板继承。模板继承允许我们创建一个基本文件,其他文件从该骨架文件继承,然后针对自己需要的地方进行修改。

骨架文件中,block关键字表示其包涵的内容可以进行修改。

如:

1
<title>{% block title %}Leticia's Blog{% endblock %}</title>

我们要替换的时候

1
{% block title %}xxx's Blog{% endblock %}

0x10 渲染模板

默认情况下,Flask在程序文件夹中的templates子文件夹中寻找模板。

1
2
3
4
5
6
7
8
9
10
11
12
import jinja2
from flask import Flask, render_template
app = Flask(__name__)
@app.route('/')
def index():
return render_template('index.html')
@app.route('/user/<name>')
def user(name):
return render_template('user.html', name=name)

render_template 函数的第一个参数是模板的文件名(index.html,user.html),随后的参数都是键值对(name=name),表示模板中变量的真实值。