你如何在 Jinja 扩展中解析和注入额外的节点？答案

【问题标题】：How do you parse and inject additional nodes in a Jinja extension?你如何在 Jinja 扩展中解析和注入额外的节点？
【发布时间】：2016-03-05 10:28:57
【问题描述】：

我正在尝试调整 Jinja2 WithExtension 以生成用于包装块的通用扩展（随后是一些更复杂的扩展）。

我的目标是在模板中支持以下内容：

{% wrap template='wrapper.html.j2' ... %}
    <img src="{{ url('image:thumbnail' ... }}">
{% endwrap %}

而 wrapper.html.j2 看起来像这样：

<div>
    some ifs and stuff
    {{ content }}
    more ifs and stuff
</div>

我相信我的示例大部分都在那里，WithExtension 似乎解析了块，然后将一些 {% assign .. %} 节点的 AST 表示附加到它正在解析的节点的上下文中。

所以我想我想要同样的东西，那些赋值，然后是一个包含块，我希望能够在解析 AST 时访问这些变量，并通过包装为变量content。

到目前为止，我有以下几点：

class WrapExtension(Extension):
    tags = set(['wrap'])

    def parse(self, parser):
        node = nodes.Scope(lineno=next(parser.stream).lineno)
        assignments = []
        while parser.stream.current.type != 'block_end':
            lineno = parser.stream.current.lineno
            if assignments:
                parser.stream.expect('comma')
            target = parser.parse_assign_target()
            parser.stream.expect('assign')
            expr = parser.parse_expression()
            assignments.append(nodes.Assign(target, expr, lineno=lineno))
        content = parser.parse_statements(('name:endwrap',), drop_needle=True)
        assignments.append(nodes.Name('content', content))
        assignments.append(nodes.Include(nodes.Template('wrapper.html.j2'), True, False))
        node.body = assignments
        return node

但是，它在我的nodes.Include 行中失败了，我只是得到assert frame is None, 'no root frame allowed'。我相信我需要将 AST 传递给 nodes.Template 而不是模板名称，但我真的不知道如何解析其他节点以获得 AST 而不是字符串输出（即渲染）——也不知道这是否是正确的做法。我是否在正确的路线上，关于我应该如何去做的任何想法？

【问题讨论】：

您能否添加更多关于您所需结果的详细信息？您的意思是以 wrapper.html.j2 的内容包含的标记结束吗？你能举一个wrapper.html.j2的内容示例吗？
哦，哎呀，为了简化我的例子，我把它弄得毫无意义，我会更新例子

标签： python django python-2.7 jinja2 django-1.6

【解决方案1】：

templatetags/wrap.py

class WrapExtension(jinja2.ext.Extension):
    tags = set(['wrap'])
    template = None

    def parse(self, parser):
        tag = parser.stream.current.value
        lineno = parser.stream.next().lineno
        args, kwargs = self.parse_args(parser)
        body = parser.parse_statements(['name:end{}'.format(tag)], drop_needle=True)

        return nodes.CallBlock(self.call_method('wrap', args, kwargs), [], [], body).set_lineno(lineno)

    def parse_args(self, parser):
        args = []
        kwargs = []
        require_comma = False

        while parser.stream.current.type != 'block_end':
            if require_comma:
                parser.stream.expect('comma')

            if parser.stream.current.type == 'name' and parser.stream.look().type == 'assign':
                key = parser.stream.current.value
                parser.stream.skip(2)
                value = parser.parse_expression()
                kwargs.append(nodes.Keyword(key, value, lineno=value.lineno))
            else:
                if kwargs:
                    parser.fail('Invalid argument syntax for WrapExtension tag',
                                parser.stream.current.lineno)
                args.append(parser.parse_expression())

            require_comma = True

        return args, kwargs

    @jinja2.contextfunction
    def wrap(self, context, caller, template=None, *args, **kwargs):
        return self.environment.get_template(template or self.template).render(dict(context, content=caller(), **kwargs))

base.html.j2

<h1>dsd</h1>
{% wrap template='wrapper.html.j2' %}
    {% for i in range(3) %}
        im wrapped content {{ i }}<br>
    {% endfor %}
{% endwrap %}

wrapper.html.j2

Hello im wrapper
<br>
<hr>
{{ content|safe }}
<hr>

args/kwargs 解析从这里获取https://github.com/Suor/django-cacheops/blob/master/cacheops/jinja2.py

此外，可以扩展上述内容以支持带有指定为包装器的默认模板的附加标签：

templatetags/example.py

class ExampleExtension(WrapExtension):
    tags = set(['example'])
    template = 'example.html.j2'

base.html.j2

{% example otherstuff=True, somethingelse=False %}
    {% for i in range(3) %}
        im wrapped content {{ i }}<br>
    {% endfor %}
{% endexample %}

【讨论】：

我稍微简化了我的例子，除了 template 传递给 hello_wrapper.js 之外，我确实需要任何 kwargs - 否则这看起来不错：D
我不确定我是否遵循，args 和 kwargs 如何在 parse 中传递到 CallBlock？我假设他们最终需要被传递给render_wrap 中的调用？
内部调用渲染。 Parse 将文本编译成节点。解析后，渲染器调用节点（可以看到CallBlock继承了Node类）。因此，您需要准备 CallBlack ：设置方法、args 和 kwargs 将它们转换为 Literal 类型。
我已经更新了您提供的示例，包括传递 args 和 kwargs，以及将它们合并到上下文中，以便我可以继续在包装模板中使用请求和上下文处理器生成的变量。此外，我还举了一个例子，说明我如何在其他具有预定义模板的自定义标签中使用它。谢谢！
很抱歉在 3 年后询问后续行动……但在 Jinja2 2.10 中，这是给 TypeError: object of type 'ExtensionRegistry' has no len()

【解决方案2】：

处理此问题的更好方法是使用宏。定义它：

{% macro wrapper() -%}
<div>
    some ifs and stuff
    {{ caller() }}
    more ifs and stuff
</div>
{%- endmacro %}

稍后使用call标签：

{% call wrapper() %}
    <img src="{{ url('image:thumbnail' ... }}">
{% endcall %}

宏可以有类似python函数的参数并且可以被导入：

{% from macros import wrapper %}

有关更多详细信息，请参阅 macro、call 和 import 标签的文档。

【讨论】：