Mapping ProtocolΒΆ
See also PyObject_GetItem(), PyObject_SetItem() and
PyObject_DelItem().
-
int
PyMapping_Check(PyObjectΒ *o)ΒΆ Return
1if the object provides mapping protocol or supports slicing, and0otherwise. Note that it returns1for Python classes with a__getitem__()method since in general case it is impossible to determine what the 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
-1on failure. This is equivalent to the Python expressionlen(o).
-
PyObject*
PyMapping_GetItemString(PyObjectΒ *o, const charΒ *key)ΒΆ - Return value: New reference.
Return element of o corresponding to the string key or NULL on failure. This is the equivalent of the Python expression
o[key]. See alsoPyObject_GetItem().
-
int
PyMapping_SetItemString(PyObjectΒ *o, const charΒ *key, PyObjectΒ *v)ΒΆ Map the string key to the value v in object o. Returns
-1on failure. This is the equivalent of the Python statemento[key] = v. See alsoPyObject_SetItem().
-
int
PyMapping_DelItem(PyObjectΒ *o, PyObjectΒ *key)ΒΆ Remove the mapping for the object key from the object o. Return
-1on failure. This is equivalent to the Python statementdel o[key]. This is an alias ofPyObject_DelItem().
-
int
PyMapping_DelItemString(PyObjectΒ *o, const charΒ *key)ΒΆ Remove the mapping for the string key from the object o. Return
-1on failure. This is equivalent to the Python statementdel o[key].
-
int
PyMapping_HasKey(PyObjectΒ *o, PyObjectΒ *key)ΒΆ Return
1if the mapping object has the key key and0otherwise. 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 usePyObject_GetItem()instead.
-
int
PyMapping_HasKeyString(PyObjectΒ *o, const charΒ *key)ΒΆ Return
1if the mapping object has the key key and0otherwise. 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 usePyMapping_GetItemString()instead.
-
PyObject*
PyMapping_Keys(PyObjectΒ *o)ΒΆ - Return value: New reference.
On success, return a list or tuple of the keys in object o. On failure, return NULL.
