Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 1 | \chapter{Undocumented Modules \label{undoc}} |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 2 | |
| 3 | Here's a quick listing of modules that are currently undocumented, but |
| 4 | that should be documented. Feel free to contribute documentation for |
Fred Drake | 9d84308 | 2003-07-30 02:55:28 +0000 | [diff] [blame] | 5 | them! (Send via email to \email{docs@python.org}.) |
Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 6 | |
| 7 | The idea and original contents for this chapter were taken |
| 8 | from a posting by Fredrik Lundh; the specific contents of this chapter |
| 9 | have been substantially revised. |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 10 | |
| 11 | |
Fred Drake | 16e81f4 | 1999-02-24 19:57:14 +0000 | [diff] [blame] | 12 | \section{Frameworks} |
| 13 | |
| 14 | Frameworks tend to be harder to document, but are well worth the |
| 15 | effort spent. |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 16 | |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 17 | \begin{description} |
Andrew M. Kuchling | 32dbdda | 2004-08-07 19:21:59 +0000 | [diff] [blame] | 18 | \item None at this time. |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 19 | \end{description} |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 20 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 21 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 22 | \section{Miscellaneous useful utilities} |
| 23 | |
Fred Drake | ae4d5c2 | 1999-06-23 14:56:13 +0000 | [diff] [blame] | 24 | Some of these are very old and/or not very robust; marked with ``hmm.'' |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 25 | |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 26 | \begin{description} |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 27 | \item[\module{bdb}] |
Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 28 | --- A generic Python debugger base class (used by pdb). |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 29 | |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 30 | \item[\module{ihooks}] |
Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 31 | --- Import hook support (for \refmodule{rexec}; may become obsolete). |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 32 | \end{description} |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 33 | |
Guido van Rossum | 9085822 | 1997-08-15 02:52:46 +0000 | [diff] [blame] | 34 | |
Andrew M. Kuchling | 32dbdda | 2004-08-07 19:21:59 +0000 | [diff] [blame] | 35 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 36 | \section{Platform specific modules} |
| 37 | |
Fred Drake | 6f49e0a | 1999-06-18 19:58:59 +0000 | [diff] [blame] | 38 | These modules are used to implement the \refmodule{os.path} module, |
| 39 | and are not documented beyond this mention. There's little need to |
| 40 | document these. |
Fred Drake | 560bcae | 1999-02-02 18:59:58 +0000 | [diff] [blame] | 41 | |
| 42 | \begin{description} |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 43 | \item[\module{ntpath}] |
Fred Drake | 8b6ed26 | 2003-05-09 15:04:56 +0000 | [diff] [blame] | 44 | --- Implementation of \module{os.path} on Win32, Win64, WinCE, and |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 45 | OS/2 platforms. |
Fred Drake | 560bcae | 1999-02-02 18:59:58 +0000 | [diff] [blame] | 46 | |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 47 | \item[\module{posixpath}] |
Fred Drake | 8b6ed26 | 2003-05-09 15:04:56 +0000 | [diff] [blame] | 48 | --- Implementation of \module{os.path} on \POSIX. |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 49 | |
Skip Montanaro | 6d9f45b | 2003-05-06 20:40:17 +0000 | [diff] [blame] | 50 | \item[\module{bsddb185}] |
| 51 | --- Backwards compatibility module for systems which still use the Berkeley |
Fred Drake | e0d4aec | 2006-07-30 03:03:43 +0000 | [diff] [blame] | 52 | DB 1.85 module. It is normally only available on certain BSD \UNIX-based |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 53 | systems. It should never be used directly. |
Skip Montanaro | 6d9f45b | 2003-05-06 20:40:17 +0000 | [diff] [blame] | 54 | \end{description} |
| 55 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 56 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 57 | \section{Multimedia} |
| 58 | |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 59 | \begin{description} |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 60 | \item[\module{audiodev}] |
Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 61 | --- Platform-independent API for playing audio data. |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 62 | |
Fred Drake | 326c72a | 2003-01-08 07:21:53 +0000 | [diff] [blame] | 63 | \item[\module{linuxaudiodev}] |
| 64 | --- Play audio data on the Linux audio device. Replaced in Python 2.3 |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 65 | by the \module{ossaudiodev} module. |
Fred Drake | 326c72a | 2003-01-08 07:21:53 +0000 | [diff] [blame] | 66 | |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 67 | \item[\module{sunaudio}] |
Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 68 | --- Interpret Sun audio headers (may become obsolete or a tool/demo). |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 69 | |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 70 | \item[\module{toaiff}] |
Fred Drake | 6f49e0a | 1999-06-18 19:58:59 +0000 | [diff] [blame] | 71 | --- Convert "arbitrary" sound files to AIFF files; should probably |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 72 | become a tool or demo. Requires the external program \program{sox}. |
Johannes Gijsbers | f654c1c | 2004-12-21 21:14:42 +0000 | [diff] [blame] | 73 | \end{description} |
Fred Drake | 326c72a | 2003-01-08 07:21:53 +0000 | [diff] [blame] | 74 | |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 75 | |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 76 | \section{Obsolete \label{obsolete-modules}} |
Guido van Rossum | 612316f | 1997-03-14 04:12:52 +0000 | [diff] [blame] | 77 | |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 78 | These modules are not normally available for import; additional work |
| 79 | must be done to make them available. |
| 80 | |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 81 | %%% lib-old is empty as of Python 2.5 |
| 82 | % Those which are written in Python will be installed into the directory |
| 83 | % \file{lib-old/} installed as part of the standard library. To use |
| 84 | % these, the directory must be added to \code{sys.path}, possibly using |
| 85 | % \envvar{PYTHONPATH}. |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 86 | |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 87 | These extension modules written in C are not built by default. |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 88 | Under \UNIX, these must be enabled by uncommenting the appropriate |
| 89 | lines in \file{Modules/Setup} in the build tree and either rebuilding |
| 90 | Python if the modules are statically linked, or building and |
| 91 | installing the shared object if using dynamically-loaded extensions. |
| 92 | |
| 93 | % XXX need Windows instructions! |
Guido van Rossum | cfaf143 | 1997-07-16 15:48:20 +0000 | [diff] [blame] | 94 | |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 95 | \begin{description} |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 96 | \item[\module{timing}] |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 97 | --- Measure time intervals to high resolution (use \function{time.clock()} |
| 98 | instead). |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 99 | \end{description} |
Guido van Rossum | 61c2703 | 1997-07-18 21:08:07 +0000 | [diff] [blame] | 100 | |
Fred Drake | 88fa962 | 2000-09-11 05:23:25 +0000 | [diff] [blame] | 101 | \section{SGI-specific Extension modules} |
Guido van Rossum | b9ee9c2 | 1997-06-02 17:34:02 +0000 | [diff] [blame] | 102 | |
Fred Drake | ae4d5c2 | 1999-06-23 14:56:13 +0000 | [diff] [blame] | 103 | The following are SGI specific, and may be out of touch with the |
| 104 | current version of reality. |
Guido van Rossum | 8d2893b | 1997-03-27 20:57:52 +0000 | [diff] [blame] | 105 | |
Fred Drake | 3700b6f | 1998-08-07 16:02:28 +0000 | [diff] [blame] | 106 | \begin{description} |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 107 | \item[\module{cl}] |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 108 | --- Interface to the SGI compression library. |
Guido van Rossum | 8d2893b | 1997-03-27 20:57:52 +0000 | [diff] [blame] | 109 | |
Fred Drake | e4694eb | 1999-07-01 20:42:57 +0000 | [diff] [blame] | 110 | \item[\module{sv}] |
Fred Drake | 272fb3a | 1998-04-07 14:15:28 +0000 | [diff] [blame] | 111 | --- Interface to the ``simple video'' board on SGI Indigo |
Georg Brandl | a5a0704 | 2006-03-17 18:47:14 +0000 | [diff] [blame] | 112 | (obsolete hardware). |
Fred Drake | 3700b6f | 1998-08-07 16:02:28 +0000 | [diff] [blame] | 113 | \end{description} |