PySequence_Check
Return 1
if the object provides sequence protocol, and 0
otherwise. Note that it returns 1
for Python classes with a __getitem__()
method unless they are dict
subclasses since in general case it is impossible to determine what the type of keys it supports. This function always succeeds.
PySequence_Size
PySequence_Length
Returns the number of objects in sequence o on success, and -1
on failure. This is equivalent to the Python expression len(o)
.
PySequence_Concat
Return the concatenation of o1 and o2 on success, and NULL
on failure. This is the equivalent of the Python expression o1 + o2
.
PySequence_Repeat
Return the result of repeating sequence object o count times, or NULL
on failure. This is the equivalent of the Python expression o * count
.
PySequence_InPlaceConcat
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 expression o1 += o2
.
PySequence_InPlaceRepeat
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 expression o *= count
.
PySequence_GetItem
Return the ith element of o, or NULL
on failure. This is the equivalent of the Python expression o[i]
.
PySequence_GetSlice
Return the slice of sequence object o between i1 and i2, or NULL
on failure. This is the equivalent of the Python expression o[i1:i2]
.
PySequence_SetItem
Assign object v to the ith element of o. Raise an exception and return -1
on failure; return 0
on success. This is the equivalent of the Python statement o[i] = v
. This function does not steal a reference to v.
If v is NULL
, the element is deleted, however this feature is deprecated in favour of using PySequence_DelItem()
.
PySequence_DelItem
Delete the ith element of object o. Returns -1
on failure. This is the equivalent of the Python statement del o[i]
.
PySequence_SetSlice
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
.
PySequence_DelSlice
Delete the slice in sequence object o from i1 to i2. Returns -1
on failure. This is the equivalent of the Python statement del o[i1:i2]
.
PySequence_Count
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 expression o.count(value)
.
PySequence_Contains
Determine if o contains value. If an item in o is equal to value, return 1
, otherwise return 0
. On error, return -1
. This is equivalent to the Python expression value in o
.
PySequence_Index
Return the first index i for which o[i] == value
. On error, return -1
. This is equivalent to the Python expression o.index(value)
.
PySequence_List
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 expression list(o)
.
PySequence_Tuple
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 expression tuple(o)
.
PySequence_Fast
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, raises TypeError
with m as the message text. Returns NULL
on failure.
The PySequence_Fast*
functions are thus named because they assume o is a PyTupleObject
or a PyListObject
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.
PySequence_Fast_GET_SIZE
Returns the length of o, assuming that o was returned by PySequence_Fast()
and that o is not NULL
. The size can also be gotten by calling PySequence_Size()
on o, but PySequence_Fast_GET_SIZE()
is faster because it can assume o is a list or tuple.
PySequence_Fast_GET_ITEM
Return the ith element of o, assuming that o was returned by PySequence_Fast()
, o is not NULL
, and that i is within bounds.
PySequence_Fast_ITEMS
Return the underlying array of PyObject pointers. Assumes that o was returned by PySequence_Fast()
and o is not NULL
.
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.
PySequence_ITEM
Return the ith element of o or NULL
on failure. Faster form of PySequence_GetItem()
but without checking that PySequence_Check()
on o is true and without adjustment for negative indices.