← Back to branch summary

~malept/ubuntu/lucid/python2.6/dev-dependency-fix

« back to all changes in this revision

Viewing changes to Doc/library/undoc.rst

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2009-02-13 12:51:00 UTC
  • Revision ID: james.westby@ubuntu.com-20090213125100-uufgcb9yeqzujpqw
Tags: upstream-2.6.1
Import upstream version 2.6.1

Show diffs side-by-side

added added

removed removed

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