Протокол последовательностей

int PySequence_Check(PyObject *o)

Часть стабильного ABI.

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

Py_ssize_t PySequence_Size(PyObject *o)

Py_ssize_t PySequence_Length(PyObject *o)

Часть стабильного ABI.

В случае успеха возвращает количество объектов в последовательности o, а при ошибке — -1. Эквивалентно выражению Python len(o).

PyObject *PySequence_Concat(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

В случае успеха возвращает конкатенацию o1 и o2, а при ошибке — NULL. Эквивалентно выражению Python o1 + o2.

PyObject *PySequence_Repeat(PyObject *o, Py_ssize_t count)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

Возвращает результат повторения объекта-последовательности o count раз или NULL при ошибке. Эквивалентно выражению Python o * count.

PyObject *PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

В случае успеха возвращает конкатенацию o1 и o2, а при ошибке — NULL. Если o1 поддерживает эту операцию, она выполняется на месте. Эквивалентно выражению Python o1 += o2.

PyObject *PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

Возвращает результат повторения объекта-последовательности o count раз или NULL при ошибке. Если o поддерживает эту операцию, она выполняется на месте. Эквивалентно выражению Python o *= count.

PyObject *PySequence_GetItem(PyObject *o, Py_ssize_t i)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

Возвращает элемент o с индексом i или NULL при ошибке. Эквивалентно выражению Python o[i].

PyObject *PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

Возвращает срез объекта-последовательности o от i1 до i2 или NULL при ошибке. Эквивалентно выражению Python o[i1:i2].

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

Часть стабильного ABI.

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

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

int PySequence_DelItem(PyObject *o, Py_ssize_t i)

Часть стабильного ABI.

Удаляет элемент объекта o с индексом i. При ошибке возвращает -1. Эквивалентно инструкции Python del o[i].

int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)

Часть стабильного ABI.

Присваивает объект-последовательность v срезу объекта-последовательности o от i1 до i2. Эквивалентно инструкции Python o[i1:i2] = v.

int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)

Часть стабильного ABI.

Удаляет срез объекта-последовательности o от i1 до i2. При ошибке возвращает -1. Эквивалентно инструкции Python del o[i1:i2].

Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)

Часть стабильного ABI.

Возвращает количество вхождений value в o, то есть количество ключей, для которых выполняется o[key] == value. При ошибке возвращает -1. Эквивалентно выражению Python o.count(value).

int PySequence_Contains(PyObject *o, PyObject *value)

Часть стабильного ABI.

Определяет, содержит ли o значение value. Если элемент в o равен value, возвращает 1, в противном случае — 0. При ошибке возвращает -1. Эквивалентно выражению Python value in o.

Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)

Часть стабильного ABI.

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

PyObject *PySequence_List(PyObject *o)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

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

PyObject *PySequence_Tuple(PyObject *o)

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

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

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

Возвращаемое значение: новая ссылка. Часть стабильного ABI.

Возвращает последовательность или итерируемый объект 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. Размер также можно получить, вызвав для o функцию PySequence_Size(), однако PySequence_Fast_GET_SIZE() работает быстрее, поскольку может предполагать, что o — список или кортеж.

PyObject *PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)

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

Возвращает элемент o с индексом i, предполагая, что 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)

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

Возвращает элемент o с индексом i или NULL при ошибке. Более быстрая версия PySequence_GetItem(), которая не проверяет, что для o выполняется PySequence_Check(), и не корректирует отрицательные индексы.