jinja2.runtime.AsyncLoopContext Class Reference

Inheritance diagram for jinja2.runtime.AsyncLoopContext:

Collaboration diagram for jinja2.runtime.AsyncLoopContext:

Public Member Functions
int	length (self)
int	revindex0 (self)
int	revindex (self)
bool	last (self)
t.Union[t.Any, "Undefined"]	nextitem (self)
"AsyncLoopContext"	__aiter__ (self)
t.Tuple[t.Any, "AsyncLoopContext"]	__anext__ (self)
Public Member Functions inherited from jinja2.runtime.LoopContext
None	__init__ (self, t.Iterable[V] iterable, t.Type["Undefined"] undefined, t.Optional["LoopRenderFunc"] recurse=None, int depth0=0)
int	__len__ (self)
int	depth (self)
int	index (self)
bool	first (self)
t.Union[t.Any, "Undefined"]	previtem (self)
V	cycle (self, *V args)
bool	changed (self, *t.Any value)
"LoopContext"	__iter__ (self)
t.Tuple[t.Any, "LoopContext"]	__next__ (self)
str	__call__ (self, t.Iterable[V] iterable)
str	__repr__ (self)

Protected Member Functions
t.Any	_peek_next (self)

Static Protected Member Functions
t.AsyncIterator[V]	_to_iterator (t.Union[t.Iterable[V], t.AsyncIterable[V]] iterable)

Protected Attributes
	_length
	_iterator
	_after
	_before
	_current
Protected Attributes inherited from jinja2.runtime.LoopContext
	_iterable
	_iterator
	_undefined
	_recurse
	_length
	_after
	_last_changed_value
	_before
	_current

Static Protected Attributes
t	_iterator .AsyncIterator[t.Any]
Static Protected Attributes inherited from jinja2.runtime.LoopContext
t	_length = None
t	_after = missing
t	_current = missing
t	_before = missing
t	_last_changed_value = missing

Additional Inherited Members
Public Attributes inherited from jinja2.runtime.LoopContext
	depth0
	index0
Static Public Attributes inherited from jinja2.runtime.LoopContext
int	index0 = -1

Member Function Documentation

_peek_next()

t.Any jinja2.runtime.AsyncLoopContext._peek_next (   self )

protected

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.

Reimplemented from jinja2.runtime.LoopContext.

_to_iterator()

t.AsyncIterator[V] jinja2.runtime.AsyncLoopContext._to_iterator ( t.Union[t.Iterable[V], t.AsyncIterable[V]]  iterable )

staticprotected

Reimplemented from jinja2.runtime.LoopContext.

last()

bool jinja2.runtime.AsyncLoopContext.last

(

self

)

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.

Reimplemented from jinja2.runtime.LoopContext.

length()

int jinja2.runtime.AsyncLoopContext.length

(

self

)

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.

Reimplemented from jinja2.runtime.LoopContext.

nextitem()

t.Union[t.Any, "Undefined"] jinja2.runtime.AsyncLoopContext.nextitem

(

self

)

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.

Reimplemented from jinja2.runtime.LoopContext.

revindex()

int jinja2.runtime.AsyncLoopContext.revindex

(

self

)

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

Requires calculating :attr:`length`.

Reimplemented from jinja2.runtime.LoopContext.

revindex0()

int jinja2.runtime.AsyncLoopContext.revindex0

(

self

)

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

Requires calculating :attr:`length`.

Reimplemented from jinja2.runtime.LoopContext.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/jinja2/runtime.py