【Flask学习笔记】Jinja2的宏功能（三）

最新推荐文章于 2024-04-23 23:20:23 发布

TroKey

最新推荐文章于 2024-04-23 23:20:23 发布

阅读量209

点赞数

分类专栏： Flask 文章标签： Flask 宏 macro

Flask 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

Jinja2的宏功能有些类似于传统程序语言中的函数，既然是函数就有其声明和调用两个部分。

先声明一个宏：

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
{% macro input(name,type='text',value='') %}
    <input type="{{ type }}" name="{{ name }}" value="{{ value }}">
{% endmacro %}
{#代码中，宏的名称就是”input”，它有三个参数分别是”name”, “type”和”value”，后两个参数有默认值。#}
</body>
</html>

代码中，宏的名称就是”input”，它有三个参数分别是”name”, “type”和”value”，后两个参数有默认值。现在，让我们使用表达式来调用这个宏：

在上面代码中加入如下代码：

<p>{{ input('username',value='user') }}</p>
<p>{{ input('password','password') }}</p>
<p>{{ input('submit','submit','submit') }}</p>

定义路由，把页面配置进入路由后，访问在页面上看到一个文本输入框，一个密码输入框及一个提交按钮。

宏的复用

{% from "macro.html" import input %}

引用需要复用的宏文件macro.html，然后调用宏内容，代码如下：

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
{% from "macro.html" import input %}
<p>{{ input('username',value='user') }}</p>
<p>{{ input('password','password') }}</p>
<p>{{ input('submit','submit','submit') }}</p>
</body>
</html>

访问调用者内容

我们先创建一个macrouser_list.html文件，代码如下：

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
{% macro user_list(users) %}
    <table>
    <tr><th>Name</th><th>Sex</th><th>Age</th><th>Action</th></tr>
    {% for user in users %}
        <tr><td>{{ user.name  }}</td><td>{{ user.gender }}</td><td>{{ user.age }}</td><td>{{ caller() }}</td></tr>
    {% endfor %}
    </table>
{% endmacro %}
</body>
</html>

我们还是在usemacro.html文件中设置调用者内容，代码如下：

{% from "macrouser_list.html" import user_list %}

{% set users=[{'name':'Tom','gender':'Boy','age':'26'},
{'name':'Jim','gender':'Boy','age':'25'},
{'name':'Lucy','gender':'Girl','age':'23'},
{'name':'Lida','gender':'Girl','age':'22'}]
        %}
_______________________________________________________________
{% call user_list(users) %}
{% endcall %}
________________________________________________________________
{% call user_list(users) %}
 <input name="delete" type="delete" value="delete">
{% endcall %}


____________________________________________________________
{% for user in users %}
        <tr><td>{{ user.name }}</td><td>{{ user.gender }}</td><td>{{ user.age }}</td><td><input name="delete" type="delete" value="delete"></td></tr>
    {% endfor %}

访问：http://127.0.0.1:5000/usemacro，可以看到结果。

与上例不同，这里我们使用了”{% call %}”语句块来调用宏，语句块中包括了一段生成”Delete”按钮的代码。运行下试试，你会发现每个用户名后面都出现了”Delete”按钮，也就是”{{ caller( ) }}”部分被调用者”{% call %}”语句块内部的内容替代了。不明觉厉吧！其实吧，这个跟函数传个参数进去没啥大区别，个人觉得，主要是有些时候HTML语句太复杂（如上例），不方便写在调用参数上，所以就写在”{% call %}”语句块里了。

Jinja2的宏不但能访问调用者语句块的内容，还能给调用者传递参数。们来扩展下上面的例子。首先，我们将表格增加一列性别，并在宏里调用”caller()”方法时，传入一个变量”user.gender”：

{% macro list_users(users) -%}
  <table>
    <tr><th>Name</th><th>Gender</th><th>Action</th></tr>
    {%- for user in users %}
      <tr><td>{{ user.name |e }}</td>{{ caller(user.gender) }}</tr>
    {%- endfor %}
  </table>
{%- endmacro %}

然后，我们修改下调用者语句块：

{% call(gender) list_users(users) %}
    <td>
    {% if gender == 'M' %}
    <img src="{{ url_for('static', filename='img/male.png') }}" width="20px">
    {% else %}
    <img src="{{ url_for('static', filename='img/female.png') }}" width="20px">
    {% endif %}
    </td>
    <td><input name="delete" type="button" value="Delete"></td>
{% endcall %}

大家注意到，我们在使用”{% call %}”语句时，将其改为了”{% call(gender) … %}”，这个括号中的”gender”就是用来接受宏里传来的”user.gender”变量。因此我们就可以在”{% call %}”语句中使用这个”gender”变量来判断用户性别。这样宏就成功地向调用者传递了参数。

宏的内部变量

上例中，我们看到宏的内部可以使用”caller( )”方法获取调用者的内容。此外宏还提供了两个内部变量：

- varargs

这是一个列表。如果调用宏时传入的参数多于宏声明时的参数，多出来的没指定参数名的参数就会保存在这个列表中。

- kwargs

这是一个字典。如果调用宏时传入的参数多于宏声明时的参数，多出来的指定了参数名的参数就会保存在这个字典中。

让我们回到第一个例子input宏，在调用时增加其传入的参数，并在宏内将上述两个变量打印出来：

{% macro input(name, type='text', value='') -%}
    <input type="{{ type }}" name="{{ name }}" value="{{ value|e }}">
    <br /> {{ varargs }}
    <br /> {{ kwargs }}
{%- endmacro %}
<p>{{ input('submit', 'submit', 'Submit', 'more arg1', 'more arg2', ext='more arg3') }}</p>

可以看到，varargs变量存了参数列表”[‘more arg1’, ‘more arg2’]”，而kwargs字典存了参数”{‘ext’:’more arg3′}”。

宏的导入

一个宏可以被不同的模板使用，所以我们建议将其声明在一个单独的模板文件中。需要使用时导入进来即可，而导入的方法也非常类似于Python中的”import”。让我们将第一个例子中”input”宏的声明放到一个”form.html”模板文件中，然后将调用的代码改为：

{% import 'form.html' as form %}
<p>{{ form.input('username', value='user') }}</p>
<p>{{ form.input('password', 'password') }}</p>
<p>{{ form.input('submit', 'submit', 'Submit') }}</p>

包含 (Include)

这里我们再介绍一个Jinja2模板中代码重用的功能，就是包含 (Include)，使用的方法就是”{% include %}”语句。其功能就是将另一个模板加载到当前模板中，并直接渲染在当前位置上。它同导入”import”不一样，”import”之后你还需要调用宏来渲染你的内容，”include”是直接将目标模板渲染出来。它同block块继承也不一样，它一次渲染整个模板文件内容，不分块。

我们可以创建一个”footer.html”模板，并在”layout.html”中包含这个模板：

<body>
    ...
    {% include 'footer.html' %}
</body>

当”include”的模板文件不存在时，程序会抛出异常。你可以加上”ignore missing”关键字，这样如果模板不存在，就会忽略这段”{% include %}”语句。

{% include 'footer.html' ignore missing %}

“{% include %}”语句还可以跟一个模板列表：

{% include ['footer.html','bottom.html','end.html'] ignore missing %}

上例中，程序会按顺序寻找模板文件，第一个被找到的模板即被加载，而其后的模板都会被忽略。如果都没找到，那整个语句都会被忽略。

TroKey

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录