[Python-checkins] CVS: python/dist/src/Doc/lib libsys.tex,1.42,1.43

Barry Warsaw python-dev@python.org
Wed, 6 Dec 2000 13:47:48 -0800


Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv7744

Modified Files:
	libsys.tex 
Log Message:
_getframe(): New sys module function for getting at the stack frame.
Implements and closes SF patch #102106, with Guido's suggested
documentation changes.


Index: libsys.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsys.tex,v
retrieving revision 1.42
retrieving revision 1.43
diff -C2 -r1.42 -r1.43
*** libsys.tex	2000/10/25 21:02:55	1.42
--- libsys.tex	2000/12/06 21:47:46	1.43
***************
*** 162,165 ****
--- 162,176 ----
  \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