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

Question

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

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

{% 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 而不是字符串输出（即渲染）的 objective – 也不知道这是否是正确的方法。我在正确的路线上吗，关于我应该如何处理这个问题有什么想法吗？

Answer 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 %}

Answer 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 标签的文档。

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

How do you parse and inject additional nodes in a Jinja extension?

python

django

python-2.7

jinja2

django-1.6