Объекты списка

type PyListObject

Этот подтип PyObject представляет объект списка Python.

PyTypeObject PyList_Type

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

Этот экземпляр PyTypeObject представляет тип списка Python. Это тот же объект, что и list на уровне Python.

int PyList_Check(PyObject *p)

Возвращает true, если p является объектом списка или экземпляром подтипа типа списка. Эта функция всегда выполняется успешно.

int PyList_CheckExact(PyObject *p)

Возвращает true, если p является объектом списка, но не экземпляром подтипа типа списка. Эта функция всегда выполняется успешно.

PyObject *PyList_New(Py_ssize_t len)

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

В случае успеха возвращает новый список длины len, а в случае ошибки — NULL.

Примечание

Если len больше нуля, элементы возвращаемого объекта списка устанавливаются в NULL. Поэтому нельзя использовать функции абстрактного API, такие как PySequence_SetItem(), или передавать объект коду Python до тех пор, пока все элементы не будут установлены в реальные объекты с помощью PyList_SetItem() или PyList_SET_ITEM(). До полной инициализации списка безопасно использовать следующие API: PyList_SetItem() и PyList_SET_ITEM().

Py_ssize_t PyList_Size(PyObject *list)

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

Возвращает длину объекта списка в list; это эквивалентно len(list) для объекта списка.

Py_ssize_t PyList_GET_SIZE(PyObject *list)

Аналогично PyList_Size(), но без проверки ошибок.

PyObject *PyList_GetItemRef(PyObject *list, Py_ssize_t index)

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

Возвращает объект в позиции index списка, на который указывает list. Позиция должна быть неотрицательной; индексация с конца списка не поддерживается. Если index выходит за границы (<0 or >=len(list)), возвращает NULL и устанавливает исключение IndexError.

Добавлено в версии 3.13.

PyObject *PyList_GetItem(PyObject *list, Py_ssize_t index)

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

Аналогично PyList_GetItemRef(), но возвращает заимствованную ссылку вместо сильной ссылки.

PyObject *PyList_GET_ITEM(PyObject *list, Py_ssize_t i)

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

Аналогично PyList_GetItem(), но без проверки ошибок.

int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item)

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

Устанавливает элемент item в списке по индексу index. В случае успеха возвращает 0. Если index выходит за границы, возвращает -1 и устанавливает исключение IndexError.

Примечание

Эта функция «забирает» ссылку на item и удаляет ссылку на элемент, находившийся в списке на соответствующей позиции.

void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o)

Макросная форма PyList_SetItem() без проверки ошибок. Обычно используется только для заполнения новых списков, в которых ещё нет элементов.

Проверка границ выполняется как утверждение, если Python собран в режиме отладки или с with assertions.

Примечание

Этот макрос «забирает» ссылку на item и, в отличие от PyList_SetItem(), не удаляет ссылку на заменяемый элемент; любая ссылка на элемент в позиции i списка list будет утрачена.

int PyList_Insert(PyObject *list, Py_ssize_t index, PyObject *item)

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

Вставляет элемент item в список list перед индексом index. В случае успеха возвращает 0; в случае неудачи возвращает -1 и устанавливает исключение. Аналогично list.insert(index, item).

int PyList_Append(PyObject *list, PyObject *item)

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

Добавляет объект item в конец списка list. В случае успеха возвращает 0; в случае неудачи возвращает -1 и устанавливает исключение. Аналогично list.append(item).

PyObject *PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high)

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

Возвращает список объектов из list, содержащий объекты между low и high. В случае неудачи возвращает NULL и устанавливает исключение. Аналогично list[low:high]. Индексация с конца списка не поддерживается.

int PyList_SetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)

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

Заменяет срез list между low и high содержимым itemlist. Аналогично list[low:high] = itemlist. Значение itemlist может быть NULL, что означает присваивание пустого списка (удаление среза). В случае успеха возвращает 0, в случае неудачи — -1. Индексация с конца списка не поддерживается.

int PyList_Extend(PyObject *list, PyObject *iterable)

Расширяет list содержимым iterable. Это то же самое, что PyList_SetSlice(list, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, iterable), и аналогично list.extend(iterable) или list += iterable.

Вызывает исключение и возвращает -1, если list не является объектом list. В случае успеха возвращает 0.

Добавлено в версии 3.13.

int PyList_Clear(PyObject *list)

Удаляет все элементы из list. Это то же самое, что PyList_SetSlice(list, 0, PY_SSIZE_T_MAX, NULL), и аналогично list.clear() или del list[:].

Вызывает исключение и возвращает -1, если list не является объектом list. В случае успеха возвращает 0.

Добавлено в версии 3.13.

int PyList_Sort(PyObject *list)

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

Сортирует элементы list на месте. В случае успеха возвращает 0, в случае неудачи — -1. Эквивалентно list.sort().

int PyList_Reverse(PyObject *list)

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

Разворачивает порядок элементов list на месте. В случае успеха возвращает 0, в случае неудачи — -1. Эквивалентно list.reverse().

PyObject *PyList_AsTuple(PyObject *list)

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

Возвращает новый объект кортежа, содержащий элементы list; эквивалентно tuple(list).