_getframe(): New sys module function for getting at the stack frame.

Implements and closes SF patch #102106, with Guido's suggested
documentation changes.
This commit is contained in:
Barry Warsaw 2000-12-06 21:47:46 +00:00
parent e63544f872
commit b6a54d2a2c
2 changed files with 48 additions and 0 deletions

View file

@ -161,6 +161,17 @@ from causing an overflow of the C stack and crashing Python. It can
be set by \function{setrecursionlimit()}.
\end{funcdesc}
\begin{funcdesc}{_getframe}{\optional{depth}}
Return a frame object from the call stack. If optional integer
\var{depth} is given, return the frame object that many calls below
the top of the stack. If that is deeper than the call stack,
\exception{ValueError} is raised. The default for \var{depth} is
zero, returning the frame at the top of the call stack.
This function should be used for internal and specialized
purposes only.
\end{funcdesc}
\begin{datadesc}{hexversion}
The version number encoded as a single integer. This is guaranteed to
increase with each version, including proper support for