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

Для работы с итераторами предназначены две функции.

int PyIter_Check(PyObject *o)

Входит в стабильный ABI с версии 3.8.

Возвращает ненулевое значение, если объект o можно безопасно передать в PyIter_Next(), и 0 в противном случае. Эта функция всегда завершается успешно.

int PyAIter_Check(PyObject *o)

Входит в стабильный ABI с версии 3.10.

Возвращает ненулевое значение, если объект o поддерживает протокол AsyncIterator, и 0 в противном случае. Эта функция всегда завершается успешно.

Добавлено в версии 3.10.

PyObject *PyIter_Next(PyObject *o)

Возвращаемое значение: новая ссылка.Входит в стабильный 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

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

Добавлено в версии 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.

Добавлено в версии 3.10.