summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorPablo Galindo <Pablogsal@gmail.com>2021-03-10 08:50:16 (GMT)
committerGitHub <noreply@github.com>2021-03-10 08:50:16 (GMT)
commita6d0182879d0bf275c4feb38b57f73236ab9c06c (patch)
tree96ea6d412c90761f0c526e4c8e230ea3926baaf2 /Doc
parente89380765df8f0f02c90ad417e164d1597bd0b05 (diff)
downloadcpython-a6d0182879d0bf275c4feb38b57f73236ab9c06c.zip
cpython-a6d0182879d0bf275c4feb38b57f73236ab9c06c.tar.gz
cpython-a6d0182879d0bf275c4feb38b57f73236ab9c06c.tar.bz2
[3.8] bpo-43439: Add audit hooks for gc functions (GH-24794). (GH-24810)
(cherry picked from commit b4f9089d4aa787c5b74134c98e5f0f11d9e63095) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/gc.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 073391d..dcbfe7f 100644
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -72,6 +72,8 @@ The :mod:`gc` module provides the following functions:
.. versionchanged:: 3.8
New *generation* parameter.
+ .. audit-event:: gc.get_objects generation gc.get_objects
+
.. function:: get_stats()
Return a list of three per-generation dictionaries containing collection
@@ -141,6 +143,8 @@ The :mod:`gc` module provides the following functions:
invalid state. Avoid using :func:`get_referrers` for any purpose other than
debugging.
+ .. audit-event:: gc.get_referrers objs gc.get_referrers
+
.. function:: get_referents(*objs)
@@ -152,6 +156,7 @@ The :mod:`gc` module provides the following functions:
be involved in a cycle. So, for example, if an integer is directly reachable
from an argument, that integer object may or may not appear in the result list.
+ .. audit-event:: gc.get_referents objs gc.get_referents
.. function:: is_tracked(obj)