PyList_Type
This instance of PyTypeObject
represents the Python list type. This is the same object as list
in the Python layer.
PyList_Check
Return true if p is a list object or an instance of a subtype of the list type.
PyList_CheckExact
Return true if p is a list object, but not an instance of a subtype of the list type.
PyList_New
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 PySequence_SetItem()
or expose the object to Python code before setting all items to a real object with PyList_SetItem()
.
PyList_Size
Return the length of the list object in list; this is equivalent to len(list)
on a list object.
PyList_GET_SIZE
Macro form of PyList_Size()
without error checking.
PyList_GetItem
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 (<0 or >=len(list)), return NULL
and set an IndexError
exception.
PyList_GET_ITEM
Macro form of PyList_GetItem()
without error checking.
PyList_SetItem
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 IndexError
exception.
Note
This function 'steals? a reference to item and discards a reference to an item already in the list at the affected position.
PyList_SET_ITEM
Macro form of PyList_SetItem()
without error checking. This is normally only used to fill in new lists where there is no previous content.
Note
This macro 'steals? a reference to item, and, unlike PyList_SetItem()
, does not discard a reference to any item that is being replaced; any reference in list at position i will be leaked.
PyList_Insert
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)
.
PyList_Append
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
Return a list of the objects in list containing the objects between low 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.
PyList_SetSlice
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.
PyList_Sort
Sort the items of list in place. Return 0
on success, -1
on failure. This is equivalent to list.sort()
.
PyList_Reverse
Reverse the items of list in place. Return 0
on success, -1
on failure. This is the equivalent of list.reverse()
.
PyList_AsTuple
Return a new tuple object containing the contents of list; equivalent to tuple(list)
.
PyList_ClearFreeList
Clear the free list. Return the total number of freed items.
New in version 3.3.