Doc/library/undoc.rst

   1
   2 .. _undoc:
   3
   4 ********************
   5 Undocumented Modules
   6 ********************
   7
   8 Here's a quick listing of modules that are currently undocumented, but that
   9 should be documented.  Feel free to contribute documentation for them!  (Send
  10 via email to docs@python.org.)
  11
  12 The idea and original contents for this chapter were taken from a posting by
  13 Fredrik Lundh; the specific contents of this chapter have been substantially
  14 revised.
  15
  16
  17 Miscellaneous useful utilities
  18 ==============================
  19
  20 Some of these are very old and/or not very robust; marked with "hmm."
  21
  22 :mod:`ihooks`
  23    --- Import hook support (for :mod:`rexec`; may become obsolete).
  24
  25
  26 Platform specific modules
  27 =========================
  28
  29 These modules are used to implement the :mod:`os.path` module, and are not
  30 documented beyond this mention.  There's little need to document these.
  31
  32 :mod:`ntpath`
  33    --- Implementation of :mod:`os.path` on Win32, Win64, WinCE, and OS/2 platforms.
  34
  35 :mod:`posixpath`
  36    --- Implementation of :mod:`os.path` on POSIX.
  37
  38 :mod:`bsddb185`
  39    --- Backwards compatibility module for systems which still use the Berkeley DB
  40    1.85 module.  It is normally only available on certain BSD Unix-based systems.
  41    It should never be used directly.
  42
  43
  44 Multimedia
  45 ==========
  46
  47 :mod:`audiodev`
  48    --- Platform-independent API for playing audio data.
  49
  50 :mod:`linuxaudiodev`
  51    --- Play audio data on the Linux audio device.  Replaced in Python 2.3 by the
  52    :mod:`ossaudiodev` module.
  53
  54 :mod:`sunaudio`
  55    --- Interpret Sun audio headers (may become obsolete or a tool/demo).
  56
  57 :mod:`toaiff`
  58    --- Convert "arbitrary" sound files to AIFF files; should probably become a tool
  59    or demo.  Requires the external program :program:`sox`.
  60
  61
  62 .. _undoc-mac-modules:
  63
  64 Undocumented Mac OS modules
  65 ===========================
  66
  67
  68 :mod:`applesingle` --- AppleSingle decoder
  69 ------------------------------------------
  70
  71 .. module:: applesingle
  72    :platform: Mac
  73    :synopsis: Rudimentary decoder for AppleSingle format files.
  74
  75
  76
  77 :mod:`buildtools` --- Helper module for BuildApplet and Friends
  78 ---------------------------------------------------------------
  79
  80 .. module:: buildtools
  81    :platform: Mac
  82    :synopsis: Helper module for BuildApplet, BuildApplication and macfreeze.
  83
  84
  85 .. deprecated:: 2.4
  86
  87 :mod:`cfmfile` --- Code Fragment Resource module
  88 ------------------------------------------------
  89
  90 .. module:: cfmfile
  91    :platform: Mac
  92    :synopsis: Code Fragment Resource module.
  93
  94
  95 :mod:`cfmfile` is a module that understands Code Fragments and the accompanying
  96 "cfrg" resources. It can parse them and merge them, and is used by
  97 BuildApplication to combine all plugin modules to a single executable.
  98
  99 .. deprecated:: 2.4
 100
 101 :mod:`icopen` --- Internet Config replacement for :meth:`open`
 102 --------------------------------------------------------------
 103
 104 .. module:: icopen
 105    :platform: Mac
 106    :synopsis: Internet Config replacement for open().
 107
 108
 109 Importing :mod:`icopen` will replace the builtin :meth:`open` with a version
 110 that uses Internet Config to set file type and creator for new files.
 111
 112
 113 :mod:`macerrors` --- Mac OS Errors
 114 ----------------------------------
 115
 116 .. module:: macerrors
 117    :platform: Mac
 118    :synopsis: Constant definitions for many Mac OS error codes.
 119
 120
 121 :mod:`macerrors` contains constant definitions for many Mac OS error codes.
 122
 123
 124 :mod:`macresource` --- Locate script resources
 125 ----------------------------------------------
 126
 127 .. module:: macresource
 128    :platform: Mac
 129    :synopsis: Locate script resources.
 130
 131
 132 :mod:`macresource` helps scripts finding their resources, such as dialogs and
 133 menus, without requiring special case code for when the script is run under
 134 MacPython, as a MacPython applet or under OSX Python.
 135
 136
 137 :mod:`Nav` --- NavServices calls
 138 --------------------------------
 139
 140 .. module:: Nav
 141    :platform: Mac
 142    :synopsis: Interface to Navigation Services.
 143
 144
 145 A low-level interface to Navigation Services.
 146
 147
 148 :mod:`PixMapWrapper` --- Wrapper for PixMap objects
 149 ---------------------------------------------------
 150
 151 .. module:: PixMapWrapper
 152    :platform: Mac
 153    :synopsis: Wrapper for PixMap objects.
 154
 155
 156 :mod:`PixMapWrapper` wraps a PixMap object with a Python object that allows
 157 access to the fields by name. It also has methods to convert to and from
 158 :mod:`PIL` images.
 159
 160
 161 :mod:`videoreader` --- Read QuickTime movies
 162 --------------------------------------------
 163
 164 .. module:: videoreader
 165    :platform: Mac
 166    :synopsis: Read QuickTime movies frame by frame for further processing.
 167
 168
 169 :mod:`videoreader` reads and decodes QuickTime movies and passes a stream of
 170 images to your program. It also provides some support for audio tracks.
 171
 172
 173 :mod:`W` --- Widgets built on :mod:`FrameWork`
 174 ----------------------------------------------
 175
 176 .. module:: W
 177    :platform: Mac
 178    :synopsis: Widgets for the Mac, built on top of FrameWork.
 179
 180
 181 The :mod:`W` widgets are used extensively in the :program:`IDE`.
 182
 183
 184 .. _obsolete-modules:
 185
 186 Obsolete
 187 ========
 188
 189 These modules are not normally available for import; additional work must be
 190 done to make them available.
 191
 192 These extension modules written in C are not built by default. Under Unix, these
 193 must be enabled by uncommenting the appropriate lines in :file:`Modules/Setup`
 194 in the build tree and either rebuilding Python if the modules are statically
 195 linked, or building and installing the shared object if using dynamically-loaded
 196 extensions.
 197
 198 .. (lib-old is empty as of Python 2.5)
 199
 200    Those which are written in Python will be installed into the directory
 201    \file{lib-old/} installed as part of the standard library.  To use
 202    these, the directory must be added to \code{sys.path}, possibly using
 203    \envvar{PYTHONPATH}.
 204
 205 :mod:`timing`
 206    --- Measure time intervals to high resolution (use :func:`time.clock` instead).
 207
 208
 209 SGI-specific Extension modules
 210 ==============================
 211
 212 The following are SGI specific, and may be out of touch with the current version
 213 of reality.
 214
 215 :mod:`cl`
 216    --- Interface to the SGI compression library.
 217
 218 :mod:`sv`
 219    --- Interface to the "simple video" board on SGI Indigo (obsolete hardware).
 220