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

ジェネレータオブジェクトは、 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)
  戻り値: 新しい参照。

  frame オブジェクトに基づいて新たなジェネレータオブジェクトを生成して返します。 この関数は frame への参照を盗みます。 引数が `NULL` であってはなりません。

PyObject *PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname)
  戻り値: 新しい参照。

  frame オブジェクトから新たなジェネレータオブジェクトを生成し、 `__name__` と `__qualname__` を name と qualname に設定して返します。 この関数は frame への参照を盗みます。 frame 引数は `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 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 a soft deprecated API that was included in Python's C API by mistake.

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