用 Flask 来写个轻博客 (9) — M(V)C_Jinja 语法基础快速概览

2022-06-10 01:58:27

#目录

前文列表
扩展阅读
Jinja
变量名
注释
控制语句
- if 语句
- 循环
过滤器
- 无参数调用
- 带参数调用
宏
兼容 JavaScript

前文列表

扩展阅读

Welcome | Jinja2 (The Python Template Engine)
欢迎来到 Jinja2 — Jinja2 2.7 documentation

Jinja

Jinja：是 Python 实现的模板语言。
模板语言：是一种被设计出来自动生成文档的简单文本格式。在模板语言中，一般都会把一些变量传给模板，来替换模板中特定位置上的预先自定义好的占位变量名。向相同的模板文件(HTML+Python)传入不同的变量，达到生成格式相同但内容不同的网页文件，这个生成的过程被称之为渲染。

变量名

Jinja 中的变量名都会定义在 {{ variables }} 中，{{}} 被称之为变量代码块。

<h1>{{ user.username }}</h1>

变量代码块中可以是任意的 Python 对象或类型，唯一的条件就是 {{}} 中的变量必须能够被 Python 的 str() 内置方法转换成一个 String 类型对象。

注释

注释代码块使用 {# Documents #} 来表示。

控制语句

使用 {% controller_flow %} 来定义控制语句，{%%} 被称之为控制代码块，可以实现一些语言层次的功能。

if 语句

{% if user.is_logged_in() %}
    <a href='/logout'>Logout</a>
{% else %}
    <a href='/login'>Login</a>
{% endif %}

循环

我们可以正常的循环迭代器或生成器函数。

NOTE 1：在 Jinja 中需要同时使用循环语句和 if 语句来模拟 continue 语句的功能。

{% for post in posts if post.text %}
    <div>
        <h1>{{ post.title }}</h1>
        <p>{{ post.text | safe }}</p>
    </div>
{% endfor %}

NOTE 2：可以使用 Jinja 提供的 loop 变量来模型 Python 中的 enumerate() 内置函数的功能。 loop 变量可以返回一些关于 for 循环的信息，EG. 索引号。

{% for post in posts %}
    {{ loop.index }}-{{ post.title }}
{% endfor %}

过滤器

Jinja 过滤器实质上是 Jinja 提供的内置函数或自定义函数，这些内置函数与 Python 函数的类型，可以接收参数并返回结果。常用于处理变量代码块中的变量。在变量代码块中使用管道符 | 来调用。

无参数调用

{{ variable | filter_name }}

带参数调用

{{ variables | filter_name(*args) }}

NOTE 1：过滤器也可以在控制代码块 {%%} 中使用。

{% filter filter_name %}
    codes
{% endfilter %}

这样的话就可以对控制代码块中的代码进行处理。

宏

宏：会返回一个 Jinja 模板或 HTML 字符串。其最主要的功能就是提高代码的重用性，我们可以将一个会被反复使用到的模板或 HTML 文件写成一个宏，然后就像调用函数一般，不断的被重用。

定义宏

{% macro input(name, label, value='', type='text')%}
    <div class="form-group">
        <label for"{{ name }}">{{ label }}</div>
        <input type="{{ type }}" name="{{ name }}"
            value="{{ value | escape }}" class="form-control">
    </div>
{% endmacro %}

这是一个带有 label 标签变量的 Bootstrao VSS 输入框。

input()：是宏的名字，类似于函数名
(name, label, value='', type='text')：是宏的参数，类似于函数的必备参数和缺省参数

调用宏

{{ input('name', 'Name') }}

结果

    <div class="form-group">
        <label for"name">Name</div>
        <input type="text" name="name"
            value="" class="form-control">
    </div>

实际上是想宏定义中的形参 name/label/value/type 传入实参 ‘name’/’Name’，其余的使用了缺省参数，而这些被传入的参数会替换 HTML 中的变量代码块。

兼容 JavaScript

如果希望将 JavaScript 代码和 Jinja 代码写在同一个模板文件中而不引起混淆(JavaScript 也含有 {{}} 语法)，需要使用 raw 代码块来进行区分。

{% raw %}
JavaScript statements
{% endraw %}

码农公寓