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.

The C structure used for generator objects.

The type object corresponding to generator objects.

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

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

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

3.16 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.

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 <steal>" by this function (even on error). The frame argument must not be NULL.

3.16 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.

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

Asynchronous Generator Objects

The type object corresponding to asynchronous generator objects. This is available as types.AsyncGeneratorType in the Python layer.

3.6

Create a new asynchronous generator wrapping frame, with __name__ and __qualname__ set to name and qualname. frame is "stolen <steal>" by this function (even on error) and must not be NULL.

On success, this function returns a strong reference to the new asynchronous generator. On failure, this function returns NULL with an exception set.

3.6

3.16 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.

Return true if op is an asynchronous generator object, false otherwise. This function always succeeds.

3.6

Deprecated API

This is an API that was included in Python's C API by mistake.

It is solely here for completeness; do not use this API.

3.14