1998-04-17 20:07:21 +00:00
|
|
|
\section{Introduction}
|
|
|
|
\label{intro}
|
|
|
|
|
1998-04-17 02:46:34 +00:00
|
|
|
The modules in this manual are available on the Apple Macintosh only.
|
1994-01-02 01:22:07 +00:00
|
|
|
|
1996-07-21 02:20:58 +00:00
|
|
|
Aside from the modules described here there are also interfaces to
|
|
|
|
various MacOS toolboxes, which are currently not extensively
|
|
|
|
described. The toolboxes for which modules exist are:
|
1998-02-18 15:21:26 +00:00
|
|
|
\module{AE} (Apple Events),
|
|
|
|
\module{Cm} (Component Manager),
|
|
|
|
\module{Ctl} (Control Manager),
|
|
|
|
\module{Dlg} (Dialog Manager),
|
|
|
|
\module{Evt} (Event Manager),
|
|
|
|
\module{Fm} (Font Manager),
|
|
|
|
\module{List} (List Manager),
|
|
|
|
\module{Menu} (Moenu Manager),
|
|
|
|
\module{Qd} (QuickDraw),
|
|
|
|
\module{Qt} (QuickTime),
|
|
|
|
\module{Res} (Resource Manager and Handles),
|
|
|
|
\module{Scrap} (Scrap Manager),
|
|
|
|
\module{Snd} (Sound Manager),
|
|
|
|
\module{TE} (TextEdit),
|
|
|
|
\module{Waste} (non-Apple \program{TextEdit} replacement) and
|
|
|
|
\module{Win} (Window Manager).
|
1996-07-21 02:20:58 +00:00
|
|
|
|
|
|
|
If applicable the module will define a number of Python objects for
|
|
|
|
the various structures declared by the toolbox, and operations will be
|
|
|
|
implemented as methods of the object. Other operations will be
|
|
|
|
implemented as functions in the module. Not all operations possible in
|
1998-02-19 19:45:19 +00:00
|
|
|
\C{} will also be possible in Python (callbacks are often a problem), and
|
1996-07-21 02:20:58 +00:00
|
|
|
parameters will occasionally be different in Python (input and output
|
|
|
|
buffers, especially). All methods and functions have a \code{__doc__}
|
|
|
|
string describing their arguments and return values, and for
|
1998-02-19 19:45:19 +00:00
|
|
|
additional description you are referred to \emph{Inside Macintosh} or
|
|
|
|
similar works.
|
|
|
|
|
|
|
|
The following modules are documented here:
|
|
|
|
|
1998-07-23 17:55:31 +00:00
|
|
|
\localmoduletable
|
1998-02-19 19:45:19 +00:00
|
|
|
|
|
|
|
|
1998-07-23 17:55:31 +00:00
|
|
|
\section{Built-in Module \module{mac}}
|
|
|
|
\declaremodule{builtin}{mac}
|
1998-02-19 19:45:19 +00:00
|
|
|
|
1998-07-23 17:55:31 +00:00
|
|
|
\modulesynopsis{Similar interfaces to the \module{posix} module.}
|
1998-02-19 19:45:19 +00:00
|
|
|
|
1996-07-21 02:20:58 +00:00
|
|
|
|
1994-01-02 01:22:07 +00:00
|
|
|
This module provides a subset of the operating system dependent
|
1998-02-18 15:21:26 +00:00
|
|
|
functionality provided by the optional built-in module \module{posix}.
|
1994-01-02 01:22:07 +00:00
|
|
|
It is best accessed through the more portable standard module
|
1998-02-18 15:21:26 +00:00
|
|
|
\module{os}.
|
1997-12-15 21:40:15 +00:00
|
|
|
\refbimodindex{posix}
|
|
|
|
\refstmodindex{os}
|
1994-01-02 01:22:07 +00:00
|
|
|
|
|
|
|
The following functions are available in this module:
|
1998-02-18 15:21:26 +00:00
|
|
|
\function{chdir()},
|
|
|
|
\function{close()},
|
|
|
|
\function{dup()},
|
|
|
|
\function{fdopen()},
|
|
|
|
\function{getcwd()},
|
|
|
|
\function{lseek()},
|
|
|
|
\function{listdir()},
|
|
|
|
\function{mkdir()},
|
|
|
|
\function{open()},
|
|
|
|
\function{read()},
|
|
|
|
\function{rename()},
|
|
|
|
\function{rmdir()},
|
|
|
|
\function{stat()},
|
|
|
|
\function{sync()},
|
|
|
|
\function{unlink()},
|
|
|
|
\function{write()},
|
|
|
|
as well as the exception \exception{error}. Note that the times
|
|
|
|
returned by \function{stat()} are floating-point values, like all time
|
|
|
|
values in MacPython.
|
1996-10-15 14:37:31 +00:00
|
|
|
|
1998-02-18 15:21:26 +00:00
|
|
|
One additional function is available: \function{xstat()}. This function
|
|
|
|
returns the same information as \function{stat()}, but with three extra
|
1996-10-15 14:37:31 +00:00
|
|
|
values appended: the size of the resource fork of the file and its
|
1998-04-17 02:46:34 +00:00
|
|
|
4-character creator and type.
|
1994-01-02 01:22:07 +00:00
|
|
|
|
1998-07-23 17:55:31 +00:00
|
|
|
|
1998-04-04 07:23:21 +00:00
|
|
|
\section{Standard Module \module{macpath}}
|
1998-07-23 17:55:31 +00:00
|
|
|
\declaremodule{standard}{macpath}
|
|
|
|
|
|
|
|
\modulesynopsis{MacOS path manipulation functions.}
|
|
|
|
|
1998-02-18 15:21:26 +00:00
|
|
|
|
1994-01-02 01:22:07 +00:00
|
|
|
This module provides a subset of the pathname manipulation functions
|
1998-02-18 15:21:26 +00:00
|
|
|
available from the optional standard module \module{posixpath}. It is
|
|
|
|
best accessed through the more portable standard module \module{os}, as
|
1994-01-02 01:22:07 +00:00
|
|
|
\code{os.path}.
|
1997-12-15 21:40:15 +00:00
|
|
|
\refstmodindex{posixpath}
|
|
|
|
\refstmodindex{os}
|
1994-01-02 01:22:07 +00:00
|
|
|
|
|
|
|
The following functions are available in this module:
|
1998-02-18 15:21:26 +00:00
|
|
|
\function{normcase()},
|
|
|
|
\function{normpath()},
|
|
|
|
\function{isabs()},
|
|
|
|
\function{join()},
|
|
|
|
\function{split()},
|
|
|
|
\function{isdir()},
|
|
|
|
\function{isfile()},
|
|
|
|
\function{walk()},
|
|
|
|
\function{exists()}.
|
|
|
|
For other functions available in \module{posixpath} dummy counterparts
|
1996-07-21 02:20:58 +00:00
|
|
|
are available.
|