Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Issue #28049: Add documentation for typing.Awaitable and friends. 

By Michael Lee.
This commit is contained in:
Guido van Rossum 2016-09-09 11:46:34 -07:00
parent bf04b0698b
commit 922175922c
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/library/typing.rst
View File

@ -646,6 +646,18 @@ The module defines the following classes, functions and decorators:
A generic version of :class:`collections.abc.ValuesView`.
.. class:: Awaitable(Generic[T_co])
A generic version of :class:`collections.abc.Awaitable`.
.. class:: AsyncIterable(Generic[T_co])
A generic version of :class:`collections.abc.AsyncIterable`.
.. class:: AsyncIterator(AsyncIterable[T_co])
A generic version of :class:`collections.abc.AsyncIterator`.
.. class:: ContextManager(Generic[T_co])
A generic version of :class:`contextlib.AbstractContextManager`.
@ -684,7 +696,7 @@ The module defines the following classes, functions and decorators:
start += 1
Alternatively, annotate your generator as having a return type of
``Iterator[YieldType]``::
either ``Iterable[YieldType]`` or ``Iterator[YieldType]``::
def infinite_stream(start: int) -> Iterator[int]:
while True: