Протокол последовательности¶Sequence Protocol

int PySequence_Check(PyObject *o)¶: Возвращает 1, если объект поддерживает протокол последовательности, и 0 в противном случае. Обратите внимание, что для классов Python с методом __getitem__() возвращается 1, если только они не являются подклассами dict, поскольку в общем случае невозможно определить, какой тип ключей они поддерживают. Эта функция всегда завершается успешно.

Py_ssize_t PySequence_Size(PyObject *o)¶
Py_ssize_t PySequence_Length(PyObject *o)¶: Возвращает количество объектов в последовательности o в случае успеха и -1 при неудаче. Эквивалентно выражению Python len(o).

PyObject* PySequence_Concat(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает конкатенацию o1 и o2 в случае успеха и NULL при неудаче. Эквивалентно выражению Python o1 + o2.

PyObject* PySequence_Repeat(PyObject *o, Py_ssize_t count)¶: Возвращаемое значение: новая ссылка.
Возвращает результат повторения объекта последовательности o count раз или NULL при неудаче. Эквивалентно выражению Python o * count.

PyObject* PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает конкатенацию o1 и o2 в случае успеха и NULL при неудаче. Операция выполняется на месте, если o1 это поддерживает. Эквивалентно выражению Python o1 += o2.

PyObject* PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)¶: Возвращаемое значение: новая ссылка.
Возвращает результат повторения объекта последовательности o count раз или NULL при неудаче. Операция выполняется на месте, если o это поддерживает. Эквивалентно выражению Python o *= count.

PyObject* PySequence_GetItem(PyObject *o, Py_ssize_t i)¶: Возвращаемое значение: новая ссылка.
Возвращает элемент с индексом i объекта o или NULL при неудаче. Эквивалентно выражению Python o[i].

PyObject* PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶: Возвращаемое значение: новая ссылка.
Возвращает срез объекта последовательности o между i1 и i2 или NULL при неудаче. Эквивалентно выражению Python o[i1:i2].

int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)¶

Присваивает объект v элементу o с индексом i. В случае ошибки возбуждает исключение и возвращает -1; в случае успеха возвращает 0. Это эквивалент оператора Python o[i] = v. Эта функция не забирает ссылку на v.

Если v равно NULL, элемент удаляется, однако эта возможность устарела, рекомендуется использовать PySequence_DelItem().

int PySequence_DelItem(PyObject *o, Py_ssize_t i)¶: Удаляет элемент с индексом i объекта o. Возвращает -1 при неудаче. Эквивалентно инструкции Python del o[i].

int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)¶: Присваивает объект последовательности v срезу в объекте последовательности o от i1 до i2. Эквивалентно инструкции Python o[i1:i2] = v.

int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶: Удаляет срез в объекте последовательности o от i1 до i2. Возвращает -1 при неудаче. Эквивалентно инструкции Python del o[i1:i2].

Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)¶: Возвращает количество вхождений value в o, то есть количество ключей, для которых o[key] == value. При неудаче возвращает -1. Эквивалентно выражению Python o.count(value).

int PySequence_Contains(PyObject *o, PyObject *value)¶: Определяет, содержит ли o значение value. Если элемент в o равен value, возвращает 1, иначе возвращает 0. При ошибке возвращает -1. Эквивалентно выражению Python value in o.

Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)¶: Возвращает первый индекс i, для которого o[i] == value. При ошибке возвращает -1. Это эквивалентно выражению Python o.index(value).

PyObject* PySequence_List(PyObject *o)¶: Возвращаемое значение: новая ссылка.
Возвращает список с тем же содержимым, что и последовательность или итерируемый объект o, или NULL при ошибке. Возвращённый список гарантированно новый. Это эквивалентно выражению Python list(o).

PyObject* PySequence_Tuple(PyObject *o)¶: Возвращаемое значение: новая ссылка.
Возвращает кортеж с тем же содержимым, что и последовательность или итерируемый объект o, или NULL при ошибке. Если o уже является кортежем, возвращается новая ссылка, иначе будет создан кортеж с соответствующим содержимым. Это эквивалентно выражению Python tuple(o).

PyObject* PySequence_Fast(PyObject *o, const char *m)¶

Возвращаемое значение: новая ссылка.

Возвращает последовательность или итерируемый объект o в виде объекта, пригодного для использования другими функциями семейства PySequence_Fast*. Если объект не является последовательностью или итерируемым объектом, возбуждается TypeError с текстом сообщения m. Возвращает NULL при ошибке.

Функции PySequence_Fast* названы так, потому что они предполагают, что o является PyTupleObject или PyListObject и обращаются к полям данных o напрямую.

В рамках реализации CPython: если o уже является последовательностью или списком, он будет возвращён.

Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)¶: Возвращает длину o, предполагая, что o был возвращён PySequence_Fast() и что o не равно NULL. Размер также можно получить, вызвав PySequence_Size() для o, но PySequence_Fast_GET_SIZE() быстрее, поскольку может считать, что o – это список или кортеж.

PyObject* PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)¶: Возвращаемое значение: заимствованная ссылка.
Возвращает i-й элемент o, предполагая, что o был возвращён PySequence_Fast(), o не является NULL, и i находится в допустимых пределах.

PyObject** PySequence_Fast_ITEMS(PyObject *o)¶

Возвращает внутренний массив указателей PyObject. Предполагается, что o был возвращён PySequence_Fast() и o не является NULL.

Примечание: если список изменяет размер, перераспределение может переместить массив элементов. Поэтому используйте указатель на внутренний массив только в контекстах, где последовательность не может измениться.

PyObject* PySequence_ITEM(PyObject *o, Py_ssize_t i)¶: Возвращаемое значение: новая ссылка.
Возвращает i-й элемент o или NULL при ошибке. Более быстрая версия PySequence_GetItem(), но без проверки того, что PySequence_Check() для o равно true, и без коррекции для отрицательных индексов.