
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.


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).

   Warning: The ``ihooks`` module has been removed in Python 3.0.


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.


Multimedia
==========

``audiodev``
   --- Platform-independent API for playing audio data.

   Warning: The ``audiodev`` module has been removed in 3.0.

``linuxaudiodev``
   --- Play audio data on the Linux audio device.  Replaced in Python
   2.3 by the ``ossaudiodev`` module.

   Warning: The ``linuxaudiodev`` module has been removed in Python 3.0.

``sunaudio``
   --- Interpret Sun audio headers (may become obsolete or a
   tool/demo).

   Warning: The ``sunaudio`` module has been removed in Python 3.0.

``toaiff``
   --- Convert "arbitrary" sound files to AIFF files; should probably
   become a tool or demo.  Requires the external program **sox**.

   Warning: The ``toaiff`` module has been removed in 3.0.


Undocumented Mac OS modules
===========================


``applesingle`` --- AppleSingle decoder
---------------------------------------

Platform: Mac

*Platforms: *Mac

Deprecated since version 2.6.


``buildtools`` --- Helper module for BuildApplet and Friends
------------------------------------------------------------

Platform: Mac

*Platforms: *Mac

Deprecated since version 2.4.


``cfmfile`` --- Code Fragment Resource module
---------------------------------------------

Platform: Mac

*Platforms: *Mac

``cfmfile`` is a module that understands Code Fragments and the
accompanying "cfrg" resources. It can parse them and merge them, and
is used by BuildApplication to combine all plugin modules to a single
executable.

Deprecated since version 2.4.


``icopen`` --- Internet Config replacement for ``open()``
---------------------------------------------------------

Platform: Mac

*Platforms: *Mac

Importing ``icopen`` will replace the builtin ``open()`` with a
version that uses Internet Config to set file type and creator for new
files.

Deprecated since version 2.6.


``macerrors`` --- Mac OS Errors
-------------------------------

Platform: Mac

*Platforms: *Mac

``macerrors`` contains constant definitions for many Mac OS error
codes.

Deprecated since version 2.6.


``macresource`` --- Locate script resources
-------------------------------------------

Platform: Mac

*Platforms: *Mac

``macresource`` helps scripts finding their resources, such as dialogs
and menus, without requiring special case code for when the script is
run under MacPython, as a MacPython applet or under OSX Python.

Deprecated since version 2.6.


``Nav`` --- NavServices calls
-----------------------------

Platform: Mac

*Platforms: *Mac

A low-level interface to Navigation Services.

Deprecated since version 2.6.


``PixMapWrapper`` --- Wrapper for PixMap objects
------------------------------------------------

Platform: Mac

*Platforms: *Mac

``PixMapWrapper`` wraps a PixMap object with a Python object that
allows access to the fields by name. It also has methods to convert to
and from ``PIL`` images.

Deprecated since version 2.6.


``videoreader`` --- Read QuickTime movies
-----------------------------------------

Platform: Mac

*Platforms: *Mac

``videoreader`` reads and decodes QuickTime movies and passes a stream
of images to your program. It also provides some support for audio
tracks.

Deprecated since version 2.6.


``W`` --- Widgets built on ``FrameWork``
----------------------------------------

Platform: Mac

*Platforms: *Mac

The ``W`` widgets are used extensively in the **IDE**.

Deprecated since version 2.6.


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).

   Warning: The ``timing`` module has been removed in Python 3.0.


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).

   Warning: The ``sv`` module has been removed in Python 3.0.
