映射协议¶
另请参阅 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 设置为NULL
;KeyError
被静音。如果引发了除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 版本中更改: 以前,该函数返回一个列表或一个元组。