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 |
Fred Drake | 9d84308 | 2003-07-30 02:55:28 +0000 | [diff] [blame] | 7 | \ulink{\email{docs@python.org}}{mailto: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 | |
Brett Cannon | 7706c2d | 2005-02-13 22:50:04 +0000 | [diff] [blame] | 24 | \deprecated{2.4} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 25 | |
| 26 | \section{\module{cfmfile} --- Code Fragment Resource module} |
| 27 | \declaremodule{standard}{cfmfile} |
| 28 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 29 | \modulesynopsis{Code Fragment Resource module.} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 30 | |
| 31 | \module{cfmfile} is a module that understands Code Fragments and the |
| 32 | accompanying ``cfrg'' resources. It can parse them and merge them, and is |
| 33 | used by BuildApplication to combine all plugin modules to a single |
| 34 | executable. |
| 35 | |
Brett Cannon | 7706c2d | 2005-02-13 22:50:04 +0000 | [diff] [blame] | 36 | \deprecated{2.4} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 37 | |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 38 | \section{\module{icopen} --- Internet Config replacement for \method{open()}} |
| 39 | \declaremodule{standard}{icopen} |
| 40 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 41 | \modulesynopsis{Internet Config replacement for \method{open()}.} |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 42 | |
| 43 | Importing \module{icopen} will replace the builtin \method{open()} |
| 44 | with a version that uses Internet Config to set file type and creator |
| 45 | for new files. |
| 46 | |
| 47 | |
Fred Drake | 0f0380a | 2001-10-01 17:04:10 +0000 | [diff] [blame] | 48 | \section{\module{macerrors} --- Mac OS Errors} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 49 | \declaremodule{standard}{macerrors} |
| 50 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 51 | \modulesynopsis{Constant definitions for many Mac OS error codes.} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 52 | |
Raymond Hettinger | 6880431 | 2005-01-01 00:28:46 +0000 | [diff] [blame] | 53 | \module{macerrors} contains constant definitions for many Mac OS error |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 54 | codes. |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 55 | |
| 56 | |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 57 | \section{\module{macresource} --- Locate script resources} |
| 58 | \declaremodule{standard}{macresource} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 59 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 60 | \modulesynopsis{Locate script resources.} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 61 | |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 62 | \module{macresource} helps scripts finding their resources, such as |
| 63 | dialogs and menus, without requiring special case code for when the |
| 64 | script is run under MacPython, as a MacPython applet or under OSX Python. |
| 65 | |
Fred Drake | ee0fe0b | 2001-09-12 00:43:13 +0000 | [diff] [blame] | 66 | \section{\module{Nav} --- NavServices calls} |
Andrew M. Kuchling | c12527e | 2004-07-21 21:34:45 +0000 | [diff] [blame] | 67 | \declaremodule{standard}{Nav} |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 68 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 69 | \modulesynopsis{Interface to Navigation Services.} |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 70 | |
| 71 | A low-level interface to Navigation Services. |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 72 | |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 73 | \section{\module{PixMapWrapper} --- Wrapper for PixMap objects} |
| 74 | \declaremodule{standard}{PixMapWrapper} |
| 75 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 76 | \modulesynopsis{Wrapper for PixMap objects.} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 77 | |
| 78 | \module{PixMapWrapper} wraps a PixMap object with a Python object that |
| 79 | allows access to the fields by name. It also has methods to convert |
| 80 | to and from \module{PIL} images. |
| 81 | |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 82 | \section{\module{videoreader} --- Read QuickTime movies} |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 83 | \declaremodule{standard}{videoreader} |
| 84 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 85 | \modulesynopsis{Read QuickTime movies frame by frame for further processing.} |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 86 | |
| 87 | \module{videoreader} reads and decodes QuickTime movies and passes |
| 88 | a stream of images to your program. It also provides some support for |
| 89 | audio tracks. |
| 90 | |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 91 | \section{\module{W} --- Widgets built on \module{FrameWork}} |
| 92 | \declaremodule{standard}{W} |
| 93 | \platform{Mac} |
Fred Drake | ac96868 | 2002-01-17 04:51:55 +0000 | [diff] [blame] | 94 | \modulesynopsis{Widgets for the Mac, built on top of \refmodule{FrameWork}.} |
Fred Drake | 4d0d621 | 2000-10-14 05:08:34 +0000 | [diff] [blame] | 95 | |
| 96 | The \module{W} widgets are used extensively in the \program{IDE}. |
Jack Jansen | 945bf5f | 2001-09-11 21:24:07 +0000 | [diff] [blame] | 97 | |