FM / c-api

/usr/share/doc/python2-docs/html/_sources/c-api/

/usr/share/doc/python2-docs/html/_sources/c-api

Name	Size	Mode	Actions
abstract.rst.txt	702	0644	edit dl rm
allocation.rst.txt	4796	0644	edit dl rm
arg.rst.txt	26004	0644	edit dl rm
bool.rst.txt	1304	0644	edit dl rm
buffer.rst.txt	22965	0644	edit dl rm
bytearray.rst.txt	2181	0644	edit dl rm
capsule.rst.txt	5741	0644	edit dl rm
cell.rst.txt	1940	0644	edit dl rm
class.rst.txt	1866	0644	edit dl rm
cobject.rst.txt	1870	0644	edit dl rm
code.rst.txt	1635	0644	edit dl rm
codec.rst.txt	4643	0644	edit dl rm
complex.rst.txt	4079	0644	edit dl rm
concrete.rst.txt	1963	0644	edit dl rm
conversion.rst.txt	7092	0644	edit dl rm
datetime.rst.txt	6413	0644	edit dl rm
descriptor.rst.txt	1296	0644	edit dl rm
dict.rst.txt	7757	0644	edit dl rm
exceptions.rst.txt	35304	0644	edit dl rm
file.rst.txt	6198	0644	edit dl rm
float.rst.txt	3371	0644	edit dl rm
function.rst.txt	2421	0644	edit dl rm
gcsupport.rst.txt	6587	0644	edit dl rm
gen.rst.txt	920	0644	edit dl rm
import.rst.txt	11221	0644	edit dl rm
index.rst.txt	578	0644	edit dl rm
init.rst.txt	49160	0644	edit dl rm
int.rst.txt	4578	0644	edit dl rm
intro.rst.txt	28473	0644	edit dl rm
iter.rst.txt	1390	0644	edit dl rm
iterator.rst.txt	1796	0644	edit dl rm
list.rst.txt	6362	0644	edit dl rm
long.rst.txt	7987	0644	edit dl rm
mapping.rst.txt	2874	0644	edit dl rm
marshal.rst.txt	3985	0644	edit dl rm
memory.rst.txt	11556	0644	edit dl rm
method.rst.txt	2099	0644	edit dl rm
module.rst.txt	3867	0644	edit dl rm
none.rst.txt	697	0644	edit dl rm
number.rst.txt	11939	0644	edit dl rm
objbuffer.rst.txt	2516	0644	edit dl rm
object.rst.txt	17491	0644	edit dl rm
objimpl.rst.txt	305	0644	edit dl rm
refcounting.rst.txt	2934	0644	edit dl rm
reflection.rst.txt	1567	0644	edit dl rm
sequence.rst.txt	8716	0644	edit dl rm
set.rst.txt	6588	0644	edit dl rm
slice.rst.txt	2979	0644	edit dl rm
string.rst.txt	15422	0644	edit dl rm
structures.rst.txt	14966	0644	edit dl rm
sys.rst.txt	5714	0644	edit dl rm
tuple.rst.txt	5491	0644	edit dl rm
type.rst.txt	2761	0644	edit dl rm
typeobj.rst.txt	66936	0644	edit dl rm
unicode.rst.txt	45126	0644	edit dl rm
utilities.rst.txt	415	0644	edit dl rm
veryhigh.rst.txt	13363	0644	edit dl rm
weakref.rst.txt	2820	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/c-api/list.rst.txt (6362B)

.. highlightlang:: c

.. _listobjects:

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

.. index:: object: list

.. c:type:: PyListObject

This subtype of :c:type:`PyObject` represents a Python list object.

.. c:var:: PyTypeObject PyList_Type

This instance of :c:type:`PyTypeObject` represents the Python list type.  This
   is the same object as ``list`` in the Python layer.

.. c:function:: int PyList_Check(PyObject *p)

Return true if *p* is a list object or an instance of a subtype of the list
   type.

.. versionchanged:: 2.2
      Allowed subtypes to be accepted.

.. c:function:: int PyList_CheckExact(PyObject *p)

Return true if *p* is a list object, but not an instance of a subtype of
   the list type.

.. versionadded:: 2.2

.. c:function:: PyObject* PyList_New(Py_ssize_t len)

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
      :c:func:`PySequence_SetItem`  or expose the object to Python code before
      setting all items to a real object with :c:func:`PyList_SetItem`.

.. versionchanged:: 2.5
      This function used an :c:type:`int` for *size*. This might require
      changes in your code for properly supporting 64-bit systems.

.. c:function:: Py_ssize_t PyList_Size(PyObject *list)

.. index:: builtin: len

Return the length of the list object in *list*; this is equivalent to
   ``len(list)`` on a list object.

.. versionchanged:: 2.5
      This function returned an :c:type:`int`. This might require changes in
      your code for properly supporting 64-bit systems.

.. c:function:: Py_ssize_t PyList_GET_SIZE(PyObject *list)

Macro form of :c:func:`PyList_Size` without error checking.

.. versionchanged:: 2.5
      This macro returned an :c:type:`int`. This might require changes in your
      code for properly supporting 64-bit systems.

.. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index)

Return the object at position *index* in the list pointed to by *list*.  The
   position must be positive, indexing from the end of the list is not
   supported.  If *index* is out of bounds, return *NULL* and set an
   :exc:`IndexError` exception.

.. versionchanged:: 2.5
      This function used an :c:type:`int` for *index*. This might require
      changes in your code for properly supporting 64-bit systems.

.. c:function:: PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i)

Macro form of :c:func:`PyList_GetItem` without error checking.

.. versionchanged:: 2.5
      This macro used an :c:type:`int` for *i*. This might require changes in
      your code for properly supporting 64-bit systems.

.. c:function:: int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item)

Set the item at index *index* in list to *item*.  Return ``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.

.. versionchanged:: 2.5
      This function used an :c:type:`int` for *index*. This might require
      changes in your code for properly supporting 64-bit systems.

.. c:function:: void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o)

Macro form of :c:func:`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
      :c:func:`PyList_SetItem`, does *not* discard a reference to any item that
      it being replaced; any reference in *list* at position *i* will be
      leaked.

.. versionchanged:: 2.5
      This macro used an :c:type:`int` for *i*. This might require
      changes in your code for properly supporting 64-bit systems.

.. c:function:: int PyList_Insert(PyObject *list, Py_ssize_t index, PyObject *item)

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)``.

.. versionchanged:: 2.5
      This function used an :c:type:`int` for *index*. This might require
      changes in your code for properly supporting 64-bit systems.

.. c:function:: int PyList_Append(PyObject *list, PyObject *item)

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)``.

.. c:function:: PyObject* PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high)

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]``.  Negative indices, as when slicing from Python, are not
   supported.

.. versionchanged:: 2.5
      This function used an :c:type:`int` for *low* and *high*. This might
      require changes in your code for properly supporting 64-bit systems.

.. c:function:: int PyList_SetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)

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.  Negative indices, as when
   slicing from Python, are not supported.

.. versionchanged:: 2.5
      This function used an :c:type:`int` for *low* and *high*. This might
      require changes in your code for properly supporting 64-bit systems.

.. c:function:: int PyList_Sort(PyObject *list)

Sort the items of *list* in place.  Return ``0`` on success, ``-1`` on
   failure.  This is equivalent to ``list.sort()``.

.. c:function:: int PyList_Reverse(PyObject *list)

Reverse the items of *list* in place.  Return ``0`` on success, ``-1`` on
   failure.  This is the equivalent of ``list.reverse()``.

.. c:function:: PyObject* PyList_AsTuple(PyObject *list)

.. index:: builtin: tuple

Return a new tuple object containing the contents of *list*; equivalent to
   ``tuple(list)``.

cmd: