[Python-checkins] python/dist/src/Doc/lib libpyclbr.tex,1.3,1.4

[aleax at users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv10557

Modified Files:
	libpyclbr.tex 
Log Message:
Add docs for readmodule_ex and its function-descriptors, fixing
sf bug#812818.
(same as commit of Sun Nov 2 to the release23-maint branch)


Index: libpyclbr.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpyclbr.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** libpyclbr.tex	29 Jun 1999 15:43:02 -0000	1.3
--- libpyclbr.tex	9 Nov 2003 16:32:54 -0000	1.4
***************
*** 9,16 ****
  
  The \module{pyclbr} can be used to determine some limited information
! about the classes and methods defined in a module.  The information
  provided is sufficient to implement a traditional three-pane class
  browser.  The information is extracted from the source code rather
! than from an imported module, so this module is safe to use with
  untrusted source code.  This restriction makes it impossible to use
  this module with modules not implemented in Python, including many
--- 9,17 ----
  
  The \module{pyclbr} can be used to determine some limited information
! about the classes, methods and top-level functions
! defined in a module.  The information
  provided is sufficient to implement a traditional three-pane class
  browser.  The information is extracted from the source code rather
! than by importing the module, so this module is safe to use with
  untrusted source code.  This restriction makes it impossible to use
  this module with modules not implemented in Python, including many
***************
*** 28,36 ****
  \end{funcdesc}
  
  
  \subsection{Class Descriptor Objects \label{pyclbr-class-objects}}
  
  The class descriptor objects used as values in the dictionary returned
! by \function{readmodule()} provide the following data members:
  
  
--- 29,48 ----
  \end{funcdesc}
  
+ \begin{funcdesc}{readmodule_ex}{module\optional{, path}}
+   % The 'inpackage' parameter appears to be for internal use only....
+   Like \function{readmodule()}, but the returned dictionary, in addition
+   to mapping class names to class descriptor objects, also maps
+   top-level function names to function descriptor objects.  Moreover, if
+   the module being read is a package, the key \code{'__path__'} in the
+   returned dictionary has as its value a list which contains the package
+   search path.
+ \end{funcdesc}
+ 
  
  \subsection{Class Descriptor Objects \label{pyclbr-class-objects}}
  
  The class descriptor objects used as values in the dictionary returned
! by \function{readmodule()} and \function{readmodule_ex()}
! provide the following data members:
  
  
***************
*** 57,65 ****
  
  \begin{memberdesc}[class descriptor]{file}
!   Name of the file containing the class statement defining the class.
  \end{memberdesc}
  
  \begin{memberdesc}[class descriptor]{lineno}
!   The line number of the class statement within the file named by
    \member{file}.
  \end{memberdesc}
--- 69,102 ----
  
  \begin{memberdesc}[class descriptor]{file}
!   Name of the file containing the \code(class} statement defining the class.
  \end{memberdesc}
  
  \begin{memberdesc}[class descriptor]{lineno}
!   The line number of the \code{class} statement within the file named by
    \member{file}.
  \end{memberdesc}
+ 
+ \subsection{Function Descriptor Objects \label{pyclbr-function-objects}}
+ 
+ The function descriptor objects used as values in the dictionary returned
+ by \function{readmodule_ex()} provide the following data members:
+ 
+ 
+ \begin{memberdesc}[function descriptor]{module}
+   The name of the module defining the function described by the function
+   descriptor.
+ \end{memberdesc}
+ 
+ \begin{memberdesc}[function descriptor]{name}
+   The name of the function.
+ \end{memberdesc}
+ 
+ \begin{memberdesc}[function descriptor]{file}
+   Name of the file containing the \code{def} statement defining the function.
+ \end{memberdesc}
+ 
+ \begin{memberdesc}[function descriptor]{lineno}
+   The line number of the \code{def} statement within the file named by
+   \member{file}.
+ \end{memberdesc}
+