summaryrefslogtreecommitdiffstats
path: root/Doc/reference/datamodel.rst
diff options
context:
space:
mode:
authorYury Selivanov <yury@magic.io>2016-12-15 22:36:05 (GMT)
committerYury Selivanov <yury@magic.io>2016-12-15 22:36:05 (GMT)
commit03660041d2d3a95e7bc4ad863278bd93e28c805e (patch)
tree601e278203f1e710c1a0bef12e8e9b82336f14e0 /Doc/reference/datamodel.rst
parent76febd079299d64abffee0bdd7c4c1785e5a0fa7 (diff)
downloadcpython-03660041d2d3a95e7bc4ad863278bd93e28c805e.zip
cpython-03660041d2d3a95e7bc4ad863278bd93e28c805e.tar.gz
cpython-03660041d2d3a95e7bc4ad863278bd93e28c805e.tar.bz2
Issue #28091: Document PEP 525 & PEP 530.
Patch by Eric Appelt.
Diffstat (limited to 'Doc/reference/datamodel.rst')
-rw-r--r--Doc/reference/datamodel.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 36a9037..82e35e5 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -627,6 +627,25 @@ Callable types
as well as :keyword:`async with` and :keyword:`async for` statements. See
also the :ref:`coroutine-objects` section.
+ Asynchronous generator functions
+ .. index::
+ single: asynchronous generator; function
+ single: asynchronous generator; asynchronous iterator
+
+ A function or method which is defined using :keyword:`async def` and
+ which uses the :keyword:`yield` statement is called a
+ :dfn:`asynchronous generator function`. Such a function, when called,
+ returns an asynchronous iterator object which can be used in an
+ :keyword:`async for` statement to execute the body of the function.
+
+ Calling the asynchronous iterator's :meth:`aiterator.__anext__` method
+ will return an :term:`awaitable` which when awaited
+ will execute until it provides a value using the :keyword:`yield`
+ expression. When the function executes an empty :keyword:`return`
+ statement or falls off the end, a :exc:`StopAsyncIteration` exception
+ is raised and the asynchronous iterator will have reached the end of
+ the set of values to be yielded.
+
Built-in functions
.. index::
object: built-in function