Объекты списков

PyTypeObject PyList_Type: Эта инстанция 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): Значение возврата: Новая ссылка.
Возвращает новый список длины len при успехе или NULL при ошибке.

Примечание

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

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

Py_ssize_t PyList_GET_SIZE(PyObject *list): Макроформа PyList_Size() без проверки ошибок.

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

PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i): Значение возврата: Заимствованная ссылка.
Макроформа PyList_GetItem() без проверки ошибок.

int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item): Устанавливает элемент в индексе index в списке на item. Возвращает 0 при успехе. Если index выходит за пределы допустимого диапазона, возвращает -1 и устанавливает исключение IndexError.

Примечание

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

void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o): Макроформа PyList_SetItem() без проверки ошибок. Обычно используется только для заполнения новых списков, где нет предыдущего содержимого.

Примечание

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

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

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

PyObject* PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high): Значение возврата: Новая ссылка.
Возвращает список объектов в list, содержащих объекты между low и high. Возвращает NULL и устанавливает исключение в случае неудачи. Аналогично list[low:high]. Индексирование с конца списка не поддерживается.

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

int PyList_Sort(PyObject *list): Сортирует элементы list на месте. Возвращает 0 при успехе, -1 при ошибке. Это эквивалентно list.sort().

int PyList_Reverse(PyObject *list): Обращает элементы list на месте. Возвращает 0 при успехе, -1 при ошибке. Это эквивалентно list.reverse().

PyObject* PyList_AsTuple(PyObject *list): Значение возврата: Новая ссылка.
Возвращает новый кортеж, содержащий содержимое list; эквивалентно tuple(list).

int PyList_ClearFreeList(): Очищает список свободных объектов. Возвращает общее количество освобожденных элементов.

Введено в версии 3.3.