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

См. также 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 при ошибке. Это эквивалентно выражению Python len(o).

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

Значение возврата: новая ссылка. Часть Стабильной ABI.

Это то же самое, что PyObject_GetItem(), но key задается как строка UTF-8 const char*, а не как PyObject*.

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

Часть Стабильной 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)

Часть Стабильной ABI с версии 3.13.

Это то же самое, что PyMapping_GetOptionalItem(), но key задается как строка UTF-8 const char*, а не как PyObject*.

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

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

Часть Стабильной ABI.

Это то же самое, что PyObject_SetItem(), но key задается как строка UTF-8 const char*, а не как PyObject*.

int PyMapping_DelItem(PyObject *o, PyObject *key)

Это псевдоним PyObject_DelItem().

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

Это то же самое, что PyObject_DelItem(), но key задается как строка UTF-8 const char*, а не как PyObject*.

int PyMapping_HasKeyWithError(PyObject *o, PyObject *key)

Часть Стабильной ABI с версии 3.13.

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

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

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

Часть Стабильной ABI с версии 3.13.

Это то же самое, что PyMapping_HasKeyWithError(), но key задается как строка UTF-8 const char*, а не как PyObject*.

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

int PyMapping_HasKey(PyObject *o, PyObject *key)

Часть Стабильной ABI.

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

Примечание

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

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

Часть Стабильной ABI.

Это то же самое, что PyMapping_HasKey(), но key задается как строка UTF-8 const char*, а не как 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: Ранее функция возвращала список или кортеж.