GNU Info

(python2.1-api.info)List Objects

---

Prev: Tuple Objects Up: Sequence Objects

---

Enter node , (file) or (file)node

List Objects
------------

`PyListObject'
     This subtype of `PyObject' represents a Python list object.

`PyTypeObject PyList_Type'
     This instance of `PyTypeObject' represents the Python list type.
     This is the same object as `types.ListType'.

`int PyList_Check(PyObject *p)'
     Returns true if its argument is a `PyListObject'.

`PyObject* PyList_New(int len)'
     Returns a new list of length LEN on success, or `NULL' on failure.

`int PyList_Size(PyObject *list)'
     Returns the length of the list object in LIST; this is equivalent
     to `len(LIST)' on a list object.

`int PyList_GET_SIZE(PyObject *list)'
     Macro form of `PyList_Size()' without error checking.

`PyObject* PyList_GetItem(PyObject *list, int index)'
     Returns the object at position POS in the list pointed to by P.
     If POS is out of bounds, returns `NULL' and sets an `IndexError'
     exception.

`PyObject* PyList_GET_ITEM(PyObject *list, int i)'
     Macro form of `PyList_GetItem()' without error checking.

`int PyList_SetItem(PyObject *list, int index, PyObject *item)'
     Sets the item at index INDEX in list to ITEM.  Returns `0' on
     success or `-1' on failure.  *Note:*  This function "steals" a
     reference to ITEM and discards a reference to an item already in
     the list at the affected position.

`void PyList_SET_ITEM(PyObject *list, int i, PyObject *o)'
     Macro form of `PyList_SetItem()' without error checking.  *Note:*
     This function "steals" a reference to ITEM, and, unlike
     `PyList_SetItem()', does _not_ discard a reference to any item
     that it being replaced; any reference in LIST at position I will
     be leaked.  This is normally only used to fill in new lists where
     there is no previous content.

`int PyList_Insert(PyObject *list, int index, PyObject *item)'
     Inserts the item ITEM into list LIST in front of index INDEX.
     Returns `0' if successful; returns `-1' and raises an exception if
     unsuccessful.  Analogous to `LIST.insert(INDEX, ITEM)'.

`int PyList_Append(PyObject *list, PyObject *item)'
     Appends the object ITEM at the end of list LIST.  Returns `0' if
     successful; returns `-1' and sets an exception if unsuccessful.
     Analogous to `LIST.append(ITEM)'.

`PyObject* PyList_GetSlice(PyObject *list, int low, int high)'
     Returns a list of the objects in LIST containing the objects
     _between_ LOW and HIGH.  Returns NULL and sets an exception if
     unsuccessful.  Analogous to `LIST[LOW:HIGH]'.

`int PyList_SetSlice(PyObject *list, int low, int high, PyObject *itemlist)'
     Sets the slice of LIST between LOW and HIGH to the contents of
     ITEMLIST.  Analogous to `LIST[LOW:HIGH] = ITEMLIST'.  Returns `0'
     on success, `-1' on failure.

`int PyList_Sort(PyObject *list)'
     Sorts the items of LIST in place.  Returns `0' on success, `-1' on
     failure.  This is equivalent to `LIST.sort()'.

`int PyList_Reverse(PyObject *list)'
     Reverses the items of LIST in place.  Returns `0' on success, `-1'
     on failure.  This is the equivalent of `LIST.reverse()'.

`PyObject* PyList_AsTuple(PyObject *list)'
     Returns a new tuple object containing the contents of LIST;
     equivalent to `tuple(LIST)'.