Protocole de correspondance

Voir aussi PyObject_GetItem(), PyObject_SetItem() et PyObject_DelItem().

int PyMapping_Check(PyObject *o)
Fait partie de l' ABI stable.

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)
Fait partie de l' ABI stable.

Renvoie le nombre de clefs dans l'objet o et -1 en cas d'échec. C'est l'équivalent de l'expression Python len(o).

PyObject *PyMapping_GetItemString(PyObject *o, const char *key)
Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

This is the same as PyObject_GetItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.

int PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)
Fait partie de l' ABI stable depuis la version 3.13.

Variant of PyObject_GetItem() which doesn't raise KeyError if the key is not found.

If the key is found, return 1 and set *result to a new strong reference to the corresponding value. If the key is not found, return 0 and set *result to NULL; the KeyError is silenced. If an error other than KeyError is raised, return -1 and set *result to NULL.

Ajouté dans la version 3.13.

int PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **result)
Fait partie de l' ABI stable depuis la version 3.13.

This is the same as PyMapping_GetOptionalItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.

Ajouté dans la version 3.13.

int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)
Fait partie de l' ABI stable.

This is the same as PyObject_SetItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.

int PyMapping_DelItem(PyObject *o, PyObject *key)

This is an alias of PyObject_DelItem().

int PyMapping_DelItemString(PyObject *o, const char *key)

This is the same as PyObject_DelItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.

int PyMapping_HasKeyWithError(PyObject *o, PyObject *key)
Fait partie de l' ABI stable depuis la version 3.13.

Return 1 if the mapping object has the key key and 0 otherwise. This is equivalent to the Python expression key in o. On failure, return -1.

Ajouté dans la version 3.13.

int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)
Fait partie de l' ABI stable depuis la version 3.13.

This is the same as PyMapping_HasKeyWithError(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.

Ajouté dans la version 3.13.

int PyMapping_HasKey(PyObject *o, PyObject *key)
Fait partie de l' ABI stable.

Renvoie 1 si l'objet de correspondance possède une clef key et 0 sinon. C'est l'équivalent de l'expression Python key in o. Cette fonction ne provoque jamais d'erreur.

Note

Exceptions which occur when this calls __getitem__() method are silently ignored. For proper error handling, use PyMapping_HasKeyWithError(), PyMapping_GetOptionalItem() or PyObject_GetItem() instead.

int PyMapping_HasKeyString(PyObject *o, const char *key)
Fait partie de l' ABI stable.

This is the same as PyMapping_HasKey(), but key is specified as a const char* 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_HasKeyStringWithError(), PyMapping_GetOptionalItemString() or PyMapping_GetItemString() instead.

PyObject *PyMapping_Keys(PyObject *o)
Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

Renvoie la liste des clefs dans l'objet o. En cas d'échec, renvoie NULL.

Modifié dans la version 3.7: Auparavant, la fonction renvoyait une liste ou un n-uplet.

PyObject *PyMapping_Values(PyObject *o)
Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

Renvoie la liste des valeurs dans l'objet o. En cas d'échec, renvoie NULL.

Modifié dans la version 3.7: Auparavant, la fonction renvoyait une liste ou un n-uplet.

PyObject *PyMapping_Items(PyObject *o)
Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

Renvoie la liste des éléments dans l'objet o, où chaque élément est un n-uplet contenant une paire clef-valeur. En cas d'échec, renvoie NULL.

Modifié dans la version 3.7: Auparavant, la fonction renvoyait une liste ou un n-uplet.