Question

是否可以编写一个Jinja2扩展，在渲染时可以访问模板上下文？我想编写一个访问上下文变量的扩展，并根据该变量输出一些数据。我无法找到有关如何编写此类扩展程序的足够信息。

现在，我有这个：

class CsrfExtension(jinja2.ext.Extension):
    r""" Adds a {% csrf %} tag to Jinja. """

    tags = set(['csrf'])
    template = '<input type="hidden" name="csrfmiddlewaretoken" value="%s">'

    def parse(self, parser):
        token = next(parser.stream)
        lineno = token.lineno
        return self.call_method('_render_csrf', lineno=lineno)

    def _render_csrf(self, value, name, *args, **kwargs):
        csrf_token = somehow_get_variable('csrf_token')
        return jinja2.Markup(self.template % csrf_token)

但是，在foo.jinja

<!DOCTYPE html>
<html>
    <body>
        <h1>This is a Test</h1>
        {% csrf %}
    </body>
</html>

我得到了

SyntaxError at /
invalid syntax (foo.jinja, line 7)

我以为我得到了一个NameError，因为somehow_get_variable()没有定义。我需要知道a）如何从当前上下文中获取变量，以及b）如何正确编写扩展。

另外，为什么7号线呢？ {% csrf %}标记位于第5行。即使我将foo.jinja修剪为只有一行包含{% csrf %}标记，也会显示第7行。

Answer 1

找到它。看起来像Jinja从Jinja AST（？）生成Python代码并且转换失败，因此导致了SyntaxError。 jinja2.nodes.ContextReference()可用于获取渲染上下文。

class CsrfExtension(jinja2.ext.Extension):
    r""" Adds a {% csrf %} tag to Jinja. """

    tags = set(['csrf', 'csrf_token'])
    template = u'<input type="hidden" name="csrfmiddlewaretoken" value="%s">'

    def parse(self, parser):
        lineno = next(parser.stream).lineno
        ctx_ref = jinja2.nodes.ContextReference()
        node = self.call_method('_render_csrf', [ctx_ref], lineno=lineno)
        return jinja2.nodes.CallBlock(node, [], [], [], lineno=lineno)

    def _render_csrf(self, context, caller):
        csrf_token = context['csrf_token']
        return jinja2.Markup(self.template % unicode(csrf_token))

csrf = CsrfExtension

Answer 2

我刚遇到这个问题，我发现解决方案是使用@contextfunction装饰器装饰call方法。这告诉运行时将活动上下文作为第一个参数传递给call方法。

from jinja2 import nodes
from jinja2.ext import Extension
from jinja2.utils import contextfunction


class MyExtension(Extension):
    """See http://jinja.pocoo.org/docs/2.10/extensions/#module-jinja2.ext
    for more information on how to create custom Jinja extensions.
    """
    tags = set(['myext'])

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

    def parse(self, parser):
        lineno = next(parser.stream).lineno

        # Parse args if you need them ...
        # args = [parser.parse_expression()]

        node = nodes.CallBlock(self.call_method('_myext_method', args),
                               [], [], []).set_lineno(lineno)
        return parser.parse_import_context(node, True)

    @contextfunction
    def _myext_method(self, context, args, caller):
        # Return what you need
        return "Hello I am a custom extension, rendered with: %r" % context

可以访问Context的Jinja Extension

2 个答案: