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

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

int PyIter_Check(PyObject *o)¶

Part of the Стабильный ABI since version 3.8.

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

int PyAIter_Check(PyObject *o)¶

Part of the Стабильный ABI since version 3.10.

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

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

PyObject *PyIter_Next(PyObject *o)¶

Возвращаемое значение: Новая ссылка. Part of the Стабильный 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)¶

Part of the Стабильный ABI since version 3.10.

Отправляет значение arg в итератор iter. Возвращается:

• PYGEN_RETURN если итератор возвращает значение. Возвращаемое значение возвращается через presult.

• PYGEN_NEXT если итератор выдает результат. Полученное значение возвращается через presult.

• PYGEN_ERROR если итератор вызвал исключение. presult имеет значение NULL.

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