Протокол отображения

См. также PyObject_GetItem(), PyObject_SetItem() и PyObject_DelItem().

int PyMapping_Check(PyObject *o)
Часть Стабильный ABI.

Возвращает 1, если объект обеспечивает протокол отображения или поддерживает нарезку, и 0 в противном случае. Обратите внимание, что она возвращает 1 для классов Python с методом __getitem__(), поскольку в общем случае невозможно определить, какой тип ключей поддерживает класс. Эта функция всегда успешна.

Py_ssize_t PyMapping_Size(PyObject *o)
Py_ssize_t PyMapping_Length(PyObject *o)
Часть Стабильный ABI.

Возвращает количество ключей в объекте o в случае успеха и -1 в случае неудачи. Это эквивалентно выражению len(o) в Python.

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 и установите *результат в новый strong reference для соответствующего значения. Если ключ не найден, верните 0 и установите *результат в NULL; KeyError затихает. Если возникла ошибка, отличная от KeyError, верните -1 и установите *результат в 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.

Возвращает 1, если объект отображения имеет ключ key, и 0 в противном случае. Это эквивалентно выражению key in o в Python. В случае неудачи возвращается -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.

Возвращает 1, если объект отображения имеет ключ key, и 0 в противном случае. Это эквивалентно выражению key in o в Python. Эта функция всегда работает успешно.

Примечание

Исключения, возникающие при вызове метода __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: Ранее функция возвращала список или кортеж.