blob: 72abadff695b517cf40f42f62af0ae2a7322c641 [file] [log] [blame]
Fred Drake4d0d6212000-10-14 05:08:34 +00001\chapter{Undocumented Modules \label{undocumented-modules}}
2
3
4The modules in this chapter are poorly documented (if at all). If you
5wish to contribute documentation of any of these modules, please get in
Fred Drake8da359b2001-07-14 02:09:32 +00006touch with
Fred Drake9d843082003-07-30 02:55:28 +00007\ulink{\email{docs@python.org}}{mailto:docs@python.org}.
Fred Drake4d0d6212000-10-14 05:08:34 +00008
9\localmoduletable
10
11
Jack Jansen945bf5f2001-09-11 21:24:07 +000012\section{\module{applesingle} --- AppleSingle decoder}
13\declaremodule{standard}{applesingle}
14 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000015\modulesynopsis{Rudimentary decoder for AppleSingle format files.}
Jack Jansen945bf5f2001-09-11 21:24:07 +000016
17
Fred Drake4d0d6212000-10-14 05:08:34 +000018\section{\module{buildtools} --- Helper module for BuildApplet and Friends}
19\declaremodule{standard}{buildtools}
20 \platform{Mac}
Fred Drake12060e52001-07-10 14:19:45 +000021\modulesynopsis{Helper module for BuildApplet, BuildApplication and
Fred Drakeac968682002-01-17 04:51:55 +000022 macfreeze.}
Fred Drake4d0d6212000-10-14 05:08:34 +000023
Brett Cannon7706c2d2005-02-13 22:50:04 +000024\deprecated{2.4}
Fred Drake4d0d6212000-10-14 05:08:34 +000025
26\section{\module{cfmfile} --- Code Fragment Resource module}
27\declaremodule{standard}{cfmfile}
28 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000029\modulesynopsis{Code Fragment Resource module.}
Fred Drake4d0d6212000-10-14 05:08:34 +000030
31\module{cfmfile} is a module that understands Code Fragments and the
32accompanying ``cfrg'' resources. It can parse them and merge them, and is
33used by BuildApplication to combine all plugin modules to a single
34executable.
35
Brett Cannon7706c2d2005-02-13 22:50:04 +000036\deprecated{2.4}
Fred Drake4d0d6212000-10-14 05:08:34 +000037
Jack Jansen945bf5f2001-09-11 21:24:07 +000038\section{\module{icopen} --- Internet Config replacement for \method{open()}}
39\declaremodule{standard}{icopen}
40 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000041\modulesynopsis{Internet Config replacement for \method{open()}.}
Jack Jansen945bf5f2001-09-11 21:24:07 +000042
43Importing \module{icopen} will replace the builtin \method{open()}
44with a version that uses Internet Config to set file type and creator
45for new files.
46
47
Fred Drake0f0380a2001-10-01 17:04:10 +000048\section{\module{macerrors} --- Mac OS Errors}
Fred Drake4d0d6212000-10-14 05:08:34 +000049\declaremodule{standard}{macerrors}
50 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000051\modulesynopsis{Constant definitions for many Mac OS error codes.}
Fred Drake4d0d6212000-10-14 05:08:34 +000052
Raymond Hettinger68804312005-01-01 00:28:46 +000053\module{macerrors} contains constant definitions for many Mac OS error
Fred Drakeac968682002-01-17 04:51:55 +000054codes.
Fred Drake4d0d6212000-10-14 05:08:34 +000055
56
Jack Jansen945bf5f2001-09-11 21:24:07 +000057\section{\module{macresource} --- Locate script resources}
58\declaremodule{standard}{macresource}
Fred Drake4d0d6212000-10-14 05:08:34 +000059 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000060\modulesynopsis{Locate script resources.}
Fred Drake4d0d6212000-10-14 05:08:34 +000061
Jack Jansen945bf5f2001-09-11 21:24:07 +000062\module{macresource} helps scripts finding their resources, such as
63dialogs and menus, without requiring special case code for when the
64script is run under MacPython, as a MacPython applet or under OSX Python.
65
Fred Drakeee0fe0b2001-09-12 00:43:13 +000066\section{\module{Nav} --- NavServices calls}
Andrew M. Kuchlingc12527e2004-07-21 21:34:45 +000067\declaremodule{standard}{Nav}
Jack Jansen945bf5f2001-09-11 21:24:07 +000068 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000069\modulesynopsis{Interface to Navigation Services.}
Jack Jansen945bf5f2001-09-11 21:24:07 +000070
71A low-level interface to Navigation Services.
Fred Drake4d0d6212000-10-14 05:08:34 +000072
Fred Drake4d0d6212000-10-14 05:08:34 +000073\section{\module{PixMapWrapper} --- Wrapper for PixMap objects}
74\declaremodule{standard}{PixMapWrapper}
75 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000076\modulesynopsis{Wrapper for PixMap objects.}
Fred Drake4d0d6212000-10-14 05:08:34 +000077
78\module{PixMapWrapper} wraps a PixMap object with a Python object that
79allows access to the fields by name. It also has methods to convert
80to and from \module{PIL} images.
81
Fred Drakeac968682002-01-17 04:51:55 +000082\section{\module{videoreader} --- Read QuickTime movies}
Jack Jansen945bf5f2001-09-11 21:24:07 +000083\declaremodule{standard}{videoreader}
84 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000085\modulesynopsis{Read QuickTime movies frame by frame for further processing.}
Jack Jansen945bf5f2001-09-11 21:24:07 +000086
87\module{videoreader} reads and decodes QuickTime movies and passes
88a stream of images to your program. It also provides some support for
89audio tracks.
90
Fred Drake4d0d6212000-10-14 05:08:34 +000091\section{\module{W} --- Widgets built on \module{FrameWork}}
92\declaremodule{standard}{W}
93 \platform{Mac}
Fred Drakeac968682002-01-17 04:51:55 +000094\modulesynopsis{Widgets for the Mac, built on top of \refmodule{FrameWork}.}
Fred Drake4d0d6212000-10-14 05:08:34 +000095
96The \module{W} widgets are used extensively in the \program{IDE}.
Jack Jansen945bf5f2001-09-11 21:24:07 +000097