mirror of https://github.com/python/cpython
Removed entries for several modules which have been documented.
Updated comments on several remaining modules.
This commit is contained in:
parent
4c8d83f311
commit
e4694eba0f
|
@ -13,16 +13,16 @@ Frameworks tend to be harder to document, but are well worth the
|
||||||
effort spent.
|
effort spent.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[Tkinter.py]
|
\item[\module{Tkinter}]
|
||||||
--- Interface to Tcl/Tk for graphical user interfaces;
|
--- Interface to Tcl/Tk for graphical user interfaces;
|
||||||
Fredrik Lundh is working on this one! See \emph{An Introduction to
|
Fredrik Lundh is working on this one! See \emph{An Introduction to
|
||||||
Tkinter} at \url{http://www.pythonware.com/library/} for on-line
|
Tkinter} at \url{http://www.pythonware.com/library/} for on-line
|
||||||
reference material.
|
reference material.
|
||||||
|
|
||||||
\item[Tkdnd.py]
|
\item[\module{Tkdnd}]
|
||||||
--- Drag-and-drop support for \module{Tkinter}.
|
--- Drag-and-drop support for \module{Tkinter}.
|
||||||
|
|
||||||
\item[test]
|
\item[\module{test}]
|
||||||
--- Regression testing framework. This is used for the Python
|
--- Regression testing framework. This is used for the Python
|
||||||
regression test, but is useful for other Python libraries as well.
|
regression test, but is useful for other Python libraries as well.
|
||||||
This is a package rather than a module.
|
This is a package rather than a module.
|
||||||
|
@ -34,17 +34,18 @@ This is a package rather than a module.
|
||||||
Some of these are very old and/or not very robust; marked with ``hmm.''
|
Some of these are very old and/or not very robust; marked with ``hmm.''
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[dircmp.py]
|
\item[\module{dircmp}]
|
||||||
--- class to build directory diff tools on (may become a demo or tool)
|
--- class to build directory diff tools on (may become a demo or tool)
|
||||||
|
|
||||||
\item[pty.py]
|
\item[\module{bdb}]
|
||||||
--- Pseudo terminal utilities
|
|
||||||
|
|
||||||
\item[bdb.py]
|
|
||||||
--- A generic Python debugger base class (used by pdb)
|
--- A generic Python debugger base class (used by pdb)
|
||||||
|
|
||||||
\item[ihooks.py]
|
\item[\module{ihooks}]
|
||||||
--- Import hook support (for \refmodule{rexec}; may become obsolete)
|
--- Import hook support (for \refmodule{rexec}; may become obsolete)
|
||||||
|
|
||||||
|
\item[\module{tzparse}]
|
||||||
|
--- Parse a timezone specification (unfinished; may disappear in the
|
||||||
|
future)
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
|
|
||||||
|
@ -55,13 +56,13 @@ and are not documented beyond this mention. There's little need to
|
||||||
document these.
|
document these.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[dospath.py]
|
\item[\module{dospath}]
|
||||||
--- implementation of \module{os.path} on MS-DOS
|
--- implementation of \module{os.path} on MS-DOS
|
||||||
|
|
||||||
\item[ntpath.py]
|
\item[\module{ntpath}]
|
||||||
--- implementation on \module{os.path} on 32-bit Windows
|
--- implementation on \module{os.path} on 32-bit Windows
|
||||||
|
|
||||||
\item[posixpath.py]
|
\item[\module{posixpath}]
|
||||||
--- implementation on \module{os.path} on \POSIX{}
|
--- implementation on \module{os.path} on \POSIX{}
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
|
@ -69,45 +70,18 @@ document these.
|
||||||
\section{Multimedia}
|
\section{Multimedia}
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[audiodev.py]
|
\item[\module{audiodev}]
|
||||||
--- Platform-independent API for playing audio data
|
--- Platform-independent API for playing audio data
|
||||||
|
|
||||||
\item[sunaudio.py]
|
\item[\module{sunaudio}]
|
||||||
--- interpret sun audio headers (may become obsolete or a tool/demo)
|
--- interpret sun audio headers (may become obsolete or a tool/demo)
|
||||||
|
|
||||||
\item[toaiff.py]
|
\item[\module{toaiff}]
|
||||||
--- Convert "arbitrary" sound files to AIFF files; should probably
|
--- Convert "arbitrary" sound files to AIFF files; should probably
|
||||||
become a tool or demo. Requires the external program \program{sox}.
|
become a tool or demo. Requires the external program \program{sox}.
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
|
|
||||||
\section{Oddities}
|
|
||||||
|
|
||||||
These modules are probably also obsolete, or just not very useful.
|
|
||||||
Some of these may be made into tools or demos in future releases.
|
|
||||||
|
|
||||||
\begin{description}
|
|
||||||
\item[find.py]
|
|
||||||
--- find files matching pattern in directory tree (may become a demo
|
|
||||||
or tool, or possibly obsolete)
|
|
||||||
|
|
||||||
\item[grep.py]
|
|
||||||
--- grep (may become a demo or tool)
|
|
||||||
|
|
||||||
\item[mutex.py]
|
|
||||||
--- Mutual exclusion --- for use with module sched
|
|
||||||
|
|
||||||
\item[packmail.py]
|
|
||||||
--- create a self-unpacking \UNIX{} shell archive
|
|
||||||
|
|
||||||
\item[sched.py]
|
|
||||||
--- event scheduler class
|
|
||||||
|
|
||||||
\item[tzparse.py]
|
|
||||||
--- Parse a timezone specification (unfinished)
|
|
||||||
\end{description}
|
|
||||||
|
|
||||||
|
|
||||||
\section{Obsolete}
|
\section{Obsolete}
|
||||||
|
|
||||||
These modules are not on the standard module search path;
|
These modules are not on the standard module search path;
|
||||||
|
@ -118,70 +92,86 @@ To use any of these modules, add that directory to \code{sys.path},
|
||||||
possibly using \envvar{PYTHONPATH}.
|
possibly using \envvar{PYTHONPATH}.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[newdir.py]
|
\item[\module{newdir}]
|
||||||
--- New \function{dir()} function (the standard \function{dir()} is
|
--- New \function{dir()} function (the standard \function{dir()} is
|
||||||
now just as good)
|
now just as good)
|
||||||
|
|
||||||
\item[addpack.py]
|
\item[\module{addpack}]
|
||||||
--- standard support for "packages"
|
--- alternate approach to packages
|
||||||
|
|
||||||
\item[codehack.py]
|
\item[\module{codehack}]
|
||||||
--- Extract function name or line number from a function
|
--- Extract function name or line number from a function
|
||||||
code object (these are now accessible as attributes:
|
code object (these are now accessible as attributes:
|
||||||
\member{co.co_name}, \member{func.func_name},
|
\member{co.co_name}, \member{func.func_name},
|
||||||
\member{co.co_firstlineno}).
|
\member{co.co_firstlineno}).
|
||||||
|
|
||||||
\item[dump.py]
|
\item[\module{dump}]
|
||||||
--- Print python code that reconstructs a variable
|
--- Print python code that reconstructs a variable
|
||||||
|
|
||||||
\item[fmt.py]
|
\item[\module{fmt}]
|
||||||
--- text formatting abstractions (too slow)
|
--- text formatting abstractions (too slow)
|
||||||
|
|
||||||
\item[Para.py]
|
\item[\module{Para}]
|
||||||
--- helper for fmt.py
|
--- helper for fmt.py
|
||||||
|
|
||||||
\item[lockfile.py]
|
\item[\module{lockfile}]
|
||||||
--- wrapper around FCNTL file locking (use
|
--- wrapper around FCNTL file locking (use
|
||||||
\function{fcntl.lockf()}/\function{flock()} intead; see \refmodule{fcntl})
|
\function{fcntl.lockf()}/\function{flock()} intead; see \refmodule{fcntl})
|
||||||
|
|
||||||
\item[poly.py]
|
\item[\module{poly}]
|
||||||
--- Polynomials
|
--- Polynomials
|
||||||
|
|
||||||
\item[tb.py]
|
\item[\module{tb}]
|
||||||
--- Print tracebacks, with a dump of local variables (use
|
--- Print tracebacks, with a dump of local variables (use
|
||||||
\function{pdb.pm()} or \refmodule{traceback} instead)
|
\function{pdb.pm()} or \refmodule{traceback} instead)
|
||||||
|
|
||||||
\item[timingmodule]
|
\item[\module{timing}]
|
||||||
--- Measure time intervals to high resolution (use
|
--- Measure time intervals to high resolution (use
|
||||||
\function{time.clock()} instead). (This is an extension module.)
|
\function{time.clock()} instead). (This is an extension module.)
|
||||||
|
|
||||||
\item[util.py]
|
\item[\module{util}]
|
||||||
--- Useful functions that don't fit elsewhere.
|
--- Useful functions that don't fit elsewhere.
|
||||||
|
|
||||||
\item[wdb.py]
|
\item[\module{wdb}]
|
||||||
--- A primitive windowing debugger based on STDWIN.
|
--- A primitive windowing debugger based on STDWIN.
|
||||||
|
|
||||||
\item[whatsound.py]
|
\item[\module{whatsound}]
|
||||||
--- Recognize sound files; use \refmodule{sndhdr} instead.
|
--- Recognize sound files; use \refmodule{sndhdr} instead.
|
||||||
|
|
||||||
\item[zmod.py]
|
\item[\module{zmod}]
|
||||||
--- Compute properties of mathematical "fields"
|
--- Compute properties of mathematical "fields"
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
|
|
||||||
|
The following modules are obsolete, but are likely re-surface as tools
|
||||||
|
or scripts.
|
||||||
|
|
||||||
|
\begin{description}
|
||||||
|
\item[\module{find}]
|
||||||
|
--- find files matching pattern in directory tree
|
||||||
|
|
||||||
|
\item[\module{grep}]
|
||||||
|
--- grep
|
||||||
|
|
||||||
|
\item[\module{packmail}]
|
||||||
|
--- create a self-unpacking \UNIX{} shell archive
|
||||||
|
\end{description}
|
||||||
|
|
||||||
|
|
||||||
The following modules were documented in previous versions of this
|
The following modules were documented in previous versions of this
|
||||||
manual, but are now considered obsolete. The source for the
|
manual, but are now considered obsolete. The source for the
|
||||||
documentation is still available as part of the documentation source
|
documentation is still available as part of the documentation source
|
||||||
archive.
|
archive.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[ni]
|
\item[\module{ni}]
|
||||||
--- Import modules in ``packages.'' Basic package support is now
|
--- Import modules in ``packages.'' Basic package support is now
|
||||||
built in.
|
built in.
|
||||||
|
|
||||||
\item[rand]
|
\item[\module{rand}]
|
||||||
--- Old interface to the random number generator.
|
--- Old interface to the random number generator.
|
||||||
|
|
||||||
\item[soundex]
|
\item[\module{soundex}]
|
||||||
--- Algorithm for collapsing names which sound similar to a shared
|
--- Algorithm for collapsing names which sound similar to a shared
|
||||||
key. (This is an extension module.)
|
key. (This is an extension module.)
|
||||||
\end{description}
|
\end{description}
|
||||||
|
@ -190,27 +180,20 @@ key. (This is an extension module.)
|
||||||
\section{Extension modules}
|
\section{Extension modules}
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[dlmodule.c]
|
\item[\module{stdwin}]
|
||||||
--- A highly experimental and dangerous device for calling
|
|
||||||
arbitrary \C{} functions in arbitrary shared libraries.
|
|
||||||
|
|
||||||
\item[nismodule.c]
|
|
||||||
--- NIS (a.k.a. Sun's Yellow Pages) interface.
|
|
||||||
|
|
||||||
\item[stdwinmodule.c]
|
|
||||||
--- Interface to STDWIN (an old, unsupported
|
--- Interface to STDWIN (an old, unsupported
|
||||||
platform-independent GUI package). Obsolete; use Tkinter for a
|
platform-independent GUI package). Obsolete; use \module{Tkinter} for
|
||||||
platform-independent GUI instead.
|
a platform-independent GUI instead.
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
The following are SGI specific, and may be out of touch with the
|
The following are SGI specific, and may be out of touch with the
|
||||||
current version of reality.
|
current version of reality.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[clmodule.c]
|
\item[\module{cl}]
|
||||||
--- Interface to the SGI compression library.
|
--- Interface to the SGI compression library.
|
||||||
|
|
||||||
\item[svmodule.c]
|
\item[\module{sv}]
|
||||||
--- Interface to the ``simple video'' board on SGI Indigo
|
--- Interface to the ``simple video'' board on SGI Indigo
|
||||||
(obsolete hardware).
|
(obsolete hardware).
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
Loading…
Reference in New Issue