Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-06 15:32:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-138098: Clarify strong references in PyDict_Next docs on the free-threaded build (GH-138106)

Browse source
This commit is contained in:
PrinceNaroliya 2025-08-25 20:23:26 +05:30 • committed by GitHub
parent 81268a3e2a
commit 9ee0214b5d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/c-api/dict.rst
View file

@ -301,6 +301,15 @@ Dictionary Objects
}
Py_END_CRITICAL_SECTION();
.. note::
On the free-threaded build, this function can be used safely inside a
critical section. However, the references returned for *pkey* and *pvalue*
are :term:`borrowed <borrowed reference>` and are only valid while the
critical section is held. If you need to use these objects outside the
critical section or when the critical section can be suspended, create a
:term:`strong reference <strong reference>` (for example, using
:c:func:`Py_NewRef`).
.. c:function:: int PyDict_Merge(PyObject *a, PyObject *b, int override)