Mapping Protocol

Python documentation

See also

PyObject_GetItem()

,

PyObject_SetItem()

and

PyObject_DelItem()

.

intPyMapping_Check(

PyObject

*o)

¶

Part of the

Stable ABI

.Return 1 if the object provides the mapping protocol or supports slicing, and 0 otherwise. Note that it returns 1 for Python classes with a

__getitem__()

method, since in general it is impossible to determine what type of keys the class supports. This function always succeeds.

Py_ssize_t

PyMapping_Size(

PyObject

*o)

¶

Py_ssize_t

PyMapping_Length(

PyObject

*o)

¶

Part of the

Stable ABI

.Returns the number of keys in object o on success, and -1 on failure. This is equivalent to the Python expression len(o).

PyObject

*PyMapping_GetItemString(

PyObject

*o, constchar*key)

¶

Return value: New reference. Part of the

Stable ABI

.This is the same as

PyObject_GetItem()

, but key is specified as a constchar* UTF-8 encoded bytes string, rather than a

PyObject

*.

intPyMapping_SetItemString(

PyObject

*o, constchar*key,

PyObject

*v)

¶

Part of the

Stable ABI

.This is the same as

PyObject_SetItem()

, but key is specified as a constchar* UTF-8 encoded bytes string, rather than a

PyObject

*.

intPyMapping_DelItem(

PyObject

*o,

PyObject

*key)

¶

This is an alias of

PyObject_DelItem()

.

intPyMapping_DelItemString(

PyObject

*o, constchar*key)

¶

This is the same as

PyObject_DelItem()

, but key is specified as a constchar* UTF-8 encoded bytes string, rather than a

PyObject

*.

intPyMapping_HasKey(

PyObject

*o,

PyObject

*key)

¶

Part of the

Stable ABI

.Return 1 if the mapping object has the key key and 0 otherwise. This is equivalent to the Python expression keyino. This function always succeeds.

intPyMapping_HasKeyString(

PyObject

*o, constchar*key)

¶

Part of the

Stable ABI

.This is the same as

PyMapping_HasKey()

, but key is specified as a constchar* UTF-8 encoded bytes string, rather than a

PyObject

*.

Note

Exceptions that occur when this calls

__getitem__()

method or while creating the temporary

str

object are silently ignored. For proper error handling, use

PyMapping_GetItemString()

instead.

PyObject

*PyMapping_Keys(

PyObject

*o)

¶

Return value: New reference. Part of the

Stable ABI

.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)

¶

Return value: New reference. Part of the

Stable ABI

.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)

¶

Return value: New reference. Part of the

Stable ABI

.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.