mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-15 21:44:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Docs: Fix and improve the PyUnstable_Object_EnableDeferredRefcount documentation (GH-135323)

Browse source
This commit is contained in:
Peter Bierma 2025-07-13 02:46:13 -04:00 • committed by GitHub
parent 609d5adc7c
commit 0d4fd10fba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/c-api/object.rst
View file

@ -611,12 +611,13 @@ Object Protocol
if supported by the runtime. In the :term:`free-threaded <free threading>` build,
this allows the interpreter to avoid reference count adjustments to *obj*,
which may improve multi-threaded performance. The tradeoff is
that *obj* will only be deallocated by the tracing garbage collector.
that *obj* will only be deallocated by the tracing garbage collector, and
not when the interpreter no longer has any references to it.
This function returns ``1`` if deferred reference counting is enabled on *obj*
(including when it was enabled before the call),
This function returns ``1`` if deferred reference counting is enabled on *obj*,
and ``0`` if deferred reference counting is not supported or if the hint was
ignored by the runtime. This function is thread-safe, and cannot fail.
ignored by the interpreter, such as when deferred reference counting is already
enabled on *obj*. This function is thread-safe, and cannot fail.
This function does nothing on builds with the :term:`GIL` enabled, which do
not support deferred reference counting. This also does nothing if *obj* is not
@ -624,7 +625,8 @@ Object Protocol
:c:func:`PyObject_GC_IsTracked`).
This function is intended to be used soon after *obj* is created,
by the code that creates it.
by the code that creates it, such as in the object's :c:member:`~PyTypeObject.tp_new`
slot.
.. versionadded:: 3.14