Issue #29198: Document typing.AsyncGenerator

Patch by Jelle Zijlstra.
This commit is contained in:
Berker Peksag 2017-02-04 09:18:11 +03:00
parent db38b6c9a9
commit 38962a6fe2
1 changed files with 33 additions and 0 deletions

View File

@ -670,6 +670,39 @@ The module defines the following classes, functions and decorators:
yield start yield start
start += 1 start += 1
.. class:: AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra])
An async generator can be annotated by the generic type
``AsyncGenerator[YieldType, SendType]``. For example::
async def echo_round() -> AsyncGenerator[int, float]:
sent = yield 0
while sent >= 0.0:
rounded = await round(sent)
sent = yield rounded
Unlike normal generators, async generators cannot return a value, so there
is no ``ReturnType`` type parameter. As with :class:`Generator`, the
``SendType`` behaves contravariantly.
If your generator will only yield values, set the ``SendType`` to
``None``::
async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
while True:
yield start
start = await increment(start)
Alternatively, annotate your generator as having a return type of
either ``AsyncIterable[YieldType]`` or ``AsyncIterator[YieldType]``::
async def infinite_stream(start: int) -> AsyncIterator[int]:
while True:
yield start
start = await increment(start)
.. versionadded:: 3.5.4
.. class:: Text .. class:: Text
``Text`` is an alias for ``str``. It is provided to supply a forward ``Text`` is an alias for ``str``. It is provided to supply a forward