Doc/c-api/sequence.rst

   1 .. highlightlang:: c
   2
   3 .. _sequence:
   4
   5 Sequence Protocol
   6 =================
   7
   8
   9 .. cfunction:: int PySequence_Check(PyObject *o)
  10
  11    Return ``1`` if the object provides sequence protocol, and ``0`` otherwise.
  12    This function always succeeds.
  13
  14
  15 .. cfunction:: Py_ssize_t PySequence_Size(PyObject *o)
  16                Py_ssize_t PySequence_Length(PyObject *o)
  17
  18    .. index:: builtin: len
  19
  20    Returns the number of objects in sequence *o* on success, and ``-1`` on failure.
  21    For objects that do not provide sequence protocol, this is equivalent to the
  22    Python expression ``len(o)``.
  23
  24    .. versionchanged:: 2.5
  25       These functions returned an :ctype:`int` type. This might require
  26       changes in your code for properly supporting 64-bit systems.
  27
  28
  29 .. cfunction:: PyObject* PySequence_Concat(PyObject *o1, PyObject *o2)
  30
  31    Return the concatenation of *o1* and *o2* on success, and *NULL* on failure.
  32    This is the equivalent of the Python expression ``o1 + o2``.
  33
  34
  35 .. cfunction:: PyObject* PySequence_Repeat(PyObject *o, Py_ssize_t count)
  36
  37    Return the result of repeating sequence object *o* *count* times, or *NULL* on
  38    failure.  This is the equivalent of the Python expression ``o * count``.
  39
  40    .. versionchanged:: 2.5
  41       This function used an :ctype:`int` type for *count*. This might require
  42       changes in your code for properly supporting 64-bit systems.
  43
  44
  45 .. cfunction:: PyObject* PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)
  46
  47    Return the concatenation of *o1* and *o2* on success, and *NULL* on failure.
  48    The operation is done *in-place* when *o1* supports it.  This is the equivalent
  49    of the Python expression ``o1 += o2``.
  50
  51
  52 .. cfunction:: PyObject* PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
  53
  54    Return the result of repeating sequence object *o* *count* times, or *NULL* on
  55    failure.  The operation is done *in-place* when *o* supports it.  This is the
  56    equivalent of the Python expression ``o *= count``.
  57
  58    .. versionchanged:: 2.5
  59       This function used an :ctype:`int` type for *count*. This might require
  60       changes in your code for properly supporting 64-bit systems.
  61
  62
  63 .. cfunction:: PyObject* PySequence_GetItem(PyObject *o, Py_ssize_t i)
  64
  65    Return the *i*\ th element of *o*, or *NULL* on failure. This is the equivalent of
  66    the Python expression ``o[i]``.
  67
  68    .. versionchanged:: 2.5
  69       This function used an :ctype:`int` type for *i*. This might require
  70       changes in your code for properly supporting 64-bit systems.
  71
  72
  73 .. cfunction:: PyObject* PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
  74
  75    Return the slice of sequence object *o* between *i1* and *i2*, or *NULL* on
  76    failure. This is the equivalent of the Python expression ``o[i1:i2]``.
  77
  78    .. versionchanged:: 2.5
  79       This function used an :ctype:`int` type for *i1* and *i2*. This might
  80       require changes in your code for properly supporting 64-bit systems.
  81
  82
  83 .. cfunction:: int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)
  84
  85    Assign object *v* to the *i*\ th element of *o*.  Returns ``-1`` on failure.  This
  86    is the equivalent of the Python statement ``o[i] = v``.  This function *does
  87    not* steal a reference to *v*.
  88
  89    .. versionchanged:: 2.5
  90       This function used an :ctype:`int` type for *i*. This might require
  91       changes in your code for properly supporting 64-bit systems.
  92
  93
  94 .. cfunction:: int PySequence_DelItem(PyObject *o, Py_ssize_t i)
  95
  96    Delete the *i*\ th element of object *o*.  Returns ``-1`` on failure.  This is the
  97    equivalent of the Python statement ``del o[i]``.
  98
  99    .. versionchanged:: 2.5
 100       This function used an :ctype:`int` type for *i*. This might require
 101       changes in your code for properly supporting 64-bit systems.
 102
 103
 104 .. cfunction:: int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)
 105
 106    Assign the sequence object *v* to the slice in sequence object *o* from *i1* to
 107    *i2*.  This is the equivalent of the Python statement ``o[i1:i2] = v``.
 108
 109    .. versionchanged:: 2.5
 110       This function used an :ctype:`int` type for *i1* and *i2*. This might
 111       require changes in your code for properly supporting 64-bit systems.
 112
 113
 114 .. cfunction:: int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
 115
 116    Delete the slice in sequence object *o* from *i1* to *i2*.  Returns ``-1`` on
 117    failure.  This is the equivalent of the Python statement ``del o[i1:i2]``.
 118
 119    .. versionchanged:: 2.5
 120       This function used an :ctype:`int` type for *i1* and *i2*. This might
 121       require changes in your code for properly supporting 64-bit systems.
 122
 123
 124 .. cfunction:: Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)
 125
 126    Return the number of occurrences of *value* in *o*, that is, return the number
 127    of keys for which ``o[key] == value``.  On failure, return ``-1``.  This is
 128    equivalent to the Python expression ``o.count(value)``.
 129
 130    .. versionchanged:: 2.5
 131       This function returned an :ctype:`int` type. This might require changes
 132       in your code for properly supporting 64-bit systems.
 133
 134
 135 .. cfunction:: int PySequence_Contains(PyObject *o, PyObject *value)
 136
 137    Determine if *o* contains *value*.  If an item in *o* is equal to *value*,
 138    return ``1``, otherwise return ``0``. On error, return ``-1``.  This is
 139    equivalent to the Python expression ``value in o``.
 140
 141
 142 .. cfunction:: Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)
 143
 144    Return the first index *i* for which ``o[i] == value``.  On error, return
 145    ``-1``.    This is equivalent to the Python expression ``o.index(value)``.
 146
 147    .. versionchanged:: 2.5
 148       This function returned an :ctype:`int` type. This might require changes
 149       in your code for properly supporting 64-bit systems.
 150
 151
 152 .. cfunction:: PyObject* PySequence_List(PyObject *o)
 153
 154    Return a list object with the same contents as the arbitrary sequence *o*.  The
 155    returned list is guaranteed to be new.
 156
 157
 158 .. cfunction:: PyObject* PySequence_Tuple(PyObject *o)
 159
 160    .. index:: builtin: tuple
 161
 162    Return a tuple object with the same contents as the arbitrary sequence *o* or
 163    *NULL* on failure.  If *o* is a tuple, a new reference will be returned,
 164    otherwise a tuple will be constructed with the appropriate contents.  This is
 165    equivalent to the Python expression ``tuple(o)``.
 166
 167
 168 .. cfunction:: PyObject* PySequence_Fast(PyObject *o, const char *m)
 169
 170    Returns the sequence *o* as a tuple, unless it is already a tuple or list, in
 171    which case *o* is returned.  Use :cfunc:`PySequence_Fast_GET_ITEM` to access the
 172    members of the result.  Returns *NULL* on failure.  If the object is not a
 173    sequence, raises :exc:`TypeError` with *m* as the message text.
 174
 175
 176 .. cfunction:: PyObject* PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)
 177
 178    Return the *i*\ th element of *o*, assuming that *o* was returned by
 179    :cfunc:`PySequence_Fast`, *o* is not *NULL*, and that *i* is within bounds.
 180
 181    .. versionchanged:: 2.5
 182       This function used an :ctype:`int` type for *i*. This might require
 183       changes in your code for properly supporting 64-bit systems.
 184
 185
 186 .. cfunction:: PyObject** PySequence_Fast_ITEMS(PyObject *o)
 187
 188    Return the underlying array of PyObject pointers.  Assumes that *o* was returned
 189    by :cfunc:`PySequence_Fast` and *o* is not *NULL*.
 190
 191    Note, if a list gets resized, the reallocation may relocate the items array.
 192    So, only use the underlying array pointer in contexts where the sequence
 193    cannot change.
 194
 195    .. versionadded:: 2.4
 196
 197
 198 .. cfunction:: PyObject* PySequence_ITEM(PyObject *o, Py_ssize_t i)
 199
 200    Return the *i*\ th element of *o* or *NULL* on failure. Macro form of
 201    :cfunc:`PySequence_GetItem` but without checking that
 202    :cfunc:`PySequence_Check(o)` is true and without adjustment for negative
 203    indices.
 204
 205    .. versionadded:: 2.3
 206
 207    .. versionchanged:: 2.5
 208       This function used an :ctype:`int` type for *i*. This might require
 209       changes in your code for properly supporting 64-bit systems.
 210
 211
 212 .. cfunction:: Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)
 213
 214    Returns the length of *o*, assuming that *o* was returned by
 215    :cfunc:`PySequence_Fast` and that *o* is not *NULL*.  The size can also be
 216    gotten by calling :cfunc:`PySequence_Size` on *o*, but
 217    :cfunc:`PySequence_Fast_GET_SIZE` is faster because it can assume *o* is a list
 218    or tuple.