diff options
| author | Pablo Galindo <Pablogsal@gmail.com> | 2021-03-23 23:57:03 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-23 23:57:03 (GMT) |
| commit | d9692027f41ee7600fe401c066617ebfc8bac930 (patch) | |
| tree | c4e711c343099c3a695701fede2d5147a168c021 /Doc/c-api/iter.rst | |
| parent | a81fca6ec8e0f748f8eafa12fb12cf9e12df465c (diff) | |
| download | cpython-d9692027f41ee7600fe401c066617ebfc8bac930.zip cpython-d9692027f41ee7600fe401c066617ebfc8bac930.tar.gz cpython-d9692027f41ee7600fe401c066617ebfc8bac930.tar.bz2 | |
bpo-31861: Complete the C-API docs for PyObject_GetAiter and PyAiter_Check (GH-25004)
Diffstat (limited to 'Doc/c-api/iter.rst')
| -rw-r--r-- | Doc/c-api/iter.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/c-api/iter.rst b/Doc/c-api/iter.rst index 5706777..63290e0 100644 --- a/Doc/c-api/iter.rst +++ b/Doc/c-api/iter.rst @@ -12,6 +12,12 @@ There are two functions specifically for working with iterators. Return non-zero if the object *o* supports the iterator protocol, and ``0`` otherwise. This function always succeeds. +.. c:function:: int PyAiter_Check(PyObject *o) + + Returns non-zero if the object 'obj' provides :class:`AsyncIterator` + protocols, and ``0`` otherwise. This function always succeeds. + + .. versionadded:: 3.10 .. c:function:: PyObject* PyIter_Next(PyObject *o) |