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 \email{python-docs@python.org}.
   7
   8 \localmoduletable
   9
  10
  11 \section{\module{buildtools} --- Helper module for BuildApplet and Friends}
  12 \declaremodule{standard}{buildtools}
  13   \platform{Mac}
  14 \modulesynopsis{Helper module for BuildApplet, BuildApplication and
  15                 macfreeze}
  16
  17
  18 \section{\module{py_resource} --- Resources from Python code}
  19 \declaremodule[pyresource]{standard}{py_resource}
  20   \platform{Mac}
  21 \modulesynopsis{Helper to create \texttt{'PYC '} resources for compiled
  22                 applications}
  23
  24 This module is primarily used as a help module for BuildApplet and
  25 BuildApplication.  It is able to store compiled Python code as
  26 \texttt{'PYC '} resources in a file.
  27
  28
  29 \section{\module{cfmfile} --- Code Fragment Resource module}
  30 \declaremodule{standard}{cfmfile}
  31   \platform{Mac}
  32 \modulesynopsis{Code Fragment Resource module}
  33
  34 \module{cfmfile} is a module that understands Code Fragments and the
  35 accompanying ``cfrg'' resources. It can parse them and merge them, and is
  36 used by BuildApplication to combine all plugin modules to a single
  37 executable.
  38
  39
  40 \section{\module{macerrors} --- MacOS Errors}
  41 \declaremodule{standard}{macerrors}
  42   \platform{Mac}
  43 \modulesynopsis{Constant definitions for many MacOS error codes}
  44
  45 \module{macerrors} cotains constant definitions for many MacOS error codes.
  46
  47
  48 \section{\module{macfsn} --- NavServices calls}
  49 \declaremodule{standard}{macfsn}
  50   \platform{Mac}
  51 \modulesynopsis{NavServices versions of StandardFile calls}
  52
  53
  54 \module{macfsn} contains wrapper functions that have the same API as the macfs
  55 StandardFile calls, but are implemented with Navigation Services. Importing it
  56 will replace the methods in macfs with these, if Navigation Services is
  57 available on your machine.
  58
  59
  60 \section{\module{icopen} --- Internet Config replacement for \method{open()}}
  61 \declaremodule{standard}{icopen}
  62   \platform{Mac}
  63 \modulesynopsis{Internet Config replacement for \method{open()}}
  64
  65 Importing \module{icopen} will replace the builtin \method{open()}
  66 with a version that uses Internet Config to set file type and creator
  67 for new files.
  68
  69
  70 \section{\module{mactty} --- Serial line connections}
  71 \declaremodule{standard}{mactty}
  72   \platform{Mac}
  73 \modulesynopsis{Easy access serial to line connections}
  74
  75
  76 \section{\module{nsremote} --- Wrapper around Netscape OSA modules}
  77 \declaremodule{standard}{nsremote}
  78   \platform{Mac}
  79 \modulesynopsis{Wrapper around Netscape OSA modules}
  80
  81 \module{nsremote} is a wrapper around the Netscape OSA modules that
  82 allows you to easily send your browser to a given URL.  A related
  83 module that may be of interest is the \module{webbrowser} module,
  84 documented in the \citetitle[../lib/lib.html]{Python Library
  85 Reference}.
  86
  87
  88 \section{\module{PixMapWrapper} --- Wrapper for PixMap objects}
  89 \declaremodule{standard}{PixMapWrapper}
  90   \platform{Mac}
  91 \modulesynopsis{Wrapper for PixMap objects}
  92
  93 \module{PixMapWrapper} wraps a PixMap object with a Python object that
  94 allows access to the fields by name. It also has methods to convert
  95 to and from \module{PIL} images.
  96
  97
  98 \section{\module{preferences} --- Application preferences manager}
  99 \declaremodule{standard}{preferences}
 100   \platform{Mac}
 101 \modulesynopsis{Nice application preferences manager with support for
 102                 defaults}
 103
 104 The \module{preferences} module allows storage of user preferences in
 105 the system-wide preferences folder, with defaults coming from the
 106 application itself and the possibility to override preferences for
 107 specific situations.
 108
 109
 110 \section{\module{pythonprefs} --- Preferences manager for Python}
 111 \declaremodule{standard}{pythonprefs}
 112   \platform{Mac}
 113 \modulesynopsis{Specialized preferences manager for the Python
 114                 interpreter}
 115
 116 This module is a specialization of the \refmodule{preferences} module
 117 that allows reading and writing of the preferences for the Python
 118 interpreter.
 119
 120
 121 \section{\module{quietconsole} --- non-visible stdout output}
 122 \declaremodule{standard}{quietconsole}
 123   \platform{Mac}
 124 \modulesynopsis{buffered, non-visible stdout output}
 125
 126 \module{quietconsole} allows you to keep stdio output in a buffer
 127 without displaying it (or without displaying the stdout window
 128 altogether, if set with \program{EditPythonPrefs}) until you try to read from
 129 stdin or disable the buffering, at which point all the saved output is
 130 sent to the window. Good for GUI programs that do want to display their
 131 output at a crash.
 132
 133
 134 \section{\module{W} --- Widgets built on \module{FrameWork}}
 135 \declaremodule{standard}{W}
 136   \platform{Mac}
 137 \modulesynopsis{Widgets for the Mac, built on top of \module{FrameWork}}
 138
 139 The \module{W} widgets are used extensively in the \program{IDE}.