如何使用 Jinja2 模板制作一个简单的计数器？

Question

我有两个 for 循环，两者在尊严上都是相似的。我希望在每次内部迭代期间增加一个计数器。

例如，考虑这个模板：

from jinja2 import Template

print Template("""
{% set count = 0 -%}
{% for i in 'a', 'b', 'c' -%}
  {% for j in 'x', 'y', 'z' -%}
    i={{i}}, j={{j}}, count={{count}}
    {% set count = count + 1 -%}
  {% endfor -%}
{% endfor -%}
""").render()

这不应该打印 count=0 到 count=8 吗？ 不，没有。

i=a, j=x, count=0
i=a, j=y, count=1
i=a, j=z, count=2
i=b, j=x, count=0
i=b, j=y, count=1
i=b, j=z, count=2
i=c, j=x, count=0
i=c, j=y, count=1
i=c, j=z, count=2

有什么作用？

注意：我不能简单地保存外部循环变量来计算计数器，因为在我的软件中，内部迭代的次数是可变的。

Answer 1

对于可变的内部组大小，这将起作用：

from jinja2 import Template

items = [
    ['foo', 'bar'],
    ['bax', 'quux', 'ketchup', 'mustard'],
    ['bacon', 'eggs'],
    ]

print Template("""
{% set counter = 0 -%}
{% for group in items -%}
  {% for item in group -%}
    item={{ item }}, count={{ counter + loop.index0 }}
  {% endfor -%}
  {% set counter = counter + group|length %}
{% endfor -%}
""").render(items=items)

...打印：

item=foo, count=0
  item=bar, count=1

item=bax, count=2
  item=quux, count=3
  item=ketchup, count=4
  item=mustard, count=5

item=bacon, count=6
  item=eggs, count=7

我猜在超过一级范围之外声明的变量不能分配给或其他东西。

Answer 2

它看起来确实像一个错误，但是将一些计算移到模板之外怎么样？

from jinja2 import Template

outer_items = list(enumerate("a b c".split()))
inner_items = list(enumerate("x y z".split()))

print Template("""
{% for outer, i in outer_items -%}
  {% for inner, j in inner_items -%}
  {% set count = outer * num_outer + inner -%}
    i={{i}}, j={{j}}, count={{count}}
  {% endfor -%}
{% endfor -%}
""").render(outer_items=outer_items,
            inner_items=inner_items,
            num_outer=len(outer_items))

输出：

i=a, j=x, count=0
  i=a, j=y, count=1
  i=a, j=z, count=2
  i=b, j=x, count=3
  i=b, j=y, count=4
  i=b, j=z, count=5
  i=c, j=x, count=6
  i=c, j=y, count=7
  i=c, j=z, count=8

Answer 3

为了解决这样的用例，我编写了一个小型环境过滤器来计算某个键的出现次数。

这是 myfilters.py 的代码（带有文档测试）：

#coding: utf-8
from collections import defaultdict

from jinja2 import environmentfilter
from jinja2.utils import soft_unicode

@environmentfilter
def inc_filter(env, key, value=1, result='value', reset=False):
    """
    Count ocurrences of key.
    Stores the counter on Jinja's environment.
        >>> class Env: pass
        >>> env = Env()
        >>> inc_filter(env, 'x')
        1
        >>> inc_filter(env, 'x')
        2
        >>> inc_filter(env, 'y')
        1
        >>> inc_filter(env, 'x')
        3
        >>> inc_filter(env, 'x', reset=True)
        1
        >>> inc_filter(env, 'x')
        2
        >>> inc_filter(env, 'x', value=0, reset=True)
        0
        >>> inc_filter(env, 'x', result=None)
        >>> inc_filter(env, 'x', result=False)
        u''
        >>> inc_filter(env, 'x', result='key')
        'x'
        >>> inc_filter(env, 'x')
        4
    """
    if not hasattr(env, 'counters'):
        env.counters = defaultdict(int)

    if reset:
        env.counters[key] = 0

    env.counters[key] += value

    if result == 'key':
        return key
    elif result == 'value':
        return env.counters[key]
    elif result == None:
        return None
    else:
        return soft_unicode('')


## Module doctest
if __name__ == '__main__':
    import doctest
    doctest.testmod()    

设置您的环境注册我们的自定义过滤器：

#coding: utf-8
from jinja2 import Environment, FileSystemLoader
from myfilters import inc_filter

env = Environment(loader=loader=FileSystemLoader('path'))
env.filters['inc'] = inc_filter

t = env.get_template('yourtemplate.txt')

items = [
    ['foo', 'bar'],
    ['bax', 'quux', 'ketchup', 'mustard'],
    ['bacon', 'eggs'],
    ]

res = t.render(items=items)

在您的模板上，像这样使用它：

{% for group in items -%}
  {% for item in group -%}
    item={{ item }}, count={{ 'an_identifier'|inc }}
  {% endfor -%}
{% endfor -%}

...打印：

item=foo, count=0
  item=bar, count=1

item=bax, count=2
  item=quux, count=3
  item=ketchup, count=4
  item=mustard, count=5

item=bacon, count=6
  item=eggs, count=7

Answer 4

有内置的全局函数 cycler() 提供与循环无关的值循环。使用相同的想法，您可以定义自己的 counter() 函数，如下所示：

env=Environment(...) # create environment
env.globals['counter']=_Counter # define global function
env.get_template(...).render(...) # render template

这是实现该函数的类：

class _Counter(object):
  def __init__(self, start_value=1):
    self.value=start_value

  def current(self):
    return self.value

  def next(self):
    v=self.value
    self.value+=1
    return v

下面是如何使用它：

{% set cnt=counter(5) %}
item #{{ cnt.next() }}
item #{{ cnt.next() }}
item #{{ cnt.next() }}
item #{{ cnt.next() }}

它将呈现：

item #5
item #6
item #7
item #8

Answer 5

从 Jinja 版本 2.10 开始，现在有一个使用命名空间的更简单的解决方案：

from jinja2 import Template

print(Template("""
{% set ns = namespace(count = 0) -%}
{% for i in 'a', 'b', 'c' -%}
  {% for j in 'x', 'y', 'z' -%}
    i={{i}}, j={{j}}, count={{ns.count}}
    {% set ns.count = ns.count + 1 -%}
  {% endfor -%}
{% endfor -%}
""").render())

结果：

i=a, j=x, count=0
i=a, j=y, count=1
i=a, j=z, count=2
i=b, j=x, count=3
i=b, j=y, count=4
i=b, j=z, count=5
i=c, j=x, count=6
i=c, j=y, count=7
i=c, j=z, count=8

参见 模板设计器文档 ->|类 jinja-globals.namespace(...)

Answer 6

无需添加计数器。您可以像这样访问外循环的索引：

{% for i in 'a', 'b', 'c' -%}
  {% set outerloop = loop %}
  {% for j in 'x', 'y', 'z' -%}
    i={{i}}, j={{j}}, count={{outerloop.index0 * loop|length + loop.index0}}
  {% endfor -%}
{% endfor -%}