summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorSteve Dower <steve.dower@python.org>2023-01-13 11:31:06 (GMT)
committerGitHub <noreply@github.com>2023-01-13 11:31:06 (GMT)
commitb5d4347950399800c6703736d716f08761b29245 (patch)
treebb838154108d6740e062cd5b3d0756fd1a4f2d89 /Doc/library/sys.rst
parent94fc7706b7bc3d57cdd6d15bf8e8c4499ae53a69 (diff)
downloadcpython-b5d4347950399800c6703736d716f08761b29245.zip
cpython-b5d4347950399800c6703736d716f08761b29245.tar.gz
cpython-b5d4347950399800c6703736d716f08761b29245.tar.bz2
gh-86682: Adds sys._getframemodulename as an alternative to using _getframe (GH-99520)
Also updates calls in collections, doctest, enum, and typing modules to use _getframemodulename first when available.
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 28adca1..605e2c9 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -808,6 +808,22 @@ always available.
It is not guaranteed to exist in all implementations of Python.
+.. function:: _getframemodulename([depth])
+
+ Return the name of a module from the call stack. If optional integer *depth*
+ is given, return the module that many calls below the top of the stack. If
+ that is deeper than the call stack, or if the module is unidentifiable,
+ ``None`` is returned. The default for *depth* is zero, returning the
+ module at the top of the call stack.
+
+ .. audit-event:: sys._getframemodulename depth sys._getframemodulename
+
+ .. impl-detail::
+
+ This function should be used for internal and specialized purposes only.
+ It is not guaranteed to exist in all implementations of Python.
+
+
.. function:: getprofile()
.. index::