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

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

int PyIter_Check(PyObject *o)

Part of the Stable ABI since version 3.8.

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

int PyAIter_Check(PyObject *o)

Part of the Stable ABI since version 3.10.

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

Нове в версії 3.10.

PyObject *PyIter_Next(PyObject *o)

Return value: New reference. Part of the Stable ABI.

Повертає наступне значення з ітератора o. Об’єкт має бути ітератором відповідно до PyIter_Check() (це залежить від того, хто викликає). Якщо не залишилося значень, повертає NULL без винятку. Якщо під час отримання елемента виникає помилка, повертається NULL і передається виняток.

Щоб написати цикл, який повторює ітератор, код C має виглядати приблизно так:

PyObject *iterator = PyObject_GetIter(obj);
PyObject *item;

if (iterator == NULL) {
    /* propagate error */
}

while ((item = PyIter_Next(iterator))) {
    /* do something with item */
    ...
    /* release reference when done */
    Py_DECREF(item);
}

Py_DECREF(iterator);

if (PyErr_Occurred()) {
    /* propagate error */
}
else {
    /* continue doing useful work */
}

type PySendResult

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

Нове в версії 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.

Нове в версії 3.10.