class documentation

class AsyncLoopContext(LoopContext): (source)

View In Hierarchy

Undocumented

Method __aiter__ Undocumented
Async Method __anext__ Undocumented
Property last Whether this is the last iteration of the loop.
Property length Length of the iterable.
Property nextitem The item in the next iteration. Undefined during the last iteration.
Property revindex Number of iterations from the end of the loop, ending at 1.
Property revindex0 Number of iterations from the end of the loop, ending at 0.
Static Method _to_iterator Undocumented
Async Method _peek_next Return the next element in the iterable, or :data:`missing` if the iterable is exhausted. Only peeks one item ahead, caching the result in :attr:`_last` for use in subsequent checks. The cache is reset when :meth:`__next__` is called.
Class Variable _iterator Undocumented
Instance Variable _after Undocumented
Instance Variable _before Undocumented
Instance Variable _current Undocumented

Inherited from LoopContext:

Method __call__ When iterating over nested data, render the body of the loop recursively with the given inner iterable data.
Method __init__ :param iterable: Iterable to wrap. :param undefined: :class:`Undefined` class to use for next and previous items. :param recurse: The function to render the loop body when the loop is marked recursive...
Method __iter__ Undocumented
Method __len__ Undocumented
Method __next__ Undocumented
Method __repr__ Undocumented
Method changed Return ``True`` if previously called with a different value (including when called for the first time).
Method cycle Return a value from the given args, cycling through based on the current :attr:`index0`.
Class Variable index0 Undocumented
Instance Variable depth0 Undocumented
Property depth How many levels deep a recursive loop currently is, starting at 1.
Property first Whether this is the first iteration of the loop.
Property index Current iteration of the loop, starting at 1.
Property previtem The item in the previous iteration. Undefined during the first iteration.
Class Variable _length Undocumented
Instance Variable _iterable Undocumented
Instance Variable _last_changed_value Undocumented
Instance Variable _recurse Undocumented
Instance Variable _undefined Undocumented
def __aiter__(self): (source)

Undocumented

Returns
AsyncLoopContextUndocumented
async def __anext__(self): (source)

Undocumented

Returns
t.Tuple[t.Any, AsyncLoopContext]Undocumented

Whether this is the last iteration of the loop. Causes the iterable to advance early. See :func:`itertools.groupby` for issues this can cause. The :func:`groupby` filter avoids that issue.

Length of the iterable. If the iterable is a generator or otherwise does not have a size, it is eagerly evaluated to get a size.

The item in the next iteration. Undefined during the last iteration. Causes the iterable to advance early. See :func:`itertools.groupby` for issues this can cause. The :func:`jinja-filters.groupby` filter avoids that issue.

@property
revindex: int = (source)

Number of iterations from the end of the loop, ending at 1. Requires calculating :attr:`length`.

@property
revindex0: int = (source)

Number of iterations from the end of the loop, ending at 0. Requires calculating :attr:`length`.

@staticmethod
def _to_iterator(iterable): (source)

Undocumented

Parameters
iterable:t.Union[t.Iterable[V], t.AsyncIterable[V]]Undocumented
Returns
t.AsyncIterator[V]Undocumented
async def _peek_next(self): (source)

Return the next element in the iterable, or :data:`missing` if the iterable is exhausted. Only peeks one item ahead, caching the result in :attr:`_last` for use in subsequent checks. The cache is reset when :meth:`__next__` is called.

Returns
t.AnyUndocumented
_after = (source)

Undocumented

_before = (source)

Undocumented

_current = (source)

Undocumented