/Doc/library/undoc.rst

http://unladen-swallow.googlecode.com/ · ReStructuredText · 248 lines · 157 code · 91 blank · 0 comment · 0 complexity · 9380d5a48b1aa50906e4b1bf699833c5 MD5 · raw file

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