On this page
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()
.
- 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
.
-
int
PyGen_CheckExact
( PyObject *ob ) -
Return true if ob’s type is
PyGen_Type
; ob must not beNULL
.
- 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. The argument must not be
NULL
.
- 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. The frame argument must not beNULL
.