Generator Objects¶

Generator objects are what Python uses to implement generator iterators. They are normally created by iterating over a function that yields values, rather than explicitly calling PyGen_New() or PyGen_NewWithQualName().

type PyGenObject¶

The C structure used for generator objects.

PyTypeObject PyGen_Type¶

The type object corresponding to generator objects.

int PyGen_Check(PyObject *ob)¶

Return true if ob is a generator object; ob must not be NULL. This function always succeeds.

int PyGen_CheckExact(PyObject *ob)¶

Return true if ob’s type is PyGen_Type; ob must not be NULL. This function always succeeds.

PyObject *PyGen_New(PyFrameObject *frame)¶

Return value: New reference.

Create and return a new generator object based on the frame object. A reference to frame is “stolen” by this function (even on error). The argument must not be NULL.

Deprecated since version 3.16, will be removed in version 3.18: This function has not been used since 3.10. It is also impossible to construct a proper frame object to call this function.

PyObject *PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname)¶

Return value: New reference.

Create and return a new generator object based on the frame object, with __name__ and __qualname__ set to name and qualname. A reference to frame is “stolen” by this function (even on error). The frame argument must not be NULL.

Deprecated since version 3.16, will be removed in version 3.18: This function has not been used since 3.10. It is also impossible to construct a proper frame object to call this function.

PyCodeObject *PyGen_GetCode(PyGenObject *gen)¶

Return a new strong reference to the code object wrapped by gen. This function always succeeds.