序列协议¶
-
int PySequence_Check(PyObject *o)¶
- 属于稳定 ABI的一部分。
如果对象提供序列协议,则返回
1
,否则返回0
。请注意,对于具有__getitem__()
方法的 Python 类,它会返回1
,除非它们是dict
子类,因为通常无法确定该类支持的键类型。此函数始终成功。
-
Py_ssize_t PySequence_Size(PyObject *o)¶
-
Py_ssize_t PySequence_Length(PyObject *o)¶
- 属于稳定 ABI的一部分。
成功时返回序列 *o* 中的对象数量,失败时返回
-1
。这等效于 Python 表达式len(o)
。
-
PyObject *PySequence_Concat(PyObject *o1, PyObject *o2)¶
- 返回值:新引用。属于稳定 ABI的一部分。
成功时返回 *o1* 和 *o2* 的串联,失败时返回
NULL
。这等效于 Python 表达式o1 + o2
。
-
PyObject *PySequence_Repeat(PyObject *o, Py_ssize_t count)¶
- 返回值:新引用。属于稳定 ABI的一部分。
返回将序列对象 *o* 重复 *count* 次的结果,失败时返回
NULL
。这等效于 Python 表达式o * count
。
-
PyObject *PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)¶
- 返回值:新引用。属于稳定 ABI的一部分。
成功时返回 *o1* 和 *o2* 的串联,失败时返回
NULL
。当 *o1* 支持时,该操作是 *就地* 完成的。这等效于 Python 表达式o1 += o2
。
-
PyObject *PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)¶
- 返回值:新引用。属于稳定 ABI的一部分。
返回将序列对象 *o* 重复 *count* 次的结果,失败时返回
NULL
。当 *o* 支持时,该操作是 *就地* 完成的。这等效于 Python 表达式o *= count
。
-
PyObject *PySequence_GetItem(PyObject *o, Py_ssize_t i)¶
- 返回值:新引用。属于稳定 ABI的一部分。
返回 *o* 的第 *i* 个元素,失败时返回
NULL
。这等效于 Python 表达式o[i]
。
-
PyObject *PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶
- 返回值:新引用。属于稳定 ABI的一部分。
返回序列对象 *o* 中 *i1* 和 *i2* 之间的切片,失败时返回
NULL
。这等效于 Python 表达式o[i1:i2]
。
-
int PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)¶
- 属于稳定 ABI的一部分。
将对象 *v* 赋值给 *o* 的第 *i* 个元素。失败时引发异常并返回
-1
;成功时返回0
。这等效于 Python 语句o[i] = v
。此函数 *不会* 窃取对 *v* 的引用。如果 *v* 是
NULL
,则会删除该元素,但此功能已弃用,建议使用PySequence_DelItem()
。
-
int PySequence_DelItem(PyObject *o, Py_ssize_t i)¶
- 属于稳定 ABI的一部分。
删除对象 *o* 的第 *i* 个元素。失败时返回
-1
。这等效于 Python 语句del o[i]
。
-
int PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)¶
- 属于稳定 ABI的一部分。
将序列对象 v 赋值给序列对象 o 中从 i1 到 i2 的切片。这等价于 Python 语句
o[i1:i2] = v
。
-
int PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶
- 属于稳定 ABI的一部分。
删除序列对象 o 中从 i1 到 i2 的切片。失败时返回
-1
。这等价于 Python 语句del o[i1:i2]
。
-
Py_ssize_t PySequence_Count(PyObject *o, PyObject *value)¶
- 属于稳定 ABI的一部分。
返回 value 在 o 中出现的次数,也就是返回满足
o[key] == value
的键的数量。失败时,返回-1
。这等价于 Python 表达式o.count(value)
。
-
int PySequence_Contains(PyObject *o, PyObject *value)¶
- 属于稳定 ABI的一部分。
确定 o 是否包含 value。如果 o 中的某个项等于 value,则返回
1
,否则返回0
。发生错误时,返回-1
。这等价于 Python 表达式value in o
。
-
Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)¶
- 属于稳定 ABI的一部分。
返回满足
o[i] == value
的第一个索引 i。发生错误时,返回-1
。这等价于 Python 表达式o.index(value)
。
-
PyObject *PySequence_List(PyObject *o)¶
- 返回值:新引用。属于稳定 ABI的一部分。
返回一个列表对象,其内容与序列或可迭代对象 o 相同,或者在失败时返回
NULL
。返回的列表保证是新的。这等价于 Python 表达式list(o)
。
-
PyObject *PySequence_Tuple(PyObject *o)¶
- 返回值:新引用。属于稳定 ABI的一部分。
返回一个元组对象,其内容与序列或可迭代对象 o 相同,或者在失败时返回
NULL
。如果 o 是一个元组,则会返回一个新的引用,否则将构造一个具有适当内容的元组。这等价于 Python 表达式tuple(o)
。
-
PyObject *PySequence_Fast(PyObject *o, const char *m)¶
- 返回值:新引用。属于稳定 ABI的一部分。
将序列或可迭代对象 o 返回为可供其他
PySequence_Fast*
函数系列使用的对象。如果该对象不是序列或可迭代对象,则会引发TypeError
,并使用 m 作为消息文本。失败时返回NULL
。之所以将
PySequence_Fast*
函数这样命名,是因为它们假定 o 是一个PyTupleObject
或一个PyListObject
,并且直接访问 o 的数据字段。作为 CPython 实现的细节,如果 o 已经是一个序列或列表,则会直接返回它。
-
Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)¶
返回 o 的长度,假设 o 是由
PySequence_Fast()
返回的,并且 o 不是NULL
。也可以通过在 o 上调用PySequence_Size()
来检索大小,但是PySequence_Fast_GET_SIZE()
更快,因为它假设 o 是列表或元组。
-
PyObject *PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)¶
- 返回值:借用引用。
返回 o 的第 i 个元素,假设 o 是由
PySequence_Fast()
返回的,o 不是NULL
,并且 i 在边界内。
-
PyObject **PySequence_Fast_ITEMS(PyObject *o)¶
返回 PyObject 指针的底层数组。假设 o 是由
PySequence_Fast()
返回的,并且 o 不是NULL
。请注意,如果列表调整了大小,重新分配可能会重新定位项数组。因此,只能在序列无法更改的上下文中使用底层数组指针。
-
PyObject *PySequence_ITEM(PyObject *o, Py_ssize_t i)¶
- 返回值:新引用。
返回 o 的第 i 个元素,如果失败则返回
NULL
。它是PySequence_GetItem()
的更快形式,但不会检查 o 上PySequence_Check()
是否为真,也不会调整负索引。