简介

对于jinjia2来说,模板仅仅是文本文件,可以生成任何基于文本的文件格式,例如HTML、XML、CSV、LaTex 等等,以下是基础的模板内容:

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul>
{% for item in seq %} {# test #}
<li>{{ item }}</li>
{% endfor %}
</ul>
</body> </html>

其中{% %}是用来执行表达式或者赋值,{{ }}则是用来显示对应变量的值,可以是表达式中的值,也可以是应用传入的值,{# #}相当于是python的注释,这个是模板中的注释。除此之外,这些标识符都可以在Environment中进行自定义修改,不过一般不会修改。

变量

众所周知,模板文件中存在表达式和变量,那么变量是怎么来的呢?当然是在调用render渲染模板时传入的,那么变量有哪几种类型呢?

1.普通值

模板文件

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<h1>{{name}}</h1>
<h2>{{gender}}</h2>
</body>
</html>

调用模板文件传递普通值(存在、不存在)以及不传部分值

from jinja2 import Environment, FileSystemLoader
import pathlib TEMPLATE_PATH = (
pathlib.Path(__file__).parent.joinpath("template_demo").joinpath("templates")
) env = Environment(loader=FileSystemLoader(TEMPLATE_PATH))
template = env.get_template("template.html")
# 如下两种方式都可以进行传递
# data = template.render(name="tom", age=18)
data = template.render({"name": "tom", "age": 18})
print(data)

结果

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<h1>tom</h1>
<h2></h2>
</body>
</html>

由结果可以看出,当传递一个不存在值或者不传递模板中所需要的值时,默认的值为空

2.字典

模板文件

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul>
<li>{{ item.name }}</li>
<li>{{ item.age }}</li>
<li>{{ item['gender'] }}</li>
</ul>
</body> </html>

调用模板文件传递字典(值存在、不存在)以及不传部分值

from jinja2 import Environment, FileSystemLoader
import pathlib TEMPLATE_PATH = (
pathlib.Path(__file__).parent.joinpath("template_demo").joinpath("templates")
) env = Environment(loader=FileSystemLoader(TEMPLATE_PATH))
template = env.get_template("template2.html")
data = template.render(item={"name": "tom", "gender": "man", "city": "nanjing"}, age=18)
print(data)

结果

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul>
<li>tom</li>
<li></li>
<li>man</li>
</ul>
</body> </html>

由结果可以看出,与普通值类似,当传递一个不存在值或者不传递模板中所需要的值时,默认的值为空。

需要注意的是当传入字典时,在模板文件中有两种方式可以接收字典的值,一种是item.attr,另一种是item['attr'],这两种效果是一致的,在官方文档中说明有如下:

Jinja2 中 item.attr 在 Python 层中做下面的事情:
检查 item 上是否有一个名为 attr 的属性。
如果没有,检查 item 中是否有一个 'attr' 项 。
如果没有,返回一个未定义对象。 item['attr'] 的方式相反,只在顺序上有细小差异:
检查在 item 中是否有一个 'attr' 项。
如果没有,检查 item 上是否有一个名为 attr 的属性。
如果没有,返回一个未定义对象。

如果一个对象有同名的项和属性,这很重要。此外,有一个attr()过滤器,它只查找属性。

那么什么情况下会出现同名的项和属性呢,如下

class Person(object):
def __init__(self, name, age, gender) -> None:
self.name = name
self.age = age
self.gender = gender
self.data = {"name": "mike"} def __getitem__(self, key):
print('__getitem__')
return self.data[key] def __setitem__(self, key, value):
print('__setitem__')
self.data[key] = value def __delitem__(self, key):
print('__delitem__')
del self.data[key] p = Person("tom", "123", "man")
print(p.name)
print(p['name'])
tom
__getitem__
mike

p.namep['name']分别是由不同的内置函数所控制的,p.name是由__setattr __、__getattr __将对应数据从__dict__中添加或者获取,p['name']是由__getitem __、__setitem __、__delitem __将对应数据从自定义字典中添加或获取、删除,只需要保证二者对应的字典中出现重名的即可。

3.序列(列表、集合、元组等)

模板文件

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul>
{% for item in seq %}
<li>{{ item }}</li>
{% endfor %}
</ul> </body> </html>

调用模板文件传递字典(值存在、不存在)以及不传部分值

from jinja2 import Environment, FileSystemLoader
import pathlib TEMPLATE_PATH = (
pathlib.Path(__file__).parent.joinpath("template_demo").joinpath("templates")
) env = Environment(loader=FileSystemLoader(TEMPLATE_PATH))
template = env.get_template("template3.html")
data = template.render(seq=[1, 2, 3, 4], item=[1, 2, 3])
print(data)

结果

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul> <li>1</li> <li>2</li> <li>3</li> <li>4</li> </ul> </body> </html>

由结果可以看出,与上述类似,当传递一个不存在值或者不传递模板中所需要的值时,默认的值为空(如果处于循环中则不显示)。除此之外,序列中元素可以在模板中进行遍历。

4.自定义对象

对象就可以是上述字典中所描述的重名对象,

模板文件如下:

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul>
<li>{{ item.name }}</li>
<li>{{ item['name'] }}</li>
<li>{{ item.age }}</li>
<li>{{ item['gender'] }}</li>
</ul> </body> </html>

调用模板文件传递对象

p = Person("tom", "123", "man")
print(p.name)
print(p['name'])
TEMPLATE_PATH = (
pathlib.Path(__file__).parent.joinpath("template_demo").joinpath("templates")
) env = Environment(loader=FileSystemLoader(TEMPLATE_PATH))
template = env.get_template("template4.html")
data = template.render(item=p)
print(data)

结果

<!DOCTYPE html>
<html lang="en"> <head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head> <body>
<ul>
<li>tom</li>
<li>mike</li>
<li>123</li>
<li>man</li>
</ul> </body> </html>

由结果可见,item.nameitem['name']虽然同名,但是不同值,当然可以使用attr过滤器只查询属性,只需要将变量改为如下方式,就只会获取到属性,详细用法到下面过滤器再进行说明。

<li>{{ item|attr("name")}}</li>

过滤器

顾名思义,就是对传入模板的变量进行过滤得到符合要求的信息,过滤器的基本用法如下

item|过滤器(参数)
例如获取对象的属性:
item|attr("name")

除此之外,过滤器还支持多条件过滤,每一次过滤后的结果作为下一个过滤器的参数,例如

将值进行绝对值后再转变成浮点型
{{ item.sale|abs|float}}

内置过滤器如下:

过滤器名称 过滤器的作用 使用方法
abs(number) 返回number的绝对值 item|abs
attr(obj, name) 获取obj的name属性,类似于obj.name foo|attr("bar")
batch(value, linecount, fill_with=None) 批处理value的过滤器,value必须为可迭代对象(字典、字符串、列表、字典等),根据linecount将value分成多个linecount个数的块,不够的使用fill_with的参数补全,返回的是一个生成器。 item|batch(2, '&nbsp;')
capitalize(s) 将字符串s首字母大写 item|capitalize
center(value, width=80) 将value值在width字符中居中, 默认width为80 item|center(20)
default(value, default_value=u'', boolean=False) 当value未传值时显示default_value默认值,需要注意当value为空字符串时,default_value将不会显示,需将boolean设置为true才会显示 item|default("test")
dictsort(value, case_sensitive=False, by='key') 将value字典按照键值对的形式形成元组并排序添加到列表中,类似于[('age', 10), ('name', 20)],case_sensitive:排序时是否区分大小写,by:排序的依据,默认为key item|dictsort(true)
escape(s) 将特殊字符( &, <, >, ‘, ”)转换成安全的html,就是转义 item|escape
filesizeformat(value, binary=False) 将文件格式化成人类可读的文件大小,默认十进制,binary为true时使用二进制 item\filesizeformat
first(seq) 返回序列的第一个元素 item|first
float(value, default=0.0) 将value转为浮点类型,默认为0.0 ite|float
forceescape(value) 强制value html转义 item|forceescape
format(value, *args, **kwargs) 格式化字符串 {{ "%s - %s"|format("Hello?", "Foo!") }} Hello? - Foo!
  • batch(value, linecount, fill_with=None)详解

    当前存在如下模板文件
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<table>
{{item}}
{{item|batch(2, '&nbsp;')|list}}
{%- for row in item|batch(2, '&nbsp;') %}
<tr>
{%- for column in row %}
<td>{{ column }}</td>
{%- endfor %}
</tr>
{%- endfor %}
</table>
</body>
</html>

python代码

from jinja2 import Environment, FileSystemLoader
import pathlib TEMPLATE_PATH = (
pathlib.Path(__file__).parent.joinpath("template_demo").joinpath("templates")
) env = Environment(loader=FileSystemLoader(TEMPLATE_PATH))
template = env.get_template("template5.html")
data = template.render(item="asdadsa")
print(data)

结果

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<table>
asdadsa
[['a', 's'], ['d', 'a'], ['d', 's'], ['a', '&nbsp;']]
<tr>
<td>a</td>
<td>s</td>
</tr>
<tr>
<td>d</td>
<td>a</td>
</tr>
<tr>
<td>d</td>
<td>s</td>
</tr>
<tr>
<td>a</td>
<td>&nbsp;</td>
</tr>
</table>
</body>
</html>

由结果可以看见,将传入的asdadsa变为了[['a', 's'], ['d', 'a'], ['d', 's'], ['a', '&nbsp;']],item|batch(2, '&nbsp;')将传入值按照每两个一组的形式,缺少的使用 补充,由此形成了一个内部嵌套可迭代对象的生成器,需要使用两次for循环获取数据,此处是因为使用了list转变成了列表。这方法非常适用于数据中存在分段数据格式需要统一(例如表格中的数据,可以传入所有数据,分块自动显示数据)。

测试

测试主要是测试一个变量或者一个表达式,使用is

注释

在模板中使用注释,需要注意,原有的模板文件的格式注释不适用,需要使用{# #},也可以自定义注释的风格,使用Environment中的comment_start_stringcomment_end_string进行修改,注意需要首尾呼应。

空白控制

默认情况下,模板引擎不会对模板中的空白做任何修改,如果应用配置了Environment的 trim_blocks ,模板标签后的第一个换行符会被自动移除。

此外,也支持手动将空白删除,只需在需要的块前或者块后添加-即可,例如,清除了for之前的空白及属性后的空白,需要注意的是标签-之间不能留空白。

    {%- for i in item %}
{{i}}
{%- endfor %}

转义

当希望Jinjia2忽略某些变量或者块、标签时,尤其是内置的标签,例如当你需要显示{{,使用{{ {{ }}会报错,需要使用{{ '{{' }}

如果对于较大的块的话,例如想在网页展示jinjia2的语法,如下,使用{% raw %}{% endraw %}包裹即可。

{% raw %}
<ul>
{% for item in seq %}
<li>{{ item }}</li>
{% endfor %}
</ul>
{% endraw %}

行语句

使用Enviromentblock_start_stringblock_end_string设置行语句前缀为#时,默认会清除行首的空白,如下两种方式是一致的, 需要注意的是当启用行语句后,除了#后面的逻辑操作之外,不建议在同一行进行其他操作。

<ul>
# for item in seq
<li>{{ item }}</li>
# endfor
</ul> <ul>
{% for item in seq %}
<li>{{ item }}</li>
{% endfor %}
</ul>

若有未闭合的圆括号、花括号或方括号,行语句可以跨越多行:

<ul>
# for href, caption in [('index.html', 'Index'),
('about.html', 'About')]:
<li><a href="{{ href }}">{{ caption }}</a></li>
# endfor
</ul>

除了行语句之外还有行注释,使用Environment中的comment_start_stringcomment_end_string修改即可设置行注释, 例如修改为#, #之后的都将作为注释。

python jinjia2 使用语法的更多相关文章

  1. python yield from 语法

    python yield from 语法 yield语法比较简单, 教程也很多 , yield from的中文讲解很少 , python官网是这样解释的 PEP 380 adds the yield ...

  2. Python基础:语法基础(3)

    本篇主要介绍Python中一些基础语法,其中包括:标识符.关键字.常量.变量.表达式.语句.注释.模块和包等内容. 1. 标识符和关键字 1.1 标识符 标识符是变量.常量.函数.属性.类.模块和包等 ...

  3. Python的基础语法(二)

    0. 前言 接着上一篇博客的内容,我将继续介绍Python相关的语法.部分篇章可能不只是简单的语法,但是对初学者很有帮助,也建议读懂. 1. 表达式 由数字.符号.括号.变量等组成的组合. 算术表达式 ...

  4. 六. Python基础(6)--语法

    六. Python基础(6)--语法 1 ● Python3中, Unicode转字节的方法 print(bytes("李泉", encoding = 'utf-8')) prin ...

  5. 五. Python基础(5)--语法

    五. Python基础(5)--语法 1 ● break结束的是它所在的循环体, continue是让它所在的循环体继续循环 # 打印: 1 10 2 10 3 10 4 10 5 10 6 10 7 ...

  6. 四. Python基础(4)--语法

    四. Python基础(4)--语法 1 ● 比较几种实现循环的代码 i = 1 sum = 0 while i <= 10: # 循环10-1+1=10次     sum += i     i ...

  7. 三. Python基础(3)--语法

    三. Python基础(3)--语法 1. 字符串格式化的知识补充 tpl = "我是%s,年龄%d,学习进度100%" %('Arroz',18) print(tpl) # 会提 ...

  8. 二. Python基础(2)--语法

    二. Python基础(2)--语法 1.实现一个简单的登录系统 '''# 形式1 n = 1 while n < 4:     name = input("请输入姓名\n" ...

  9. 一. Python基础(1)--语法

    一. Python基础(1)--语法 1. 应用程序 1.1 什么是计算机(Computer)? 组成 ①运算器 arithmetic unit; ※ Arithmetic unit and cont ...

随机推荐

  1. Flask01 第一个flask项目

    参考地址:https://github.com/miguelgrinberg/microblog/tree/v0.1 flask环境[苹果M1] 添加虚拟环境 python3 -m venv venv ...

  2. Java 17 新特性:switch的模式匹配(Preview)

    还记得Java 16中的instanceof增强吗? 通过下面这个例子再回忆一下: Map<String, Object> data = new HashMap<>(); da ...

  3. awk内建函数

    内建函数 length() 获得字符串长度 cat score.txt Marry 2143 78 84 77 Jack 2321 66 78 45 Tom 2122 48 77 71 Mike 25 ...

  4. linux篇-linux下源码安装nginx

    LNMP模式 后续继续更新,先搭建nginx 安装环境gcc gcc-c++ 2 下载源码包解压 配置第一个报错 安装openssl openssl-devel yum -y install open ...

  5. 好客租房17-jsx的样式处理

    1行内样式-style <h1 style={{color:"red",backgroundColor:"skyblue"}}> jsx的样式处理 ...

  6. Lucene开发实例:Lucene中文分词(转载)

    1.准备工作下载lucene 3.6.1 : http://lucene.apache.org/下载中文分词IK Analyzer: http://code.google.com/p/ik-analy ...

  7. MVC - MVC的工作流程

    MVC 是Model-View-Controller的简写."Model" 代表的是应用的业务逻辑(通过JavaBean,EJB组件实现), "View" 是应 ...

  8. 【Java面试】请你简单说一下Mysql的事务隔离级别

    一个工作了6年的粉丝,去阿里面试,在第一面的时候被问到"Mysql的事务隔离级别". 他竟然没有回答上来,一直在私信向我诉苦. 我说,你只能怪年轻时候的你,那个时候不够努力导致现在 ...

  9. 【spring源码系列】之【FactoryBean类型的接口】

    1.概述 目前我们知道,spring创建bean有多种方式,比如xml方式创建,比如@Component,@Service,@Controler,@Repository注解创建,比如@Autowire ...

  10. LVS简单搭建(一)

    先说一个坑: 192.168.65.110为虚拟ip,在主节点设置(ifconfig  eth0:8 192.168.65.110/24),其他子节点要与主节点保持一致(ifconfig  lo:3  ...