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

int PySequence_Check(PyObject *o)

Возвращает 1, если объект поддерживает протокол последовательности, и 0 в противном случае. Обратите внимание, что он возвращает 1 для классов Python с методом __getitem__(), за исключением случаев, когда они являются подклассами 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 i-му элементу o. Вызывает исключение и возвращает -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 истинно и без корректировки для отрицательных индексов.