jinja2.runtime.AsyncLoopContext

class documentation

class AsyncLoopContext(LoopContext):

Undocumented

Static Method	`_to_iterator`	Undocumented
Method	`__aiter__`	Undocumented
Async Method	`__anext__`	Undocumented
Async Method	`_peek_next`	No summary
Class Variable	`_iterator`	Undocumented
Instance Variable	`_after`	Undocumented
Instance Variable	`_before`	Undocumented
Instance Variable	`_current`	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.

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__`	No summary
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 `index0`.
Class Variable	`_length`	Undocumented
Class Variable	`index0`	Undocumented
Instance Variable	`_iterable`	Undocumented
Instance Variable	`_last_changed_value`	Undocumented
Instance Variable	`_recurse`	Undocumented
Instance Variable	`_undefined`	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.

@staticmethod
def _to_iterator(iterable):

overrides jinja2.runtime.LoopContext._to_iterator

Undocumented

Parameters
iterable:`t.Union[t.Iterable[V], t.AsyncIterable[V]]`	Undocumented
Returns
`t.AsyncIterator[V]`	Undocumented

def __aiter__(self):

Undocumented

Returns
`AsyncLoopContext`	Undocumented

async def __anext__(self):

Undocumented

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

async def _peek_next(self):

overrides jinja2.runtime.LoopContext._peek_next

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

Returns
`t.Any`	Undocumented

_iterator: t.AsyncIterator[t.Any] =

overrides jinja2.runtime.LoopContext._iterator

Undocumented

_after =

overrides jinja2.runtime.LoopContext._after

Undocumented

_before =

overrides jinja2.runtime.LoopContext._before

Undocumented

_current =

overrides jinja2.runtime.LoopContext._current

Undocumented

@property
last: bool =

overrides jinja2.runtime.LoopContext.last

Whether this is the last iteration of the loop.

Causes the iterable to advance early. See itertools.groupby for issues this can cause. The groupby filter avoids that issue.

@property
length: int =

overrides jinja2.runtime.LoopContext.length

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.

@property
nextitem: t.Union[t.Any, Undefined] =

overrides jinja2.runtime.LoopContext.nextitem

The item in the next iteration. Undefined during the last iteration.

Causes the iterable to advance early. See itertools.groupby for issues this can cause. The jinja-filters.groupby filter avoids that issue.

@property
revindex: int =

overrides jinja2.runtime.LoopContext.revindex

Number of iterations from the end of the loop, ending at 1.

Requires calculating length.

@property
revindex0: int =

overrides jinja2.runtime.LoopContext.revindex0

Number of iterations from the end of the loop, ending at 0.

Requires calculating length.