# 產生器 (Generator) 物件

產生器物件是 Python 用來實現產生器疊代器 (generator iterator) 的物件。它們通常透過疊代會產生值的函式來建立，而不是顯式呼叫 `PyGen_New()` 或 `PyGen_NewWithQualName()`。

type PyGenObject

  用於產生器物件的 C 結構。

PyTypeObject PyGen_Type

  與產生器物件對應的型別物件。

int PyGen_Check(PyObject *ob)

  如果 ob 是一個產生器 (generator) 物件則回傳真值；ob 必須不為 `NULL`。此函式總是會成功執行。

int PyGen_CheckExact(PyObject *ob)

  如果 ob 的型別是 `PyGen_Type` 則回傳真值；ob 必須不為 `NULL`。此函式總是會成功執行。

PyObject *PyGen_New(PyFrameObject *frame)
  回傳值：新的參照。

  基於 frame 物件建立並回傳一個新的產生器物件。此函式會取走一個對 frame 的參照 (reference)。引數必須不為 `NULL`。

PyObject *PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname)
  回傳值：新的參照。

  基於 frame 物件建立並回傳一個新的產生器物件，其中 `__name__` 和 `__qualname__` 設為 name 和 qualname。此函式會取走一個對 frame 的參照。frame 引數必須不為 `NULL`。

PyCodeObject *PyGen_GetCode(PyGenObject *gen)

  回傳一個對 gen 所包裝的程式碼物件的新強參照。此函式總是會成功執行。

## 非同步產生器 (Asynchronous Generator) 物件

也參考

PEP 525

PyTypeObject PyAsyncGen_Type

  與非同步產生器物件對應的型別物件。在 Python 層中可以 `types.AsyncGeneratorType` 使用。

  在 3.6 版被加入.

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

  建立一個包裝 frame 的非同步產生器，並將 `__name__` 和 `__qualname__` 設為 name 和 qualname。frame 會被此函式取走，且不得為 `NULL`。

  成功時此函式回傳對新的非同步產生器的強參照。失敗時此函式回傳 `NULL` 並設定一個例外。

  在 3.6 版被加入.

int PyAsyncGen_CheckExact(PyObject *op)

  如果 op 是一個非同步產生器物件則回傳 true，否則回傳 false。此函式總是會成功執行。

  在 3.6 版被加入.

## 已棄用的 API

PyAsyncGenASend_CheckExact(op)

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

  它僅僅是為了完整性而存在；請勿使用此 API。

  Soft deprecated since version 3.14.