Doc/mac/undoc.tex

   1 \chapter{Undocumented Modules \label{undocumented-modules}}
   2
   3
   4 The modules in this chapter are poorly documented (if at all).  If you
   5 wish to contribute documentation of any of these modules, please get in
   6 touch with
   7 \ulink{\email{python-docs@python.org}}{mailto:python-docs@python.org}.
   8
   9 \localmoduletable
  10
  11
  12 \section{\module{applesingle} --- AppleSingle decoder}
  13 \declaremodule{standard}{applesingle}
  14   \platform{Mac}
  15 \modulesynopsis{Rudimentary decoder for AppleSingle format files}
  16
  17
  18 \section{\module{buildtools} --- Helper module for BuildApplet and Friends}
  19 \declaremodule{standard}{buildtools}
  20   \platform{Mac}
  21 \modulesynopsis{Helper module for BuildApplet, BuildApplication and
  22                 macfreeze}
  23
  24
  25 \section{\module{py_resource} --- Resources from Python code}
  26 \declaremodule[pyresource]{standard}{py_resource}
  27   \platform{Mac}
  28 \modulesynopsis{Helper to create \texttt{'PYC '} resources for compiled
  29                 applications}
  30
  31 This module is primarily used as a help module for
  32 \program{BuildApplet} and \program{BuildApplication}.  It is able to
  33 store compiled Python code as \texttt{'PYC~'} resources in a file.
  34
  35
  36 \section{\module{cfmfile} --- Code Fragment Resource module}
  37 \declaremodule{standard}{cfmfile}
  38   \platform{Mac}
  39 \modulesynopsis{Code Fragment Resource module}
  40
  41 \module{cfmfile} is a module that understands Code Fragments and the
  42 accompanying ``cfrg'' resources. It can parse them and merge them, and is
  43 used by BuildApplication to combine all plugin modules to a single
  44 executable.
  45
  46
  47 \section{\module{icopen} --- Internet Config replacement for \method{open()}}
  48 \declaremodule{standard}{icopen}
  49   \platform{Mac}
  50 \modulesynopsis{Internet Config replacement for \method{open()}}
  51
  52 Importing \module{icopen} will replace the builtin \method{open()}
  53 with a version that uses Internet Config to set file type and creator
  54 for new files.
  55
  56
  57 \section{\module{macerrors} --- Mac OS Errors}
  58 \declaremodule{standard}{macerrors}
  59   \platform{Mac}
  60 \modulesynopsis{Constant definitions for many Mac OS error codes}
  61
  62 \module{macerrors} cotains constant definitions for many Mac OS error codes.
  63
  64
  65 \section{\module{macfsn} --- NavServices calls}
  66 \declaremodule{standard}{macfsn}
  67   \platform{Mac}
  68 \modulesynopsis{NavServices versions of StandardFile calls}
  69
  70
  71 \module{macfsn} contains wrapper functions that have the same API as the macfs
  72 StandardFile calls, but are implemented with Navigation Services through the
  73 \refmodule{Nav}\refbimodindex{Nav} module. Importing it
  74 will replace the methods in \refmodule{macfs}\refbimodindex{macfs} with these,
  75 if Navigation Services is
  76 available on your machine.
  77
  78
  79 \section{\module{macresource} --- Locate script resources}
  80 \declaremodule{standard}{macresource}
  81   \platform{Mac}
  82 \modulesynopsis{Locate script resources}
  83
  84 \module{macresource} helps scripts finding their resources, such as
  85 dialogs and menus, without requiring special case code for when the
  86 script is run under MacPython, as a MacPython applet or under OSX Python.
  87
  88 \section{\module{Nav} --- NavServices calls}
  89 \declaremodule{standard}{Nac}
  90   \platform{Mac}
  91 \modulesynopsis{Interface to Navigation Services}
  92
  93 A low-level interface to Navigation Services.
  94
  95
  96 \section{\module{mactty} --- Serial line connections}
  97 \declaremodule{standard}{mactty}
  98   \platform{Mac}
  99 \modulesynopsis{Easy access serial to line connections}
 100
 101 This module is only available under Mac OS 9 or earlier in classic PPC
 102 MacPython.
 103
 104 \section{\module{mkcwproject} --- Create CodeWarrior projects}
 105 \declaremodule{standard}{mkcwproject}
 106   \platform{Mac}
 107 \modulesynopsis{Create CodeWarrior projects}
 108
 109 \module{mkcwproject} creates project files for the Metrowerks CodeWarrior
 110 development environment. It is a helper module for
 111 \refmodule{distutils}\refbimodindex{distutils} but can be used separately for more
 112 control.
 113
 114
 115 \section{\module{nsremote} --- Wrapper around Netscape OSA modules}
 116 \declaremodule{standard}{nsremote}
 117   \platform{Mac}
 118 \modulesynopsis{Wrapper around Netscape OSA modules}
 119
 120 \module{nsremote} is a wrapper around the Netscape OSA modules that
 121 allows you to easily send your browser to a given URL.  A related
 122 module that may be of interest is the \module{webbrowser} module,
 123 documented in the \citetitle[../lib/lib.html]{Python Library
 124 Reference}.
 125
 126
 127 \section{\module{PixMapWrapper} --- Wrapper for PixMap objects}
 128 \declaremodule{standard}{PixMapWrapper}
 129   \platform{Mac}
 130 \modulesynopsis{Wrapper for PixMap objects}
 131
 132 \module{PixMapWrapper} wraps a PixMap object with a Python object that
 133 allows access to the fields by name. It also has methods to convert
 134 to and from \module{PIL} images.
 135
 136
 137 \section{\module{preferences} --- Application preferences manager}
 138 \declaremodule{standard}{preferences}
 139   \platform{Mac}
 140 \modulesynopsis{Nice application preferences manager with support for
 141                 defaults}
 142
 143 The \module{preferences} module allows storage of user preferences in
 144 the system-wide preferences folder, with defaults coming from the
 145 application itself and the possibility to override preferences for
 146 specific situations.
 147
 148
 149 \section{\module{pythonprefs} --- Preferences manager for Python}
 150 \declaremodule{standard}{pythonprefs}
 151   \platform{Mac}
 152 \modulesynopsis{Specialized preferences manager for the Python
 153                 interpreter}
 154
 155 This module is a specialization of the \refmodule{preferences} module
 156 that allows reading and writing of the preferences for the Python
 157 interpreter.
 158
 159
 160 \section{\module{quietconsole} --- non-visible stdout output}
 161 \declaremodule{standard}{quietconsole}
 162   \platform{Mac}
 163 \modulesynopsis{buffered, non-visible stdout output}
 164
 165 \module{quietconsole} allows you to keep stdio output in a buffer
 166 without displaying it (or without displaying the stdout window
 167 altogether, if set with \program{EditPythonPrefs}) until you try to read from
 168 stdin or disable the buffering, at which point all the saved output is
 169 sent to the window.  Good for programs with graphical user interfaces
 170 that do want to display their output at a crash.
 171
 172
 173 \section{\module{videoreader} --- read QuickTime movies}
 174 \declaremodule{standard}{videoreader}
 175   \platform{Mac}
 176 \modulesynopsis{read QuickTime movies frame by frame for further processing}
 177
 178 \module{videoreader} reads and decodes QuickTime movies and passes
 179 a stream of images to your program. It also provides some support for
 180 audio tracks.
 181
 182 \section{\module{W} --- Widgets built on \module{FrameWork}}
 183 \declaremodule{standard}{W}
 184   \platform{Mac}
 185 \modulesynopsis{Widgets for the Mac, built on top of \module{FrameWork}}
 186
 187 The \module{W} widgets are used extensively in the \program{IDE}.
 188
 189 \section{\module{waste} --- non-Apple \program{TextEdit} replacement}
 190 \declaremodule{standard}{waste}
 191   \platform{Mac}
 192 \modulesynopsis{Interface to the ``WorldScript-Aware Styled Text Engine.''}
 193
 194 \begin{seealso}
 195   \seetitle[http://www.merzwaren.com/waste/]{About WASTE}{Information
 196             about the WASTE widget and library, including
 197             documentation and downloads.}
 198 \end{seealso}
 199