summaryrefslogtreecommitdiffstats
path: root/Doc/library/gc.rst
diff options
context:
space:
mode:
authorPablo Galindo <Pablogsal@gmail.com>2019-02-23 03:02:06 (GMT)
committerInada Naoki <methane@users.noreply.github.com>2019-02-23 03:02:06 (GMT)
commit175421b58cc97a2555e474f479f30a6c5d2250b0 (patch)
tree05724237baa3c2334c7a0cd07081009cf9a7dc5b /Doc/library/gc.rst
parentdf5cdc11123a35065bbf1636251447d0bfe789a5 (diff)
downloadcpython-175421b58cc97a2555e474f479f30a6c5d2250b0.zip
cpython-175421b58cc97a2555e474f479f30a6c5d2250b0.tar.gz
cpython-175421b58cc97a2555e474f479f30a6c5d2250b0.tar.bz2
bpo-36016: Add generation option to gc.getobjects() (GH-11909)
Diffstat (limited to 'Doc/library/gc.rst')
-rw-r--r--Doc/library/gc.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 722a0e8..084cd6a 100644
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -63,11 +63,14 @@ The :mod:`gc` module provides the following functions:
Return the debugging flags currently set.
-.. function:: get_objects()
+.. function:: get_objects(generation=None)
Returns a list of all objects tracked by the collector, excluding the list
- returned.
+ returned. If *generation* is not None, return only the objects tracked by
+ the collector that are in that generation.
+ .. versionchanged:: 3.8
+ New *generation* parameter.
.. function:: get_stats()