jinja2.utils.Cycler

class documentation

class Cycler: (source)

View In Hierarchy

Cycle through values by yield them one at a time, then restarting once the end is reached. Available as ``cycler`` in templates. Similar to ``loop.cycle``, but can be used outside loops or across multiple loops. For example, render a list of folders and files in a list, alternating giving them "odd" and "even" classes. .. code-block:: html+jinja {% set row_class = cycler("odd", "even") %} <ul class="browser"> {% for folder in folders %} <li class="folder {{ row_class.next() }}">{{ folder }} {% endfor %} {% for file in files %} <li class="file {{ row_class.next() }}">{{ file }} {% endfor %} </ul> :param items: Each positional argument will be yielded in the order given for each cycle. .. versionadded:: 2.1

Method __init__ Undocumented
Method next Return the current item, then advance :attr:`current` to the next item.
Method reset Resets the current item to the first item.
Instance Variable items Undocumented
Instance Variable pos Undocumented
Property current Return the current item. Equivalent to the item that will be returned next time :meth:`next` is called.
def __init__(self, *items): (source)

Undocumented

Parameters
*items:t.AnyUndocumented
def next(self): (source)

Return the current item, then advance :attr:`current` to the next item.

Returns
t.AnyUndocumented
def reset(self): (source)

Resets the current item to the first item.

items = (source)

Undocumented

pos = (source)

Undocumented

@property
current: t.Any = (source)

Return the current item. Equivalent to the item that will be returned next time :meth:`next` is called.