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

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

int PyMapping_Check(PyObject *o)

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

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)
Return value: New reference.

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

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

Отобразить строку key со значением v в объекте o. В случае ошибки возвращает -1. Это эквивалент оператора Python o[key] = v. Также PyObject_SetItem(). Эта функция не крадёт ссылку на v.

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__(), будут подавлены. Чтобы получить отчёт об ошибках, используйте вместо неё: c:func:PyObject_GetItem().

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

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

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

PyObject* PyMapping_Keys(PyObject *o)
Return value: New reference.

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

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

PyObject* PyMapping_Values(PyObject *o)
Return value: New reference.

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

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

PyObject* PyMapping_Items(PyObject *o)
Return value: New reference.

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

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