Протокол ітератора

Є дві функції спеціально для роботи з ітераторами.

int PyIter_Check(PyObject *o)

Part of the Stable ABI since version 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)

Part of the Stable ABI since version 3.10.

Повертає відмінне від нуля значення, якщо об’єкт o забезпечує протокол AsyncIterator, і 0 інакше. Ця функція завжди успішна.

Added in version 3.10.

int PyIter_NextItem(PyObject *iter, PyObject **item)

Part of the Stable ABI since version 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)

Return value: New reference. Part of the Stable 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

Значення enum, яке використовується для представлення різних результатів PyIter_Send().

Added in version 3.10.

PySendResult PyIter_Send(PyObject *iter, PyObject *arg, PyObject **presult)

Part of the Stable ABI since version 3.10.

Надсилає значення arg в ітератор iter. Повернення:

• PYGEN_RETURN, якщо повертає ітератор. Повернене значення повертається через presult.

• PYGEN_NEXT, якщо ітератор дає результат. Отримане значення повертається через presult.

• PYGEN_ERROR, якщо ітератор підняв і виняток. presult має значення NULL.

Added in version 3.10.