[Python-checkins] CVS: python/dist/src/Doc/lib libinspect.tex,1.2,1.3

Fred L. Drake fdrake@users.sourceforge.net
Tue, 10 Apr 2001 08:12:36 -0700

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

Modified Files:
Log Message:

Add documentation for getmoduleinfo() and getmodulename().

Index: libinspect.tex
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libinspect.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** libinspect.tex	2001/02/28 23:01:38	1.2
--- libinspect.tex	2001/04/10 15:12:34	1.3
*** 94,97 ****
--- 94,120 ----
+ \begin{funcdesc}{getmoduleinfo}{path}
+   Return a tuple of values that describe how Python will interpret the
+   file identified by \var{path} if it is a module, or \code{None} if
+   it would not be identified as a module.  The return tuple is
+   \code{(\var{name}, \var{suffix}, \var{mode}, \var{mtype})}, where
+   \var{name} is the name of the module without the name of any
+   enclosing package, \var{suffix} is the trailing part of the file
+   name (which may not be a dot-delimited extension), \var{mode} is the
+   \function{open()} mode that would be used (\code{'r'} or
+   \code{'rb'}), and \var{mtype} is an integer giving the type of the
+   module.  \var{mtype} will have a value which can be compared to the
+   constants defined in the \refmodule{imp} module; see the
+   documentation for that module for more information on module types.
+ \end{funcdesc}
+ \begin{funcdesc}{getmodulename}{path}
+   Return the name of the module named by the file \var{path}, without
+   including the names of enclosing packages.  This uses the same
+   algortihm as the interpreter uses when searching for modules.  If
+   the name cannot be matched according to the interpreter's rules,
+   \code{None} is returned.
+ \end{funcdesc}
    Return true if the object is a module.