Skip to main content

Browse the archive

Staging
v0.5.1
https://github.com/python/cpython
09 December 2020, 11:06:31 UTC
Revision 7ea0551592d80584b318099d5ebde4e7c552679f authored by Ned Deily on 11 December 2019, 08:27:49 UTC, committed by Ned Deily on 11 December 2019, 08:28:36 UTC 
3.6.10rc1
1 parent b23c084
Raw File
Tip revision: 7ea0551592d80584b318099d5ebde4e7c552679f authored by Ned Deily on 11 December 2019, 08:27:49 UTC
3.6.10rc1
Tip revision: 7ea0551
coro.rst 
.. highlightlang:: c

.. _coro-objects:

Coroutine Objects
-----------------

.. versionadded:: 3.5

Coroutine objects are what functions declared with an ``async`` keyword
return.


.. c:type:: PyCoroObject

   The C structure used for coroutine objects.


.. c:var:: PyTypeObject PyCoro_Type

   The type object corresponding to coroutine objects.


.. c:function:: int PyCoro_CheckExact(PyObject *ob)

   Return true if *ob*'s type is *PyCoro_Type*; *ob* must not be *NULL*.


.. c:function:: PyObject* PyCoro_New(PyFrameObject *frame, PyObject *name, PyObject *qualname)

   Create and return a new coroutine object based on the *frame* object,
   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*.
back to top