Fred Drake | 3a0351c | 1998-04-04 07:23:21 +0000 | [diff] [blame] | 1 | \section{Standard Module \module{macostools}} |
Fred Drake | fe7f3bc | 1998-07-23 17:55:31 +0000 | [diff] [blame] | 2 | \declaremodule{standard}{macostools} |
| 3 | |
| 4 | \modulesynopsis{Convenience routines for file manipulation.} |
| 5 | |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 6 | |
| 7 | This module contains some convenience routines for file-manipulation |
| 8 | on the Macintosh. |
| 9 | |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 10 | The \module{macostools} module defines the following functions: |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 11 | |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 12 | |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 13 | \begin{funcdesc}{copy}{src, dst\optional{, createpath\optional{, copytimes}}} |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 14 | Copy file \var{src} to \var{dst}. The files can be specified as |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 15 | pathnames or \pytype{FSSpec} objects. If \var{createpath} is non-zero |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 16 | \var{dst} must be a pathname and the folders leading to the |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 17 | destination are created if necessary. The method copies data and |
| 18 | resource fork and some finder information (creator, type, flags) and |
| 19 | optionally the creation, modification and backup times (default is to |
| 20 | copy them). Custom icons, comments and icon position are not copied. |
| 21 | |
| 22 | If the source is an alias the original to which the alias points is |
| 23 | copied, not the aliasfile. |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 24 | \end{funcdesc} |
| 25 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 26 | \begin{funcdesc}{copytree}{src, dst} |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 27 | Recursively copy a file tree from \var{src} to \var{dst}, creating |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 28 | folders as needed. \var{src} and \var{dst} should be specified as |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 29 | pathnames. |
| 30 | \end{funcdesc} |
| 31 | |
Fred Drake | cce1090 | 1998-03-17 06:33:25 +0000 | [diff] [blame] | 32 | \begin{funcdesc}{mkalias}{src, dst} |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 33 | Create a finder alias \var{dst} pointing to \var{src}. Both may be |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 34 | specified as pathnames or \pytype{FSSpec} objects. |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 35 | \end{funcdesc} |
| 36 | |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 37 | \begin{funcdesc}{touched}{dst} |
| 38 | Tell the finder that some bits of finder-information such as creator |
| 39 | or type for file \var{dst} has changed. The file can be specified by |
| 40 | pathname or fsspec. This call should prod the finder into redrawing the |
| 41 | files icon. |
| 42 | \end{funcdesc} |
| 43 | |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 44 | \begin{datadesc}{BUFSIZ} |
| 45 | The buffer size for \code{copy}, default 1 megabyte. |
| 46 | \end{datadesc} |
| 47 | |
| 48 | Note that the process of creating finder aliases is not specified in |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 49 | the Apple documentation. Hence, aliases created with \function{mkalias()} |
Jack Jansen | da53c52 | 1995-10-10 14:43:20 +0000 | [diff] [blame] | 50 | could conceivably have incompatible behaviour in some cases. |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 51 | |
Fred Drake | 3a0351c | 1998-04-04 07:23:21 +0000 | [diff] [blame] | 52 | \section{Standard Module \module{findertools}} |
Fred Drake | fe7f3bc | 1998-07-23 17:55:31 +0000 | [diff] [blame] | 53 | \declaremodule{standard}{findertools} |
| 54 | |
| 55 | \modulesynopsis{Wrappers around the \program{finder}'s Apple Events interface.} |
| 56 | |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 57 | |
| 58 | This module contains routines that give Python programs access to some |
| 59 | functionality provided by the finder. They are implemented as wrappers |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 60 | around the AppleEvent\index{AppleEvents} interface to the finder. |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 61 | |
| 62 | All file and folder parameters can be specified either as full |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 63 | pathnames or as \pytype{FSSpec} objects. |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 64 | |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 65 | The \module{findertools} module defines the following functions: |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 66 | |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 67 | |
| 68 | \begin{funcdesc}{launch}{file} |
| 69 | Tell the finder to launch \var{file}. What launching means depends on the file: |
| 70 | applications are started, folders are opened and documents are opened |
| 71 | in the correct application. |
| 72 | \end{funcdesc} |
| 73 | |
| 74 | \begin{funcdesc}{Print}{file} |
| 75 | Tell the finder to print a file (again specified by full pathname or |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 76 | \pytype{FSSpec}). The behaviour is identical to selecting the file and using |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 77 | the print command in the finder. |
| 78 | \end{funcdesc} |
| 79 | |
| 80 | \begin{funcdesc}{copy}{file, destdir} |
| 81 | Tell the finder to copy a file or folder \var{file} to folder |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 82 | \var{destdir}. The function returns an \pytype{Alias} object pointing to |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 83 | the new file. |
| 84 | \end{funcdesc} |
| 85 | |
| 86 | \begin{funcdesc}{move}{file, destdir} |
| 87 | Tell the finder to move a file or folder \var{file} to folder |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 88 | \var{destdir}. The function returns an \pytype{Alias} object pointing to |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 89 | the new file. |
| 90 | \end{funcdesc} |
| 91 | |
| 92 | \begin{funcdesc}{sleep}{} |
Fred Drake | 6188592 | 1998-04-03 07:16:46 +0000 | [diff] [blame] | 93 | Tell the finder to put the Macintosh to sleep, if your machine |
| 94 | supports it. |
Guido van Rossum | 7e42cab | 1996-10-15 14:37:31 +0000 | [diff] [blame] | 95 | \end{funcdesc} |
| 96 | |
| 97 | \begin{funcdesc}{restart}{} |
| 98 | Tell the finder to perform an orderly restart of the machine. |
| 99 | \end{funcdesc} |
| 100 | |
| 101 | \begin{funcdesc}{shutdown}{} |
| 102 | Tell the finder to perform an orderly shutdown of the machine. |
| 103 | \end{funcdesc} |