[3.14] gh-138098: Clarify strong references in PyDict_Next docs on the free-threaded build (GH-138106) (#138141)

Co-authored-by: PrinceNaroliya <naroliyaprince@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-08-27 15:58:07 +02:00 committed by GitHub
parent 86f7bb7ede
commit 65bf6f549b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

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)