Protocolo de mapeamento¶
Veja também PyObject_GetItem()
, PyObject_SetItem()
e PyObject_DelItem()
.
-
int PyMapping_Check(PyObject *o)¶
- Parte da ABI Estável.
Retorna
1
se o objeto fornece protocolo de mapeamento ou suporta fatiamento e0
caso contrário. Note que ele retorna1
para classes Python com um método__getitem__()
visto que geralmente é impossível determinar a que tipo de chaves a classe tem suporte. Esta função sempre tem sucesso.
-
Py_ssize_t PyMapping_Size(PyObject *o)¶
-
Py_ssize_t PyMapping_Length(PyObject *o)¶
- Parte da ABI Estável.
Retorna o número de chaves no objeto o em caso de sucesso e
-1
em caso de falha. Isso é equivalente à expressão Pythonlen(o)
.
-
PyObject *PyMapping_GetItemString(PyObject *o, const char *key)¶
- Retorna valor: Nova referência. Parte da ABI Estável.
É o mesmo que
PyObject_GetItem()
, mas key é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um PyObject*.
-
int PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)¶
- Parte da ABI Estável desde a versão 3.13.
Variant of
PyObject_GetItem()
which doesn’t raiseKeyError
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, return0
and set *result toNULL
; theKeyError
is silenced. If an error other thanKeyError
is raised, return-1
and set *result toNULL
.Adicionado na versão 3.13.
-
int PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **result)¶
- Parte da ABI Estável desde a versão 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*.Adicionado na versão 3.13.
-
int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)¶
- Parte da ABI Estável.
É o mesmo que
PyObject_SetItem()
, mas key é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um PyObject*.
-
int PyMapping_DelItem(PyObject *o, PyObject *key)¶
Este é um apelido de
PyObject_DelItem()
.
-
int PyMapping_DelItemString(PyObject *o, const char *key)¶
É o mesmo que
PyObject_DelItem()
, mas key é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um PyObject*.
-
int PyMapping_HasKeyWithError(PyObject *o, PyObject *key)¶
- Parte da ABI Estável desde a versão 3.13.
Return
1
if the mapping object has the key key and0
otherwise. This is equivalent to the Python expressionkey in o
. On failure, return-1
.Adicionado na versão 3.13.
-
int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)¶
- Parte da ABI Estável desde a versão 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*.Adicionado na versão 3.13.
-
int PyMapping_HasKey(PyObject *o, PyObject *key)¶
- Parte da ABI Estável.
Retorna
1
se o objeto de mapeamento tiver a chave key e0
caso contrário. Isso é equivalente à expressão Pythonkey in o
. Esta função sempre tem sucesso.Nota
Exceptions which occur when this calls
__getitem__()
method are silently ignored. For proper error handling, usePyMapping_HasKeyWithError()
,PyMapping_GetOptionalItem()
orPyObject_GetItem()
instead.
-
int PyMapping_HasKeyString(PyObject *o, const char *key)¶
- Parte da ABI Estável.
É o mesmo que
PyMapping_HasKey()
, mas key é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um PyObject*.Nota
Exceptions that occur when this calls
__getitem__()
method or while creating the temporarystr
object are silently ignored. For proper error handling, usePyMapping_HasKeyStringWithError()
,PyMapping_GetOptionalItemString()
orPyMapping_GetItemString()
instead.
-
PyObject *PyMapping_Keys(PyObject *o)¶
- Retorna valor: Nova referência. Parte da ABI Estável.
Em caso de sucesso, retorna uma lista das chaves no objeto o. Em caso de falha, retorna
NULL
.Alterado na versão 3.7: Anteriormente, a função retornava uma lista ou tupla.
-
PyObject *PyMapping_Values(PyObject *o)¶
- Retorna valor: Nova referência. Parte da ABI Estável.
Em caso de sucesso, retorna uma lista dos valores no objeto o. Em caso de falha, retorna
NULL
.Alterado na versão 3.7: Anteriormente, a função retornava uma lista ou tupla.
-
PyObject *PyMapping_Items(PyObject *o)¶
- Retorna valor: Nova referência. Parte da ABI Estável.
Em caso de sucesso, retorna uma lista dos itens no objeto o, onde cada item é uma tupla contendo um par de valores-chave. Em caso de falha, retorna
NULL
.Alterado na versão 3.7: Anteriormente, a função retornava uma lista ou tupla.