typePyListObject
This subtype of
represents a Python list object.
PyList_Type
Part of the
.This instance of
represents the Python list type. This is the same object as
in the Python layer.
intPyList_Check(
*p)
Thread safety:
.Return true if p is a list object or an instance of a subtype of the list type. This function always succeeds.
intPyList_CheckExact(
*p)
Thread safety:
.Return true if p is a list object, but not an instance of a subtype of the list type. This function always succeeds.
*PyList_New(
len)
Return value: New reference. Part of the
. Thread safety:
.Return a new list of length len on success, or NULL on failure.
Note
If len is greater than zero, the returned list object’s items are set to NULL. Thus you cannot use abstract API functions such as
or expose the object to Python code before setting all items to a real object with
or
. The following APIs are safe APIs before the list is fully initialized: PyList_SetItem() and PyList_SET_ITEM().
PyList_Size(
*list)
Part of the
. Thread safety:
.Return the length of the list object in list; this is equivalent to len(list) on a list object.
PyList_GET_SIZE(
*list)
Thread safety:
.Similar to
, but without error checking.
*PyList_GetItemRef(
*list,
index)
Return value: New reference. Part of the
since version 3.13. Thread safety:
.Return the object at position index in the list pointed to by list. The position must be non-negative; indexing from the end of the list is not supported. If index is out of bounds (<0or>=len(list)), return NULL and set an
exception.
Added in version 3.13.
*PyList_GetItem(
*list,
index)
Return value: Borrowed reference. Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.Like
, but returns a
instead of a
.
*PyList_GET_ITEM(
*list,
i)
Return value: Borrowed reference. Thread safety:
Safe to call from multiple threads with external synchronization only
.Similar to
, but without error checking.
intPyList_SetItem(
*list,
index,
*item)
Part of the
. Thread safety:
.Set the item at index index in list to item. Return 0 on success. If index is out of bounds, return -1 and set an
exception.
Note
This function “
” a reference to item, even on error. On success, it discards a reference to an item already in the list at the affected position (unless it was NULL).
voidPyList_SET_ITEM(
*list,
i,
*o)
Thread safety:
Safe to call from multiple threads with external synchronization only
.Macro form of
without error checking. This is normally only used to fill in new lists where there is no previous content.
Bounds checking is performed as an assertion if Python is built in
or
.
Note
This macro “
” a reference to item, and, unlike
, does not discard a reference to any item that is being replaced; any reference in list at position i will be leaked.
Note
In the
, this macro has no internal synchronization. It is normally only used to fill in new lists where no other thread has a reference to the list. If the list may be shared, use
instead, which uses a
.
intPyList_Insert(
*list,
index,
*item)
Part of the
. Thread safety:
Safe for concurrent use on the same object
.Insert the item item into list list in front of index index. Return 0 if successful; return -1 and set an exception if unsuccessful. Analogous to list.insert(index,item).
intPyList_Append(
*list,
*item)
Part of the
. Thread safety:
.Append the object item at the end of list list. Return 0 if successful; return -1 and set an exception if unsuccessful. Analogous to list.append(item).
*PyList_GetSlice(
*list,
low,
high)
Return value: New reference. Part of the
. Thread safety:
.Return a list of the objects in list containing the objects betweenlow and high. Return NULL and set an exception if unsuccessful. Analogous to list[low:high]. Indexing from the end of the list is not supported.
intPyList_SetSlice(
*list,
low,
high,
*itemlist)
Part of the
. Thread safety:
Safe for concurrent use on the same object
.Set the slice of list between low and high to the contents of itemlist. Analogous to list[low:high]=itemlist. The itemlist may be NULL, indicating the assignment of an empty list (slice deletion). Return 0 on success, -1 on failure. Indexing from the end of the list is not supported.
Note
In the
, when itemlist is a
, both list and itemlist are locked for the duration of the operation. For other iterables (or NULL), only list is locked.
intPyList_Extend(
*list,
*iterable)
Thread safety:
Safe for concurrent use on the same object
.Extend list with the contents of iterable. This is the same as PyList_SetSlice(list,PY_SSIZE_T_MAX,PY_SSIZE_T_MAX,iterable) and analogous to list.extend(iterable) or list+=iterable.
Raise an exception and return -1 if list is not a
object. Return 0 on success.
Added in version 3.13.
Note
In the
, when iterable is a
,
,
, or dict view, both list and iterable (or its underlying dict) are locked for the duration of the operation. For other iterables, only list is locked; iterable may be concurrently modified by another thread.
intPyList_Clear(
*list)
Thread safety:
.Remove all items from list. This is the same as PyList_SetSlice(list,0,PY_SSIZE_T_MAX,NULL) and analogous to list.clear() or dellist[:].
Raise an exception and return -1 if list is not a
object. Return 0 on success.
Added in version 3.13.
intPyList_Sort(
*list)
Part of the
. Thread safety:
Safe for concurrent use on the same object
.Sort the items of list in place. Return 0 on success, -1 on failure. This is equivalent to list.sort().
intPyList_Reverse(
*list)
Part of the
. Thread safety:
Safe for concurrent use on the same object
.Reverse the items of list in place. Return 0 on success, -1 on failure. This is the equivalent of list.reverse().
*PyList_AsTuple(
*list)
Return value: New reference. Part of the
. Thread safety:
.Return a new tuple object containing the contents of list; equivalent to tuple(list).