From e4af0712036fa04f5f1f4cbc59477685d9dccbcb Mon Sep 17 00:00:00 2001 From: Nathan Goldbaum Date: Mon, 19 Oct 2026 12:58:15 -0600 Subject: [PATCH] gh-159730: Warn that gc.get_objects() can expose objects under construction (GH-159731) (cherry picked from commit 42c7e265320dd84f95b37bf0120f20d58a692fb0) Co-authored-by: Nathan Goldbaum --- Doc/library/gc.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index 3b28408b03a657c..e4198222b26e2e0 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -78,6 +78,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.