Протокол последовательности¶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).

Изменено в версии 2.5: Эти функции возвращали тип int. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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.

Изменено в версии 2.5: Эта функция использовала тип int для count. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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 это поддерживает. Это eквивалентно выражению Python o *= count.

Изменено в версии 2.5: Эта функция использовала тип int для count. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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

Изменено в версии 2.5: Эта функция использовала тип int для i. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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

Изменено в версии 2.5: Эта функция использовала тип int для i1 и i2. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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().

Изменено в версии 2.5: Эта функция использовала тип int для i. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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

Изменено в версии 2.5: Эта функция использовала тип int для i. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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

Присваивает объект последовательности v срезу объекта последовательности o от i1 до i2. В случае ошибки возбуждает исключение и возвращает -1; в случае успеха возвращает 0. Это эквивалент оператора Python o[i1:i2] = v.

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

Изменено в версии 2.5: Эта функция использовала тип int для i1 и i2. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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

Изменено в версии 2.5: Эта функция использовала тип int для i1 и i2. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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

Изменено в версии 2.5: Эта функция возвращала тип int. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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).

Изменено в версии 2.5: Эта функция возвращала тип int. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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 находится в допустимых пределах.

Изменено в версии 2.5: Эта функция использовала тип int для i. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

PyObject** PySequence_Fast_ITEMS(PyObject *o)¶

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

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

Новое в версии 2.4.

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

Новое в версии 2.3.

Изменено в версии 2.5: Эта функция использовала тип int для i. Возможно, потребуется внести изменения в код для корректной поддержки 64-битных систем.

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