*key*, return ``1``, otherwise return ``0``. On error, return ``-1``.
This is equivalent to the Python expression ``key in p``.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. c:function:: int PyDict_ContainsString(PyObject *p, const char *key)
``0`` on success or ``-1`` on failure. This function *does not* steal a
reference to *val*.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. c:function:: int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val)
If *key* is not in the dictionary, :exc:`KeyError` is raised.
Return ``0`` on success or ``-1`` on failure.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. c:function:: int PyDict_DelItemString(PyObject *p, const char *key)
* If the key is missing, set *\*result* to ``NULL`` and return ``0``.
* On error, raise an exception and return ``-1``.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. versionadded:: 3.13
See also the :c:func:`PyObject_GetItem` function.
:meth:`~object.__eq__` methods are silently ignored.
Prefer the :c:func:`PyDict_GetItemWithError` function instead.
+ .. note::
+
+ In the :term:`free-threaded build`, the returned
+ :term:`borrowed reference` may become invalid if another thread modifies
+ the dictionary concurrently. Prefer :c:func:`PyDict_GetItemRef`, which
+ returns a :term:`strong reference`.
+
.. versionchanged:: 3.10
Calling this API without an :term:`attached thread state` had been allowed for historical
reason. It is no longer allowed.
occurred. Return ``NULL`` **without** an exception set if the key
wasn't present.
+ .. note::
+
+ In the :term:`free-threaded build`, the returned
+ :term:`borrowed reference` may become invalid if another thread modifies
+ the dictionary concurrently. Prefer :c:func:`PyDict_GetItemRef`, which
+ returns a :term:`strong reference`.
+
.. c:function:: PyObject* PyDict_GetItemString(PyObject *p, const char *key)
Prefer using the :c:func:`PyDict_GetItemWithError` function with your own
:c:func:`PyUnicode_FromString` *key* instead.
+ .. note::
+
+ In the :term:`free-threaded build`, the returned
+ :term:`borrowed reference` may become invalid if another thread modifies
+ the dictionary concurrently. Prefer :c:func:`PyDict_GetItemStringRef`,
+ which returns a :term:`strong reference`.
+
.. c:function:: int PyDict_GetItemStringRef(PyObject *p, const char *key, PyObject **result)
.. versionadded:: 3.4
+ .. note::
+
+ In the :term:`free-threaded build`, the returned
+ :term:`borrowed reference` may become invalid if another thread modifies
+ the dictionary concurrently. Prefer :c:func:`PyDict_SetDefaultRef`,
+ which returns a :term:`strong reference`.
+
+
.. c:function:: int PyDict_SetDefaultRef(PyObject *p, PyObject *key, PyObject *default_value, PyObject **result)
These may refer to the same object: in that case you hold two separate
references to it.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. versionadded:: 3.13
Similar to :meth:`dict.pop`, but without the default value and
not raising :exc:`KeyError` if the key is missing.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. versionadded:: 3.13
only be added if there is not a matching key in *a*. Return ``0`` on
success or ``-1`` if an exception was raised.
+ .. note::
+
+ In the :term:`free-threaded build`, when *b* is a
+ :class:`dict` (with the standard iterator), both *a* and *b* are locked
+ for the duration of the operation. When *b* is a non-dict mapping, only
+ *a* is locked; *b* may be concurrently modified by another thread.
+
.. c:function:: int PyDict_Update(PyObject *a, PyObject *b)
argument has no "keys" attribute. Return ``0`` on success or ``-1`` if an
exception was raised.
+ .. note::
+
+ In the :term:`free-threaded build`, when *b* is a
+ :class:`dict` (with the standard iterator), both *a* and *b* are locked
+ for the duration of the operation. When *b* is a non-dict mapping, only
+ *a* is locked; *b* may be concurrently modified by another thread.
+
.. c:function:: int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override)
if override or key not in a:
a[key] = value
+ .. note::
+
+ In the :term:`free-threaded <free threading>` build, only *a* is locked.
+ The iteration over *seq2* is not synchronized; *seq2* may be concurrently
+ modified by another thread.
+
+
.. c:function:: int PyDict_AddWatcher(PyDict_WatchCallback callback)
Register *callback* as a dictionary watcher. Return a non-negative integer
of error (e.g. no more watcher IDs available), return ``-1`` and set an
exception.
+ .. note::
+
+ This function is not internally synchronized. In the
+ :term:`free-threaded <free threading>` build, callers should ensure no
+ concurrent calls to :c:func:`PyDict_AddWatcher` or
+ :c:func:`PyDict_ClearWatcher` are in progress.
+
.. versionadded:: 3.12
.. c:function:: int PyDict_ClearWatcher(int watcher_id)
:c:func:`PyDict_AddWatcher`. Return ``0`` on success, ``-1`` on error (e.g.
if the given *watcher_id* was never registered.)
+ .. note::
+
+ This function is not internally synchronized. In the
+ :term:`free-threaded <free threading>` build, callers should ensure no
+ concurrent calls to :c:func:`PyDict_AddWatcher` or
+ :c:func:`PyDict_ClearWatcher` are in progress.
+
.. versionadded:: 3.12
.. c:function:: int PyDict_Watch(int watcher_id, PyObject *dict)
actually iterable. The constructor is also useful for copying a set
(``c=set(s)``).
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *iterable* is a :class:`set`, :class:`frozenset` or :class:`dict`.
+
.. c:function:: PyObject* PyFrozenSet_New(PyObject *iterable)
set on success or ``NULL`` on failure. Raise :exc:`TypeError` if *iterable* is
not actually iterable.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *iterable* is a :class:`set`, :class:`frozenset` or :class:`dict`.
+
The following functions and macros are available for instances of :class:`set`
or :class:`frozenset` or instances of their subtypes.
the *key* is unhashable. Raise :exc:`SystemError` if *anyset* is not a
:class:`set`, :class:`frozenset`, or an instance of a subtype.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
.. c:function:: int PySet_Add(PyObject *set, PyObject *key)
:exc:`SystemError` if *set* is not an instance of :class:`set` or its
subtype.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
+
The following functions are available for instances of :class:`set` or its
subtypes but not for instances of :class:`frozenset` or its subtypes.
temporary frozensets. Raise :exc:`SystemError` if *set* is not an
instance of :class:`set` or its subtype.
+ .. note::
+
+ The operation is atomic on :term:`free threading <free-threaded build>`
+ when *key* is :class:`str`, :class:`int`, :class:`float`, :class:`bool` or :class:`bytes`.
+
.. c:function:: PyObject* PySet_Pop(PyObject *set)
success. Return ``-1`` and raise :exc:`SystemError` if *set* is not an instance of
:class:`set` or its subtype.
+ .. note::
+
+ In the :term:`free-threaded build`, the set is emptied before its entries
+ are cleared, so other threads will observe an empty set rather than
+ intermediate states.
+
Deprecated API
^^^^^^^^^^^^^^
# The function name must match the C domain identifier used in the documentation.
# Synchronization primitives (Doc/c-api/synchronization.rst)
-PyMutex_Lock:shared:
-PyMutex_Unlock:shared:
+PyMutex_Lock:atomic:
+PyMutex_Unlock:atomic:
PyMutex_IsLocked:atomic:
+
+# Dictionary objects (Doc/c-api/dict.rst)
+
+# Type checks - read ob_type pointer, always safe
+PyDict_Check:atomic:
+PyDict_CheckExact:atomic:
+
+# Creation - pure allocation, no shared state
+PyDict_New:atomic:
+
+# Lock-free lookups - use _Py_dict_lookup_threadsafe(), no locking.
+# Atomic with simple types.
+PyDict_Contains:shared:
+PyDict_ContainsString:atomic:
+PyDict_GetItemRef:shared:
+PyDict_GetItemStringRef:atomic:
+PyDict_Size:atomic:
+PyDict_GET_SIZE:atomic:
+
+# Borrowed-reference lookups - lock-free dict access but returned
+# borrowed reference is unsafe in free-threaded builds without
+# external synchronization
+PyDict_GetItem:compatible:
+PyDict_GetItemWithError:compatible:
+PyDict_GetItemString:compatible:
+PyDict_SetDefault:compatible:
+
+# Iteration - no locking; returns borrowed refs
+PyDict_Next:compatible:
+
+# Single-item mutations - protected by per-object critical section
+PyDict_SetItem:shared:
+PyDict_SetItemString:atomic:
+PyDict_DelItem:shared:
+PyDict_DelItemString:atomic:
+PyDict_SetDefaultRef:shared:
+PyDict_Pop:shared:
+PyDict_PopString:atomic:
+
+# Bulk reads - hold per-object lock for duration
+PyDict_Clear:atomic:
+PyDict_Copy:atomic:
+PyDict_Keys:atomic:
+PyDict_Values:atomic:
+PyDict_Items:atomic:
+
+# Merge/update - lock target dict; also lock source when it is a dict
+PyDict_Update:shared:
+PyDict_Merge:shared:
+PyDict_MergeFromSeq2:shared:
+
+# Watcher registration - no synchronization on interpreter state
+PyDict_AddWatcher:compatible:
+PyDict_ClearWatcher:compatible:
+
+# Per-dict watcher tags - non-atomic RMW on _ma_watcher_tag;
+# safe on distinct dicts only
+PyDict_Watch:distinct:
+PyDict_Unwatch:distinct:
+
+
# List objects (Doc/c-api/list.rst)
# Type checks - read ob_type pointer, always safe
PyByteArray_AsString:compatible:
PyByteArray_AS_STRING:compatible:
+# Creation - may iterate the iterable argument, calling arbitrary code.
+# Atomic for sets, frozensets, dicts, and frozendicts.
+PySet_New:shared:
+PyFrozenSet_New:shared:
+
+# Size - uses atomic load on free-threaded builds
+PySet_Size:atomic:
+PySet_GET_SIZE:atomic:
+
+# Contains - lock-free, atomic with simple types
+PySet_Contains:shared:
+
+# Mutations - hold per-object lock for duration
+# atomic with simple types
+PySet_Add:shared:
+PySet_Discard:shared:
+
+# Pop - hold per-object lock for duration
+PySet_Pop:atomic:
+
+# Clear - empties the set before clearing
+PySet_Clear:atomic:
+
# Capsule objects (Doc/c-api/capsule.rst)
# Type check - read ob_type pointer, always safe
projects / thirdparty / Python / cpython.git / commitdiff
