1、Jinja2模版过滤器
过滤器是通过管道符号(|)进行使用的,例如:{{ name|length }},将返回name的长度。过滤器相当于是一个函数,把当前的变量传入到过滤器中,然后过滤器根据自己的功能,再返回相应的值,之后再将结果渲染到页面中。Jinja2中内置了许多过滤器,在这里可以看到所有的过滤器。
- abs(value):返回一个数值的绝对值。
- default(value,default_value,boolean=false):如果当前变量没有值,则会使用参数中的值来代替。
- name|default(‘xxx’)——如果name不存在,则会使用xxx来替代。boolean=False默认是在只有这个变量为undefined的时候才会使用default中的值,如果想使用python的形式判断是否为false,则可以传递boolean=true。也可以使用or来替换。
- escape(value)或e:转义字符,会将<、>等符号转义成HTML中的符号。例如:content|escape或content|e。
first(value):返回一个序列的第一个元素。names|first。 - format(value,*arags,**kwargs):格式化字符串。例如以下代码:
- last(value):返回一个序列的最后一个元素。示例:names|last。
- length(value):返回一个序列或者字典的长度。示例:names|length。
- join(value,d=u’’):将一个序列用d这个参数的值拼接成字符串。
- safe(value):如果开启了全局转义,那么safe过滤器会将变量关掉转义。示例:content_html|safe。
- int(value):将值转换为int类型。
- float(value):将值转换为float类型。
- lower(value):将字符串转换为小写。
- upper(value):将字符串转换为小写。
- replace(value,old,new): 替换将old替换为new的字符串。
- truncate(value,length=255,killwords=False):截取length长度的字符串。
- striptags(value):删除字符串中所有的HTML标签,如果出现多个空格,将替换成一个空格。
- trim:截取字符串前面和后面的空白字符。
- string(value):将变量转换成字符串。
- wordcount(s):计算一个长字符串中单词的个数。
# -*- encoding: utf-8 -*-
"""
@File : template_filter.py
@Time : 2020/4/12 15:19
@Author : chen
"""
from flask import Flask,render_template
from datetime import datetime
app = Flask(__name__)
# 模板文件自动更新
app.config['TEMPLATES_AUTO_RELOAD'] = True
@app.route("/")
def index():
contents={
"username": " xxYxxyxx hello world nihao ",
"age": -100, # 在index.html模板文件中需要对这样的数据进行处理
"name": "设置了新的name,不显示default了", # 如果这里的name没有设置,在模板文件中会显示的是default的设置 非空默认
"es": "<script>alert('12345')</script>", # 网页弹出窗口,如果被渲染到页面中,没被flask转义时,应该会显示12345的窗口
"books": ["python", "java", "php"],
"address": " 北京 市 朝 阳 区 ",
"now_time": datetime(2020, 4, 12, 20, 00) # 2020-4-12-20:00
}
return render_template("index.html", **contents)
@app.template_filter("my_cut") # 自定义模板过滤 而不是route路由了 "my_cut"代表过滤器的名字
def cut(value):
return value.replace("hello", "")
@app.template_filter("handle_time") # 自定义模板过滤:显示发表时间距现在的时间长度 handle_time代表过滤器的名字
def handle(time):
"""
小于1分钟:刚刚
大于1分钟---小于1小时:xxx分钟之前
大于1小时---小于24小时:xxx小时之前
"""
if isinstance(time, datetime):
now = datetime.now()
# 总秒数函数total_seconds()
time_contest = (now - time).total_seconds() # time是传入的参数 在模板中是now_time参数
if time_contest < 60:
return "刚刚"
elif time_contest >=60 and time_contest <= 60*60:
return "%s分钟之前" % int(time_contest/60)
elif time_contest > 60*60 and time_contest < 24*60*60:
return "%s小时之前" % int(time_contest/60/60)
else:
return time
if __name__ == '__main__':
app.run(debug=True)
对应的渲染网页界面代码的是templates 这个文件夹下的index.html文件
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>项目代码3测试网页-Jinjia2模板过滤</title>
</head>
<body>
<h1>首页</h1>
<h2>{{ username }}</h2>
<h2>{{ age|abs }}</h2>
<h2>{{ name|default('这个人很懒,并没有任何的签名') }}</h2>
<!-- flask转义了源码,使网页更加安全,不易受到攻击 -->
<h2>{{ es }}</h2>
<!-- flask转义了源码,可以标记为安全的代码,就会正常显示,没有转义 -->
<h2>{{ es|safe }}</h2>
<!-- 另一种关闭转义的方法 -->
{% autoescape off %}
<h2>{{ es }}</h2>
{% endautoescape %}
<!-- 分割线-->
<hr>
<!-- list中取值第一个 -->
<h2>{{ books|first }}</h2>
<!-- list中取值最后一个 -->
<h2>{{ books|last }}</h2>
<!-- list中取值第一个并计算长度 -->
<h2>{{ books|first|length }}</h2>
<hr>
<!-- 全部变成小写 -->
<h2>{{ username|lower }}</h2>
<!-- 全部变成大写 -->
<h2>{{ username|upper }}</h2>
<hr>
<!-- 将字符串"xxYxxyxx"替换为"hello" -->
<h2>{{ username|replace("xxYxxyxx", "hello") }}</h2>
<hr>
<!-- truncate(value,length=255,killwords=False):截取length长度的字符串且最少为3。 主要用于标题,新闻等 -->
<p>{{ username|truncate(length=20) }}</p>
<hr>
<!-- striptags(value):删除字符串中所有的HTML标签,如果出现多个空格,将替换成一个空格。 -->
<h2>{{ es|striptags() }}</h2>
<hr>
<!-- wordcount(s):计算一个长字符串中单词的个数。 -->
<h2>{{ username|wordcount() }}</h2>
<p>{{ address|wordcount() }}</p>
<hr>
<!--trim:截取字符串前面和后面的空白字符。 -->
<p>{{ address|trim }}</p>
<p>{{ username|trim }}</p>
<hr>
<!--使用自定义的模板过滤 -->
<p>{{ username|my_cut() }}</p>
<hr>
<!--使用自定义的模板过滤 时间过滤 -->
<p>文章发表时间:{{ now_time }}</p>
<p>文章发表时间距现在:{{ now_time|handle_time() }}</p>
</body>
</html>
<!--这里的 html文件 只能放在 templates 这个文件夹下-->
效果如下图所示:
2、控制语句
所有的控制语句都是放在{% … %}中,并且有一个语句{% endxxx %}来进行结束,Jinja中常用的控制语句有if/for…in…
if:if语句和python中的类似,可以使用>,<,<=,>=,==,!=来进行判断,也可以通过and,or,not,()来进行逻辑合并操作。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>控制语句:if_for测试网页</title>
</head>
<body>
{# <!-- {{变量}} --> flask只认识这样的注释符号,不认识html文件的注释符号 #}
{# <!-- {% 函数 if for %} --> #}
{# <!-- 函数都要成对出现,即必须出现end符号 --> #}
{% if username == "xxY" %}
<p>{{ username }}</p>
{% else %}
<p>当前的用户名不是xxY</p>
{% endif %}
{#<!-- 函数必须出现end符号 --> #}
</body>
</html>
注意flask只认识{# 。。。 #}这样的注释符号,不认识html文件的注释符号。
for…in…:for循环可以遍历任何一个序列包括列表、字典、元组。并且可以进行反向遍历
列表遍历
{#<!-- list遍历 --> #}
{% for book in books %}
{# <!-- 当前迭代的索引(从1开始) --> #}
<p>{{loop.index}}</p>
<p>{{ book }}</p>
{% endfor %}
<hr>
字典遍历
{#<!-- 字典遍历 --> #}
{% for user in users %}
{# <!-- 当前迭代的索引(从0开始) --> #}
<p>{{loop.index0 }}</p>
<p>{{ user }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for key,value in users.items() %}
{# <!-- 是否是第一次迭代,返回True或False --> #}
<p>{{ loop.first}}</p>
<p>{{ key }}</p>
<p>{{ value }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for key in users.keys() %}
<p>{{ key }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for value in users.values() %}
<p>{{ value }}</p>
{% endfor %}
<hr>
并且Jinja中的for循环还包含以下变量,可以用来获取当前的遍历状态
变量名称
- loop.index 当前迭代的索引(从1开始)
- loop.index0 当前迭代的索引(从0开始)
- loop.first 是否是第一次迭代,返回True或False
- loop.last 是否是最后一次迭代,返回True或False
- loop.length 序列的长度
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>控制语句:if_for测试网页</title>
</head>
<body>
{# <!-- {{变量}} --> flask只认识这样的注释符号,不认识html文件的注释符号 #}
{# <!-- {% 函数 if for %} --> #}
{# <!-- 函数都要成对出现,即必须出现end符号 --> #}
{% if username == "xxY" %}
<p>{{ username }}</p>
{% else %}
<p>当前的用户名不是xxY</p>
{% endif %}
<hr>
{#<!-- list遍历 --> #}
{% for book in books %}
{# <!-- 当前迭代的索引(从1开始) --> #}
<p>{{loop.index}}</p>
<p>{{ book }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for user in users %}
{# <!-- 当前迭代的索引(从0开始) --> #}
<p>{{loop.index0 }}</p>
<p>{{ user }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for key,value in users.items() %}
{# <!-- 是否是第一次迭代,返回True或False --> #}
<p>{{ loop.first}}</p>
<p>{{ key }}</p>
<p>{{ value }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for key in users.keys() %}
<p>{{ key }}</p>
{% endfor %}
<hr>
{#<!-- 字典遍历 --> #}
{% for value in users.values() %}
<p>{{ value }}</p>
{% endfor %}
<hr>
</body>
</html>
另外,不可以使用continue和break表达式来控制循环的执行。
3、宏和import语句
宏
模板中的宏跟python中的函数类似,可以传递参数,但是不能有返回值,可以将一些经常用到的代码片段放到宏中,然后把一些不固定的值抽取出来当成一个变量.
{% macro input(name, value='', type='text') %}
{#<!-- type="{{type}}", name="{{name}}", value="{{value}}" 传入的都是变量 即上一句定义的 -->#}
<input type="{{type}}", name="{{name}}", value="{{value}}">
{% endmacro %}
以上例子可以抽取出了一个input标签,指定了一些默认参数。那么我们以后创建input标签的时候,可以通过他快速的创建:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>宏定义模板测试网页</title>
</head>
<body>
{% macro input(name, value='', type='text') %}
{#<!-- type="{{type}}", name="{{name}}", value="{{value}}" 传入的都是变量 即上一句定义的 -->#}
<input type="{{type}}", name="{{name}}", value="{{value}}">
{% endmacro %}
<table>
<tr>
<td>
用户名:
</td>
<!-- input(username) 传参到上面的input中 -->
<td>{{ input(username) }}</td>
<td>密码:</td>
<td>{{ input('password', type='password') }}</td>
<td>提交:</td>
<td>{{ input(value='点击提交', type='submit') }}</td>
</tr>
</table>
</body>
</html>
import语句
在真实的开发中,会将一些常用的宏单独放在一个文件中,在需要使用的时候,再从这个文件中进行导入。import语句的用法跟python中的import类似,可以直接import…as…,也可以from…import…或者from…import…as…
导入宏的例子
1.import…as…形式
{# <!-- 导入macro.html中的宏 --> #}
{% import 'macro.html' as macro %}
{# <!-- 导入macro.html中的宏 进行使用宏 --> #}
{{ macro.input('username') }}
{% import 'macro.html' as macro %}
<tr>
<td>用户名:</td>
<td>{{ macro.input('username') }}</td>
</tr>
2.from…import…as…/from…import…形式
{% from "macro.html" import input %}
<tr>
<td>密码:</td>
<td>{{ input("password",type="password") }}</td>
</tr>
另外需要注意的是,导入模板并不会把当前上下文中的变量添加到被导入的模板中,如果你想要导入一个需要访问当前上下文变量的宏,有两种可能的方法:
- 显式地传入请求或请求对象的属性作为宏的参数
- 与上下文一起(with context)导入宏
与上下文中一起(with context)导入的方式
{% import 'macro.html' as macro with context %}
4、include和set语句
include语句
include语句可以把一个模板引入到另外一个模板中,类似于把一个模板的代码copy到另外一个模板的指定位置。
{# <!-- 'commit/xxx.html' 是指在当前文件夹commit下的html文件 相对于templates这个目录来写绝对路径 --> #}
{% include 'commit/header.html' %}
{% include 'commit/footer.html' %}
赋值(set)语句
有时候我们想在在模板中添加变量,这时候赋值语句(set)就派上用场了
{# <!-- 这是全局变量 --> #}
{% set name='xxx' %}
也可以在with的后面直接添加变量,比如以上的写法可以修改成这样
{# <!-- 这是局部变量 超出with代码块就无效了 --> #}
{% with %}
{% set name='局部变量' %}
<p>{{ name }}</p>
{% endwith %}
<hr>
{# <!-- 这是局部变量 超出with代码块就无效了 --> #}
{% with name='局部变量'%}
<p>{{ name }}</p>
{% endwith %}
既可以定义字典、列表等,同时,也可以给他赋值为字符串和元组:,只要是变量就可以定义
{% set navigation = [('index.html', 'Index'), ('about.html', 'About')] %}
<hr>
{# <!-- 定义字典 --> #}
{% with a={'dict':'定义字典'} %}
<p>{{ a.keys() }}</p>
<p>{{ a.values() }}</p>
{% endwith %}
网页效果如下: