映射协议

另请参阅 PyObject_GetItem()PyObject_SetItem()PyObject_DelItem()

int PyMapping_Check(PyObject *o)
作为 稳定 ABI 的一部分。

如果对象提供映射协议或支持切片,则返回 1,否则返回 0。请注意,它为具有 __getitem__() 方法的 Python 类返回 1,因为通常无法确定该类支持何种类型的键。此函数总是成功的。

Py_ssize_t PyMapping_Size(PyObject *o)
Py_ssize_t PyMapping_Length(PyObject *o)
作为 稳定 ABI 的一部分。

成功时返回对象 o 中的键数,失败时返回 -1。这等同于 Python 表达式 len(o)

PyObject *PyMapping_GetItemString(PyObject *o, const char *key)
返回值: 新引用。 稳定ABI 的一部分。

这与 PyObject_GetItem() 相同,但 key 指定为 const char* UTF-8 编码字节字符串,而不是 PyObject*

int PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)
自 3.13 版本起成为 稳定 ABI 的一部分。

PyObject_GetItem() 的变体,如果未找到键,则不引发 KeyError

如果找到键,则返回 1 并将 *result 设置为指向相应值的新 强引用。如果未找到键,则返回 0 并将 *result 设置为 NULLKeyError 被静默。如果引发了除 KeyError 之外的错误,则返回 -1 并将 *result 设置为 NULL

在 3.13 版本加入。

int PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **result)
自 3.13 版本起成为 稳定 ABI 的一部分。

这与 PyMapping_GetOptionalItem() 相同,但 key 指定为 const char* UTF-8 编码字节字符串,而不是 PyObject*

在 3.13 版本加入。

int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)
作为 稳定 ABI 的一部分。

这与 PyObject_SetItem() 相同,但 key 指定为 const char* UTF-8 编码字节字符串,而不是 PyObject*

int PyMapping_DelItem(PyObject *o, PyObject *key)

这是 PyObject_DelItem() 的别名。

int PyMapping_DelItemString(PyObject *o, const char *key)

这与 PyObject_DelItem() 相同,但 key 指定为 const char* UTF-8 编码字节字符串,而不是 PyObject*

int PyMapping_HasKeyWithError(PyObject *o, PyObject *key)
自 3.13 版本起成为 稳定 ABI 的一部分。

如果映射对象具有键 key,则返回 1,否则返回 0。这等同于 Python 表达式 key in o。失败时,返回 -1

在 3.13 版本加入。

int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)
自 3.13 版本起成为 稳定 ABI 的一部分。

这与 PyMapping_HasKeyWithError() 相同,但 key 指定为 const char* UTF-8 编码字节字符串,而不是 PyObject*

在 3.13 版本加入。

int PyMapping_HasKey(PyObject *o, PyObject *key)
作为 稳定 ABI 的一部分。

如果映射对象具有键 key,则返回 1,否则返回 0。这等同于 Python 表达式 key in o。此函数总是成功的。

备注

当此调用 __getitem__() 方法时发生的异常被静默忽略。为了正确处理错误,请改用 PyMapping_HasKeyWithError()PyMapping_GetOptionalItem()PyObject_GetItem()

int PyMapping_HasKeyString(PyObject *o, const char *key)
作为 稳定 ABI 的一部分。

这与 PyMapping_HasKey() 相同,但 key 指定为 const char* UTF-8 编码字节字符串,而不是 PyObject*

备注

当此调用 __getitem__() 方法或创建临时 str 对象时发生的异常被静默忽略。为了正确处理错误,请改用 PyMapping_HasKeyStringWithError()PyMapping_GetOptionalItemString()PyMapping_GetItemString()

PyObject *PyMapping_Keys(PyObject *o)
返回值: 新引用。 稳定ABI 的一部分。

成功时,返回对象 o 中键的列表。失败时,返回 NULL

3.7 版本中的变化: 以前,该函数返回一个列表或一个元组。

PyObject *PyMapping_Values(PyObject *o)
返回值: 新引用。 稳定ABI 的一部分。

成功时,返回对象 o 中值的列表。失败时,返回 NULL

3.7 版本中的变化: 以前,该函数返回一个列表或一个元组。

PyObject *PyMapping_Items(PyObject *o)
返回值: 新引用。 稳定ABI 的一部分。

成功时,返回对象 o 中项目的列表,其中每个项目都是一个包含键值对的元组。失败时,返回 NULL

3.7 版本中的变化: 以前,该函数返回一个列表或一个元组。