summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Foord <fuzzyman@voidspace.org.uk>2009-09-13 16:46:19 (GMT)
committerMichael Foord <fuzzyman@voidspace.org.uk>2009-09-13 16:46:19 (GMT)
commit668be589ef5700aa1d7fd29e9f0b528824804d07 (patch)
tree719ed9402f1bfa31ec804ef3513777024837c9e4
parentc3f79373e89cfe926b6e1f9e2f73dada1cbfff8e (diff)
downloadcpython-668be589ef5700aa1d7fd29e9f0b528824804d07.zip
cpython-668be589ef5700aa1d7fd29e9f0b528824804d07.tar.gz
cpython-668be589ef5700aa1d7fd29e9f0b528824804d07.tar.bz2
Note that sys._getframe is not guaranteed to exist in all implementations of Python, and a corresponding note in inspect.currentframe. Issue 6712.
-rw-r--r--Doc/library/inspect.rst5
-rw-r--r--Doc/library/sys.rst3
2 files changed, 7 insertions, 1 deletions
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index bea12c9..ac89850 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -567,6 +567,11 @@ line.
Return the frame object for the caller's stack frame.
+ This function relies on Python stack frame support in the interpreter, which
+ isn't guaranteed to exist in all implementations of Python. If running in
+ an implmentation without Python stack frame support this function returns
+ ``None``.
+
.. function:: stack([context])
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 0005792..7a3f642 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -417,7 +417,8 @@ always available.
that is deeper than the call stack, :exc:`ValueError` is raised. The default
for *depth* is zero, returning the frame at the top of the call stack.
- This function should be used for internal and specialized purposes only.
+ This function should be used for internal and specialized purposes only. It
+ is not guaranteed to exist in all implementations of Python.
.. function:: getprofile()