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

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

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

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

PyObject* PyMapping_GetItemString(PyObject *o, const char *key)¶: Возвращаемое значение: новая ссылка.
Возвращает элемент o, соответствующий строке key, или NULL при ошибке. Это эквивалент выражения Python o[key]. См. также PyObject_GetItem().

int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)¶: Сопоставляет строку ключ со значением v в объекте o. Возвращает -1 в случае неудачи. Это эквивалент выражения Python o[key] = v. См. также PyObject_SetItem().

int PyMapping_DelItem(PyObject *o, PyObject *key)¶: Удаляет отображение для объекта key из объекта o. Возвращает -1 при ошибке. Это эквивалентно оператору Python del o[key]. Это псевдоним PyObject_DelItem().

int PyMapping_DelItemString(PyObject *o, const char *key)¶: Удаляет отображение для строки key из объекта o. Возвращает -1 при ошибке. Это эквивалентно оператору Python del o[key].

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

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

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

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

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

PyObject* PyMapping_Keys(PyObject *o)¶: Возвращаемое значение: новая ссылка.
При успехе возвращает список или кортеж ключей объекта o. При ошибке возвращает NULL.

PyObject* PyMapping_Values(PyObject *o)¶: Возвращаемое значение: новая ссылка.
При успехе возвращает список или кортеж значений объекта o. При ошибке возвращает NULL.

PyObject* PyMapping_Items(PyObject *o)¶: Возвращаемое значение: новая ссылка.
При успехе возвращает список или кортеж элементов объекта o, где каждый элемент является кортежем, содержащим пару ключ-значение. При ошибке возвращает NULL.