34. Undocumented Modules

IronPython

34. Undocumented Modules

Here’s a quick listing of modules that are currently undocumented, but that should be documented. Feel free to contribute documentation for them! (Send via email to docs@python.org.)

The idea and original contents for this chapter were taken from a posting by Fredrik Lundh; the specific contents of this chapter have been substantially revised.

34.1. Miscellaneous useful utilities

Some of these are very old and/or not very robust; marked with “hmm.”

ihooks
— Import hook support (for rexec; may become obsolete). Removed in Python 3.x.

34.2. Platform specific modules

These modules are used to implement the os.path module, and are not documented beyond this mention. There’s little need to document these.

ntpath
— Implementation of os.path on Win32, Win64, WinCE, and OS/2 platforms.
posixpath
— Implementation of os.path on POSIX.
bsddb185
— Backwards compatibility module for systems which still use the Berkeley DB 1.85 module. It is normally only available on certain BSD Unix-based systems. It should never be used directly.

34.3. Multimedia

audiodev
— Platform-independent API for playing audio data. Removed in Python 3.x.
toaiff
— Convert “arbitrary” sound files to AIFF files; should probably become a tool or demo. Requires the external program sox. Removed in Python 3.x.

34.4. Obsolete

These modules are not normally available for import; additional work must be done to make them available.

These extension modules written in C are not built by default. Under Unix, these must be enabled by uncommenting the appropriate lines in Modules/Setup in the build tree and either rebuilding Python if the modules are statically linked, or building and installing the shared object if using dynamically-loaded extensions.

timing
— Measure time intervals to high resolution (use time.clock() instead). Removed in Python 3.x.

34.5. SGI-specific Extension modules

The following are SGI specific, and may be out of touch with the current version of reality.

cl
— Interface to the SGI compression library.
sv
— Interface to the “simple video” board on SGI Indigo (obsolete hardware). Removed in Python 3.x.