Macintosh Library Modules Release 2.1 Guido van Rossum Fred L. Drake, Jr., editor April 15, 2001 PythonLabs E-mail: [email protected] Copyright c 2001 Python Software Foundation. All rights reserved. Copyright c 2000 BeOpen.com. All rights reserved. Copyright c 1995-2000 Corporation for National Research Initiatives. All rights reserved. Copyright c 1991-1995 Stichting Mathematisch Centrum. All rights reserved. BEOPEN.COM TERMS AND CONDITIONS FOR PYTHON 2.0 BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1 1. This LICENSE AGREEMENT is between BeOpen.com (“BeOpen”), having an office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or Organization (“Licensee”) accessing and otherwise using this software in source or binary form and its associated documentation (“the Software”). 2. Subject to the terms and conditions of this BeOpen Python License Agreement, BeOpen hereby grants Licensee a non- exclusive, royalty-free, world-wide license to reproduce, analyze, test, perform and/or display publicly, prepare derivative works, distribute, and otherwise use the Software alone or in any derivative version, provided, however, that the BeOpen Python License is retained in the Software, alone or in any derivative version prepared by Licensee. 3. BeOpen is making the Software available to Licensee on an “AS IS” basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. 4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR ANY IN- CIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. 5. This License Agreement will automatically terminate upon a material breach of its terms and conditions. 6. This License Agreement shall be governed by and interpreted in all respects by the law of the State of California, excluding conflict of law provisions. Nothing in this License Agreement shall be deemed to create any relationship of agency, part- nership, or joint venture between BeOpen and Licensee. This License Agreement does not grant permission to use BeOpen trademarks or trade names in a trademark sense to endorse or promote products or services of Licensee, or any third party. As an exception, the “BeOpen Python” logos available at http://www.pythonlabs.com/logos.html may be used according to the permissions granted on that web page. 7. By copying, installing or otherwise using the software, Licensee agrees to be bound by the terms and conditions of this License Agreement. CNRI OPEN SOURCE GPL-COMPATIBLE LICENSE AGREEMENT Python 1.6.1 is made available subject to the terms and conditions in CNRI’s License Agreement. This Agreement to- gether with Python 1.6.1 may be located on the Internet using the following unique, persistent identifier (known as a han- dle): 1895.22/1013. This Agreement may also be obtained from a proxy server on the Internet using the following URL: http://hdl.handle.net/1895.22/1013. CWI PERMISSIONS STATEMENT AND DISCLAIMER Copyright c 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, The Netherlands. All rights reserved. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Stichting Mathematisch Centrum or CWI not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, IN- CLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CON- TRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Abstract This library reference manual documents Python’s extensions for the Macintosh. It should be used in conjunction with the Python Library Reference, which documents the standard library and built-in types. This manual assumes basic knowledge about the Python language. For an informal introduction to Python, see the Python Tutorial; the Python Reference Manual remains the highest authority on syntactic and semantic questions. Finally, the manual entitled Extending and Embedding the Python Interpreter describes how to add new extensions to Python and how to embed it in other applications. CONTENTS 1 Using Python on the Macintosh 1 1.1 Getting and Installing MacPython .................................... 1 1.2 Entering the interactive Interpreter ................................... 1 1.3 How to run a Python script ........................................ 1 1.4 Simulating command line arguments .................................. 2 1.5 Creating a Python script ......................................... 2 1.6 The IDE ................................................. 3 1.7 Configuration .............................................. 4 1.8 Mac OS X ................................................ 5 2 MacPython Modules 7 2.1 mac — Implementations for the os module ............................... 7 2.2 macpath — MacOS path manipulation functions ........................... 7 2.3 ctb — Interface to the Communications Tool Box ........................... 8 2.4 macdnr — Interface to the Macintosh Domain Name Resolver .................... 9 2.5 macfs — Various file system services ................................. 11 2.6 ic — Access to Internet Config ..................................... 13 2.7 MacOS — Access to MacOS interpreter features ............................ 15 2.8 macostools — Convenience routines for file manipulation ..................... 16 2.9 findertools — The finder’s Apple Events interface ........................ 16 2.10 mactcp — The MacTCP interfaces ................................... 17 2.11 macspeech — Interface to the Macintosh Speech Manager ...................... 19 2.12 EasyDialogs — Basic Macintosh dialogs .............................. 20 2.13 FrameWork — Interactive application framework ........................... 20 2.14 MiniAEFrame — Open Scripting Architecture server support .................... 24 2.15 aepack — Conversion between Python variables and AppleEvent data containers . 24 2.16 aetypes — AppleEvent objects .................................... 25 3 MacOS Toolbox Modules 27 3.1 AE — Apple Events ........................................... 28 3.2 Cm — Component Manager ....................................... 28 3.3 Ctl — Control Manager ........................................ 28 3.4 Dlg — Dialog Manager ......................................... 28 3.5 Evt — Event Manager ......................................... 28 3.6 Fm — Font Manager ........................................... 28 3.7 List — List Manager .......................................... 28 3.8 Menu — Menu Manager ......................................... 28 3.9 Qd — QuickDraw ............................................ 28 3.10 Qt — QuickTime ............................................ 28 i 3.11 Res — Resource Manager and Handles ................................. 28 3.12 Scrap — Scrap Manager ........................................ 28 3.13 Snd — Sound Manager ......................................... 28 3.14 TE — TextEdit .............................................. 28 3.15 waste — non-Apple TextEdit replacement .............................. 28 3.16 Win — Window Manager ........................................ 28 3.17 ColorPicker — Color selection dialog ............................... 28 4 Undocumented Modules 31 4.1 buildtools — Helper module for BuildApplet and Friends ..................... 31 4.2 py resource — ........................................... 31 4.3 cfmfile — Code Fragment Resource module ............................. 31 4.4 macerrors — MacOS Errors ..................................... 31 4.5 macfsn — NavServices calls ...................................... 31 4.6 icopen — Internet Config replacement for open() ......................... 32 4.7 mactty — ............................................... 32 4.8 nsremote — Wrapper around Netscape OSA modules ........................ 32 4.9 PixMapWrapper — Wrapper for PixMap objects .......................... 32 4.10 preferences — ........................................... 32 4.11 pythonprefs — ........................................... 32 4.12 quietconsole — non-visible stdout output ............................. 32 4.13 W — Widgets built on FrameWork ................................... 32 Module Index 33 Index 35 ii CHAPTER ONE Using Python on the Macintosh Using Python on the Macintosh can seem like something completely different than using it on a UNIX-like or Windows system. Most of the Python documentation, both the “official” documentation and published books, describe only how Python is used on these systems, causing confusion for the new user of MacPython. This chapter gives a brief introduction to the specifics of using Python on a Macintosh. 1.1 Getting and Installing