Протокол итератора¶
Есть две функции, специально предназначенные для работы с итераторами.
-
int PyIter_Check(PyObject *o)¶
- Часть Стабильный ABI с версии 3.8.
Возвращает ненулевое значение, если объект o может быть безопасно передан в
PyIter_Next()
, и0
в противном случае. Эта функция всегда успешна.
-
int PyAIter_Check(PyObject *o)¶
- Часть Стабильный ABI с версии 3.10.
Возвращает ненулевое значение, если объект o предоставляет протокол
AsyncIterator
, и0
в противном случае. Эта функция всегда успешна.Added in version 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()
.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.