Jinja 模板中是否允许内联代码？

Question

我在我的网站上使用 Jinja，我喜欢它。

我遇到了一个简单的需求。如何显示今天的日期？ 有没有办法在 Jinja 模板中内联一些 Python 代码？

import datetime
now = datetime.datetime.utcnow()
print now.strftime("%Y-%m-%d %H:%M")

本文说不，但建议使用宏或过滤器？

真的吗？我们必须诉诸所有这些吗？好的，在这种情况下会是什么样子？

Answer 1

不，没有办法将 Python 内联到 Jinja 中。但是，您可以通过扩展模板的环境来添加 Jinja 知道的构造引擎或适用于所有模板的全局命名空间。或者，您可以添加一个过滤器来设置日期时间对象的格式。

Flask 将 Jinja2 环境存储在 app.jinja_env。您可以通过直接添加到此字典或使用 @ 来将新上下文注入到环境中app.context_processor 装饰器。

无论您选择什么路径，都应该在设置应用程序时、在处理任何请求之前完成。 （请参阅网站的片段部分，了解一些好的如何设置过滤器的示例 - 文档包含添加到全局变量的一个很好的示例）。

Answer 2

目前的答案几乎适用于所有情况。然而，在极少数情况下，您可能希望在模板中包含 Python 代码。就我而言，我想用它来预处理一些乳胶文件，并且我更愿意将生成表值、绘图等的 python 代码保留在乳胶文件中。

所以我做了一个 Jinja2 扩展，添加了一个新的“py”块，允许在模板内编写 python 代码。请记住，我必须采取一些有问题的解决方法才能使其正常工作，因此我不能 100% 确定它在哪些情况下会失败或表现异常。

这是一个示例模板。

Foo was given to the template
foo: {{ foo }}

Bar was not, so it is missing
bar is missing: {{ bar == missing }}

{% py %}
    # Normal python code in here
    # Excess indentation will be removed.
    # All template variables are accessible and can be modified.
    import numpy as np
    a = np.array([1, 2])
    m = np.array([[3, 4], [5, 6]])
    bar = m @ a * foo

    # It's also possible to template the python code.
    {% if change_foo %}
    foo = 'new foo value'
    {% endif %}

    print("Stdio is redirected to the output.")
{% endpy %}

Foo will have the new value if you set change_foo to True
foo: {{ foo }}

Bar will now have a value.
bar: {{ bar }}

{% py %}
    # The locals from previous blocks are accessible.
    m = m**2
{% endpy %}
m:
{{ m }}

如果我们将模板参数设置为 foo=10,change_foo=True ，则输出为：

Foo was given to the template
foo: 10

Bar was not, so it is missing
bar is missing: True

Stdio is redirected to the output.


Foo will have the new value if you set change_foo to True
foo: new foo value

Bar will now have a value.
bar: [110 170]


m:
[[ 9 16]
 [25 36]]

带有用于运行示例的 main 函数的扩展。

from jinja2 import Environment, PackageLoader, nodes
from jinja2.ext import Extension
from textwrap import dedent
from io import StringIO
import sys
import re
import ctypes


def main():
    env = Environment(
        loader=PackageLoader('python_spike', 'templates'),
        extensions=[PythonExtension]
    )

    template = env.get_template('emb_py2.txt')
    print(template.render(foo=10, change_foo=True))


var_name_regex = re.compile(r"l_(\d+)_(.+)")


class PythonExtension(Extension):
    # a set of names that trigger the extension.
    tags = {'py'}

    def __init__(self, environment: Environment):
        super().__init__(environment)

    def parse(self, parser):
        lineno = next(parser.stream).lineno
        body = parser.parse_statements(['name:endpy'], drop_needle=True)
        return nodes.CallBlock(self.call_method('_exec_python',
                                                [nodes.ContextReference(), nodes.Const(lineno), nodes.Const(parser.filename)]),
                               [], [], body).set_lineno(lineno)

    def _exec_python(self, ctx, lineno, filename, caller):
        # Remove access indentation
        code = dedent(caller())

        # Compile the code.
        compiled_code = compile("\n"*(lineno-1) + code, filename, "exec")

        # Create string io to capture stdio and replace it.
        sout = StringIO()
        stdout = sys.stdout
        sys.stdout = sout

        try:
            # Execute the code with the context parents as global and context vars and locals.
            exec(compiled_code, ctx.parent, ctx.vars)
        except Exception:
            raise
        finally:
            # Restore stdout whether the code crashed or not.
            sys.stdout = stdout

        # Get a set of all names in the code.
        code_names = set(compiled_code.co_names)

        # The the frame in the jinja generated python code.
        caller_frame = sys._getframe(2)

        # Loop through all the locals.
        for local_var_name in caller_frame.f_locals:
            # Look for variables matching the template variable regex.
            match = re.match(var_name_regex, local_var_name)
            if match:
                # Get the variable name.
                var_name = match.group(2)

                # If the variable's name appears in the code and is in the locals.
                if (var_name in code_names) and (var_name in ctx.vars):
                    # Copy the value to the frame's locals.
                    caller_frame.f_locals[local_var_name] = ctx.vars[var_name]
                    # Do some ctypes vodo to make sure the frame locals are actually updated.
                    ctx.exported_vars.add(var_name)
                    ctypes.pythonapi.PyFrame_LocalsToFast(
                        ctypes.py_object(caller_frame),
                        ctypes.c_int(1))

        # Return the captured text.
        return sout.getvalue()

if __name__ == "__main__":
    main()

Answer 3

您可以添加全局变量，这些变量可以从 Jinja 模板访问。您可以将自己的函数定义放在那里，它可以执行您需要的任何操作。