Flask中Jinja2模板过滤器

IT之一小佬

已于 2023-12-09 12:52:42 修改

阅读量445

点赞数

分类专栏： Flask框架文章标签： flask python Jinja2

于 2022-08-14 00:12:31 首次发布

本文链接：https://blog.csdn.net/weixin_44799217/article/details/126324345

版权

Flask框架专栏收录该内容

47 篇文章 15 订阅

订阅专栏

1、过滤器的使用

有时候我们想要在模版中对一些变量进行处理，那么就必须需要类似于Python中的函数一样，可以将这个值传到函数中，然后做一些操作。

在模版中，过滤器相当于是一个函数，把当前的变量传入到过滤器中，然后过滤器根据自己的功能，再返回相应的值，之后再将结果渲染到页面中。

过滤器是通过管道符号（|）进行使用的，例如：{{ name | length }}，将返回name的长度。过滤器相当于是一个函数，把当前的变量传入到过滤器中，然后过滤器根据自己的功能，再返回相应的值，之后再将结果渲染到页面中。

2、默认过滤器

常见的过滤器如下所示：

abs(value)：返回一个数值的绝对值。例如：-1|abs。
default(value,default_value,boolean=false)：如果当前变量没有值，则会使用参数中的值来代替。name|default('张三')——如果name不存在，则会使用’张三‘来替代。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)：格式化字符串。{{ "%s"-"%s"|format('Hello?',"Foo!") }}输出 Hello?-Fool!
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)：计算一个长字符串中单词的个数。

小提示
jinja2模板默认全局开启了自动转义功能

safe 过滤器：可以关闭一个字符串的自动转义
escape 过滤器：对某一个字符串进行转义
autoescape 标签，可以对他包含的代码块关闭或开启自动转义
{% autoescape true/false %} 代码块 {% endautoescape %}

示例代码1：

main.py

from flask import Flask, render_template

app = Flask(__name__)


@app.route('/')
def index():
    content = {
        "names": {"name": 'dgw'},
        "age": 25,
        "sex": '男'
    }
    name_list = ['张三', '李四', '王五', '赵六', '孙七']
    num = -5
    data = {
        "content": content,
        "name_list": name_list,
        "num": num
    }
    return render_template('index.html', **data)


if __name__ == '__main__':
    app.run()

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
欢迎来到首页！
<div>
    names:{{ content.names.name }} <br>
    names:{{ content.names['name'] }} <br>
    sex:{{ content.sex }} <br>
    age:{{ content.age }} <br>

    {# personal info #}
</div>
<div>
    <ul>
        {% for name in content.name_list %}
            <li>{{ name }}</li>
        {% endfor %}
    </ul>
</div>
<div>
    abs(value)--->:{{ num | abs }} <br>
    default(value)-->:{{ nums | default('666') }} <br>
    name_list-->:{{ name_list }} <br>
    first(value)-->:{{ name_list | first }} <br>
    last(value)-->:{{ name_list | last }} <br>
    format(value,*args,**kwargs)-->{{ "%s - %s" | format(content.names.name, content.names.name) }} <br>
    length(vale)--->:{{ content.names.name | length }}
    float(value)-->:{{ num | float }}
</div>
</body>
</html>

运行结果：

3、default过滤器

<!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>default过滤器</title>
</head>
<body>
    <h1>default过滤器</h1>
    过滤前的昵称数据是：{{nick_name}}<br>
    过滤后的昵称数据是：{{nick_name | default('用户1',boolean=true)}}<br>
    过滤后的昵称数据是：{{nick_name or '用户2'}}<br>
</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>转义字符过滤器</title>
</head>
<body>
    <h1>转义字符过滤器</h1>
    <!-- 模板中默认 做了转义字符的效果 -->
    转义前的数据是：{{ info | safe }}  <!-- 不转义：不将特殊字符转换成 &lt;类似的数据 -->

    {% autoescape true %} <!-- false代表不再转义特殊字符 / true 转义特殊字符  &lt;-->
    {{info }}  <!-- 转义：将特殊字符转换成 &lt;类似的数据 -->
    {% endautoescape %}

</body>
</html>

5、自定义过滤器

只有当系统提供的过滤器不符合需求后，才须自定义过滤器。

过滤器本质上就是一个函数。

如果在模版中调用这个过滤器，那么就会将这个变量的值作为第一个参数传给过滤器这个函数，
然后函数的返回值会作为这个过滤器的返回值。

需要使用到一个装饰器： @app.template_filter('过滤器名称')

5.1 自定义数据替换转换器

示例代码：

main.py

from flask import Flask, render_template

app = Flask(__name__)


@app.template_filter('cut')
def cut(value):
    value = value.replace('dgw', 'Dgw')
    return value


@app.route('/')
def index():
    info = 'My name is dgw!'
    return render_template('index.html', info=info)


if __name__ == '__main__':
    app.run(debug=True)

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>自定义过滤器</title>
</head>
<body>
    <h1>自定义过滤器</h1>
    过滤前的数据是：{{info}}<br>
    过滤后的数据是：{{info|cut}}
</body>
</html>

运行结果：

5.2 自定义时间过滤器

示例代码：

main.py

from flask import Flask, render_template
from datetime import datetime

app = Flask(__name__)


# 年 月 日  时 分 秒
# 数据库中存放的数据是 2030/01/01 00:00:00
# 现在时间是          2030/01/01 01:30:00


@app.template_filter('handler_time')
def handler_time(time):
    '''
        time距离现在的时间间隔
       1. 如果时间间隔小于1分钟以内，那么就显示“刚刚”
       2. 如果是大于1分钟小于1小时，那么就显示“xx分钟前”
       3. 如果是大于1小时小于24小时，那么就显示“xx小时前”
       4. 如果是大于24小时小于30天以内，那么就显示“xx天前”
       5. 否则就是显示具体的时间 2030/10/20 16:15
    '''
    # 获取当前时间
    now = datetime.now()
    # 将相差的时间转为秒
    temp_stamp = (now - time).total_seconds()
    if temp_stamp < 60:
        return '1分钟之前'
    elif temp_stamp >= 60 and temp_stamp < 60 * 60:
        return '1小时之前'
    elif temp_stamp >= 60 * 60 and temp_stamp < 60 * 60 * 24:
        hours = int(temp_stamp / (60 * 60))
        return f'{hours}小时之前'
    elif temp_stamp >= 60 * 60 * 24 and temp_stamp < 60 * 60 * 24 * 30:
        day = int(temp_stamp / (60 * 60 * 24))
        return f'{day}天之前'
    else:
        return '很久以前'


@app.route('/')
def index():
    tmp_time = datetime(2023, 12, 9, 10, 10, 10)
    return render_template('index.html', tmp_time=tmp_time)


if __name__ == '__main__':
    app.run(debug=True)

index.html

<!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>自定义时间过滤器</title>
</head>
<body>
    <h1>自定义时间过滤器</h1>
    数据过滤后的：{{tmp_time|handler_time}}
</body>
</html>

运行结果：