Mapping Protocol — Python documentation
Mapping Protocol
See also PyObject_GetItem(), PyObject_SetItem() and PyObject_DelItem().
- int PyMapping_Check(PyObject *o)
- Return
1
if the object provides mapping protocol or supports slicing, and0
otherwise. Note that it returns1
for Python classes with a__getitem__()
method since in general case it is impossible to determine what type of keys it supports. This function always succeeds.
- Py_ssize_t PyMapping_Size(PyObject *o)
Py_ssize_t PyMapping_Length(PyObject *o)
- Returns the number of keys in object o on success, and
-1
on failure. This is equivalent to the Python expressionlen(o)
.
- Return element of o corresponding to the string key or
NULL
on failure. This is the equivalent of the Python expressiono[key]
. See also PyObject_GetItem().
- Map the string key to the value v in object o. Returns
-1
on failure. This is the equivalent of the Python statemento[key] = v
. See also PyObject_SetItem(). This function does not steal a reference to v.
- Remove the mapping for the object key from the object o. Return
-1
on failure. This is equivalent to the Python statementdel o[key]
. This is an alias of PyObject_DelItem().
- int PyMapping_DelItemString(PyObject *o, const char *key)
- Remove the mapping for the string key from the object o. Return
-1
on failure. This is equivalent to the Python statementdel o[key]
.
- int PyMapping_HasKey(PyObject *o, PyObject *key)
Return
1
if the mapping object has the key key and0
otherwise. This is equivalent to the Python expressionkey in o
. This function always succeeds.Note that exceptions which occur while calling the
__getitem__()
method will get suppressed. To get error reporting use PyObject_GetItem() instead.
- int PyMapping_HasKeyString(PyObject *o, const char *key)
Return
1
if the mapping object has the key key and0
otherwise. This is equivalent to the Python expressionkey in o
. This function always succeeds.Note that exceptions which occur while calling the
__getitem__()
method and creating a temporary string object will get suppressed. To get error reporting use PyMapping_GetItemString() instead.
- PyObject *PyMapping_Keys(PyObject *o)
On success, return a list of the keys in object o. On failure, return
NULL
.Changed in version 3.7: Previously, the function returned a list or a tuple.
- PyObject *PyMapping_Values(PyObject *o)
On success, return a list of the values in object o. On failure, return
NULL
.Changed in version 3.7: Previously, the function returned a list or a tuple.
- PyObject *PyMapping_Items(PyObject *o)
On success, return a list of the items in object o, where each item is a tuple containing a key-value pair. On failure, return
NULL
.Changed in version 3.7: Previously, the function returned a list or a tuple.