From 4365388a3cc49dd9e969b27d5db6ebcf2636dbd5 Mon Sep 17 00:00:00 2001 From: Peter Bierma Date: Tue, 11 Nov 2025 10:42:43 -0500 Subject: [PATCH 1/4] Document PyGen_GetCode() --- Doc/c-api/gen.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst index 0eb5922f6da75f..2ac8ffd922b411 100644 --- a/Doc/c-api/gen.rst +++ b/Doc/c-api/gen.rst @@ -44,3 +44,8 @@ than explicitly calling :c:func:`PyGen_New` or :c:func:`PyGen_NewWithQualName`. with ``__name__`` and ``__qualname__`` set to *name* and *qualname*. A reference to *frame* is stolen by this function. The *frame* argument must not be ``NULL``. + +.. c:function:: PyCodeObject *PyGen_GetCode(PyGenObject *gen) + + Return a new :term:`strong reference` to the code object wrapped by *gen*. + This function always succeeds. From d274ffa87828029536ebf932929020c2cee1db93 Mon Sep 17 00:00:00 2001 From: Peter Bierma Date: Tue, 11 Nov 2025 10:49:43 -0500 Subject: [PATCH 2/4] Document asynchronous generator APIs. --- Doc/c-api/gen.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst index 2ac8ffd922b411..0142e437dc2e85 100644 --- a/Doc/c-api/gen.rst +++ b/Doc/c-api/gen.rst @@ -49,3 +49,32 @@ than explicitly calling :c:func:`PyGen_New` or :c:func:`PyGen_NewWithQualName`. Return a new :term:`strong reference` to the code object wrapped by *gen*. This function always succeeds. + + +Asynchronous Generator Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. seealso:: + :pep:`525` + +.. c:var:: PyTypeObject PyAsyncGen_Type + + The type object corresponding to asynchronous generator objects. This is + available as :class:`types.AsyncGeneratorType` in the Python layer. + +.. c:function:: PyObject *PyAsyncGen_New(PyFrameObject *frame, PyObject *name, PyObject *qualname) + + Create a new asynchronous generator wrapping *frame*, with ``__name__`` and + ``__qualname__`` set to *name* and *qualname*. *frame* is stolen by this + function and must not be ``NULL``. + + On success, this function returns a :term:`strong reference` to the + new asynchronous generator. On failure, this function returns ``NULL`` + with an exception set. + + .. versionadded:: 3.6 + +.. c:function:: int PyAsyncGen_CheckExact(PyObject *op) + + Return true if *op* is an asynchronous generator object, false otherwise. + This function always succeeds. From 3a6200c32ff6a312abb990224d66bf7519bb005c Mon Sep 17 00:00:00 2001 From: Peter Bierma Date: Tue, 11 Nov 2025 10:51:51 -0500 Subject: [PATCH 3/4] Add missing versionadded notes. --- Doc/c-api/gen.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst index 0142e437dc2e85..5aae22c29f2b63 100644 --- a/Doc/c-api/gen.rst +++ b/Doc/c-api/gen.rst @@ -62,6 +62,8 @@ Asynchronous Generator Objects The type object corresponding to asynchronous generator objects. This is available as :class:`types.AsyncGeneratorType` in the Python layer. + .. versionadded:: 3.6 + .. c:function:: PyObject *PyAsyncGen_New(PyFrameObject *frame, PyObject *name, PyObject *qualname) Create a new asynchronous generator wrapping *frame*, with ``__name__`` and @@ -78,3 +80,5 @@ Asynchronous Generator Objects Return true if *op* is an asynchronous generator object, false otherwise. This function always succeeds. + + .. versionadded:: 3.6 From 5fc61d441a99b0a7fdf2975ecaad13041477e715 Mon Sep 17 00:00:00 2001 From: Peter Bierma Date: Thu, 20 Nov 2025 08:17:12 -0500 Subject: [PATCH 4/4] Update Doc/c-api/gen.rst Co-authored-by: Victor Stinner --- Doc/c-api/gen.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst index 5aae22c29f2b63..44f3bdbf959b9c 100644 --- a/Doc/c-api/gen.rst +++ b/Doc/c-api/gen.rst @@ -45,7 +45,7 @@ than explicitly calling :c:func:`PyGen_New` or :c:func:`PyGen_NewWithQualName`. A reference to *frame* is stolen by this function. The *frame* argument must not be ``NULL``. -.. c:function:: PyCodeObject *PyGen_GetCode(PyGenObject *gen) +.. c:function:: PyCodeObject* PyGen_GetCode(PyGenObject *gen) Return a new :term:`strong reference` to the code object wrapped by *gen*. This function always succeeds.