映射协议¶
参见 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)¶
- 属于 稳定 ABI 自 3.13 版起.
PyObject_GetItem()
的变化形式,它在未找到键时不会引发KeyError
。如果找到了键,则返回
1
并将 *result 设为指向相应值的新 strong reference。 如果未找到键,则返回0
并将 *result 设为NULL
;KeyError
会被静默。 如果引发了KeyError
以外的错误,则返回-1
并将 *result 设为NULL
。Added in version 3.13.
-
int PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **result)¶
- 属于 稳定 ABI 自 3.13 版起.
这与
PyMapping_GetOptionalItem()
相同,但 key 被指定为 const char* UTF-8 编码的字节串,而不是 PyObject*。Added in version 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)¶
- 属于 稳定 ABI 自 3.13 版起.
如果映射对象具有键 key 则返回
1
,否则返回0
。 这相当于 Python 表达式key in o
。 当失败时,将返回-1
。Added in version 3.13.
-
int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)¶
- 属于 稳定 ABI 自 3.13 版起.
这与
PyMapping_HasKeyWithError()
相同,但 key 被指定为 const char* UTF-8 编码的字节串,而不是 PyObject*。Added in version 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 版本发生变更: 在之前版本中,此函数返回一个列表或元组。