Mapping Protocol — Python documentation
From Get docs
Python/docs/2.7/c-api/mapping
Mapping Protocol
- int PyMapping_Check(PyObject *o)
- Return
1
if the object provides mapping protocol, and0
otherwise. 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. For objects that do not provide mapping protocol, this is equivalent to the Python expressionlen(o)
.Changed in version 2.5: These functions returned an
int
type. This might require changes in your code for properly supporting 64-bit systems.
- int PyMapping_DelItemString(PyObject *o, char *key)
- Remove the mapping for object key from the object o. Return
-1
on failure. This is equivalent to the Python statementdel o[key]
.
- Remove the mapping for object key from the object o. Return
-1
on failure. This is equivalent to the Python statementdel o[key]
.
- int PyMapping_HasKeyString(PyObject *o, char *key)
- On success, return
1
if the mapping object has the key key and0
otherwise. This is equivalent too[key]
, returningTrue
on success andFalse
on an exception. This function always succeeds.
- Return
1
if the mapping object has the key key and0
otherwise. This is equivalent too[key]
, returningTrue
on success andFalse
on an exception. This function always succeeds.
- On success, return a list of the keys in object o. On failure, return NULL. This is equivalent to the Python expression
o.keys()
.
- On success, return a list of the values in object o. On failure, return NULL. This is equivalent to the Python expression
o.values()
.
- 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. This is equivalent to the Python expression
o.items()
.
- Return element of o corresponding to the object key or NULL on failure. This is the equivalent of the Python expression
o[key]
.
- Map the object key to the value v in object o. Returns
-1
on failure. This is the equivalent of the Python statemento[key] = v
.