mirror of
https://github.com/python/cpython
synced 2024-10-14 23:28:08 +00:00
246cb64984
* Express functions which take argument as a C string in terms of
functions which take Python object.
* Use "note" directive for PyMapping_HasKey() and
PyMapping_HasKeyString() notes..
(cherry picked from commit 6f97eeec22
)
107 lines
3.3 KiB
ReStructuredText
107 lines
3.3 KiB
ReStructuredText
.. highlight:: c
|
|
|
|
.. _mapping:
|
|
|
|
Mapping Protocol
|
|
================
|
|
|
|
See also :c:func:`PyObject_GetItem`, :c:func:`PyObject_SetItem` and
|
|
:c:func:`PyObject_DelItem`.
|
|
|
|
|
|
.. c:function:: int PyMapping_Check(PyObject *o)
|
|
|
|
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 :meth:`~object.__getitem__` method, since in general it is impossible to
|
|
determine what type of keys the class supports. This function always succeeds.
|
|
|
|
|
|
.. c:function:: Py_ssize_t PyMapping_Size(PyObject *o)
|
|
Py_ssize_t PyMapping_Length(PyObject *o)
|
|
|
|
.. index:: pair: built-in function; len
|
|
|
|
Returns the number of keys in object *o* on success, and ``-1`` on failure.
|
|
This is equivalent to the Python expression ``len(o)``.
|
|
|
|
|
|
.. c:function:: PyObject* PyMapping_GetItemString(PyObject *o, const char *key)
|
|
|
|
This is the same as :c:func:`PyObject_GetItem`, but *key* is
|
|
specified as a :c:expr:`const char*` UTF-8 encoded bytes string,
|
|
rather than a :c:expr:`PyObject*`.
|
|
|
|
|
|
.. c:function:: int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)
|
|
|
|
This is the same as :c:func:`PyObject_SetItem`, but *key* is
|
|
specified as a :c:expr:`const char*` UTF-8 encoded bytes string,
|
|
rather than a :c:expr:`PyObject*`.
|
|
|
|
|
|
.. c:function:: int PyMapping_DelItem(PyObject *o, PyObject *key)
|
|
|
|
This is an alias of :c:func:`PyObject_DelItem`.
|
|
|
|
|
|
.. c:function:: int PyMapping_DelItemString(PyObject *o, const char *key)
|
|
|
|
This is the same as :c:func:`PyObject_DelItem`, but *key* is
|
|
specified as a :c:expr:`const char*` UTF-8 encoded bytes string,
|
|
rather than a :c:expr:`PyObject*`.
|
|
|
|
|
|
.. c:function:: int PyMapping_HasKey(PyObject *o, PyObject *key)
|
|
|
|
Return ``1`` if the mapping object has the key *key* and ``0`` otherwise.
|
|
This is equivalent to the Python expression ``key in o``.
|
|
This function always succeeds.
|
|
|
|
.. note::
|
|
|
|
Exceptions which occur when this calls :meth:`~object.__getitem__`
|
|
method are silently ignored.
|
|
For proper error handling, use :c:func:`PyObject_GetItem()` instead.
|
|
|
|
|
|
.. c:function:: int PyMapping_HasKeyString(PyObject *o, const char *key)
|
|
|
|
This is the same as :c:func:`PyMapping_HasKey`, but *key* is
|
|
specified as a :c:expr:`const char*` UTF-8 encoded bytes string,
|
|
rather than a :c:expr:`PyObject*`.
|
|
|
|
.. note::
|
|
|
|
Exceptions that occur when this calls :meth:`~object.__getitem__`
|
|
method or while creating the temporary :class:`str`
|
|
object are silently ignored.
|
|
For proper error handling, use :c:func:`PyMapping_GetItemString` instead.
|
|
|
|
|
|
.. c:function:: PyObject* PyMapping_Keys(PyObject *o)
|
|
|
|
On success, return a list of the keys in object *o*. On failure, return
|
|
``NULL``.
|
|
|
|
.. versionchanged:: 3.7
|
|
Previously, the function returned a list or a tuple.
|
|
|
|
|
|
.. c:function:: PyObject* PyMapping_Values(PyObject *o)
|
|
|
|
On success, return a list of the values in object *o*. On failure, return
|
|
``NULL``.
|
|
|
|
.. versionchanged:: 3.7
|
|
Previously, the function returned a list or a tuple.
|
|
|
|
|
|
.. c:function:: PyObject* PyMapping_Items(PyObject *o)
|
|
|
|
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``.
|
|
|
|
.. versionchanged:: 3.7
|
|
Previously, the function returned a list or a tuple.
|