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