9 .. cfunction:: int PyMapping_Check(PyObject *o)
11 Return ``1`` if the object provides mapping protocol, and ``0`` otherwise. This
12 function always succeeds.
15 .. cfunction:: Py_ssize_t PyMapping_Size(PyObject *o)
16 Py_ssize_t PyMapping_Length(PyObject *o)
18 .. index:: builtin: len
20 Returns the number of keys in object *o* on success, and ``-1`` on failure. For
21 objects that do not provide mapping protocol, this is equivalent to the Python
22 expression ``len(o)``.
24 .. versionchanged:: 2.5
25 These functions returned an :ctype:`int` type. This might require
26 changes in your code for properly supporting 64-bit systems.
29 .. cfunction:: int PyMapping_DelItemString(PyObject *o, char *key)
31 Remove the mapping for object *key* from the object *o*. Return ``-1`` on
32 failure. This is equivalent to the Python statement ``del o[key]``.
35 .. cfunction:: int PyMapping_DelItem(PyObject *o, PyObject *key)
37 Remove the mapping for object *key* from the object *o*. Return ``-1`` on
38 failure. This is equivalent to the Python statement ``del o[key]``.
41 .. cfunction:: int PyMapping_HasKeyString(PyObject *o, char *key)
43 On success, return ``1`` if the mapping object has the key *key* and ``0``
44 otherwise. This is equivalent to ``o[key]``, returning ``True`` on success
45 and ``False`` on an exception. This function always succeeds.
48 .. cfunction:: int PyMapping_HasKey(PyObject *o, PyObject *key)
50 Return ``1`` if the mapping object has the key *key* and ``0`` otherwise.
51 This is equivalent to ``o[key]``, returning ``True`` on success and ``False``
52 on an exception. This function always succeeds.
55 .. cfunction:: PyObject* PyMapping_Keys(PyObject *o)
57 On success, return a list of the keys in object *o*. On failure, return *NULL*.
58 This is equivalent to the Python expression ``o.keys()``.
61 .. cfunction:: PyObject* PyMapping_Values(PyObject *o)
63 On success, return a list of the values in object *o*. On failure, return
64 *NULL*. This is equivalent to the Python expression ``o.values()``.
67 .. cfunction:: PyObject* PyMapping_Items(PyObject *o)
69 On success, return a list of the items in object *o*, where each item is a tuple
70 containing a key-value pair. On failure, return *NULL*. This is equivalent to
71 the Python expression ``o.items()``.
74 .. cfunction:: PyObject* PyMapping_GetItemString(PyObject *o, char *key)
76 Return element of *o* corresponding to the object *key* or *NULL* on failure.
77 This is the equivalent of the Python expression ``o[key]``.
80 .. cfunction:: int PyMapping_SetItemString(PyObject *o, char *key, PyObject *v)
82 Map the object *key* to the value *v* in object *o*. Returns ``-1`` on failure.
83 This is the equivalent of the Python statement ``o[key] = v``.