jinja2
本文转自:https://www.cnblogs.com/dachenzi/p/8242713.html
模板
要了解jinja2,那么需要先理解模板的概念。模板在Python的web开发中广泛使用,它能够有效的将业务逻辑和页面逻辑分开,使代码可读性增强、并且更加容易理解和维护。
模板简单来说就是一个其中包涵占位变量表示动态的部分的文件,模板文件在经过动态赋值后,返回给用户。 --> 可以理解为渲染
python中自带一个简单的模板,就是string提供的。
|
1
2
3
4
5
6
7
|
>>> import string>>> a = string.Template('$who is $role')>>> a.substitute(who='daxin',role='Linux')'daxin is Linux'>>> a.substitute(who='daxin',role='cat')'daxin is cat'>>> |
Python自带的模板功能极其有限,如果我们想要在模板中使用控制语句,和表达式,以及继承等功能的话,就无法实现了。
目前主流的模板系统,最常用的就是jinja2和mako
jinja2介绍
jinja2是Flask作者开发的一个模板系统,起初是仿django模板的一个模板引擎,为Flask提供模板支持,由于其灵活,快速和安全等优点被广泛使用。
jinja2的优点
jinja2之所以被广泛使用是因为它具有以下优点:
- 相对于Template,jinja2更加灵活,它提供了控制结构,表达式和继承等。
- 相对于Mako,jinja2仅有控制结构,不允许在模板中编写太多的业务逻辑。
- 相对于Django模板,jinja2性能更好。
- Jinja2模板的可读性很棒。
安装jinja2
由于jinja2属于第三方模块,首先需要对其进行安装
|
1
|
pip3 install jinja2 |
测试模板是否安装成功
|
1
2
3
4
|
python -c "import jinja2"# 没有报错就表示安装成功# 必须用双引号" |
jinja2语法
作为一个模板系统,它还提供了特殊的语法,我们按照它支持的语法进行编写之后,就能使用jinja2模块进行渲染。
基本语法
在jinja2中,存在三种语法:
- 控制结构 {% %}
- 变量取值 {{ }}
- 注释 {# #}
下面是一个简单的jinja2例子
|
1
2
3
4
5
6
7
|
{# This is jinja code {% for file in filenames %} ... {% endfor %}#} |
可以看到,for循环的使用方式和Python比较类似,但是没有了句尾的冒号,另外需要使用endfor最为结尾,其实在jinja2中,if也是一样的,结尾需要使用endif。
jinja2变量
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> |
jinja2中的过滤器
变量可以通过“过滤器”进行修改,过滤器可以理解为是jinja2里面的内置函数和字符串处理函数。
常用的过滤器有:
| 过滤器名称 | 说明 |
| safe | 渲染时值不转义 |
| capitialize | 把值的首字母转换成大写,其他子母转换为小写 |
| lower | 把值转换成小写形式 |
| upper | 把值转换成大写形式 |
| title | 把值中每个单词的首字母都转换成大写 |
| trim | 把值的首尾空格去掉 |
| striptags | 渲染之前把值中所有的HTML标签都删掉 |
| join | 拼接多个值为字符串 |
| replace | 替换字符串的值 |
| round | 默认对数字进行四舍五入,也可以用参数进行控制 |
| int | 把值转换成整型 |
那么如何使用这些过滤器呢? 只需要在变量后面使用管道(|)分割,多个过滤器可以链式调用,前一个过滤器的输出会作为后一个过滤器的输入。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
{{ 'abc' | captialize }}# Abc{{ 'abc' | upper }}# ABC{{ 'hello world' | title }}# Hello World{{ "hello world" | replace('world','daxin') | upper }}# HELLO DAXIN{{ 18.18 | round | int }}# 18 |
jinja2的控制结构
jinja2中的if语句类似与Python的if语句,它也具有单分支,多分支等多种结构,不同的是,条件语句不需要使用冒号结尾,而结束控制语句,需要使用endif关键字。
|
1
2
3
4
5
6
7
|
{% if daxin.safe %}daxin is safe.{% elif daxin.dead %}daxin is dead{% else %}daxin is okay{% endif %} |
jinja2的for循环
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> |
当然也可以加入else语句,在循环正确执行完毕后,执行
在for循环中,jinja2还提供了一些特殊的变量,用以来获取当前的遍历状态:
| 变量 | 描述 |
| loop.index | 当前迭代的索引(从1开始) |
| loop.index0 | 当前迭代的索引(从0开始) |
| loop.first | 是否是第一次迭代,返回bool |
| loop.last | 是否是最后一次迭代,返回bool |
| loop.length | 序列中的项目数量 |
| loop.revindex | 到循环结束的次数(从1开始) |
| loop.revindex0 | 到循环结束的次数(从0开始) |
jinja2的宏
宏类似于Python中的函数,我们在宏中定义行为,还可以进行传递参数,就像Python中的函数一样一样儿的。
在宏中定义一个宏的关键字是macro,后面跟其 宏的名称和参数等
|
1
2
3
4
5
|
{% macro input(name,age=18) %} # 参数age的默认值为18 <input type='text' name="{{ name }}" value="{{ age }}" >{% endmacro %} |
调用方法也和Python的类似
|
1
2
|
<p>{{ input('daxin') }} </p><p>{{ input('daxin',age=20) }} </p> |
jinja2的继承和Super函数
jinja2中最强大的部分就是模板继承。模板继承允许我们创建一个基本(骨架)文件,其他文件从该骨架文件继承,然后针对自己需要的地方进行修改。
jinja2的骨架文件中,利用block关键字表示其包涵的内容可以进行修改。
以下面的骨架文件base.html为例:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<!DOCTYPE html><html lang="en"><head> {% block head %} <link rel="stylesheet" href="style.css"/> <title>{% block title %}{% endblock %} - My Webpage</title> {% endblock %}</head><body><div id="content">{% block content %}{% endblock %}</div><div id="footer"> {% block footer %} <script>This is javascript code </script> {% endblock %}</div></body></html> |
这里定义了四处 block,即:head,title,content,footer。那怎么进行继承和变量替换呢?注意看下面的文件
|
1
2
3
4
5
6
7
8
9
10
11
12
|
{% extend "base.html" %} # 继承base.html文件{% block title %} Dachenzi {% endblock %} # 定制title部分的内容{% block head %} {{ super() }} # 用于获取原有的信息 <style type='text/css'> .important { color: #FFFFFF } </style>{% endblock %} # 其他不修改的原封不同的继承 |
PS: super()函数 表示获取block块中定义的原来的内容。
利用jinja2进行渲染
jinja2模块中有一个名为Enviroment的类,这个类的实例用于存储配置和全局对象,然后从文件系统或其他位置中加载模板。
基本使用方法
大多数应用都在初始化的时候撞见一个Environment对象,并用它加载模板。Environment支持两种加载方式:
- PackageLoader:包加载器
- FileSystemLoader:文件系统加载器
PackageLoader
使用包加载器来加载文档的最简单的方式如下:
|
1
2
3
4
5
|
from jinja2 import PackageLoader,Environmentenv = Environment(loader=PackageLoader('python_project','templates')) # 创建一个包加载器对象template = env.get_template('bast.html') # 获取一个模板文件template.render(name='daxin',age=18) # 渲染 |
其中:
- PackageLoader()的两个参数为:python包的名称,以及模板目录名称。
- get_template():获取模板目录下的某个具体文件。
- render():接受变量,对模板进行渲染
FileSystemLoader
文件系统加载器,不需要模板文件存在某个Python包下,可以直接访问系统中的文件。
jinja2的更多相关文章
- 自定义jinja2 过滤器
今天,我们要讲的是自定义jinja2 过滤器这个知识点,因为官方文档对此一代而过,讲得不够清楚,所以我们专门拿出来讲一下. 例子 例子写了两个自定义过滤器,一个是转换字典到字符串的过滤器,一个是返回当 ...
- 在windows上如何安装python web引擎jinja2
首先要把你的Python文件夹加到环境变量里头去.假设你的Python文件夹位于C:\Python34,那么你需要打开CMD并输入: SETX PATH "%path%;C:\Python3 ...
- SaltStack配置管理之状态模块和jinja2(五)
官方文档 https://docs.saltstack.com/en/latest/topics/states/index.html 配置管理之SLS Salt State SLS描述文件(YAM ...
- Ansible用于网络设备管理 part 2 对Jinja2 YAML 和 module的理解
虽然很不想用“应该”这个词,但是还是写上了,的确我自己目前就是这么理解的. 那么这个理解就是,Ansible的一个key point 就是总的一个playbook是去依赖很多元素的,就像一开始那个图里 ...
- Ansible用于网络设备管理 part 1 Jinja2 YAML初窥
这一次的实验内容依然来自Kirk Byers的博客,源地址在https://pynet.twb-tech.com/blog/python/paramiko-ssh-part1.html 但是,这次实验 ...
- easy_install jinja2 mac linux
error: can't create or remove files in install directory The following error occurred while trying t ...
- Flask 框架下 Jinja2 模板引擎高层 API 类——Environment
Environment 类版本: 本文所描述的 Environment 类对应于 Jinja2-2.7 版本. Environment 类功能: Environment 是 Jinja2 中的一个 ...
- jinja2 宏的简单使用总结(macro)
Table of Contents 1. 简介 2. 用法 3. 参数和变量 4. 注意事项 4.1. macro的变量只能为如下三种: 4.2. 和block的关系: 5. 参考文档 1 简介 ji ...
- Jinja2学习笔记暨官方文档的翻译
http://blog.csdn.net/lgg201/article/details/4647471 呵呵, 刚刚看完Python模板引擎Jinja2的文档, 感觉很好, 觉得动态语言真是很好. ...
- Jinja2模版语言自定义filter的使用
Jinja2模版语言,自带有一些filter,能够在前端的模版中控制数据按照相应的方式显示.比如以下两种filter,分别能在前端控制数字的近似精度显示和根据字符串长度补齐: round(value, ...
随机推荐
- Java基础 -- 字符串(格式化输出、正则表达式)
一 字符串 1.不可变String String对象是不可变的,查看JDK文档你就会发现,String类中每一个看起来会修改String值的方法,实际上都是创建一个全新的String对象,以包含修改后 ...
- Java基础 -- 嵌套类(非静态嵌套类、静态嵌套类)
可以将一个类的定义放在另一个类的内部定义,这样的类就被称为嵌套类,包含嵌套类的类被称为外部类(outer class),也可以叫做封闭类. 嵌套类可以分为两种: 静态嵌套类(Static Nested ...
- python自动启动appium服务
我们可以通过socket模块来检查appium是否启动,如果未启动,可以通过subprocess模块来启动,需要导入socket和subprocess模块,具体如下图: 第1个函数:表示检查appiu ...
- Python模拟弹道轨迹
http://www.itongji.cn/cms/article/articledetails?articleid=5029 最近美国把萨德系统部署到韩国,一时心血来潮就用python模拟最简单的弹 ...
- 条件随机场(conditional random field,CRF)模型初探
0. 引言 0x1:为什么会有条件随机场?它解决了什么问题? 在开始学习CRF条件随机场之前,我们需要先了解一下这个算法的来龙去脉,它是在什么情况下被提出的,是从哪个算法演进而来的,它又解决了哪些问题 ...
- ElasticSearch query_string vs multi_match cross_fields query
ElasticSearch query_string vs multi_match cross_fields query 本文记录以字段为中心的查询和以词为中心的查询这两种查询方式的区别以及在Elas ...
- npm knowledge basics
npm inro https://www.npmjs.com/ npm is the package manager for javascript npm 为 nodejs默认的包管理工具, 为nod ...
- django --视图装饰器
- 最近面试被问到一个问题,AtomicInteger如何保证线程安全?
最近面试被问到一个问题,AtomicInteger如何保证线程安全?我查阅了资料 发现还可以引申到 乐观锁/悲观锁的概念,觉得值得一记. 众所周知,JDK提供了AtomicInteger保证对数字的操 ...
- hibernate之HQL,Criteria与SQL
HQL是针对封装好的对象. HQL :hibernate自己用的sql语句 -------HQL不能出现表中的任何内容 ---------不经常使用开发中 基本查询:String hql = &q ...