Sequence Protocol¶
-
int PySequence_Check(PyObject *o)¶
- Część stabilnego ABI.
Return
1
if the object provides the sequence protocol, and0
otherwise. Note that it returns1
for Python classes with a__getitem__()
method, unless they aredict
subclasses, since in general it is impossible to determine what type of keys the class supports. This function always succeeds.
-
Py_ssize_t PySequence_Size(PyObject *o)¶
-
Py_ssize_t PySequence_Length(PyObject *o)¶
- Część stabilnego ABI.
Returns the number of objects in sequence o on success, and
-1
on failure. This is equivalent to the Python expressionlen(o)
.
-
PyObject *PySequence_Concat(PyObject *o1, PyObject *o2)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the concatenation of o1 and o2 on success, and
NULL
on failure. This is the equivalent of the Python expressiono1 + o2
.
-
PyObject *PySequence_Repeat(PyObject *o, Py_ssize_t count)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the result of repeating sequence object o count times, or
NULL
on failure. This is the equivalent of the Python expressiono * count
.
-
PyObject *PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the concatenation of o1 and o2 on success, and
NULL
on failure. The operation is done in-place when o1 supports it. This is the equivalent of the Python expressiono1 += o2
.
-
PyObject *PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the result of repeating sequence object o count times, or
NULL
on failure. The operation is done in-place when o supports it. This is the equivalent of the Python expressiono *= count
.
-
PyObject *PySequence_GetItem(PyObject *o, Py_ssize_t i)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the ith element of o, or
NULL
on failure. This is the equivalent of the Python expressiono[i]
.
-
PyObject *PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the slice of sequence object o between i1 and i2, or
NULL
on failure. This is the equivalent of the Python expressiono[i1:i2]
.
-
int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)¶
- Część stabilnego ABI.
Assign object v to the ith element of o. Raise an exception and return
-1
on failure; return0
on success. This is the equivalent of the Python statemento[i] = v
. This function does not steal a reference to v.If v is
NULL
, the element is deleted, but this feature is deprecated in favour of usingPySequence_DelItem()
.
-
int PySequence_DelItem(PyObject *o, Py_ssize_t i)¶
- Część stabilnego ABI.
Delete the ith element of object o. Returns
-1
on failure. This is the equivalent of the Python statementdel o[i]
.
-
int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)¶
- Część stabilnego ABI.
Assign the sequence object v to the slice in sequence object o from i1 to i2. This is the equivalent of the Python statement
o[i1:i2] = v
.
-
int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶
- Część stabilnego ABI.
Delete the slice in sequence object o from i1 to i2. Returns
-1
on failure. This is the equivalent of the Python statementdel o[i1:i2]
.
-
Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)¶
- Część stabilnego ABI.
Return the number of occurrences of value in o, that is, return the number of keys for which
o[key] == value
. On failure, return-1
. This is equivalent to the Python expressiono.count(value)
.
-
int PySequence_Contains(PyObject *o, PyObject *value)¶
- Część stabilnego ABI.
Determine if o contains value. If an item in o is equal to value, return
1
, otherwise return0
. On error, return-1
. This is equivalent to the Python expressionvalue in o
.
-
Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)¶
- Część stabilnego ABI.
Return the first index i for which
o[i] == value
. On error, return-1
. This is equivalent to the Python expressiono.index(value)
.
-
PyObject *PySequence_List(PyObject *o)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return a list object with the same contents as the sequence or iterable o, or
NULL
on failure. The returned list is guaranteed to be new. This is equivalent to the Python expressionlist(o)
.
-
PyObject *PySequence_Tuple(PyObject *o)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return a tuple object with the same contents as the sequence or iterable o, or
NULL
on failure. If o is a tuple, a new reference will be returned, otherwise a tuple will be constructed with the appropriate contents. This is equivalent to the Python expressiontuple(o)
.
-
PyObject *PySequence_Fast(PyObject *o, const char *m)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return the sequence or iterable o as an object usable by the other
PySequence_Fast*
family of functions. If the object is not a sequence or iterable, raisesTypeError
with m as the message text. ReturnsNULL
on failure.The
PySequence_Fast*
functions are thus named because they assume o is aPyTupleObject
or aPyListObject
and access the data fields of o directly.As a CPython implementation detail, if o is already a sequence or list, it will be returned.
-
Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)¶
Returns the length of o, assuming that o was returned by
PySequence_Fast()
and that o is notNULL
. The size can also be retrieved by callingPySequence_Size()
on o, butPySequence_Fast_GET_SIZE()
is faster because it can assume o is a list or tuple.
-
PyObject *PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)¶
- Wartość zwracana: pożyczona referencja.
Return the ith element of o, assuming that o was returned by
PySequence_Fast()
, o is notNULL
, and that i is within bounds.
-
PyObject **PySequence_Fast_ITEMS(PyObject *o)¶
Return the underlying array of PyObject pointers. Assumes that o was returned by
PySequence_Fast()
and o is notNULL
.Note, if a list gets resized, the reallocation may relocate the items array. So, only use the underlying array pointer in contexts where the sequence cannot change.
-
PyObject *PySequence_ITEM(PyObject *o, Py_ssize_t i)¶
- Wartość zwracana: nowa referencja.
Return the ith element of o or
NULL
on failure. Faster form ofPySequence_GetItem()
but without checking thatPySequence_Check()
on o is true and without adjustment for negative indices.