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

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

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 в случае ошибки. Это эквивалент оператора Python o[i] = v. Эта функция не заимствует ссылку на v.

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. Гарантируется, что возвращённый список является новым.

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

PyObject* PySequence_Fast(PyObject *o, const char *m)¶: Возвращаемое значение: новая ссылка.
Возвращает последовательность o в виде кортежа, если только она уже не является кортежем или списком – в этом случае возвращается o. Для доступа к элементам результата используйте PySequence_Fast_GET_ITEM(). В случае ошибки возвращает NULL. Если объект не является последовательностью, возбуждает TypeError с текстом сообщения m.

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 возвращает истину, и без корректировки для отрицательных индексов.

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