Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="mac.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="mac.html" title='Macintosh Library Modules' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="module-macostools.html" /> | |
13 | <link rel="prev" href="module-ic.html" /> | |
14 | <link rel="parent" href="macpython-modules.html" /> | |
15 | <link rel="next" href="module-macostools.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>2.4 MacOS -- Access to Mac OS interpreter features</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="2.3.1 IC Objects" | |
25 | href="node21.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="2. MacPython Modules" | |
28 | href="macpython-modules.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="2.5 macostools " | |
31 | href="module-macostools.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Macintosh Library Modules</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="node21.html">2.3.1 IC Objects</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="macpython-modules.html">2. MacPython Modules</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="module-macostools.html">2.5 macostools </A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H1><A NAME="SECTION004400000000000000000"> | |
56 | 2.4 <tt class="module">MacOS</tt> -- | |
57 | Access to Mac OS interpreter features</A> | |
58 | </H1> | |
59 | ||
60 | <P> | |
61 | <A NAME="module-MacOS"></A> | |
62 | <p class="availability">Availability: <span | |
63 | class="platform">Macintosh</span>.</p> | |
64 | ||
65 | <P> | |
66 | This module provides access to MacOS specific functionality in the | |
67 | Python interpreter, such as how the interpreter eventloop functions | |
68 | and the like. Use with care. | |
69 | ||
70 | <P> | |
71 | Note the capitalization of the module name; this is a historical | |
72 | artifact. | |
73 | ||
74 | <P> | |
75 | <dl><dt><b><tt id='l2h-53' xml:id='l2h-53'>runtimemodel</tt></b></dt> | |
76 | <dd> | |
77 | Always <code>'macho'</code>, from Python 2.4 on. | |
78 | In earlier versions of Python the value could | |
79 | also be <code>'ppc'</code> for the classic Mac OS 8 runtime model or | |
80 | <code>'carbon'</code> for the Mac OS 9 runtime model. | |
81 | </dd></dl> | |
82 | ||
83 | <P> | |
84 | <dl><dt><b><tt id='l2h-54' xml:id='l2h-54'>linkmodel</tt></b></dt> | |
85 | <dd> | |
86 | The way the interpreter has been linked. As extension modules may be | |
87 | incompatible between linking models, packages could use this information to give | |
88 | more decent error messages. The value is one of <code>'static'</code> for a | |
89 | statically linked Python, <code>'framework'</code> for Python in a Mac OS X framework, | |
90 | <code>'shared'</code> for Python in a standard unix shared library. | |
91 | Older Pythons could also have the value | |
92 | <code>'cfm'</code> for Mac OS 9-compatible Python. | |
93 | </dd></dl> | |
94 | ||
95 | <P> | |
96 | <dl><dt><b><span class="typelabel">exception</span> <tt id='l2h-55' xml:id='l2h-55' class="exception">Error</tt></b></dt> | |
97 | <dd> | |
98 | This exception is raised on MacOS generated errors, either from | |
99 | functions in this module or from other mac-specific modules like the | |
100 | toolbox interfaces. The arguments are the integer error code (the | |
101 | <tt class="cdata">OSErr</tt> value) and a textual description of the error code. | |
102 | Symbolic names for all known error codes are defined in the standard | |
103 | module <tt class="module"><a href="module-macerrors.html">macerrors</a></tt>.<a id='l2h-64' xml:id='l2h-64'></a> | |
104 | </dd></dl> | |
105 | ||
106 | <P> | |
107 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
108 | <td><nobr><b><tt id='l2h-56' xml:id='l2h-56' class="function">GetErrorString</tt></b>(</nobr></td> | |
109 | <td><var>errno</var>)</td></tr></table></dt> | |
110 | <dd> | |
111 | Return the textual description of MacOS error code <var>errno</var>. | |
112 | </dl> | |
113 | ||
114 | <P> | |
115 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
116 | <td><nobr><b><tt id='l2h-57' xml:id='l2h-57' class="function">DebugStr</tt></b>(</nobr></td> | |
117 | <td><var>message </var><big>[</big><var>, object</var><big>]</big><var></var>)</td></tr></table></dt> | |
118 | <dd> | |
119 | On Mac OS X the string is simply printed to stderr (on older | |
120 | Mac OS systems more elaborate functionality was available), | |
121 | but it provides a convenient location to attach a breakpoint | |
122 | in a low-level debugger like <b class="program">gdb</b>. | |
123 | </dl> | |
124 | ||
125 | <P> | |
126 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
127 | <td><nobr><b><tt id='l2h-58' xml:id='l2h-58' class="function">SysBeep</tt></b>(</nobr></td> | |
128 | <td><var></var>)</td></tr></table></dt> | |
129 | <dd> | |
130 | Ring the bell. | |
131 | </dl> | |
132 | ||
133 | <P> | |
134 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
135 | <td><nobr><b><tt id='l2h-59' xml:id='l2h-59' class="function">GetTicks</tt></b>(</nobr></td> | |
136 | <td><var></var>)</td></tr></table></dt> | |
137 | <dd> | |
138 | Get the number of clock ticks (1/60th of a second) since system boot. | |
139 | </dl> | |
140 | ||
141 | <P> | |
142 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
143 | <td><nobr><b><tt id='l2h-60' xml:id='l2h-60' class="function">GetCreatorAndType</tt></b>(</nobr></td> | |
144 | <td><var>file</var>)</td></tr></table></dt> | |
145 | <dd> | |
146 | Return the file creator and file type as two four-character strings. | |
147 | The <var>file</var> parameter can be a pathname or an <code>FSSpec</code> or | |
148 | <code>FSRef</code> object. | |
149 | </dl> | |
150 | ||
151 | <P> | |
152 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
153 | <td><nobr><b><tt id='l2h-61' xml:id='l2h-61' class="function">SetCreatorAndType</tt></b>(</nobr></td> | |
154 | <td><var>file, creator, type</var>)</td></tr></table></dt> | |
155 | <dd> | |
156 | Set the file creator and file type. | |
157 | The <var>file</var> parameter can be a pathname or an <code>FSSpec</code> or | |
158 | <code>FSRef</code> object. <var>creator</var> and <var>type</var> must be four character | |
159 | strings. | |
160 | </dl> | |
161 | ||
162 | <P> | |
163 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
164 | <td><nobr><b><tt id='l2h-62' xml:id='l2h-62' class="function">openrf</tt></b>(</nobr></td> | |
165 | <td><var>name </var><big>[</big><var>, mode</var><big>]</big><var></var>)</td></tr></table></dt> | |
166 | <dd> | |
167 | Open the resource fork of a file. Arguments are the same as for the | |
168 | built-in function <tt class="function">open()</tt>. The object returned has file-like | |
169 | semantics, but it is not a Python file object, so there may be subtle | |
170 | differences. | |
171 | </dl> | |
172 | ||
173 | <P> | |
174 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
175 | <td><nobr><b><tt id='l2h-63' xml:id='l2h-63' class="function">WMAvailable</tt></b>(</nobr></td> | |
176 | <td><var></var>)</td></tr></table></dt> | |
177 | <dd> | |
178 | Checks whether the current process has access to the window manager. | |
179 | The method will return <code>False</code> if the window manager is not available, | |
180 | for instance when running on Mac OS X Server or when logged in via ssh, | |
181 | or when the current interpreter is not running from a fullblown application | |
182 | bundle. A script runs from an application bundle either when it has been | |
183 | started with <b class="program">pythonw</b> instead of <b class="program">python</b> or when running | |
184 | as an applet. | |
185 | </dl> | |
186 | ||
187 | <DIV CLASS="navigation"> | |
188 | <div class='online-navigation'> | |
189 | <p></p><hr /> | |
190 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
191 | <tr> | |
192 | <td class='online-navigation'><a rel="prev" title="2.3.1 IC Objects" | |
193 | href="node21.html"><img src='../icons/previous.png' | |
194 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
195 | <td class='online-navigation'><a rel="parent" title="2. MacPython Modules" | |
196 | href="macpython-modules.html"><img src='../icons/up.png' | |
197 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
198 | <td class='online-navigation'><a rel="next" title="2.5 macostools " | |
199 | href="module-macostools.html"><img src='../icons/next.png' | |
200 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
201 | <td align="center" width="100%">Macintosh Library Modules</td> | |
202 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
203 | href="contents.html"><img src='../icons/contents.png' | |
204 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
205 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
206 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
207 | <td class='online-navigation'><a rel="index" title="Index" | |
208 | href="genindex.html"><img src='../icons/index.png' | |
209 | border='0' height='32' alt='Index' width='32' /></A></td> | |
210 | </tr></table> | |
211 | <div class='online-navigation'> | |
212 | <b class="navlabel">Previous:</b> | |
213 | <a class="sectref" rel="prev" href="node21.html">2.3.1 IC Objects</A> | |
214 | <b class="navlabel">Up:</b> | |
215 | <a class="sectref" rel="parent" href="macpython-modules.html">2. MacPython Modules</A> | |
216 | <b class="navlabel">Next:</b> | |
217 | <a class="sectref" rel="next" href="module-macostools.html">2.5 macostools </A> | |
218 | </div> | |
219 | </div> | |
220 | <hr /> | |
221 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
222 | </DIV> | |
223 | <!--End of Navigation Panel--> | |
224 | <ADDRESS> | |
225 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
226 | </ADDRESS> | |
227 | </BODY> | |
228 | </HTML> |