https://github.com/python/cpython/commit/42c7e265320dd84f95b37bf0120f20d58a692fb0
commit: 42c7e265320dd84f95b37bf0120f20d58a692fb0
branch: main
author: Nathan Goldbaum <[email protected]>
committer: ngoldbaum <[email protected]>
date: 2026-10-19T11:58:15-07:00
summary:
gh-159730: Warn that gc.get_objects() can expose objects under construction
(#159731)
files:
M Doc/library/gc.rst
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 65533e7e57adc33..84edd0a5b561153 100644
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -75,6 +75,12 @@ The :mod:`!gc` module provides the following functions:
returned. If *generation* is not ``None``, return only the objects tracked
by
the collector that are in that generation.
+ .. warning::
+ Care must be taken when using objects returned by :func:`get_objects`
because
+ some of them could still be under construction and hence in a temporarily
+ invalid state. Avoid using :func:`get_objects` for any purpose other than
+ debugging.
+
.. versionchanged:: 3.8
New *generation* parameter.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
