# 迭代器协议

迭代器有两个函数。

int PyIter_Check(PyObject *o)
  属于 稳定 ABI 自 3.8 版起.

  Return non-zero if the object o can be safely passed to `PyIter_NextItem()` and `0` otherwise. This function always succeeds.

int PyAIter_Check(PyObject *o)
  属于 稳定 ABI 自 3.10 版起.

  如果对象 o 提供了 `AsyncIterator` 协议则返回非零值，否则返回 `0`。 此函数总是会成功执行。

  Added in version 3.10.

int PyIter_NextItem(PyObject *iter, PyObject **item)
  属于 稳定 ABI 自 3.14 版起.

  Return `1` and set item to a strong reference of the next value of the iterator iter on success. Return `0` and set item to `NULL` if there are no remaining values. Return `-1`, set item to `NULL` and set an exception on error.

  Added in version 3.14.

PyObject *PyIter_Next(PyObject *o)
  返回值：新的引用。 属于 稳定 ABI.

  This is an older version of `PyIter_NextItem()`, which is retained for backwards compatibility. Prefer `PyIter_NextItem()`.

  从迭代器 o 返回下一个值。 对象必须可被 `PyIter_Check()` 确认为迭代器（需要调用方来负责检查）。 如果没有剩余的值，则返回 `NULL` 并且不设置异常。 如果在获取条目时发生了错误，则返回 `NULL` 并且传递异常。

type PySendResult

  用于代表 `PyIter_Send()` 的不同结果的枚举值。

  Added in version 3.10.

PySendResult PyIter_Send(PyObject *iter, PyObject *arg, PyObject **presult)
  属于 稳定 ABI 自 3.10 版起.

  将 arg 值发送到迭代器 iter。 返回:

  - `PYGEN_RETURN`，如果迭代器返回的话。 返回值会通过 presult 来返回。

  - `PYGEN_NEXT`，如果迭代器生成值的话。 生成的值会通过 presult 来返回。

  - `PYGEN_ERROR`，如果迭代器引发异常的话。 presult 会被设为 `NULL`。

  Added in version 3.10.