ジェネレータオブジェクト

ジェネレータオブジェクトは、 Python がジェネレータイテレータを実装するのに使っているオブジェクトです。ジェネレータオブジェクトは通常、 PyGen_New() や PyGen_NewWithQualName() の明示的な呼び出しではなく、値を yield する関数のイテレーションにより生成されます。

type PyGenObject

ジェネレータオブジェクトに使われている C 構造体です。

PyTypeObject PyGen_Type

ジェネレータオブジェクトに対応する型オブジェクトです。

int PyGen_Check(PyObject *ob)

ob がジェネレータオブジェクトの場合に真を返ます、 ob は NULL であってはなりません。この関数は常に成功します。

int PyGen_CheckExact(PyObject *ob)

ob が PyGen_Type の場合に真を返します。 o は NULL であってはなりません。 この関数は常に成功します。

PyObject *PyGen_New(PyFrameObject *frame)

戻り値: 新しい参照。

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.

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

戻り値: 新しい参照。

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.

PyCodeObject *PyGen_GetCode(PyGenObject *gen)

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

Asynchronous Generator Objects

参考

PEP 525

PyTypeObject PyAsyncGen_Type

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

Added in version 3.6.

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

Added in version 3.6.

int PyAsyncGen_CheckExact(PyObject *op)

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

Added in version 3.6.

Deprecated API

PyAsyncGenASend_CheckExact(op)

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.

Soft deprecated since version 3.14.