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

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

int PyMapping_Check(PyObject *o)¶

Часть Stable ABI.

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

Py_ssize_t PyMapping_Size(PyObject *o)¶

Py_ssize_t PyMapping_Length(PyObject *o)¶

Часть Stable ABI.

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

PyObject *PyMapping_GetItemString(PyObject *o, const char *key)¶

Возвращаемое значение: новая ссылка. Часть Stable ABI.

То же, что и PyObject_GetItem(), но key задаётся как const char* строка байтов в кодировке UTF-8, а не как PyObject*.

int PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)¶

Часть Stable ABI, начиная с версии 3.13.

Вариант 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)¶

Часть Stable ABI, начиная с версии 3.13.

То же, что и PyMapping_GetOptionalItem(), но key задаётся как const char* строка байтов в кодировке UTF-8, а не как PyObject*.

Добавлено в версии 3.13.

int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)¶

Часть Stable 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)¶

Часть Stable ABI, начиная с версии 3.13.

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

Добавлено в версии 3.13.

int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)¶

Часть Stable ABI, начиная с версии 3.13.

То же, что и PyMapping_HasKeyWithError(), но key задаётся как const char* строка байтов в кодировке UTF-8, а не как PyObject*.

Добавлено в версии 3.13.

int PyMapping_HasKey(PyObject *o, PyObject *key)¶

Часть Stable ABI.

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

Примечание

Исключения, возникающие при вызове метода __getitem__(), молча игнорируются. Для правильной обработки ошибок используйте PyMapping_HasKeyWithError(), PyMapping_GetOptionalItem() или PyObject_GetItem().

int PyMapping_HasKeyString(PyObject *o, const char *key)¶

Часть Stable ABI.

То же, что и PyMapping_HasKey(), но key задаётся как const char* строка байтов в кодировке UTF-8, а не как PyObject*.

Примечание

Исключения, возникающие при вызове метода __getitem__() или при создании временного объекта str, молча игнорируются. Для правильной обработки ошибок используйте PyMapping_HasKeyStringWithError(), PyMapping_GetOptionalItemString() или PyMapping_GetItemString().

PyObject *PyMapping_Keys(PyObject *o)¶

Возвращаемое значение: новая ссылка. Часть Stable ABI.

В случае успеха возвращает список ключей в объекте o. В случае ошибки возвращает NULL.

Изменено в версии 3.7: Ранее функция возвращала список или кортеж.

PyObject *PyMapping_Values(PyObject *o)¶

Возвращаемое значение: новая ссылка. Часть Stable ABI.

В случае успеха возвращает список значений в объекте o. В случае ошибки возвращает NULL.

Изменено в версии 3.7: Ранее функция возвращала список или кортеж.

PyObject *PyMapping_Items(PyObject *o)¶

Возвращаемое значение: новая ссылка. Часть Stable ABI.

В случае успеха возвращает список элементов объекта o, где каждый элемент – это кортеж, содержащий пару ключ-значение. В случае неудачи возвращает NULL.

Изменено в версии 3.7: Ранее функция возвращала список или кортеж.