diff options
| author | R David Murray <rdmurray@bitdance.com> | 2013-12-26 20:11:28 (GMT) |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2013-12-26 20:11:28 (GMT) |
| commit | 0e814634e5b279b3d8eb4987dc5039a0e8ec270e (patch) | |
| tree | 60d775b28507b4d0ea3b48f9c5b7586b2022219f | |
| parent | e190fac5f957c6da69fa7401a290291e89904879 (diff) | |
| download | cpython-0e814634e5b279b3d8eb4987dc5039a0e8ec270e.zip cpython-0e814634e5b279b3d8eb4987dc5039a0e8ec270e.tar.gz cpython-0e814634e5b279b3d8eb4987dc5039a0e8ec270e.tar.bz2 | |
whatsnew for gc.get_stats, plus doc tweaks.
Clarified the "At the moment" wording, and added the get_stats entry in the
module summary that Serhiy noted was missing at the end of issue 16351.
Given that pydoc lists all the function docstrings, I'm not sure that module
summary section is actually needed; but, it is probably better to address that
when the module is converted to use Argument Clinic. In the meantime we
should keep the list complete.
| -rw-r--r-- | Doc/library/gc.rst | 7 | ||||
| -rw-r--r-- | Doc/whatsnew/3.4.rst | 8 | ||||
| -rw-r--r-- | Modules/gcmodule.c | 1 |
3 files changed, 13 insertions, 3 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index 6b95dc5..8135542 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -69,9 +69,10 @@ The :mod:`gc` module provides the following functions: .. function:: get_stats() - Return a list of 3 per-generation dictionaries containing collection - statistics since interpreter start. At this moment, each dictionary will - contain the following items: + Return a list of three per-generation dictionaries containing collection + statistics since interpreter start. The number of keys may change + in the future, but currently each dictionary will contain the following + items: * ``collections`` is the number of times this generation was collected; diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst index e2f810c..96f2ba8 100644 --- a/Doc/whatsnew/3.4.rst +++ b/Doc/whatsnew/3.4.rst @@ -628,6 +628,14 @@ multiple implementations of an operation that allows it to work with PEP written and implemented by Łukasz Langa. +gc +-- + +New :func:`~gc.get_stats` returns a list of three per-generation dictionaries +containing the collections statistics since interpreter startup. (Contributed +by Antoine Pitrou in :issue:`16351`.) + + hashlib ------- diff --git a/Modules/gcmodule.c b/Modules/gcmodule.c index a84d752..d5fd9df 100644 --- a/Modules/gcmodule.c +++ b/Modules/gcmodule.c @@ -1498,6 +1498,7 @@ PyDoc_STRVAR(gc__doc__, "isenabled() -- Returns true if automatic collection is enabled.\n" "collect() -- Do a full collection right now.\n" "get_count() -- Return the current collection counts.\n" +"get_stats() -- Return list of dictionaries containing per-generation stats.\n" "set_debug() -- Set debugging flags.\n" "get_debug() -- Get debugging flags.\n" "set_threshold() -- Set the collection thresholds.\n" |