blob: c18f45b0d344b9f5a7be8f58f719e21afcc98097 [file] [log] [blame]
Guido van Rossuma7925f11994-01-26 10:20:16 +00001Subject: FAQ: Python -- an object-oriented language
Guido van Rossum5333c5d1994-04-11 11:06:22 +00002Newsgroups: comp.lang.python,comp.answers,news.answers
3Followup-to: comp.lang.python
Guido van Rossum81300541996-09-06 16:37:56 +00004From: guido@cnri.reston.va.us (Guido van Rossum)
Guido van Rossum7be34a81995-05-31 15:17:12 +00005Reply-to: guido@cnri.reston.va.us (Guido van Rossum)
Guido van Rossumc458e941996-09-11 15:43:13 +00006Expires: Sun, 1 Dec 1996 00:00:00 GMT
7Supersedes: <DxJ3t1.CJv@cwi.nl>
Guido van Rossuma7925f11994-01-26 10:20:16 +00008Approved: news-answers-request@MIT.Edu
9
10Archive-name: python-faq/part1
Guido van Rossum81300541996-09-06 16:37:56 +000011Submitted-by: Guido van Rossum <guido@cnri.reston.va.us>
Guido van Rossumc458e941996-09-11 15:43:13 +000012Version: $Revision$
Guido van Rossum9c5dc291996-10-13 15:48:56 +000013Last-modified: $Date$
Guido van Rossuma7925f11994-01-26 10:20:16 +000014
15This article contains answers to Frequently Asked Questions about
16Python (an object-oriented interpreted programming language -- see
17the answer to question 1.1 for a short overview).
18
Guido van Rossumc458e941996-09-11 15:43:13 +000019Copyright 1993-1996 Guido van Rossum. Unchanged electronic
Guido van Rossuma7925f11994-01-26 10:20:16 +000020redistribution of this FAQ is allowed. Printed redistribution only
21with permission of the author. No warranties.
22
23Author's address:
Guido van Rossume7d92d51995-10-11 18:06:54 +000024 Guido van Rossum
25 C.N.R.I.
26 1895 Preston White Drive
Guido van Rossum81300541996-09-06 16:37:56 +000027 Reston, VA 20191
Guido van Rossume7d92d51995-10-11 18:06:54 +000028 U.S.A.
Guido van Rossum81300541996-09-06 16:37:56 +000029Email: <guido@python.org>, <guido@cnri.reston.va.us>
Guido van Rossuma7925f11994-01-26 10:20:16 +000030
31The latest version of this FAQ is available by anonymous ftp from
Guido van Rossumca318ec1996-06-26 19:50:09 +000032<URL:ftp://ftp.python.org/pub/python/doc/FAQ>. It will also be posted
Guido van Rossuma6c707c1995-01-02 17:32:28 +000033regularly to the newsgroups comp.answers <URL:news:comp.answers> and
34comp.lang.python <URL:news:comp.lang.python>.
Guido van Rossuma7925f11994-01-26 10:20:16 +000035
Guido van Rossuma6c707c1995-01-02 17:32:28 +000036Many FAQs, including this one, are available by anonymous ftp
37<URL:ftp://rtfm.mit.edu/pub/usenet/news.answers/>. The name under
38which a FAQ is archived appears in the Archive-name line at the top of
39the article. This FAQ is archived as python-faq/part1
40<URL:ftp://rtfm.mit.edu/pub/usenet/news.answers/python-faq/part1>.
Guido van Rossuma7925f11994-01-26 10:20:16 +000041
42There's a mail server on that machine which will send you files from
43the archive by e-mail if you have no ftp access. You send a e-mail
Guido van Rossuma6c707c1995-01-02 17:32:28 +000044message to <mail-server@rtfm.mit.edu> containing the single word help
45in the message body to receive instructions.
Guido van Rossuma7925f11994-01-26 10:20:16 +000046
47This FAQ is divided in the following chapters:
48
49 1. General information and availability
50 2. Python in the real world
Guido van Rossumb0a2ce51995-08-28 19:41:35 +000051 3. Building Python and Other Known Bugs
Guido van Rossuma7925f11994-01-26 10:20:16 +000052 4. Programming in Python
53 5. Extending Python
54 6. Python's design
55 7. Using Python on non-UNIX platforms
56
57To find the start of a particular chapter, search for the chapter number
58followed by a dot and a space at the beginning of a line (e.g. to
59find chapter 4 in vi, type /^4\. /).
60
61Here's an overview of the questions per chapter:
62
63 1. General information and availability
64 1.1. Q. What is Python?
65 1.2. Q. Why is it called Python?
66 1.3. Q. How do I obtain a copy of the Python source?
67 1.4. Q. How do I get documentation on Python?
Guido van Rossumc50158e1994-05-31 09:18:50 +000068 1.5. Q. Are there other ftp sites that mirror the Python distribution?
69 1.6. Q. Is there a newsgroup or mailing list devoted to Python?
Guido van Rossuma6c707c1995-01-02 17:32:28 +000070 1.7. Q. Is there a WWW page devoted to Python?
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +000071 1.8. Q. Is the Python documentation available on the WWW?
72 1.9. Q. Is there a book on Python, or will there be one out soon?
73 1.10. Q. Are there any published articles about Python that I can quote?
74 1.11. Q. Are there short introductory papers or talks on Python?
75 1.12. Q. How does the Python version numbering scheme work?
76 1.13. Q. How do I get a beta test version of Python?
Guido van Rossum05151e01995-09-28 13:24:46 +000077 1.14. Q. Are there copyright restrictions on the use of Python?
78 1.15. Q. Why was Python created in the first place?
Guido van Rossuma7925f11994-01-26 10:20:16 +000079
80 2. Python in the real world
81 2.1. Q. How many people are using Python?
82 2.2. Q. Have any significant projects been done in Python?
83 2.3. Q. Are there any commercial projects going on using Python?
Guido van Rossum95f61a71994-01-26 17:23:37 +000084 2.4. Q. How stable is Python?
Guido van Rossum8727df41996-09-09 15:16:39 +000085 2.5. Q. What new developments are expected for Python in the future?
86 2.6. Q. Is it reasonable to propose incompatible changes to Python?
87 2.7. Q. What is the future of Python?
88 2.8. Q. What is the PSA, anyway?
89 2.9. Q. How do I join the PSA?
90 2.10. Q. What are the benefits of joining the PSA?
Guido van Rossuma7925f11994-01-26 10:20:16 +000091
Guido van Rossumb0a2ce51995-08-28 19:41:35 +000092 3. Building Python and Other Known Bugs
Guido van Rossum91f60831994-02-15 15:52:27 +000093 3.1. Q. Is there a test set?
94 3.2. Q. When running the test set, I get complaints about floating point
Guido van Rossuma7925f11994-01-26 10:20:16 +000095 operations, but when playing with floating point operations I cannot
96 find anything wrong with them.
Guido van Rossum7be34a81995-05-31 15:17:12 +000097 3.3. Q. Link errors after rerunning the configure script.
98 3.4. Q. The python interpreter complains about options passed to a
Guido van Rossum24349991994-02-02 14:12:45 +000099 script (after the script name).
Guido van Rossum7be34a81995-05-31 15:17:12 +0000100 3.5. Q. When building on the SGI, make tries to run python to create
Guido van Rossum5333c5d1994-04-11 11:06:22 +0000101 glmodule.c, but python hasn't been built or installed yet.
Guido van Rossum8727df41996-09-09 15:16:39 +0000102 3.6. Q. I use VPATH but some targets are built in the source directory.
103 3.7. Q. Trouble building or linking with the GNU readline library.
104 3.8. Q. Trouble with socket I/O on older Linux 1.x versions.
105 3.9. Q. Trouble with prototypes on Ultrix.
Guido van Rossum8a913021996-10-08 17:18:30 +0000106 3.10. Q. Other trouble building Python on platform X.
107 3.11. Q. How to configure dynamic loading on Linux.
Guido van Rossum9c5dc291996-10-13 15:48:56 +0000108 3.12. Q: I can't get shared modules to work on Linux 2.0 (Slackware96)?
Guido van Rossumcaa83c41996-11-13 15:06:24 +0000109 3.13. Q: Trouble when making modules shared on Linux.
110 3.14. Q. How to use threads on Linux.
111 3.15. Q. Errors when linking with a shared library containing C++ code.
112 3.16. Q. I built with tkintermodule.c enabled but get "Tkinter not found".
113 3.17. Q. I built with Tk 4.0 but Tkinter complains about the Tk version.
114 3.18. Q. Link errors for Tcl/Tk symbols when linking with Tcl/Tk.
115 3.19. Q. I configured and built Python for Tcl/Tk but "import Tkinter"
Guido van Rossum8727df41996-09-09 15:16:39 +0000116 fails.
Guido van Rossumcaa83c41996-11-13 15:06:24 +0000117 3.20. Q. Tk doesn't work right on DEC Alpha.
118 3.21. Q. Several common system calls are missing from the posix module.
119 3.22. Q. ImportError: No module named string, on MS Windows.
120 3.23. Q. Core dump on SGI when using the gl module.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000121
122 4. Programming in Python
Guido van Rossum24349991994-02-02 14:12:45 +0000123 4.1. Q. Is there a source code level debugger with breakpoints, step,
124 etc.?
125 4.2. Q. Can I create an object class with some methods implemented in
Guido van Rossuma7925f11994-01-26 10:20:16 +0000126 C and others in Python (e.g. through inheritance)? (Also phrased as:
127 Can I use a built-in type as base class?)
Guido van Rossum24349991994-02-02 14:12:45 +0000128 4.3. Q. Is there a curses/termcap package for Python?
129 4.4. Q. Is there an equivalent to C's onexit() in Python?
130 4.5. Q. When I define a function nested inside another function, the
Guido van Rossuma7925f11994-01-26 10:20:16 +0000131 nested function seemingly can't access the local variables of the
132 outer function. What is going on? How do I pass local data to a
133 nested function?
Guido van Rossum24349991994-02-02 14:12:45 +0000134 4.6. Q. How do I iterate over a sequence in reverse order?
135 4.7. Q. My program is too slow. How do I speed it up?
136 4.8. Q. When I have imported a module, then edit it, and import it
Guido van Rossuma7925f11994-01-26 10:20:16 +0000137 again (into the same Python process), the changes don't seem to take
138 place. What is going on?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000139 4.9. Q. How do I find the current module name?
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000140 4.10. Q. I have a module in which I want to execute some extra code
141 when it is run as a script. How do I find out whether I am running as
142 a script?
143 4.11. Q. I try to run a program from the Demo directory but it fails
144 with ImportError: No module named ...; what gives?
Guido van Rossum061f1821994-10-06 16:03:45 +0000145 4.12. Q. I have successfully built Python with STDWIN but it can't
146 find some modules (e.g. stdwinevents).
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000147 4.13. Q. What GUI toolkits exist for Python?
Guido van Rossum061f1821994-10-06 16:03:45 +0000148 4.14. Q. Are there any interfaces to database packages in Python?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000149 4.15. Q. Is it possible to write obfuscated one-liners in Python?
150 4.16. Q. Is there an equivalent of C's "?:" ternary operator?
151 4.17. Q. My class defines __del__ but it is not called when I delete the
152 object.
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000153 4.18. Q. How do I change the shell environment for programs called
154 using os.popen() or os.system()? Changing os.environ doesn't work.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000155 4.19. Q. What is a class?
156 4.20. Q. What is a method?
157 4.21. Q. What is self?
158 4.22. Q. What is a unbound method?
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000159 4.23. Q. How do I call a method defined in a base class from a derived
160 class that overrides it?
161 4.24. Q. How do I call a method from a base class without using the
162 name of the base class?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000163 4.25. Q. How can I organize my code to make it easier to change the base
164 class?
165 4.26. Q. How can I find the methods or attributes of an object?
Guido van Rossum061f1821994-10-06 16:03:45 +0000166 4.27. Q. I can't seem to use os.read() on a pipe created with os.popen().
167 4.28. Q. How can I create a stand-alone binary from a Python script?
Guido van Rossum7be34a81995-05-31 15:17:12 +0000168 4.29. Q. What WWW tools are there for Python?
169 4.30. Q. How do I run a subprocess with pipes connected to both input
Guido van Rossum796b2591995-01-20 23:05:52 +0000170 and output?
Guido van Rossum7be34a81995-05-31 15:17:12 +0000171 4.31. Q. How do I call a function if I have the arguments in a tuple?
172 4.32. Q. How do I enable font-lock-mode for Python in Emacs?
173 4.33. Q. Is there an inverse to the format operator (a la C's scanf())?
Guido van Rossumca318ec1996-06-26 19:50:09 +0000174 4.34. Q. Can I have Tk events handled while waiting for I/O?
175 4.35. Q. How do I write a function with output parameters (call by reference)?
Guido van Rossum0d20cfa1996-07-30 18:53:05 +0000176 4.36. Q. Please explain the rules for local and global variables in Python.
177 4.37. Q. How can I have modules that mutually import each other?
Guido van Rossum8727df41996-09-09 15:16:39 +0000178 4.38. Q. How do I copy an object in Python?
179 4.39. Q. How to implement persistent objects in Python? (Persistent ==
180 automatically saved to and restored from disk.)
Guido van Rossuma4e41a81996-10-22 03:00:43 +0000181 4.40. Q. I try to use __spam and I get an error about _SomeClassName__spam.
Guido van Rossumc59120b1996-11-14 14:10:11 +0000182 4.41. Q. How do I delete a file? And other file questions.
Guido van Rossum4a908be1997-03-16 18:34:00 +0000183 4.42. Q. How to modify urllib or httplib to support HTTP/1.1?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000184
185 5. Extending Python
186 5.1. Q. Can I create my own functions in C?
187 5.2. Q. Can I create my own functions in C++?
Guido van Rossum7ce61c11994-06-13 15:13:56 +0000188 5.3. Q. How can I execute arbitrary Python statements from C?
189 5.4. Q. How can I evaluate an arbitrary Python expression from C?
190 5.5. Q. How do I extract C values from a Python object?
191 5.6. Q. How do I use mkvalue() to create a tuple of arbitrary length?
Guido van Rossum8727df41996-09-09 15:16:39 +0000192 5.7. Q. How do I call an object's method from C?
193 5.8. Q. How do I catch the output from print_error()?
194 5.9. Q. How do I access a module written in Python from C?
195 5.10. Q. How do I interface to C++ objects from Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000196
197 6. Python's design
Guido van Rossum8727df41996-09-09 15:16:39 +0000198 6.1. Q. Why isn't there a switch or case statement in Python?
199 6.2. Q. Why does Python use indentation for grouping of statements?
200 6.3. Q. Why are Python strings immutable?
201 6.4. Q. Why don't strings have methods like index() or sort(), like
Guido van Rossum3de27361994-07-25 14:19:33 +0000202 lists?
Guido van Rossum8727df41996-09-09 15:16:39 +0000203 6.5. Q. Why does Python use methods for some functionality
Guido van Rossum3de27361994-07-25 14:19:33 +0000204 (e.g. list.index()) but functions for other (e.g. len(list))?
Guido van Rossum8727df41996-09-09 15:16:39 +0000205 6.6. Q. Why can't I derive a class from built-in types (e.g. lists or
Guido van Rossum3de27361994-07-25 14:19:33 +0000206 files)?
Guido van Rossum8727df41996-09-09 15:16:39 +0000207 6.7. Q. Why must 'self' be declared and used explicitly in method
Guido van Rossum3de27361994-07-25 14:19:33 +0000208 definitions and calls?
Guido van Rossum8727df41996-09-09 15:16:39 +0000209 6.8. Q. Can't you emulate threads in the interpreter instead of
210 relying on an OS-specific thread implementation?
211 6.9. Q. Why can't lambda forms contain statements?
212 6.10. Q. Why don't lambdas have access to variables defined in the
213 containing scope?
214 6.11. Q. Why can't recursive functions be defined inside other functions?
Guido van Rossum061f1821994-10-06 16:03:45 +0000215 6.12. Q. Why is there no more efficient way of iterating over a dictionary
216 than first constructing the list of keys()?
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000217 6.13. Q. Can Python be compiled to machine code, C or some other language?
Guido van Rossum05151e01995-09-28 13:24:46 +0000218 6.14. Q. Why doesn't Python use proper garbage collection?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000219
220 7. Using Python on non-UNIX platforms
Guido van Rossum91f60831994-02-15 15:52:27 +0000221 7.1. Q. Is there a Mac version of Python?
Guido van Rossumc458e941996-09-11 15:43:13 +0000222 7.2. Q. Are there DOS and Windows versions of Python?
223 7.3. Q. Is there an OS/2 version of Python?
224 7.4. Q. Is there a VMS version of Python?
225 7.5. Q. What about IBM mainframes, or other non-UNIX platforms?
226 7.6. Q. Where are the source or Makefiles for the non-UNIX versions?
227 7.7. Q. What is the status and support for the non-UNIX versions?
228 7.8. Q. I have a PC version but it appears to be only a binary.
229 Where's the library?
230 7.9. Q. Where's the documentation for the Mac or PC version?
231 7.10. Q. The Mac (PC) version doesn't seem to have any facilities for
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000232 creating or editing programs apart from entering it interactively, and
233 there seems to be no way to save code that was entered interactively.
234 How do I create a Python program on the Mac (PC)?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000235
236To find a particular question, search for the question number followed
237by a dot, a space, and a Q at the beginning of a line (e.g. to find
238question 4.2 in vi, type /^4\.2\. Q/).
239
240
2411. General information and availability
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000242 =======================================
Guido van Rossuma7925f11994-01-26 10:20:16 +0000243
2441.1. Q. What is Python?
245
246A. Python is an interpreted, interactive, object-oriented programming
247language. It incorporates modules, exceptions, dynamic typing, very
248high level dynamic data types, and classes. Python combines
249remarkable power with very clear syntax. It has interfaces to many
250system calls and libraries, as well as to various window systems, and
251is extensible in C or C++. It is also usable as an extension language
252for applications that need a programmable interface. Finally, Python
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000253is portable: it runs on many brands of UNIX, on the Mac, and on PCs
254under MS-DOS, Windows, Windows NT, and OS/2.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000255
256To find out more, the best thing to do is to start reading the
257tutorial from the documentation set (see a few questions further
258down).
259
2601.2. Q. Why is it called Python?
261
Guido van Rossum796b2591995-01-20 23:05:52 +0000262A. Apart from being a computer scientist, I'm also a fan of "Monty
Guido van Rossuma7925f11994-01-26 10:20:16 +0000263Python's Flying Circus" (a BBC comedy series from the seventies, in
Guido van Rossum5333c5d1994-04-11 11:06:22 +0000264the -- unlikely -- case you didn't know). It occurred to me one day
265that I needed a name that was short, unique, and slightly mysterious.
266And I happened to be reading some scripts from the series at the
267time... So then I decided to call my language Python. But Python is
268not a joke. And don't you associate it with dangerous reptiles
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000269either! (If you need an icon, use an image of the 16-ton weight from
270the TV series or of a can of SPAM :-)
Guido van Rossuma7925f11994-01-26 10:20:16 +0000271
2721.3. Q. How do I obtain a copy of the Python source?
273
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000274A. The latest complete Python source distribution is always available
275by anonymous ftp, e.g.
Guido van Rossum8727df41996-09-09 15:16:39 +0000276<URL:ftp://ftp.python.org/pub/python/src/python1.3.tar.gz>. It is a
Guido van Rossume530c581995-04-10 12:32:16 +0000277gzipped tar file containing the complete C source, LaTeX
278documentation, Python library modules, example programs, and several
279useful pieces of freely distributable software. This will compile and
280run out of the box on most UNIX platforms. (See section 7 for
281non-UNIX information.)
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000282
Guido van Rossum8727df41996-09-09 15:16:39 +0000283Sometimes beta versions of a newer release are available; check the
284subdirectory "beta" of the above-mentioned URL (i.e.
285<URL:ftp://ftp.python.org/pub/python/src/beta/>). (At the time of
286writing, beta3 for Python 1.4 is available there, and should be
287checked before reporting problems with version 1.3.)
288
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000289Occasionally a set of patches is issued which has to be applied using
290the patch program. These patches are placed in the same directory,
Guido van Rossum7be34a81995-05-31 15:17:12 +0000291e.g. <URL:ftp://ftp.python.org/pub/python/src/patch1.1.1>. (At the time
Guido van Rossum8727df41996-09-09 15:16:39 +0000292of writing, no patches exist.)
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000293
294An index of said ftp directory can be found in the file INDEX. An
295HTML version of the index can be found in the file index.html,
Guido van Rossum7be34a81995-05-31 15:17:12 +0000296<URL:ftp://ftp.python.org/pub/python/index.html>.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000297
2981.4. Q. How do I get documentation on Python?
299
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000300A. The LaTeX source for the documentation is part of the source
301distribution. If you don't have LaTeX, the latest Python
302documentation set is always available by anonymous ftp, e.g.
Guido van Rossum7be34a81995-05-31 15:17:12 +0000303<URL:ftp://ftp.python.org/pub/python/doc/postscript.tar.gz>. It is a
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000304gzipped tar file containing PostScript files of the reference manual,
Guido van Rossum3de27361994-07-25 14:19:33 +0000305the library manual, and the tutorial. Note that the library manual is
306the most important one of the set, as much of Python's power stems
307from the standard or built-in types, functions and modules, all of
308which are described here. PostScript for a high-level description of
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000309Python is in the file nluug-paper.ps (a separate file on the ftp
310site).
Guido van Rossuma7925f11994-01-26 10:20:16 +0000311
Guido van Rossumc50158e1994-05-31 09:18:50 +00003121.5. Q. Are there other ftp sites that mirror the Python distribution?
313
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000314A. The following anonymous ftp sites keep mirrors of the Python
315distribution:
Guido van Rossuma7925f11994-01-26 10:20:16 +0000316
Guido van Rossume7d92d51995-10-11 18:06:54 +0000317USA:
318
319 <URL:ftp://ftp.python.org/pub/python/>
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000320 <URL:ftp://gatekeeper.dec.com/pub/plan/python/>
Guido van Rossume7d92d51995-10-11 18:06:54 +0000321 <URL:ftp://ftp.uu.net/languages/python/>
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000322 <URL:ftp://ftp.wustl.edu/graphics/graphics/sgi-stuff/python/>
Guido van Rossume7d92d51995-10-11 18:06:54 +0000323 <URL:ftp://ftp.sterling.com/programming/languages/python/>
324 <URL:ftp://uiarchive.cso.uiuc.edu/pub/lang/python/>
325 <URL:ftp://ftp.pht.com/mirrors/python/python/>
Guido van Rossum7b6f3431997-02-25 23:08:03 +0000326 <URL:ftp://ftp.cdrom.com/pub/python/>
Guido van Rossume7d92d51995-10-11 18:06:54 +0000327
328Europe:
329
330 <URL:ftp://ftp.cwi.nl/pub/python/>
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000331 <URL:ftp://ftp.funet.fi/pub/languages/python/>
332 <URL:ftp://ftp.sunet.se/pub/lang/python/>
Guido van Rossum3fc9d731995-07-25 15:10:56 +0000333 <URL:ftp://unix.hensa.ac.uk/mirrors/uunet/languages/python/>
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000334 <URL:ftp://ftp.ibp.fr/pub/python/>
Guido van Rossum79413791996-12-05 22:01:11 +0000335 <URL:ftp://sunsite.cnlab-switch.ch/mirror/python/>
Guido van Rossum3fc9d731995-07-25 15:10:56 +0000336 <URL:ftp://ftp.informatik.tu-muenchen.de/pub/comp/programming/languages/python/>
Guido van Rossuma7925f11994-01-26 10:20:16 +0000337
Guido van Rossume7d92d51995-10-11 18:06:54 +0000338Australia:
339
340 <URL:ftp://ftp.dstc.edu.au/pub/python/>
341
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000342Or try archie on the string "python".
Guido van Rossuma7925f11994-01-26 10:20:16 +0000343
Guido van Rossumc50158e1994-05-31 09:18:50 +00003441.6. Q. Is there a newsgroup or mailing list devoted to Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000345
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000346A. There is a newsgroup, comp.lang.python <URL:news:comp.lang.python>,
347and a mailing list. The newsgroup and mailing list are gatewayed into
348each other -- if you can read news it's unnecessary to subscribe to
349the mailing list. Send e-mail to <python-list-request@cwi.nl> to
Guido van Rossume530c581995-04-10 12:32:16 +0000350(un)subscribe to the mailing list. Hypermail archives of (nearly)
351everything posted to the mailing list (and thus the newsgroup) are
352available on our WWW server,
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000353<URL:http://www.cwi.nl/~guido/hypermail/index.html>. The raw archives
354are also available by ftp, e.g.
Guido van Rossum7be34a81995-05-31 15:17:12 +0000355<URL:ftp://ftp.python.org/pub/python/mail/mailinglist.gz>. The
Guido van Rossume530c581995-04-10 12:32:16 +0000356uncompressed versions of these files can be read with the standard
357UNIX Mail program ("Mail -f file") or with nn ("nn file"). To read
Guido van Rossumbf8e7d51995-08-28 03:09:13 +0000358them using MH, you could use "inc -file file". (The archival service
359has stopped archiving new articles around the end of April 1995. I
360hope to revive it on the PSA server www.python.org sometime in the
361future.)
Guido van Rossuma7925f11994-01-26 10:20:16 +0000362
Guido van Rossuma6c707c1995-01-02 17:32:28 +00003631.7. Q. Is there a WWW page devoted to Python?
364
Guido van Rossum7be34a81995-05-31 15:17:12 +0000365A. Yes, <URL:http://www.python.org/> is the official Python home page.
366At the time of writing, this page is not yet completely operational;
367you may have a look at the old Python home page:
368<URL:http://www.cwi.nl/~guido/Python.html> or at the U.S. copy:
369<URL:http://www.python.org/~guido/Python.html>.
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000370
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00003711.8. Q. Is the Python documentation available on the WWW?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000372
Guido van Rossum7be34a81995-05-31 15:17:12 +0000373A. Yes, see <URL:http://www.python.org/> (Python's home page). It
374contains pointers to hypertext versions of the whole documentation set
375(as hypertext, not just PostScript).
Guido van Rossuma7925f11994-01-26 10:20:16 +0000376
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000377If you wish to browse this collection of HTML files on your own
378machine, it is available bundled up by anonymous ftp,
Guido van Rossum7be34a81995-05-31 15:17:12 +0000379e.g. <URL:ftp://ftp.python.org/pub/python/doc/html.tar.gz>.
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000380
381An Emacs-INFO set containing the library manual is also available by
Guido van Rossum7be34a81995-05-31 15:17:12 +0000382ftp, e.g. <URL:ftp://ftp.python.org/pub/python/doc/lib-info.tar.gz>.
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000383
3841.9. Q. Is there a book on Python, or will there be one out soon?
385
Guido van Rossum3fc9d731995-07-25 15:10:56 +0000386A. Mark Lutz is writing a Python book for O'Reilly and Associates, to
387be published early 1996. See the outline (in PostScript):
388<URL:http://www.python.org/workshops/1995-05/outlinep.eps>.
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000389
3901.10. Q. Are there any published articles about Python that I can quote?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000391
392A. So far the only refereed and published article that describes
393Python in some detail is:
394
395 Guido van Rossum and Jelke de Boer, "Interactively Testing Remote
396 Servers Using the Python Programming Language", CWI Quarterly, Volume
397 4, Issue 4 (December 1991), Amsterdam, pp 283-303.
398
399LaTeX source for this paper is available as part of the Python source
400distribution.
401
Guido van Rossum05151e01995-09-28 13:24:46 +0000402See also the next section (supposedly Aaron Watters' paper has been
403refereed).
404
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00004051.11. Q. Are there short introductory papers or talks on Python?
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000406
Guido van Rossum05151e01995-09-28 13:24:46 +0000407A. A recent, very entertaining introduction to Python is the tutorial by
408Aaron Watters in UnixWorld Online:
409
410 Aaron R. Watters: "The What, Why, Who, and Where of Python",
411 <URL:http://www.wcmh.com/uworld/archives/95/tutorial/005.html>
412
413An olded paper is:
Guido van Rossuma7925f11994-01-26 10:20:16 +0000414
415 Guido van Rossum, "An Introduction to Python for UNIX/C
416 Programmers", in the proceedings of the NLUUG najaarsconferentie
Guido van Rossum061f1821994-10-06 16:03:45 +0000417 1993 (dutch UNIX users group meeting November 1993).
Guido van Rossuma7925f11994-01-26 10:20:16 +0000418
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000419PostScript for this paper and for the slides used for the accompanying
420presentation is available by ftp as
Guido van Rossum7be34a81995-05-31 15:17:12 +0000421<URL:ftp://ftp.python.org/pub/python/doc/nluug-paper.ps> and
422<URL:ftp://ftp.python.org/pub/python/doc/nluug-slides.ps>, respectively.
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000423
424Slides for a talk on Python that I gave at the Usenix Symposium on
Guido van Rossum05151e01995-09-28 13:24:46 +0000425Very High Level Languages in Santa Fe, NM, USA in October 1994 are
Guido van Rossum7be34a81995-05-31 15:17:12 +0000426available as <URL:ftp://ftp.python.org/pub/python/doc/vhll-slides.ps>.
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000427
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00004281.12. Q. How does the Python version numbering scheme work?
Guido van Rossum95f61a71994-01-26 17:23:37 +0000429
Guido van Rossum05151e01995-09-28 13:24:46 +0000430A. Python versions are numbered A.B.C or A.B. A is the major version
431number -- it is only incremented for major changes in functionality or
432source structure. B is the minor version number, incremented for less
Guido van Rossum95f61a71994-01-26 17:23:37 +0000433earth-shattering changes to a release. C is the patchlevel -- it is
Guido van Rossum05151e01995-09-28 13:24:46 +0000434incremented for each new patch release. Not all releases have patch
435releases. Note that in the past, patches have added significant
436changes; in fact the changeover from 0.9.9 to 1.0.0 was the first time
437that either A or B changed!
Guido van Rossum95f61a71994-01-26 17:23:37 +0000438
Guido van Rossum8727df41996-09-09 15:16:39 +0000439Beta versions have an additional suffix of "betaN" for some small
440number N. Note that (for instance) all versions labeled 1.4betaN
441*precede* the actual release of 1.4. 1.4b3 is short for 1.4beta3.
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000442
4431.13. Q. How do I get a beta test version of Python?
444
Guido van Rossum05151e01995-09-28 13:24:46 +0000445A. If there are any beta releases, they are published in the normal
446source directory (e.g. <URL:ftp://ftp.python.org/pub/python/src/>).
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +0000447
Guido van Rossum05151e01995-09-28 13:24:46 +00004481.14. Q. Are there copyright restrictions on the use of Python?
Guido van Rossum7ce61c11994-06-13 15:13:56 +0000449
450A. Hardly. You can do anything you want with the source, as long as
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000451you leave the copyrights in, and display those copyrights in any
452documentation about Python that you produce. Also, don't use the
453author's institute's name in publicity without prior written
454permission, and don't hold them responsible for anything (read the
455actual copyright for a precise legal wording).
456
457In particular, if you honor the copyright rules, it's OK to use Python
458for commercial use, to sell copies of Python in source or binary form,
459or to sell products that enhance Python or incorporate Python (or part
460of it) in some form. I would still like to know about all commercial
461use of Python!
Guido van Rossum5333c5d1994-04-11 11:06:22 +0000462
Guido van Rossum05151e01995-09-28 13:24:46 +00004631.15. Q. Why was Python created in the first place?
Guido van Rossum7be34a81995-05-31 15:17:12 +0000464
465A. Here's a *very* brief summary of what got me started:
466
467- I had extensive experience with implementing an interpreted language
468in the ABC group at CWI, and from working with this group I had
469learned a lot about language design. This is the origin of many
470Python features, including the use of indentation for statement
471grouping and the inclusion of very-high-level data types (although the
472details are all different in Python).
473
474- I had a number of gripes about the ABC language, but also liked many
475of its features. It was impossible to extend the ABC language (or its
476implementation) to remedy my complaints -- in fact its lack of
477extensibility was one of its biggest problems.
478
479- I had some experience with using Modula-2+ and talked with the
480designers of Modula-3 (and read the M3 report). M3 is the origin of
481the syntax and semantics used for exceptions, and some other Python
482features.
483
484- I was working in the Amoeba distributed operating system group at
485CWI. We needed a better way to do system administration than by
486writing either C programs or Bourne shell scripts, since Amoeba had
487its own system call interface which wasn't easily accessible from the
Guido van Rossumbf8e7d51995-08-28 03:09:13 +0000488Bourne shell. My experience with error handling in Amoeba made me
489acutely aware of the importance of exceptions as a programming
490language feature.
Guido van Rossum7be34a81995-05-31 15:17:12 +0000491
492- It occurred to me that a scripting language with a syntax like ABC
493but with access to the Amoeba system calls would fill the need. I
494realized that it would be foolish to write an Amoeba-specific
495language, so I decided that I needed a language that was generally
496extensible.
497
498- During the 1989 Christmas holidays, I had a lot of time on my hand,
499so I decided to give it a try. During the next year, while still
500mostly working on it in my own time, Python was used in the Amoeba
501project with increasing success, and the feedback from colleagues made
502me add many early improvements.
503
504- In February 1991, after just over a year of development, I decided
505to post to USENET. The rest is in the Misc/HISTORY file.
506
Guido van Rossuma7925f11994-01-26 10:20:16 +0000507
5082. Python in the real world
509===========================
510
5112.1. Q. How many people are using Python?
512
Guido van Rossum5333c5d1994-04-11 11:06:22 +0000513A. I don't know, but the maximum number of simultaneous subscriptions
514to the Python mailing list before it was gatewayed into the newsgroup
515was about 180 (several of which were local redistribution lists). I
516believe that many active Python users don't bother to subscribe to the
517list, and now that there's a newsgroup the mailing list subscription
Guido van Rossum7ce61c11994-06-13 15:13:56 +0000518is even less meaningful. I see new names on the newsgroup all the
519time and my best guess is that there are currently at least several
520thousands of users.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000521
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000522Another statistic is the number of accesses to the Python WWW server.
523Have a look at <URL:http://www.python.org/stats/>.
524
Guido van Rossuma7925f11994-01-26 10:20:16 +00005252.2. Q. Have any significant projects been done in Python?
526
527A. Here at CWI (the home of Python), we have written a 20,000 line
528authoring environment for transportable hypermedia presentations, a
Guido van Rossum5333c5d1994-04-11 11:06:22 +00005295,000 line multimedia teleconferencing tool, as well as many many
530smaller programs.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000531
532The University of Virginia uses Python to control a virtual reality
533engine. Contact: Matt Conway <conway@virginia.edu>.
534
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000535The ILU project at Xerox PARC can generate Python glue for ILU
536interfaces. See <URL:ftp://ftp.parc.xerox.com/pub/ilu/ilu.html>.
537
Guido van Rossumac3f2121995-04-10 11:53:42 +0000538The University of California, Irvine uses a student administration
539system called TELE-Vision written entirely in Python. Contact: Ray
540Price <rlprice@uci.edu>.
541
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000542See also the next question.
543
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000544If you have done a significant project in Python that you'd like to be
545included in the list above, send me email!
Guido van Rossuma7925f11994-01-26 10:20:16 +0000546
5472.3. Q. Are there any commercial projects going on using Python?
548
Guido van Rossum17e973c1997-02-26 16:11:55 +0000549A. Yes, there's lots of commercial activity using Python. See
550<URL:http://www.python.org/python/Users.html> for a list.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000551
Guido van Rossum95f61a71994-01-26 17:23:37 +00005522.4. Q. How stable is Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000553
Guido van Rossum3de27361994-07-25 14:19:33 +0000554A. Very stable. While the current version number would suggest it is
555in the early stages of development, in fact new, stable releases
Guido van Rossumba469ba1996-12-05 22:26:17 +0000556(numbered 0.9.x through 1.4) have been coming out roughly every 3 to
5576 or 12 months for the past four years.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000558
Guido van Rossum8727df41996-09-09 15:16:39 +00005592.5. Q. What new developments are expected for Python in the future?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000560
Guido van Rossumba469ba1996-12-05 22:26:17 +0000561A. Follow the newsgroup discussions! The workshop proceedings
562(<URL:http://www.python.org/workshops/>) may also contain interesting
563looks into the future.
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000564
Guido van Rossum8727df41996-09-09 15:16:39 +00005652.6. Q. Is it reasonable to propose incompatible changes to Python?
Guido van Rossum3de27361994-07-25 14:19:33 +0000566
567A. In general, no. There are already millions of lines of Python code
568around the world, so any changes in the language that invalidates more
569than a very small fraction of existing programs has to be frowned
570upon. Even if you can provide a conversion program, there still is
571the problem of updating all documentation. Providing a gradual
572upgrade path is the only way if a feature has to be changed.
573
Guido van Rossum8727df41996-09-09 15:16:39 +00005742.7. Q. What is the future of Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000575
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000576A. If I knew, I'd be rich :-)
577
578Seriously, the formation of the PSA (Pyton Software Activity, see
579<URL:http://www.python.org/psa/>) ensures some kind of support even in
580the (unlikely! event that I'd be hit by a bus (actually, here in the
581US, a car accident would be more likely :-), were to join a nunnery,
582or would be head-hunted. A large number of Python users have become
583experts at Python programming as well as maintenance of the
584implementation, and would easily fill the vacuum created by my
585disappearance.
586
587In the mean time, I have no plans to disappear -- rather, I am
588committed to improving Python, and my current benefactor, CNRI (see
589<URL:http://www.cnri.reston.va.us>) is just as committed to continue
590its support of Python and the PSA. In fact, we have great plans for
591Python -- we just can't tell yet!
592
Guido van Rossum8727df41996-09-09 15:16:39 +00005932.8. Q. What is the PSA, anyway?
Guido van Rossum05151e01995-09-28 13:24:46 +0000594
595A. The Python Software Activity <URL:http://www.python.org/psa/> was
596created by a number of Python aficionados who want Python to be more
597than the product and responsibility of a single individual. It has
598found a home at CNRI <URL:http://www.cnri.reston.va.us>. Anybody who
599wishes Python well should join the PSA.
600
Guido van Rossum8727df41996-09-09 15:16:39 +00006012.9. Q. How do I join the PSA?
Guido van Rossum05151e01995-09-28 13:24:46 +0000602
603A. The full scoop is available on the web, see
604<URL:http://www.python.org/psa/Joining.html>. Summary: send a check
605of at least $50 to CNRI/PSA, 1895 Preston White Drive, Suite 100, in
Guido van Rossum81300541996-09-06 16:37:56 +0000606Reston, VA 20191. Full-time students pay $25. Companies can join for
Guido van Rossum05151e01995-09-28 13:24:46 +0000607a mere $500.
608
Guido van Rossum8727df41996-09-09 15:16:39 +00006092.10. Q. What are the benefits of joining the PSA?
Guido van Rossum05151e01995-09-28 13:24:46 +0000610
611A. Like National Public Radio, if not enough people join, Python will
612wither. Your name will be mentioned on the PSA's web server.
613Workshops organized by the PSA <URL:http://www.python.org/workshops/>
614are only accessible to PSA members (you can join at the door). The
615PSA is working on additional benefits, such as reduced prices for
616books and software, and early access to beta versions of Python.
617
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000618
6193. Building Python and Other Known Bugs
620=======================================
Guido van Rossuma7925f11994-01-26 10:20:16 +0000621
Guido van Rossum91f60831994-02-15 15:52:27 +00006223.1. Q. Is there a test set?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000623
624A. Yes, simply do "import testall" (or "import autotest" if you aren't
625interested in the output). The standard modules whose name begins
626with "test" together comprise the test. The test set doesn't test
627*all* features of Python but it goes a long way to confirm that a new
628port is actually working. The Makefile contains an entry "make test"
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000629which runs the autotest module. NOTE: if "make test" fails, run the
630tests manually ("import testall") to see what goes wrong before
631reporting the error.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000632
Guido van Rossum91f60831994-02-15 15:52:27 +00006333.2. Q. When running the test set, I get complaints about floating point
Guido van Rossuma7925f11994-01-26 10:20:16 +0000634operations, but when playing with floating point operations I cannot
635find anything wrong with them.
636
637A. The test set makes occasional unwarranted assumptions about the
638semantics of C floating point operations. Until someone donates a
639better floating point test set, you will have to comment out the
640offending floating point tests and execute similar tests manually.
641
Guido van Rossum7be34a81995-05-31 15:17:12 +00006423.3. Q. Link errors after rerunning the configure script.
Guido van Rossum24349991994-02-02 14:12:45 +0000643
644A. It is generally necessary to run "make clean" after a configuration
645change.
646
Guido van Rossum7be34a81995-05-31 15:17:12 +00006473.4. Q. The python interpreter complains about options passed to a
Guido van Rossum24349991994-02-02 14:12:45 +0000648script (after the script name).
649
650A. You are probably linking with GNU getopt, e.g. through -liberty.
Guido van Rossumf8c76d01994-08-17 12:19:53 +0000651Don't. The reason for the complaint is that GNU getopt, unlike System
652V getopt and other getopt implementations, doesn't consider a
653non-option to be the end of the option list. A quick (and compatible)
654fix for scripts is to add "--" to the interpreter, like this:
655
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000656 #! /usr/local/bin/python --
Guido van Rossumf8c76d01994-08-17 12:19:53 +0000657
658You can also use this interactively:
659
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000660 python -- script.py [options]
661
662Note that a working getopt implementation is provided in the Python
663distribution (in Python/getopt.c) but not automatically used.
Guido van Rossum24349991994-02-02 14:12:45 +0000664
Guido van Rossum7be34a81995-05-31 15:17:12 +00006653.5. Q. When building on the SGI, make tries to run python to create
Guido van Rossum24349991994-02-02 14:12:45 +0000666glmodule.c, but python hasn't been built or installed yet.
667
668A. Comment out the line mentioning glmodule.c in Setup and build a
669python without gl first; install it or make sure it is in your $PATH,
670then edit the Setup file again to turn on the gl module, and make
671again. You don't need to do "make clean"; you do need to run "make
672Makefile" in the Modules subdirectory (or just run "make" at the
673toplevel).
674
Guido van Rossum8727df41996-09-09 15:16:39 +00006753.6. Q. I use VPATH but some targets are built in the source directory.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000676
677A. On some systems (e.g. Sun), if the target already exists in the
678source directory, it is created there instead of in the build
679directory. This is usually because you have previously built without
680VPATH. Try running "make clobber" in the source directory.
681
Guido van Rossum8727df41996-09-09 15:16:39 +00006823.7. Q. Trouble building or linking with the GNU readline library.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000683
Guido van Rossumac3f2121995-04-10 11:53:42 +0000684A. Consider using readline 2.0. Some hints:
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000685
686- You can use the GNU readline library to improve the interactive user
687interface: this gives you line editing and command history when
Guido van Rossum796b2591995-01-20 23:05:52 +0000688calling python interactively. You need to configure and build the GNU
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000689readline library before running the configure script. Its sources are
690no longer distributed with Python; you can ftp them from any GNU
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000691mirror site, or from its home site
692<URL:ftp://slc2.ins.cwru.edu/pub/dist/readline-2.0.tar.gz> (or a
693higher version number -- using version 1.x is not recommended). Pass
694the Python configure script the option --with-readline=DIRECTORY where
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000695DIRECTORY is the absolute pathname of the directory where you've built
696the readline library. Some hints on building and using the readline
697library:
698
699- On SGI IRIX 5, you may have to add the following
700to rldefs.h:
701
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000702 #ifndef sigmask
703 #define sigmask(sig) (1L << ((sig)-1))
704 #endif
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000705
706- On most systems, you will have to add #include "rldefs.h" to the
707top of several source files, and if you use the VPATH feature, you
708will have to add dependencies of the form foo.o: foo.c to the
709Makefile for several values of foo.
710
711- The readline library requires use of the termcap library. A
712known problem with this is that it contains entry points which
Guido van Rossum061f1821994-10-06 16:03:45 +0000713cause conflicts with the STDWIN and SGI GL libraries. The STDWIN
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000714conflict can be solved (and will be, in the next release of
Guido van Rossum061f1821994-10-06 16:03:45 +0000715STDWIN) by adding a line saying '#define werase w_erase' to the
716stdwin.h file (in the STDWIN distribution, subdirectory H). The
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000717GL conflict has been solved in the Python configure script by a
718hack that forces use of the static version of the termcap library.
719
Guido van Rossumac3f2121995-04-10 11:53:42 +0000720- Check the newsgroup gnu.bash.bug <URL:news:gnu.bash.bug> for
721specific problems with the readline library (I don't read this group
722but I've been told that it is the place for readline bugs).
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000723
Guido van Rossum8727df41996-09-09 15:16:39 +00007243.8. Q. Trouble with socket I/O on older Linux 1.x versions.
Guido van Rossumca318ec1996-06-26 19:50:09 +0000725
726A. Once you've built Python, use it to run the regen.py script in the
727Lib/linux1 directory. Apparently the files as distributed don't match
728the system headers on some Linux versions.
729
Guido van Rossum8727df41996-09-09 15:16:39 +00007303.9. Q. Trouble with prototypes on Ultrix.
Guido van Rossum72eb83c1994-10-07 11:33:28 +0000731
732A. Ultrix cc seems broken -- use gcc, or edit config.h to #undef
733HAVE_PROTOTYPES.
734
Guido van Rossum8a913021996-10-08 17:18:30 +00007353.10. Q. Other trouble building Python on platform X.
Guido van Rossum95f61a71994-01-26 17:23:37 +0000736
Guido van Rossum81300541996-09-06 16:37:56 +0000737A. Please email the details to <guido@cnri.reston.va.us> and I'll look
738into it. Please provide as many details as possible. In particular,
739if you don't tell me what type of computer and what operating system
740(and version) you are using it will be difficult for me to figure out
741what is the matter. If you get a specific error message, please email
742it to me too.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000743
Guido van Rossum8a913021996-10-08 17:18:30 +00007443.11. Q. How to configure dynamic loading on Linux.
Guido van Rossum07779351995-02-07 16:59:56 +0000745
Guido van Rossum8727df41996-09-09 15:16:39 +0000746A. This is now automatic as long as your Linux version uses the ELF
747object format (all recent Linuxes do).
Guido van Rossum07779351995-02-07 16:59:56 +0000748
Guido van Rossum9c5dc291996-10-13 15:48:56 +00007493.12. Q: I can't get shared modules to work on Linux 2.0 (Slackware96)?
750
751A: This is a bug in the Slackware96 release. The fix is simple:
752
753Make sure that there is a link from /lib/libdl.so to /lib/libdl.so.1
754so that the following links are setup:
755
756 /lib/libdl.so -> /lib/libdl.so.1
757 /lib/libdl.so.1 -> /lib/libdl.so.1.7.14
758
Guido van Rossum8651d271997-02-17 18:27:32 +0000759You may have to rerun the configure script, after rm'ing the
760config.cache file, before you attempt to rebuild python after this
761fix.
762
Guido van Rossumcaa83c41996-11-13 15:06:24 +00007633.13. Q: Trouble when making modules shared on Linux.
764
765A. This happens when you have built Python for static linking and then
766enable *shared* in the Setup file. Shared library code must be
767compiled with "-fpic". If a .o file for the module already exist that
768was compiled for static linking, you must remove it or do "make clean"
769in the Modules directory.
770
7713.14. Q. How to use threads on Linux.
Guido van Rossum9e0e4dd1996-10-23 20:52:55 +0000772
773A. [Greg Stein] I built myself a libpthreads.so from the libc.5.3.12
774distribution (the binary distribution doesn't have pthreads in
775it). Then, I configured Python with --with-threads and then tweaked
776config.h to include a #define _MIT_POSIX_THREADS (or something like
777that, see /usr/include/pthreads.h). It worked fine at that point.
778
779Note that I couldn't get threading to "operate well" with any of the
780other thread packages. Prior libc versions didn't integrate well with
781threads, either, so I couldn't use them (e.g. sleep() blocked all
782threads :-( ).
783
Guido van Rossumcaa83c41996-11-13 15:06:24 +00007843.15. Q. Errors when linking with a shared library containing C++ code.
Guido van Rossum3fc9d731995-07-25 15:10:56 +0000785
786A. Link the main Python binary with C++. Change the definition of
787LINKCC in Modules/Makefile to be your C++ compiler. You may have to
788edit config.c slightly to make it compilable with C++.
Guido van Rossum07779351995-02-07 16:59:56 +0000789
Guido van Rossumcaa83c41996-11-13 15:06:24 +00007903.16. Q. I built with tkintermodule.c enabled but get "Tkinter not found".
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000791
792A. Tkinter.py (note: upper case T) lives in a subdirectory of Lib,
793Lib/tkinter. If you are using the default module search path, you
794probably didn't enable the line in the Modules/Setup file defining
795TKPATH; if you use the environment variable PYTHONPATH, you'll have to
796add the proper tkinter subdirectory.
797
Guido van Rossumcaa83c41996-11-13 15:06:24 +00007983.17. Q. I built with Tk 4.0 but Tkinter complains about the Tk version.
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000799
800A. Several things could cause this. You most likely have a Tk 3.6
801installation that wasn't completely eradicated by the Tk 4.0
802installation (which tends to add "4.0" to its installed files). You
803may have the Tk 3.6 support library installed in the place where the
804Tk 4.0 support files should be (default /usr/local/lib/tk/); you may
805have compiled Python with the old tk.h header file (yes, this actually
806compiles!); you may actually have linked with Tk 3.6 even though Tk
8074.0 is also around. Similar for Tcl 7.4 vs. Tcl 7.3.
808
Guido van Rossumcaa83c41996-11-13 15:06:24 +00008093.18. Q. Link errors for Tcl/Tk symbols when linking with Tcl/Tk.
Guido van Rossum8727df41996-09-09 15:16:39 +0000810
811Quite possibly, there's a version mismatch between the Tcl/Tk header
812files (tcl.h and tk.h) and the tck/tk libraries you are using (the
813"-ltk4.0" and "-ltcl7.4" arguments for _tkinter in the Setup file).
814If you have installed both versions 7.4/4.0 and 7.5/4.1 of Tcl/Tk,
815most likely your header files are for The newer versions, but the
816Setup line for _tkinter in some Python distributions references
8177.4/4.0 by default. Changing this to 7.5/4.1 should take care of
818this.
819
Guido van Rossumcaa83c41996-11-13 15:06:24 +00008203.19. Q. I configured and built Python for Tcl/Tk but "import Tkinter"
Guido van Rossum8727df41996-09-09 15:16:39 +0000821fails.
822
823A. Most likely, you forgot to enable the line in Setup that says
824"TKPATH=:$(DESTLIB)/tkinter".
825
Guido van Rossumcaa83c41996-11-13 15:06:24 +00008263.20. Q. Tk doesn't work right on DEC Alpha.
Guido van Rossumb0a2ce51995-08-28 19:41:35 +0000827
828A. You probably compiled either Tcl, Tk or Python with gcc. Don't.
829For this platform, which has 64-bit integers, gcc is known to generate
830broken code. The standard cc (which comes bundled with the OS!)
831works. If you still prefer gcc, at least try recompiling with cc
832before reporting problems to the newsgroup or the author; if this
833fixes the problem, report the bug to the gcc developers instead. (As
834far as we know, there are no problem with gcc on other platforms --
835the instabilities seem to be restricted to the DEC Alpha.) See also
836question 3.6.
837
Guido van Rossumcaa83c41996-11-13 15:06:24 +00008383.21. Q. Several common system calls are missing from the posix module.
Guido van Rossumca318ec1996-06-26 19:50:09 +0000839
840A. Most likely, *all* test compilations run by the configure script
841are failing for some reason or another. Have a look in config.log to
842see what could be the reason. A common reason is specifying a
843directory to the --with-readline option that doesn't contain the
844libreadline.a file.
845
Guido van Rossumcaa83c41996-11-13 15:06:24 +00008463.22. Q. ImportError: No module named string, on MS Windows.
Guido van Rossumca318ec1996-06-26 19:50:09 +0000847
848A. Most likely, your PYTHONPATH environment variable should be set to
849something like:
850
851set PYTHONPATH=c:\python;c:\python\lib;c:\python\scripts
852
853(assuming Python was installed in c:\python)
854
Guido van Rossumcaa83c41996-11-13 15:06:24 +00008553.23. Q. Core dump on SGI when using the gl module.
Guido van Rossumca318ec1996-06-26 19:50:09 +0000856
857There are conflicts between entry points in the termcap and curses
858libraries and an entry point in the GL library. There's a hack of a
859fix for the termcap library if it's needed for the GNU readline
860library, but it doesn't work when you're using curses. Concluding,
861you can't build a Python binary containing both the curses and gl
862modules.
863
864
Guido van Rossuma7925f11994-01-26 10:20:16 +0000865
8664. Programming in Python
867========================
868
Guido van Rossum24349991994-02-02 14:12:45 +00008694.1. Q. Is there a source code level debugger with breakpoints, step,
870etc.?
871
872A. Yes. Check out module pdb; pdb.help() prints the documentation (or
873you can read it as Lib/pdb.doc). If you use the STDWIN option,
874there's also a windowing interface, wdb. You can write your own
875debugger by using the code for pdb or wdb as an example.
876
8774.2. Q. Can I create an object class with some methods implemented in
Guido van Rossuma7925f11994-01-26 10:20:16 +0000878C and others in Python (e.g. through inheritance)? (Also phrased as:
879Can I use a built-in type as base class?)
880
881A. No, but you can easily create a Python class which serves as a
882wrapper around a built-in object, e.g. (for dictionaries):
883
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000884 # A user-defined class behaving almost identical
885 # to a built-in dictionary.
886 class UserDict:
887 def __init__(self): self.data = {}
888 def __repr__(self): return repr(self.data)
889 def __cmp__(self, dict):
890 if type(dict) == type(self.data):
891 return cmp(self.data, dict)
892 else:
893 return cmp(self.data, dict.data)
894 def __len__(self): return len(self.data)
895 def __getitem__(self, key): return self.data[key]
896 def __setitem__(self, key, item): self.data[key] = item
897 def __delitem__(self, key): del self.data[key]
898 def keys(self): return self.data.keys()
899 def items(self): return self.data.items()
900 def values(self): return self.data.values()
901 def has_key(self, key): return self.data.has_key(key)
Guido van Rossuma7925f11994-01-26 10:20:16 +0000902
Guido van Rossum8651d271997-02-17 18:27:32 +0000903A2. See Jim Fulton's ExtensionClass for an example of a mechanism
904which allows you to have superclasses which you can inherit from in
905Python -- that way you can have some methods from a C superclass (call
906it a mixin) and some methods from either a Python superclass or your
907subclass. See <URL:http://www.digicool.com/papers/ExtensionClass.html>.
908
Guido van Rossum24349991994-02-02 14:12:45 +00009094.3. Q. Is there a curses/termcap package for Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000910
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000911A. Yes -- Lance Ellinghaus has written a module that interfaces to
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000912System V's "ncurses". If you know a little curses and some Python,
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000913it's straightforward to use. It is part of the standard Python
914distribution, but not configured by default -- you must enable it by
915editing Modules/Setup. It requires a System V curses implementation.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000916
917You could also consider using the "alfa" (== character cell) version
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000918of STDWIN. (Standard Window System Interface, a portable windowing
919system interface by myself <URL:ftp://ftp.cwi.nl/pub/stdwin/>.) This
Guido van Rossumb34e8aa1994-09-23 14:20:38 +0000920will also prepare your program for porting to windowing environments
921such as X11 or the Macintosh.
Guido van Rossuma7925f11994-01-26 10:20:16 +0000922
Guido van Rossum24349991994-02-02 14:12:45 +00009234.4. Q. Is there an equivalent to C's onexit() in Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000924
925A. Yes, if you import sys and assign a function to sys.exitfunc, it
926will be called when your program exits, is killed by an unhandled
927exception, or (on UNIX) receives a SIGHUP or SIGTERM signal.
928
Guido van Rossum24349991994-02-02 14:12:45 +00009294.5. Q. When I define a function nested inside another function, the
Guido van Rossuma7925f11994-01-26 10:20:16 +0000930nested function seemingly can't access the local variables of the
931outer function. What is going on? How do I pass local data to a
932nested function?
933
934A. Python does not have arbitrarily nested scopes. When you need to
935create a function that needs to access some data which you have
936available locally, create a new class to hold the data and return a
937method of an instance of that class, e.g.:
938
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000939 class MultiplierClass:
940 def __init__(self, factor):
941 self.factor = factor
942 def multiplier(self, argument):
943 return argument * self.factor
Guido van Rossuma7925f11994-01-26 10:20:16 +0000944
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000945 def generate_multiplier(factor):
946 return MultiplierClass(factor).multiplier
Guido van Rossuma7925f11994-01-26 10:20:16 +0000947
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000948 twice = generate_multiplier(2)
949 print twice(10)
950 # Output: 20
951
952An alternative solution uses default arguments, e.g.:
953
954 def generate_multiplier(factor):
955 def multiplier(arg, fact = factor):
956 return arg*fact
957 return multiplier
958
959 twice = generate_multiplier(2)
960 print twice(10)
961 # Output: 20
Guido van Rossuma7925f11994-01-26 10:20:16 +0000962
Guido van Rossum24349991994-02-02 14:12:45 +00009634.6. Q. How do I iterate over a sequence in reverse order?
Guido van Rossuma7925f11994-01-26 10:20:16 +0000964
965A. If it is a list, the fastest solution is
966
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000967 list.reverse()
968 try:
969 for x in list:
970 "do something with x"
971 finally:
972 list.reverse()
Guido van Rossuma7925f11994-01-26 10:20:16 +0000973
974This has the disadvantage that while you are in the loop, the list
975is temporarily reversed. If you don't like this, you can make a copy.
976This appears expensive but is actually faster than other solutions:
977
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000978 rev = list[:]
979 rev.reverse()
980 for x in rev:
981 <do something with x>
Guido van Rossuma7925f11994-01-26 10:20:16 +0000982
983If it isn't a list, a more general but slower solution is:
984
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000985 i = len(list)
986 while i > 0:
987 i = i-1
988 x = list[i]
989 <do something with x>
Guido van Rossuma7925f11994-01-26 10:20:16 +0000990
991A more elegant solution, is to define a class which acts as a sequence
992and yields the elements in reverse order (solution due to Steve
993Majewski):
994
Guido van Rossuma6c707c1995-01-02 17:32:28 +0000995 class Rev:
996 def __init__(self, seq):
997 self.forw = seq
998 def __len__(self):
999 return len(self.forw)
1000 def __getitem__(self, i):
1001 return self.forw[-(i + 1)]
Guido van Rossuma7925f11994-01-26 10:20:16 +00001002
1003You can now simply write:
1004
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001005 for x in Rev(list):
1006 <do something with x>
Guido van Rossuma7925f11994-01-26 10:20:16 +00001007
Guido van Rossum061f1821994-10-06 16:03:45 +00001008Unfortunately, this solution is slowest of all, due to the method
Guido van Rossuma7925f11994-01-26 10:20:16 +00001009call overhead...
1010
Guido van Rossum24349991994-02-02 14:12:45 +000010114.7. Q. My program is too slow. How do I speed it up?
Guido van Rossuma7925f11994-01-26 10:20:16 +00001012
1013A. That's a tough one, in general. There are many tricks to speed up
1014Python code; I would consider rewriting parts in C only as a last
1015resort. One thing to notice is that function and (especially) method
1016calls are rather expensive; if you have designed a purely OO interface
1017with lots of tiny functions that don't do much more than get or set an
1018instance variable or call another method, you may consider using a
1019more direct way, e.g. directly accessing instance variables. Also see
1020the standard module "profile" (described in the file
1021"python/lib/profile.doc") which makes it possible to find out where
1022your program is spending most of its time (if you have some patience
1023-- the profiling itself can slow your program down by an order of
1024magnitude).
1025
Guido van Rossum24349991994-02-02 14:12:45 +000010264.8. Q. When I have imported a module, then edit it, and import it
Guido van Rossuma7925f11994-01-26 10:20:16 +00001027again (into the same Python process), the changes don't seem to take
1028place. What is going on?
1029
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001030A. For reasons of efficiency as well as consistency, Python only reads
Guido van Rossum796b2591995-01-20 23:05:52 +00001031the module file on the first time a module is imported. (Otherwise a
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001032program consisting of many modules, each of which imports the same
Guido van Rossum796b2591995-01-20 23:05:52 +00001033basic module, would read the basic module over and over again.) To
1034force rereading of a changed module, do this:
Guido van Rossuma7925f11994-01-26 10:20:16 +00001035
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001036 import modname
1037 reload(modname)
Guido van Rossuma7925f11994-01-26 10:20:16 +00001038
1039Warning: this technique is not 100% fool-proof. In particular,
1040modules containing statements like
1041
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001042 from modname import some_objects
Guido van Rossuma7925f11994-01-26 10:20:16 +00001043
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001044will continue to work with the old version of the imported objects.
Guido van Rossuma7925f11994-01-26 10:20:16 +00001045
Guido van Rossumb34e8aa1994-09-23 14:20:38 +000010464.9. Q. How do I find the current module name?
Guido van Rossum24349991994-02-02 14:12:45 +00001047
Guido van Rossum061f1821994-10-06 16:03:45 +00001048A. A module can find out its own module name by looking at the
Guido van Rossum24349991994-02-02 14:12:45 +00001049(predefined) global variable __name__. If this has the value
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001050'__main__' you are running as a script.
1051
Guido van Rossuma6c707c1995-01-02 17:32:28 +000010524.10. Q. I have a module in which I want to execute some extra code
1053when it is run as a script. How do I find out whether I am running as
1054a script?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001055
1056A. See the previous question. E.g. if you put the following on the
1057last line of your module, main() is called only when your module is
1058running as a script:
Guido van Rossum24349991994-02-02 14:12:45 +00001059
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001060 if __name__ == '__main__': main()
Guido van Rossum24349991994-02-02 14:12:45 +00001061
Guido van Rossuma6c707c1995-01-02 17:32:28 +000010624.11. Q. I try to run a program from the Demo directory but it fails
1063with ImportError: No module named ...; what gives?
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001064
Guido van Rossum061f1821994-10-06 16:03:45 +00001065A. This is probably an optional module (written in C!) which hasn't
1066been configured on your system. This especially happens with modules
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001067like "Tkinter", "stdwin", "gl", "Xt" or "Xm". For Tkinter, STDWIN and
1068many other modules, see Modules/Setup.in for info on how to add these
1069modules to your Python, if it is possible at all. Sometimes you will
1070have to ftp and build another package first (e.g. STDWIN). Sometimes
1071the module only works on specific platforms (e.g. gl only works on SGI
1072machines).
1073
1074NOTE: if the complaint is about "Tkinter" (upper case T) and you have
Guido van Rossumca318ec1996-06-26 19:50:09 +00001075already configured module "tkinter" (lower case t), the solution is
1076*not* to rename tkinter to Tkinter or vice versa. There is probably
1077something wrong with your module search path. Check out the value of
1078sys.path.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001079
Guido van Rossum061f1821994-10-06 16:03:45 +00001080For X-related modules (Xt and Xm) you will have to do more work: they
1081are currently not part of the standard Python distribution. You will
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001082have to ftp the Extensions tar file, e.g.
Guido van Rossum7be34a81995-05-31 15:17:12 +00001083<URL:ftp://ftp.python.org/pub/python/src/extensions.tar.gz> and follow
1084the instructions there.
Guido van Rossum061f1821994-10-06 16:03:45 +00001085
1086See also the next question.
1087
10884.12. Q. I have successfully built Python with STDWIN but it can't
1089find some modules (e.g. stdwinevents).
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001090
1091A. There's a subdirectory of the library directory named 'stdwin'
1092which should be in the default module search path. There's a line in
1093Modules/Setup(.in) that you have to enable for this purpose --
Guido van Rossum061f1821994-10-06 16:03:45 +00001094unfortunately in the latest release it's not near the other
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001095STDWIN-related lines so it's easy to miss it.
1096
10974.13. Q. What GUI toolkits exist for Python?
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001098
1099A. Depending on what platform(s) you are aiming at, there are several.
1100
Guido van Rossumc458e941996-09-11 15:43:13 +00001101Currently supported solutions:
1102
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001103- There's a neat object-oriented interface to the Tcl/Tk widget set,
Guido van Rossumc458e941996-09-11 15:43:13 +00001104called Tkinter. It is part of the standard Python distribution and
1105well-supported -- all you need to do is build and install Tcl/Tk and
1106enable the _tkinter module and the TKPATH definition in Modules/Setup
1107when building Python. This is probably the easiest to install and
1108use, and the most complete widget set. It is also very likely that in
1109the future the standard Python GUI API will be based on or at least
1110look very much like the Tkinter interface. For more info about Tk,
1111including pointers to the source, see the Tcl/Tk home page
1112<URL:http://www.sunlabs.com/research/tcl/>. Tcl/Tk is now fully
1113portable to the Mac and Windows platforms (NT and 95 only); you need
1114Python 1.4beta3 or later and Tk 4.1patch1 or later.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001115
1116- There's an interface to X11, including the Athena and Motif widget
1117sets (and a few individual widgets, like Mosaic's HTML widget and
Guido van Rossumc458e941996-09-11 15:43:13 +00001118SGI's GL widget) available from
1119<URL:ftp://ftp.python.org/pub/python/src/X-extension.tar.gz>.
1120Support by Sjoerd Mullender <sjoerd@cwi.nl>.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001121
Guido van Rossum8a913021996-10-08 17:18:30 +00001122- On top of the X11 interface there's the (recently revived) vpApp
1123toolkit by Per Spilling, now also maintained by Sjoerd Mullender
1124<sjoerd@cwi.nl>. See <URL:ftp://ftp.cwi.nl/pub/sjoerd/vpApp.tar.gz>.
1125
Guido van Rossumc458e941996-09-11 15:43:13 +00001126- The Mac port has a rich and ever-growing set of modules that support
1127the native Mac toolbox calls. See the documentation that comes with
1128the Mac port. See <URL:ftp://ftp.python.org/pub/python/mac>. Support
1129by Jack Jansen <jack@cwi.nl>.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001130
Guido van Rossumc458e941996-09-11 15:43:13 +00001131- The NT port supported by Mark Hammond <MHammond@skippinet.com.au>
1132(see question 7.2) includes an interface to the Microsoft Foundation
1133Classes and a Python programming environment using it that's written
1134mostly in Python. See
1135<URL:ftp://ftp.python.org/pub/python/pythonwin/>.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001136
Guido van Rossumc458e941996-09-11 15:43:13 +00001137- There's an object-oriented GUI based on the Microsoft Foundation
1138Classes model called WPY, supported by Jim Ahlstrom <jim@interet.com>.
1139Programs written in WPY run unchanged and with native look and feel on
1140Windows NT/95, Windows 3.1 (using win32s), and on Unix (using Tk).
1141Source and binaries for Windows and Linux are available in
1142<URL:ftp://ftp.python.org/pub/python/wpy/>.
1143
1144Obsolete or minority solutions:
Guido van Rossumbf8e7d51995-08-28 03:09:13 +00001145
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00001146- There's an interface to wxWindows. wxWindows is a portable GUI
1147class library written in C++. It supports XView, Motif, MS-Windows as
Guido van Rossumc458e941996-09-11 15:43:13 +00001148targets. There is some support for Macs and CURSES as well.
1149wxWindows preserves the look and feel of the underlying graphics
1150toolkit. See the wxPython WWW page at
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00001151<URL:http://www.aiai.ed.ac.uk/~jacs/wx/wxpython/wxpython.html>.
Guido van Rossumc458e941996-09-11 15:43:13 +00001152Support for wxPython (by Harri Pasanen <pa@tekla.fi>) appears
1153to have a low priority.
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00001154
Guido van Rossumc458e941996-09-11 15:43:13 +00001155- For SGI IRIX only, there are unsupported interfaces to the complete
1156GL (Graphics Library -- low level but very good 3D capabilities) as
1157well as to FORMS (a buttons-and-sliders-etc package built on top of GL
1158by Mark Overmars -- ftp'able from
1159<URL:ftp://ftp.cs.ruu.nl/pub/SGI/FORMS/>). This is probably also
1160becoming obsolete, as OpenGL takes over.
1161
1162- There's an interface to STDWIN, a platform-independent low-level
1163windowing interface for Mac and X11. This is totally unsupported and
1164rapidly becoming obsolete. The STDWIN sources are at
1165<URL:ftp://ftp.cwi.nl/pub/stdwin/>. (For info about STDWIN 2.0,
1166please refer to Steven Pemberton <steven@cwi.nl> -- I believe it is
1167also dead.)
1168
1169- There once was an interface to WAFE, a Tcl interface to the X11
1170Motif and Athena widget sets. WAFE is at
1171<URL:ftp://ftp.wu-wien.ac.at/pub/src/X11/wafe/>. It's not clear what
1172the status of the Python support is.
Guido van Rossum3fc9d731995-07-25 15:10:56 +00001173
Guido van Rossum0d20cfa1996-07-30 18:53:05 +00001174- (The Fresco port that was mentioned in earlier versions of this FAQ
1175no longer seems to exist. Inquire with Mark Linton.)
Guido van Rossuma8a8d4a1995-03-10 16:19:31 +00001176
Guido van Rossum061f1821994-10-06 16:03:45 +000011774.14. Q. Are there any interfaces to database packages in Python?
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001178
Guido van Rossum8727df41996-09-09 15:16:39 +00001179A. There's a whole collection of them in the contrib area of the ftp
1180server, see <URL:http://www.python.org/ftp/python/contrib/Database/>.
Guido van Rossum796b2591995-01-20 23:05:52 +00001181
Guido van Rossumb34e8aa1994-09-23 14:20:38 +000011824.15. Q. Is it possible to write obfuscated one-liners in Python?
Guido van Rossumc24da7c1994-09-23 14:08:41 +00001183
1184A. Yes. See the following three examples, due to Ulf Bartelt:
1185
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001186 # Primes < 1000
1187 print filter(None,map(lambda y:y*reduce(lambda x,y:x*y!=0,
1188 map(lambda x,y=y:y%x,range(2,int(pow(y,0.5)+1))),1),range(2,1000)))
Guido van Rossumc24da7c1994-09-23 14:08:41 +00001189
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001190 # First 10 Fibonacci numbers
1191 print map(lambda x,f=lambda x,f:(x<=1) or (f(x-1,f)+f(x-2,f)): f(x,f),
1192 range(10))
Guido van Rossumc24da7c1994-09-23 14:08:41 +00001193
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001194 # Mandelbrot set
1195 print (lambda Ru,Ro,Iu,Io,IM,Sx,Sy:reduce(lambda x,y:x+y,map(lambda y,
1196 Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,Sy=Sy,L=lambda yc,Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,i=IM,
1197 Sx=Sx,Sy=Sy:reduce(lambda x,y:x+y,map(lambda x,xc=Ru,yc=yc,Ru=Ru,Ro=Ro,
1198 i=i,Sx=Sx,F=lambda xc,yc,x,y,k,f=lambda xc,yc,x,y,k,f:(k<=0)or (x*x+y*y
1199 >=4.0) or 1+f(xc,yc,x*x-y*y+xc,2.0*x*y+yc,k-1,f):f(xc,yc,x,y,k,f):chr(
1200 64+F(Ru+x*(Ro-Ru)/Sx,yc,0,0,i)),range(Sx))):L(Iu+y*(Io-Iu)/Sy),range(Sy
1201 ))))(-2.1, 0.7, -1.2, 1.2, 30, 80, 24)
1202 # \___ ___/ \___ ___/ | | |__ lines on screen
1203 # V V | |______ columns on screen
1204 # | | |__________ maximum of "iterations"
1205 # | |_________________ range on y axis
1206 # |____________________________ range on x axis
Guido van Rossumc24da7c1994-09-23 14:08:41 +00001207
1208Don't try this at home, kids!
1209
Guido van Rossumb34e8aa1994-09-23 14:20:38 +000012104.16. Q. Is there an equivalent of C's "?:" ternary operator?
Guido van Rossumc24da7c1994-09-23 14:08:41 +00001211
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001212A. Not directly. In many cases you can mimic a?b:c with "a and b or
1213c", but there's a flaw: if b is zero (or empty, or None -- anything
1214that tests false) then c will be selected instead. In many cases you
1215can prove by looking at the code that this can't happen (e.g. because
1216b is a constant or has a type that can never be false), but in general
1217this can be a problem.
1218
Guido van Rossumc458e941996-09-11 15:43:13 +00001219Tim Peters (who wishes it was Steve Majewski) suggested the following
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001220solution: (a and [b] or [c])[0]. Because [b] is a singleton list it
1221is never false, so the wrong path is never taken; then applying [0] to
1222the whole thing gets the b or c that you really wanted. Ugly, but it
1223gets you there in the rare cases where it is really inconvenient to
1224rewrite your code using 'if'.
1225
12264.17. Q. My class defines __del__ but it is not called when I delete the
1227object.
1228
1229A. There are several possible reasons for this.
1230
1231- The del statement does not necessarily call __del__ -- it simply
1232decrements the object's reference count, and if this reaches zero
1233__del__ is called.
1234
1235- If your data structures contain circular links (e.g. a tree where
1236each child has a parent pointer and each parent has a list of
1237children) the reference counts will never go back to zero. You'll
Guido van Rossum061f1821994-10-06 16:03:45 +00001238have to define an explicit close() method which removes those
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001239pointers. Please don't ever call __del__ directly -- __del__ should
Guido van Rossum061f1821994-10-06 16:03:45 +00001240call close() and close() should make sure that it can be called more
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001241than once for the same object.
1242
1243- If the object has ever been a local variable (or argument, which is
1244really the same thing) to a function that caught an expression in an
1245except clause, chances are that a reference to the object still exists
1246in that function's stack frame as contained in the stack trace.
1247Normally, deleting (better: assigning None to) sys.exc_traceback will
1248take care of this. If you a stack was printed for an unhandled
1249exception in an interactive interpreter, delete sys.last_traceback
1250instead.
1251
1252- There is code that deletes all objects when the interpreter exits,
1253but if your Python has been configured to support threads, it is not
1254called (because other threads may still be active). You can define
Guido van Rossum061f1821994-10-06 16:03:45 +00001255your own cleanup function using sys.exitfunc (see question 4.4).
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001256
Guido van Rossum8727df41996-09-09 15:16:39 +00001257- Finally, if your __del__ method raises an exception, this will be
1258ignored. Starting with Python 1.4beta3, a warning message is printed
1259to sys.stderr when this happens.
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001260
12614.18. Q. How do I change the shell environment for programs called
1262using os.popen() or os.system()? Changing os.environ doesn't work.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001263
Guido van Rossum01094e41997-02-17 18:40:02 +00001264A. You must be using either a version of python before 1.4, or on a
1265(rare) system that doesn't have the putenv() library function.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001266
Guido van Rossum01094e41997-02-17 18:40:02 +00001267Before Python 1.4, modifying the environment passed to subshells was
1268left out of the interpreter because there seemed to be no
1269well-established portable way to do it (in particular, some systems,
1270have putenv(), others have setenv(), and some have none at all). As
1271of Python 1.4, almost all Unix systems *do* have putenv(), and so does
1272the Win32 API, and thus the os module was modified so that changes to
1273os.environ are trapped and the corresponding putenv() call is made.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001274
12754.19. Q. What is a class?
1276
1277A. A class is the particular object type that is created by executing
Guido van Rossum796b2591995-01-20 23:05:52 +00001278a class statement. Class objects are used as templates, to create
1279class instance objects, which embody both the data structure and
1280program routines specific to a datatype.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001281
12824.20. Q. What is a method?
1283
1284A. A method is a function that you normally call as
Guido van Rossum796b2591995-01-20 23:05:52 +00001285x.name(arguments...) for some object x. The term is used for methods
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001286of classes and class instances as well as for methods of built-in
Guido van Rossum796b2591995-01-20 23:05:52 +00001287objects. (The latter have a completely different implementation and
1288only share the way their calls look in Python code.) Methods of
1289classes (and class instances) are defined as functions inside the
1290class definition.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001291
12924.21. Q. What is self?
1293
1294A. Self is merely a conventional name for the first argument of a
1295method -- i.e. a function defined inside a class definition. A method
1296defined as meth(self, a, b, c) should be called as x.meth(a, b, c) for
1297some instance x of the class in which the definition occurs;
1298the called method will think it is called as meth(x, a, b, c).
1299
13004.22. Q. What is a unbound method?
1301
1302A. An unbound method is a method defined in a class that is not yet
1303bound to an instance. You get an unbound method if you ask for a
1304class attribute that happens to be a function. You get a bound method
1305if you ask for an instance attribute. A bound method knows which
Guido van Rossum061f1821994-10-06 16:03:45 +00001306instance it belongs to and calling it supplies the instance automatically;
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001307an unbound method only knows which class it wants for its first
1308argument (a derived class is also OK). Calling an unbound method
1309doesn't "magically" derive the first argument from the context -- you
1310have to provide it explicitly.
1311
Guido van Rossuma6c707c1995-01-02 17:32:28 +000013124.23. Q. How do I call a method defined in a base class from a derived
1313class that overrides it?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001314
1315A. If your class definition starts with "class Derived(Base): ..."
1316then you can call method meth defined in Base (or one of Base's base
1317classes) as Base.meth(self, arguments...). Here, Base.meth is an
1318unbound method (see previous question).
1319
Guido van Rossuma6c707c1995-01-02 17:32:28 +000013204.24. Q. How do I call a method from a base class without using the
1321name of the base class?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001322
1323A. DON'T DO THIS. REALLY. I MEAN IT. It appears that you could call
1324self.__class__.__bases__[0].meth(self, arguments...) but this fails when
Guido van Rossum061f1821994-10-06 16:03:45 +00001325a doubly-derived method is derived from your class: for its instances,
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001326self.__class__.__bases__[0] is your class, not its base class -- so
1327(assuming you are doing this from within Derived.meth) you would start
1328a recursive call.
1329
13304.25. Q. How can I organize my code to make it easier to change the base
1331class?
1332
1333A. You could define an alias for the base class, assign the real base
1334class to it before your class definition, and use the alias throughout
1335your class. Then all you have to change is the value assigned to the
1336alias. Incidentally, this trick is also handy if you want to decide
1337dynamically (e.g. depending on availability of resources) which base
1338class to use. Example:
1339
Guido van Rossumc458e941996-09-11 15:43:13 +00001340 BaseAlias = <real base class>
1341 class Derived(BaseAlias):
1342 def meth(self):
1343 BaseAlias.meth(self)
1344 ...
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001345
13464.26. Q. How can I find the methods or attributes of an object?
1347
1348A. This depends on the object type.
1349
1350For an instance x of a user-defined class, instance attributes are
1351found in the dictionary x.__dict__, and methods and attributes defined
1352by its class are found in x.__class__.__bases__[i].__dict__ (for i in
1353range(len(x.__class__.__bases__))). You'll have to walk the tree of
1354base classes to find *all* class methods and attributes.
1355
1356Many, but not all built-in types define a list of their method names
1357in x.__methods__, and if they have data attributes, their names may be
1358found in x.__members__. However this is only a convention.
1359
1360For more information, read the source of the standard (but
1361undocumented) module newdir.
1362
13634.27. Q. I can't seem to use os.read() on a pipe created with os.popen().
1364
1365A. os.read() is a low-level function which takes a file descriptor (a
1366small integer). os.popen() creates a high-level file object -- the
1367same type used for sys.std{in,out,err} and returned by the builtin
1368open() function. Thus, to read n bytes from a pipe p created with
1369os.popen(), you need to use p.read(n).
Guido van Rossuma7925f11994-01-26 10:20:16 +00001370
Guido van Rossum061f1821994-10-06 16:03:45 +000013714.28. Q. How can I create a stand-alone binary from a Python script?
1372
1373The demo script "Demo/scripts/freeze.py" does what you want. (It's
1374actually not a demo but a support tool -- there is some extra code in
1375the interpreter to accommodate it.) It requires that you have the
1376Python build tree handy, complete with all the lib*.a files.
1377
1378This works by scanning your source recursively for import statements
1379(both forms) and looking for the modules on the standard Python path
1380as well as in the source directory (for built-in modules). It then
1381"compiles" the modules written in Python to C code (array initializers
1382that can be turned into code objects using the marshal module) and
1383creates a custom-made config file that only contains those built-in
1384modules which are actually used in the program. It then compiles the
1385generated C code and links it with the rest of the Python interpreter
1386to form a self-contained binary which acts exactly like your script.
1387
Guido van Rossum7be34a81995-05-31 15:17:12 +00001388Hint: the freeze program only works if your script's filename ends in
1389".py".
Guido van Rossum061f1821994-10-06 16:03:45 +00001390
Guido van Rossum7be34a81995-05-31 15:17:12 +000013914.29. Q. What WWW tools are there for Python?
Guido van Rossum061f1821994-10-06 16:03:45 +00001392
Guido van Rossum8727df41996-09-09 15:16:39 +00001393A. See the chapter titled "Internet and WWW" in the Library Reference
1394Manual. There's also a web browser written in Python, called Grail --
Guido van Rossum4662b871996-11-27 15:24:34 +00001395see <URL:http://grail.cnri.reston.va.us/grail/>.
Guido van Rossum061f1821994-10-06 16:03:45 +00001396
1397Steve Miale <smiale@cs.indiana.edu> has written a modular WWW browser
1398called Dancer. An alpha version can be FTP'ed from
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001399<URL:ftp://ftp.cs.indiana.edu/pub/smiale/dancer.tar.gz>. (There are a
1400few articles about Dancer in the (hyper)mail archive
1401<URL:http://www.cwi.nl/~guido/hypermail/python-1994q3/index.html>.)
Guido van Rossum061f1821994-10-06 16:03:45 +00001402
Guido van Rossum7be34a81995-05-31 15:17:12 +000014034.30. Q. How do I run a subprocess with pipes connected to both input
Guido van Rossum796b2591995-01-20 23:05:52 +00001404and output?
1405
1406A. This is really a UNIX question. Also, in general, it is unwise to
1407do so, because you can easily cause a deadlock where the parent
1408process is blocked waiting for output from the child, while the child
1409is blocked waiting for input from the child. This can be caused
1410because the parent expects the child to output more text than it does,
1411or it can be caused by data being stuck in stdio buffers due to lack
1412of flushing. The Python parent can of course explicitly flush the data
1413it sends to the child before it reads any output, but if the child is
1414a naive C program it can easily have been written to never explicitly
1415flush its output, even if it is interactive, since flushing is
1416normally automatic.
1417
1418In many cases, all you really need is to run some data through a
1419command and get the result back. Unless the data is infinite in size,
1420the easiest (and often the most efficient!) way to do this is to write
1421it to a temporary file and run the command with that temporary file as
1422input. The standard module tempfile exports a function mktemp() which
1423generates unique temporary file names.
1424
1425If after reading all of the above you still want to connect two pipes
1426to a subprocess's standard input and output, here's a simple solution,
1427due to Jack Jansen:
1428
Guido van Rossume7d92d51995-10-11 18:06:54 +00001429 import os
1430 import sys
1431 import string
Guido van Rossum796b2591995-01-20 23:05:52 +00001432
Guido van Rossume7d92d51995-10-11 18:06:54 +00001433 MAXFD = 100 # Max number of file descriptors in this system
Guido van Rossum796b2591995-01-20 23:05:52 +00001434
Guido van Rossume7d92d51995-10-11 18:06:54 +00001435 def popen2(cmd):
1436 cmd = string.split(cmd)
1437 p2cread, p2cwrite = os.pipe()
1438 c2pread, c2pwrite = os.pipe()
1439 pid = os.fork()
1440 if pid == 0:
1441 # Child
1442 os.close(0)
1443 os.close(1)
Guido van Rossumca318ec1996-06-26 19:50:09 +00001444 if os.dup(p2cread) != 0:
Guido van Rossume7d92d51995-10-11 18:06:54 +00001445 sys.stderr.write('popen2: bad read dup\n')
Guido van Rossumca318ec1996-06-26 19:50:09 +00001446 if os.dup(c2pwrite) != 1:
Guido van Rossume7d92d51995-10-11 18:06:54 +00001447 sys.stderr.write('popen2: bad write dup\n')
1448 for i in range(3, MAXFD):
1449 try:
1450 os.close(i)
1451 except:
1452 pass
1453 try:
1454 os.execv(cmd[0], cmd)
1455 finally:
1456 os._exit(1)
1457 os.close(p2cread)
1458 tochild = os.fdopen(p2cwrite, 'w')
1459 os.close(c2pwrite)
1460 fromchild = os.fdopen(c2pread, 'r')
1461 return fromchild, tochild
Guido van Rossum796b2591995-01-20 23:05:52 +00001462
1463Note that many interactive programs (e.g. vi) don't work well with
1464pipes substituted for standard input and output. You will have to use
1465pseudo ttys ("ptys") instead of pipes. There is some undocumented
1466code to use these in the library module pty.py -- I'm afraid you're on
Guido van Rossum3fc9d731995-07-25 15:10:56 +00001467your own here.
1468
1469A different answer is a Python interface to Don Libes' "expect"
1470library. A prerelease of this is available on the Python ftp mirror
1471sites in the contrib subdirectory as expy-0.3.tar.gz, e.g.
1472<URL:ftp://ftp.python.org/pub/python/contrib/expy-0.3.tar.gz>.
Guido van Rossum796b2591995-01-20 23:05:52 +00001473
Guido van Rossum7be34a81995-05-31 15:17:12 +000014744.31. Q. How do I call a function if I have the arguments in a tuple?
Guido van Rossumac3f2121995-04-10 11:53:42 +00001475
1476A. Use the built-in function apply(). For instance,
1477
1478 func(1, 2, 3)
1479
1480is equivalent to
1481
1482 args = (1, 2, 3)
1483 apply(func, args)
1484
1485Note that func(args) is not the same -- it calls func() with exactly
1486one argument, the tuple args, instead of three arguments, the integers
14871, 2 and 3.
1488
Guido van Rossum7be34a81995-05-31 15:17:12 +000014894.32. Q. How do I enable font-lock-mode for Python in Emacs?
1490
1491A. Assuming you're already using python-mode and font-lock-mode
1492separately, all you need to do is put this in your .emacs file:
1493
Guido van Rossume7d92d51995-10-11 18:06:54 +00001494 (defun my-python-mode-hook ()
1495 (setq font-lock-keywords python-font-lock-keywords)
1496 (font-lock-mode 1))
1497 (add-hook 'python-mode-hook 'my-python-mode-hook)
Guido van Rossum7be34a81995-05-31 15:17:12 +00001498
14994.33. Q. Is there an inverse to the format operator (a la C's scanf())?
1500
1501A. Not as such.
1502
1503For simple input parsing, the easiest approach is usually to split
1504the line into whitespace-delimited words using string.split(), and to
1505convert decimal strings to numeric values using string.atoi(),
1506string.atol() or string.atof(). (Python's atoi() is 32-bit and its
1507atol() is arbitrary precision.) If you want to use another delimiter
1508than whitespace, use string.splitfield() (possibly combining it with
1509string.strip() which removes surrounding whitespace from a string).
1510
1511For more complicated input parsing, regular expressions (see module
1512regex) are better suited and more powerful than C's scanf().
1513
Guido van Rossumca318ec1996-06-26 19:50:09 +000015144.34. Q. Can I have Tk events handled while waiting for I/O?
1515
1516A. Yes, and you don't even need threads! But you'll have to
1517restructure your I/O code a bit. Tk has the equivalent of Xt's
1518XtAddInput() call, which allows you to register a callback function
1519which will be called from the Tk mainloop when I/O is possible on a
1520file descriptor. Here's what you need:
1521
Guido van Rossumc458e941996-09-11 15:43:13 +00001522 from Tkinter import tkinter
1523 tkinter.createfilehandler(file, mask, callback)
Guido van Rossumca318ec1996-06-26 19:50:09 +00001524
1525The file may be a Python file or socket object (actually, anything
1526with a fileno() method), or an integer file descriptor. The mask is
1527one of the constants tkinter.READABLE or tkinter.WRITABLE. The
1528callback is called as follows:
1529
Guido van Rossumc458e941996-09-11 15:43:13 +00001530 callback(file, mask)
Guido van Rossumca318ec1996-06-26 19:50:09 +00001531
1532You must unregister the callback when you're done, using
1533
Guido van Rossumc458e941996-09-11 15:43:13 +00001534 tkinter.deletefilehandler(file)
Guido van Rossumca318ec1996-06-26 19:50:09 +00001535
1536Note: since you don't know *how many bytes* are available for reading,
1537you can't use the Python file object's read or readline methods, since
1538these will insist on reading a predefined number of bytes. For
1539sockets, the recv() or recvfrom() methods will work fine; for other
1540files, use os.read(file.fileno(), maxbytecount).
1541
15424.35. Q. How do I write a function with output parameters (call by reference)?
1543
1544A. [Mark Lutz] The thing to remember is that arguments are passed by
1545assignment in Python. Since assignment just creates references to
1546objects, there's no alias between an argument name in the caller and
1547callee, and so no call-by-reference per se. But you can simulate it
1548in a number of ways:
1549
15501) By using global variables; but you probably shouldn't :-)
1551
15522) By passing a mutable (changeable in-place) object:
1553
1554 def func1(a):
1555 a[0] = 'new-value' # 'a' references a mutable list
1556 a[1] = a[1] + 1 # changes a shared object
1557
1558 args = ['old-value', 99]
1559 func1(args)
1560 print args[0], args[1] # output: new-value 100
1561
15623) By return a tuple, holding the final values of arguments:
1563
1564 def func2(a, b):
1565 a = 'new-value' # a and b are local names
1566 b = b + 1 # assigned to new objects
1567 return a, b # return new values
1568
1569 x, y = 'old-value', 99
1570 x, y = func2(x, y)
1571 print x, y # output: new-value 100
1572
15734) And other ideas that fall-out from Python's object model. For
1574 instance, it might be clearer to pass in a mutable dictionary:
1575
1576 def func3(args):
1577 args['a'] = 'new-value' # args is a mutable dictionary
1578 args['b'] = args['b'] + 1 # change it in-place
1579
1580 args = {'a':' old-value', 'b': 99}
1581 func3(args)
1582 print args['a'], args['b']
1583
15845) Or bundle-up values in a class instance:
1585
1586 class callByRef:
1587 def __init__(self, **args):
1588 for (key, value) in args.items():
1589 setattr(self, key, value)
1590
1591 def func4(args):
1592 args.a = 'new-value' # args is a mutable callByRef
1593 args.b = args.b + 1 # change object in-place
1594
1595 args = callByRef(a='old-value', b=99)
1596 func4(args)
1597 print args.a, args.b
1598
1599 But there's probably no good reason to get this complicated :-).
1600
1601[Python' author favors solution 3 in most cases.]
1602
Guido van Rossum0d20cfa1996-07-30 18:53:05 +000016034.36. Q. Please explain the rules for local and global variables in Python.
1604
1605A. [Ken Manheimer] In Python, procedure variables are implicitly
1606global, unless they assigned anywhere within the block. In that case
1607they are implicitly local, and you need to explicitly declare them as
1608'global'.
1609
1610Though a bit surprising at first, a moments consideration explains
1611this. On one hand, requirement of 'global' for assigned vars provides
1612a bar against unintended side-effects. On the other hand, if global
1613were required for all global references, you'd be using global all the
1614time. Eg, you'd have to declare as global every reference to a
1615builtin function, or to a component of an imported module. This
1616clutter would defeat the usefulness of the 'global' declaration for
1617identifying side-effects.
1618
16194.37. Q. How can I have modules that mutually import each other?
1620
1621A. Jim Roskind recommends the following order in each module:
1622
1623First: all exports (like globals, functions, and classes that don't
1624need imported bases classes).
1625
1626Then: all import statements.
1627
1628Finally: all active code (including globals that are initialized from
1629imported values).
1630
1631Python's author doesn't like this approach much because the imports
1632appear in a strange place, but has to admit that it works. His
1633recommended strategy is to avoid all uses of "from <module> import *"
1634(so everything from an imported module is referenced as
1635<module>.<name>) and to place all code inside functions.
1636Initializations of global variables and class variables should use
1637constants or built-in functions only.
1638
Guido van Rossum8727df41996-09-09 15:16:39 +000016394.38. Q. How do I copy an object in Python?
1640
1641A. There is no generic copying operation built into Python, however
1642most object types have some way to create a clone. Here's how for the
1643most common objects:
1644
1645- For immutable objects (numbers, strings, tuples), cloning is
1646unnecessary since their value can't change.
1647
1648- For lists (and generally for mutable sequence types), a clone is
1649created by the expression l[:].
1650
1651- For dictionaries, the following function returns a clone:
1652
Guido van Rossumc458e941996-09-11 15:43:13 +00001653 def dictclone(o):
1654 n = {}
1655 for k in o.keys(): n[k] = o[k]
1656 return n
Guido van Rossum8727df41996-09-09 15:16:39 +00001657
1658- Finally, for generic objects, the "copy" module defines two
1659functions for copying objects. copy.copy(x) returns a copy as shown
1660by the above rules. copy.deepcopy(x) also copies the elements of
1661composite objects. See the section on this module in the Library
1662Reference Manual.
1663
16644.39. Q. How to implement persistent objects in Python? (Persistent ==
1665automatically saved to and restored from disk.)
1666
1667A. The library module "pickle" now solves this in a very general way
1668(though you still can't store things like open files, sockests or
1669windows), and the library module "shelve" uses pickle and (g)dbm to
1670create presistent mappings containing arbitrary Python objects.
1671
Guido van Rossuma4e41a81996-10-22 03:00:43 +000016724.40. Q. I try to use __spam and I get an error about _SomeClassName__spam.
1673
1674A. Variables with double leading underscore are "mangled" to provide a
1675simple but effective way to define class private variables. See the
1676chapter "New in Release 1.4" in the Python Tutorial.
1677
Guido van Rossumc59120b1996-11-14 14:10:11 +000016784.41. Q. How do I delete a file? And other file questions.
1679
1680A. Use os.remove(filename) or os.unlink(filename); for documentation,
1681see the posix section of the library manual. They are the same,
1682unlink() is simply the Unix name for this function. In earlier
1683versions of Python, only os.unlink() was available.
1684
1685To remove a directory, use os.rmdir(); use os.mkdir() to create one.
1686
1687To rename a file, use os.rename().
1688
1689To truncate a file, open it using f = open(filename, "w+"), and use
1690f.truncate(offset); offset defaults to the current seek position.
1691There's also os.ftruncate(fd, offset) for files opened with os.open()
1692-- for advanced Unix hacks only.
1693
Guido van Rossum4a908be1997-03-16 18:34:00 +000016944.42. Q. How to modify urllib or httplib to support HTTP/1.1?
1695
1696A. Apply the following patch to httplib.py:
1697
169841c41
1699< replypat = regsub.gsub('\\.', '\\\\.', HTTP_VERSION) + \
1700---
1701> replypat = regsub.gsub('\\.', '\\\\.', 'HTTP/1.[0-9]+') + \
1702
1703
Guido van Rossum061f1821994-10-06 16:03:45 +00001704
Guido van Rossuma7925f11994-01-26 10:20:16 +000017055. Extending Python
1706===================
1707
17085.1. Q. Can I create my own functions in C?
1709
1710A. Yes, you can create built-in modules containing functions,
Guido van Rossum24349991994-02-02 14:12:45 +00001711variables, exceptions and even new types in C. This is explained in
1712the document "Extending and Embedding the Python Interpreter" (the
1713LaTeX file Doc/ext.tex). Also read the chapter on dynamic loading.
Guido van Rossuma7925f11994-01-26 10:20:16 +00001714
17155.2. Q. Can I create my own functions in C++?
1716
1717A. Yes, using the C-compatibility features found in C++. Basically
1718you place extern "C" { ... } around the Python include files and put
1719extern "C" before each function that is going to be called by the
1720Python interpreter. Global or static C++ objects with constructors
1721are probably not a good idea.
1722
Guido van Rossum7ce61c11994-06-13 15:13:56 +000017235.3. Q. How can I execute arbitrary Python statements from C?
1724
1725A. The highest-level function to do this is run_command() which takes
1726a single string argument which is executed in the context of module
1727__main__ and returns 0 for success and -1 when an exception occurred
1728(including SyntaxError). If you want more control, use run_string();
1729see the source for run_command() in Python/pythonrun.c.
1730
17315.4. Q. How can I evaluate an arbitrary Python expression from C?
1732
1733A. Call the function run_string() from the previous question with the
1734start symbol eval_input; it then parses an expression, evaluates it
1735and returns its value. See exec_eval() in Python/bltinmodule.c.
1736
17375.5. Q. How do I extract C values from a Python object?
1738
1739A. That depends on the object's type. If it's a tuple,
1740gettuplesize(o) returns its length and gettupleitem(o, i) returns its
1741i'th item; similar for lists with getlistsize(o) and getlistitem(o,
1742i). For strings, getstringsize(o) returns its length and
1743getstringvalue(o) a pointer to its value (note that Python strings may
1744contain null bytes so strlen() is not safe). To test which type an
1745object is, first make sure it isn't NULL, and then use
1746is_stringobject(o), is_tupleobject(o), is_listobject(o) etc.
1747
17485.6. Q. How do I use mkvalue() to create a tuple of arbitrary length?
1749
1750A. You can't. Use t = newtupleobject(n) instead, and fill it with
1751objects using settupleitem(t, i, o) -- note that this "eats" a
1752reference count of o. Similar for lists with newlistobject(n) and
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001753setlistitem(l, i, o). Note that you *must* set all the tuple items to
1754some value before you pass the tuple to Python code --
1755newtupleobject(n) initializes them to NULL, which isn't a valid Python
1756value.
1757
Guido van Rossum8727df41996-09-09 15:16:39 +000017585.7. Q. How do I call an object's method from C?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001759
1760A. Here's a function (untested) that might become part of the next
1761release in some form. It uses <stdarg.h> to allow passing the
1762argument list on to vmkvalue():
1763
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001764 object *call_method(object *inst, char *methodname, char *format, ...)
1765 {
1766 object *method;
1767 object *args;
1768 object *result;
1769 va_list va;
1770 method = getattr(inst, methodname);
1771 if (method == NULL) return NULL;
1772 va_start(va, format);
1773 args = vmkvalue(format, va);
1774 va_end(va);
1775 if (args == NULL) {
1776 DECREF(method);
1777 return NULL;
1778 }
1779 result = call_object(method, args);
1780 DECREF(method);
1781 DECREF(args);
1782 return result;
1783 }
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001784
1785This works for any instance that has methods -- whether built-in or
1786user-defined. You are responsible for eventually DECREF'ing the
1787return value.
1788
1789To call, e.g., a file object's "seek" method with arguments 10, 0
1790(assuming the file object pointer is "f"):
1791
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001792 res = call_method(f, "seek", "(OO)", 10, 0);
1793 if (res == NULL) {
1794 ... an exception occurred ...
1795 }
1796 else {
1797 DECREF(res);
1798 }
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001799
1800Note that since call_object() *always* wants a tuple for the argument
1801list, to call a function without arguments, pass "()" for the format,
1802and to call a function with one argument, surround the argument in
1803parentheses, e.g. "(i)".
1804
Guido van Rossum8727df41996-09-09 15:16:39 +000018055.8. Q. How do I catch the output from print_error()?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001806
1807A. (Due to Mark Hammond):
1808
1809* in Python code, define an object that supports the "write()" method.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001810
1811* redirect sys.stdout and sys.stderr to this object.
1812
Guido van Rossum061f1821994-10-06 16:03:45 +00001813* call print_error, or just allow the standard traceback mechanism to
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001814work.
1815
Guido van Rossum061f1821994-10-06 16:03:45 +00001816Then, the output will go wherever your write() method sends it.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001817
Guido van Rossum8727df41996-09-09 15:16:39 +000018185.9. Q. How do I access a module written in Python from C?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001819
1820A. You can get a pointer to the module object as follows:
1821
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001822 module = import_module("<modulename>");
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001823
1824If the module hasn't been imported yet (i.e. it is not yet present in
1825sys.modules), this initializes the module; otherwise it simply returns
1826the value of sys.modules["<modulename>"]. Note that it doesn't enter
1827the module into any namespace -- it only ensures it has been
1828initialized and is stored in sys.modules.
1829
1830You can then access the module's attributes (i.e. any name defined in
1831the module) as follows:
1832
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001833 attr = getattr(module, "<attrname>");
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00001834
1835Calling setattr(), to assign to variables in the module, also works.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00001836
Guido van Rossum8727df41996-09-09 15:16:39 +000018375.10. Q. How do I interface to C++ objects from Python?
Guido van Rossumb0a2ce51995-08-28 19:41:35 +00001838
1839A. Depending on your requirements, there are many approaches. Begin
1840by reading the "Extending and Embedding" document (Doc/ext.tex, see
1841also <URL:http://www.python.org/doc/>). Realize that for the Python
1842run-time system, there isn't a whole lot of difference between C and
1843C++ -- so the strategy to build a new Python type around a C structure
1844(pointer) type will also work for C++ objects.
1845
1846Automatic generation of interfaces between Python and C++ is still at
1847the horizon -- parsing C++ header files requires an almost complete
1848C++ parser, and many features aren't easily translated from C++ to
1849Python: certain forms of operator oveloading, function overloading
1850(best approached by a varargs function which explicitly type-checks
1851its arguments), and reference arguments are just a number of features
1852that are hard to translate correctly if at all.
1853
1854The hardest problem is to transparently translate the C++ class
1855hierarchy to Python, so that Python programs derive classes from C++
1856classes. Given suitable constraints, this may be possible, but it
1857would require more space than I have in this FAQ to explain how.
1858In any case, you can get quite a bit done without this, using just the
1859existing classes from Python.
1860
1861If this all seems rather daunting, that may be because it is -- C++
1862isn't exactly a baby to handle without gloves! However, people have
1863accomplished amazing feats of interfacing between Python and C++, and
1864a detailed question posted to the Python list is likely to elicit some
1865interesting and useful responses.
1866
Guido van Rossuma7925f11994-01-26 10:20:16 +00001867
18686. Python's design
1869==================
1870
Guido van Rossum8727df41996-09-09 15:16:39 +000018716.1. Q. Why isn't there a switch or case statement in Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +00001872
1873A. You can do this easily enough with a sequence of
1874if... elif... elif... else. There have been some proposals for switch
Guido van Rossum061f1821994-10-06 16:03:45 +00001875statement syntax, but there is no consensus (yet) on whether and how
Guido van Rossuma7925f11994-01-26 10:20:16 +00001876to do range tests.
1877
Guido van Rossum8727df41996-09-09 15:16:39 +000018786.2. Q. Why does Python use indentation for grouping of statements?
Guido van Rossumc50158e1994-05-31 09:18:50 +00001879
1880A. Basically I believe that using indentation for grouping is
1881extremely elegant and contributes a lot to the clarity of the average
1882Python program. Most people learn to love this feature after a while.
1883Some arguments for it:
1884
1885- Since there are no begin/end brackets there cannot be a disagreement
1886between grouping perceived by the parser and the human reader. I
1887remember long ago seeing a C fragment like this:
1888
Guido van Rossuma6c707c1995-01-02 17:32:28 +00001889 if (x <= y)
1890 x++;
1891 y--;
1892 z++;
Guido van Rossumc50158e1994-05-31 09:18:50 +00001893
1894and staring a long time at it wondering why y was being decremented
1895even for x > y... (And I wasn't a C newbie then either.)
1896
Guido van Rossum7be34a81995-05-31 15:17:12 +00001897- Since there are no begin/end brackets, Python is much less prone to
1898coding-style conflicts. In C there are loads of different ways to
1899place the braces (including the choice whether to place braces around
1900single statements in certain cases, for consistency). If you're used
1901to reading (and writing) code that uses one style, you will feel at
1902least slightly uneasy when reading (or being required to write)
1903another style.
Guido van Rossumc50158e1994-05-31 09:18:50 +00001904
1905- Many coding styles place begin/end brackets on a line by themself.
1906This makes programs considerably longer and wastes valuable screen
1907space, making it harder to get a good overview over a program.
1908Ideally, a function should fit on one basic tty screen (say, 20
1909lines). 20 lines of Python are worth a LOT more than 20 lines of C.
1910This is not solely due to the lack of begin/end brackets (the lack of
1911declarations also helps, and the powerful operations of course), but
1912it certainly helps!
1913
Guido van Rossum8727df41996-09-09 15:16:39 +000019146.3. Q. Why are Python strings immutable?
Guido van Rossum3de27361994-07-25 14:19:33 +00001915
1916A. There are two advantages. One is performance: knowing that a
1917string is immutable makes it easy to lay it out at construction time
1918-- fixed and unchanging storage requirements. (This is also one of
Guido van Rossum061f1821994-10-06 16:03:45 +00001919the reasons for the distinction between tuples and lists.) The
Guido van Rossum3de27361994-07-25 14:19:33 +00001920other is that strings in Python are considered as "elemental" as
1921numbers. No amount of activity will change the value 8 to anything
1922else, and in Python, no amount of activity will change the string
1923"eight" to anything else. (Adapted from Jim Roskind)
1924
Guido van Rossum8727df41996-09-09 15:16:39 +000019256.4. Q. Why don't strings have methods like index() or sort(), like
Guido van Rossum3de27361994-07-25 14:19:33 +00001926lists?
1927
1928A. Good question. Strings currently don't have methods at all
1929(likewise tuples and numbers). Long ago, it seemed unnecessary to
1930implement any of these functions in C, so a standard library module
1931"string" written in Python was created that performs string related
1932operations. Since then, the cry for performance has moved most of
1933them into the built-in module strop (this is imported by module
Guido van Rossumf8c76d01994-08-17 12:19:53 +00001934string, which is still the preferred interface, without loss of
Guido van Rossum3de27361994-07-25 14:19:33 +00001935performance except during initialization). Some of these functions
1936(e.g. index()) could easily be implemented as string methods instead,
1937but others (e.g. sort()) can't, since their interface prescribes that
1938they modify the object, while strings are immutable (see the previous
1939question).
1940
Guido van Rossum8727df41996-09-09 15:16:39 +000019416.5. Q. Why does Python use methods for some functionality
Guido van Rossum3de27361994-07-25 14:19:33 +00001942(e.g. list.index()) but functions for other (e.g. len(list))?
1943
1944A. Functions are used for those operations that are generic for a
1945group of types and which should work even for objects that don't have
1946methods at all (e.g. numbers, strings, tuples). Also, implementing
1947len(), max(), min() as a built-in function is actually less code than
1948implementing them as methods for each type. One can quibble about
1949individual cases but it's really too late to change such things
1950fundamentally now.
1951
Guido van Rossum8727df41996-09-09 15:16:39 +000019526.6. Q. Why can't I derive a class from built-in types (e.g. lists or
Guido van Rossum3de27361994-07-25 14:19:33 +00001953files)?
1954
1955A. This is caused by the relatively late addition of (user-defined)
1956classes to the language -- the implementation framework doesn't easily
1957allow it. See the answer to question 4.2 for a work-around. This
1958*may* be fixed in the (distant) future.
1959
Guido van Rossum8727df41996-09-09 15:16:39 +000019606.7. Q. Why must 'self' be declared and used explicitly in method
Guido van Rossum3de27361994-07-25 14:19:33 +00001961definitions and calls?
1962
1963A. By asking this question you reveal your C++ background. :-)
1964When I added classes, this was (again) the simplest way of
1965implementing methods without too many changes to the interpreter. I
1966borrowed the idea from Modula-3. It turns out to be very useful, for
1967a variety of reasons.
1968
1969First, it makes it more obvious that you are using a method or
1970instance attribute instead of a local variable. Reading "self.x" or
1971"self.meth()" makes it absolutely clear that an instance variable or
1972method is used even if you don't know the class definition by heart.
1973In C++, you can sort of tell by the lack of a local variable
Guido van Rossum061f1821994-10-06 16:03:45 +00001974declaration (assuming globals are rare or easily recognizable) -- but
Guido van Rossum3de27361994-07-25 14:19:33 +00001975in Python, there are no local variable declarations, so you'd have to
1976look up the class definition to be sure.
1977
1978Second, it means that no special syntax is necessary if you want to
1979explicitly reference or call the method from a particular class. In
1980C++, if you want to use a method from base class that is overridden in
1981a derived class, you have to use the :: operator -- in Python you can
1982write baseclass.methodname(self, <argument list>). This is
1983particularly useful for __init__() methods, and in general in cases
1984where a derived class method wants to extend the base class method of
1985the same name and thus has to call the base class method somehow.
1986
1987Lastly, for instance variables, it solves a syntactic problem with
1988assignment: since local variables in Python are (by definition!) those
1989variables to which a value assigned in a function body (and that
1990aren't explicitly declared global), there has to be some way to tell
1991the interpreter that an assignment was meant to assign to an instance
1992variable instead of to a local variable, and it should preferably be
1993syntactic (for efficiency reasons). C++ does this through
1994declarations, but Python doesn't have declarations and it would be a
1995pity having to introduce them just for this purpose. Using the
1996explicit "self.var" solves this nicely. Similarly, for using instance
1997variables, having to write "self.var" means that references to
1998unqualified names inside a method don't have to search the instance's
1999directories.
2000
Guido van Rossum8727df41996-09-09 15:16:39 +000020016.8. Q. Can't you emulate threads in the interpreter instead of
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002002relying on an OS-specific thread implementation?
2003
2004A. Unfortunately, the interpreter pushes at least one C stack frame
2005for each Python stack frame. Also, extensions can call back into
2006Python at almost random moments. Therefore a complete threads
2007implementation requires thread support for C.
2008
Guido van Rossum8727df41996-09-09 15:16:39 +000020096.9. Q. Why can't lambda forms contain statements?
Guido van Rossum061f1821994-10-06 16:03:45 +00002010
2011A. Python lambda forms cannot contain statements because Python's
Guido van Rossum796b2591995-01-20 23:05:52 +00002012syntactic framework can't handle statements nested inside expressions.
Guido van Rossum061f1821994-10-06 16:03:45 +00002013
2014However, in Python, this is not a serious problem. Unlike lambda
2015forms in other languages, where they add functionality, Python lambdas
2016are only a shorthand notation if you're too lazy to define a function.
2017
2018Functions are already first class objects in Python, and can be
2019declared in a local scope. Therefore the only advantage of using a
2020lambda form instead of a locally-defined function is that you'll have
2021to invent a name for the function -- but that's just a local variable
2022to which the function object (which is exactly the same type of object
2023that a lambda form yields) is assigned!
2024
Guido van Rossum8727df41996-09-09 15:16:39 +000020256.10. Q. Why don't lambdas have access to variables defined in the
2026containing scope?
2027
Guido van Rossumc458e941996-09-11 15:43:13 +00002028A. Because they are implemented as ordinary functions.
2029See question 4.5 above.
Guido van Rossum8727df41996-09-09 15:16:39 +00002030
20316.11. Q. Why can't recursive functions be defined inside other functions?
2032
2033A. See question 4.5 above.
2034
Guido van Rossum061f1821994-10-06 16:03:45 +000020356.12. Q. Why is there no more efficient way of iterating over a dictionary
2036than first constructing the list of keys()?
2037
2038A. Have you tried it? I bet it's fast enough for your purposes! In
2039most cases such a list takes only a few percent of the space occupied
2040by the dictionary -- it needs only 4 bytes (the size of a pointer) per
2041key -- a dictionary costs 8 bytes per key plus between 30 and 70
2042percent hash table overhead, plus the space for the keys and values --
2043by necessity all keys are unique objects and a string object (the most
2044common key type) costs at least 18 bytes plus the length of the
2045string. Add to that the values contained in the dictionary, and you
2046see that 4 bytes more per item really isn't that much more memory...
2047
2048A call to dict.keys() makes one fast scan over the dictionary
2049(internally, the iteration function does exist) copying the pointers
2050to the key objects into a pre-allocated list object of the right size.
2051The iteration time isn't lost (since you'll have to iterate anyway --
2052unless in the majority of cases your loop terminates very prematurely
2053(which I doubt since you're getting the keys in random order).
2054
2055I don't expose the dictionary iteration operation to Python
2056programmers because the dictionary shouldn't be modified during the
2057entire iteration -- if it is, there's a very small chance that the
2058dictionary is reorganized because the hash table becomes too full, and
2059then the iteration may miss some items and see others twice. Exactly
2060because this only occurs rarely, it would lead to hidden bugs in
2061programs: it's easy never to have it happen during test runs if you
2062only insert or delete a few items per iteration -- but your users will
2063surely hit upon it sooner or later.
2064
Guido van Rossumb0a2ce51995-08-28 19:41:35 +000020656.13. Q. Can Python be compiled to machine code, C or some other language?
2066
2067A. Not easily. Python's high level data types, dynamic typing of
2068objects and run-time invocation of the interpreter (using eval() or
2069exec) together mean that a "compiled" Python program would probably
2070consist mostly of calls into the Python run-time system, even for
2071seemingly simple operations like "x+1". Thus, the performance gain
2072would probably be minimal.
2073
2074Internally, Python source code is always translated into a "virtual
2075machine code" or "byte code" representation before it is interpreted
2076(by the "Python virtual machine" or "bytecode interpreter"). In order
2077to avoid the overhead of parsing and translating modules that rarely
2078change over and over again, this byte code is written on a file whose
2079name ends in ".pyc" whenever a module is parsed (from a file whose
2080name ends in ".py"). When the corresponding .py file is changed, it
2081is parsed and translated again and the .pyc file is rewritten. There
2082is no performance difference once the .pyc file has been loaded (the
2083bytecode read from the .pyc file is exactly the same as the bytecode
2084created by direct translation). The only difference is that loading
2085code from a .pyc file is faster than parsing and translating a .py
2086file, so the presence of precompiled .pyc files will generally improve
2087start-up time of Python scripts. If desired, the Lib/compileall.py
2088module/script can be used to force creation of valid .pyc files for a
2089given set of modules.
2090
2091If you are looking for a way to translate Python programs in order to
2092distribute them in binary form, without the need to distribute the
2093interpreter and library as well, have a look at the freeze.py script
2094in the Tools/freeze directory. This creates a single binary file
2095incorporating your program, the Python interpreter, and those parts of
2096the Python library that are needed by your program. Of course, the
2097resulting binary will only run on the same type of platform as that
2098used to create it.
2099
2100Hints for proper usage of freeze.py:
2101
2102- the script must be in a file whose name ends in .py
2103
2104- you must have installed Python fully:
2105
Guido van Rossume7d92d51995-10-11 18:06:54 +00002106 make install
2107 make libinstall
2108 make inclinstall
2109 make libainstall
Guido van Rossumb0a2ce51995-08-28 19:41:35 +00002110
Guido van Rossum05151e01995-09-28 13:24:46 +000021116.14. Q. Why doesn't Python use proper garbage collection?
2112
2113A. It's looking less and less likely that Python will ever get
2114"automatic" garbage collection (GC). For one thing, unless this were
2115added to C as a standard feature, it's a portability pain in the ass.
2116And yes, I know about the Xerox library. It has bits of assembler
2117code for *most* *common* platforms. Not for all. And although it is
2118mostly transparent, it isn't completely transparent (when I once
2119linked Python with it, it dumped core).
2120
2121"Proper" GC also becomes a problem when Python gets embedded into
2122other applications. While in a stand-alone Python it may be fine to
2123replace the standard malloc() and free() with versions provided by the
2124GC library, an application embedding Python may want to have its *own*
2125substitute for malloc() and free(), and may not want Python's. Right
2126now, Python works with anything that implements malloc() and free()
2127properly.
2128
2129Besides, the predictability of destructor calls in Python is kind of
2130attractive. With GC, the following code (which is fine in current
2131Python) will run out of file descriptors long before it runs out of
2132memory:
2133
Guido van Rossume7d92d51995-10-11 18:06:54 +00002134 for file in <very long list of files>:
2135 f = open(file)
2136 c = file.read(1)
Guido van Rossum05151e01995-09-28 13:24:46 +00002137
2138Using the current reference counting and destructor scheme, each new
2139assignment to f closes the previous file. Using GC, this is not
2140guaranteed. Sure, you can think of ways to fix this. But it's not
2141off-the-shelf technology.
2142
Guido van Rossuma7925f11994-01-26 10:20:16 +00002143
21447. Using Python on non-UNIX platforms
2145=====================================
2146
Guido van Rossum91f60831994-02-15 15:52:27 +000021477.1. Q. Is there a Mac version of Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +00002148
Guido van Rossume530c581995-04-10 12:32:16 +00002149A. Yes, see the "mac" subdirectory of the distribution sites,
Guido van Rossum7be34a81995-05-31 15:17:12 +00002150e.g. <URL:ftp://ftp.python.org/pub/python/mac/>.
Guido van Rossuma7925f11994-01-26 10:20:16 +00002151
Guido van Rossumc458e941996-09-11 15:43:13 +000021527.2. Q. Are there DOS and Windows versions of Python?
Guido van Rossuma7925f11994-01-26 10:20:16 +00002153
Guido van Rossumc458e941996-09-11 15:43:13 +00002154A. Yes. There is a plethora of not-always-compatible versions. See
2155the "pythonwin", "wpy", "nt" and "pc" subdirectories of the
2156distribution sites. A quick comparison:
Guido van Rossuma7925f11994-01-26 10:20:16 +00002157
Guido van Rossumc458e941996-09-11 15:43:13 +00002158PythonWin: Extensive support for the 32-bit native Windows API and GUI
2159building using MFC. Windows NT and Windows 95 only (and Windows
21603.1(1) using win32s, until Microsoft stops supporting it :-( ).
2161<URL:ftp://ftp.python.org/pub/python/pythonwin/>.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002162
Guido van Rossumc458e941996-09-11 15:43:13 +00002163WPY: Ports to DOS, Windows 3.1(1), Windows 95, Windows NT and OS/2.
2164Also contains a GUI package that offers portability between Windows
2165(not DOS) and Unix, and native look and feel on both.
2166<URL:ftp://ftp.python.org/pub/python/wpy/>.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002167
Guido van Rossumc458e941996-09-11 15:43:13 +00002168NT: Basic ports built straight from the 1.4 distribution for Windows
216995 and Windows NT. This will eventually provide core support for
2170both PythonWin and WPY on all 32-bit Microsoft platforms.
Guido van Rossum3fc9d731995-07-25 15:10:56 +00002171<URL:ftp://ftp.python.org/pub/python/nt/>.
2172
Guido van Rossumc458e941996-09-11 15:43:13 +00002173PC: Old, unsupported ports to DOS, Windows 3.1(1) and OS/2.
2174<URL:ftp://ftp.python.org/pub/python/pc/>.
Guido van Rossum91f60831994-02-15 15:52:27 +00002175
Guido van Rossumc458e941996-09-11 15:43:13 +000021767.3. Q. Is there an OS/2 version of Python?
Guido van Rossum061f1821994-10-06 16:03:45 +00002177
Guido van Rossumc458e941996-09-11 15:43:13 +00002178A. Yes, see the "pc" and "wpy" subdirectory of the distribution sites
2179(see above).
Guido van Rossum061f1821994-10-06 16:03:45 +00002180
Guido van Rossumc458e941996-09-11 15:43:13 +000021817.4. Q. Is there a VMS version of Python?
Guido van Rossume530c581995-04-10 12:32:16 +00002182
Guido van Rossum3fc9d731995-07-25 15:10:56 +00002183A. Donn Cave <donn@cac.washington.edu> did a partial port. The
2184results of his efforts are on public display in
Guido van Rossumbf8e7d51995-08-28 03:09:13 +00002185<<URL:ftp://ftp.python.org/pub/python/contrib/vms.tar.gz/>. Someone
2186else is working on a more complete port, for details watch the list.
Guido van Rossume530c581995-04-10 12:32:16 +00002187
Guido van Rossumc458e941996-09-11 15:43:13 +000021887.5. Q. What about IBM mainframes, or other non-UNIX platforms?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002189
Guido van Rossumb0a2ce51995-08-28 19:41:35 +00002190A. I haven't heard about these, except I remember hearing about an
2191OS/9 port and a port to Vxworks (both operating systems for embedded
2192systems). If you're interested in any of this, go directly to the
2193newsgroup and ask there, you may find exactly what you need. For
2194example, a port to MPE/iX 5.0 on HP3000 computers was just announced,
2195see <URL:http://www.allegro.com/software/>.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002196
Guido van Rossumc458e941996-09-11 15:43:13 +000021977.6. Q. Where are the source or Makefiles for the non-UNIX versions?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002198
Guido van Rossume530c581995-04-10 12:32:16 +00002199A. The standard sources can (almost) be used. Additional sources can
2200be found in the platform-specific subdirectories of the distribution.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002201
Guido van Rossumc458e941996-09-11 15:43:13 +000022027.7. Q. What is the status and support for the non-UNIX versions?
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002203
2204A. I don't have access to most of these platforms, so in general I am
2205dependent on material submitted by volunteers(*). However I strive to
2206integrate all changes needed to get it to compile on a particular
2207platform back into the standard sources, so porting of the next
2208version to the various non-UNIX platforms should be easy.
2209
Guido van Rossuma6c707c1995-01-02 17:32:28 +00002210(*) For the Macintosh, that volunteer is me, with help from Jack
2211Jansen <jack@cwi.nl>.
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002212
Guido van Rossumc458e941996-09-11 15:43:13 +000022137.8. Q. I have a PC version but it appears to be only a binary.
Guido van Rossum7ce61c11994-06-13 15:13:56 +00002214Where's the library?
Guido van Rossuma7925f11994-01-26 10:20:16 +00002215
2216A. You still need to copy the files from the distribution directory
Guido van Rossum91f60831994-02-15 15:52:27 +00002217"python/Lib" to your system. If you don't have the full distribution,
Guido van Rossume530c581995-04-10 12:32:16 +00002218you can get the file lib<version>.tar.gz from most ftp sites carrying
2219Python; this is a subset of the distribution containing just those
Guido van Rossum7be34a81995-05-31 15:17:12 +00002220files, e.g. <URL:ftp://ftp.python.org/pub/python/src/lib1.1.tar.gz>.
Guido van Rossuma7925f11994-01-26 10:20:16 +00002221
Guido van Rossum5333c5d1994-04-11 11:06:22 +00002222Once you have installed the library, you need to point sys.path to it.
2223Assuming the library is in C:\misc\python\lib, the following commands
2224will point your Python interpreter to it (note the doubled backslashes
2225-- you can also use single forward slashes instead):
2226
Guido van Rossuma6c707c1995-01-02 17:32:28 +00002227 >>> import sys
2228 >>> sys.path.insert(0, 'C:\\misc\\python\\lib')
2229 >>>
Guido van Rossum5333c5d1994-04-11 11:06:22 +00002230
2231For a more permanent effect, set the environment variable PYTHONPATH,
2232as follows (talking to a DOS prompt):
2233
Guido van Rossuma6c707c1995-01-02 17:32:28 +00002234 C> SET PYTHONPATH=C:\misc\python\lib
Guido van Rossum5333c5d1994-04-11 11:06:22 +00002235
Guido van Rossumc458e941996-09-11 15:43:13 +000022367.9. Q. Where's the documentation for the Mac or PC version?
Guido van Rossuma7925f11994-01-26 10:20:16 +00002237
Guido van Rossume530c581995-04-10 12:32:16 +00002238A. The documentation for the Unix version also applies to the Mac and
2239PC versions. Where applicable, differences are indicated in the text.
Guido van Rossuma7925f11994-01-26 10:20:16 +00002240
Guido van Rossumc458e941996-09-11 15:43:13 +000022417.10. Q. The Mac (PC) version doesn't seem to have any facilities for
Guido van Rossum91f60831994-02-15 15:52:27 +00002242creating or editing programs apart from entering it interactively, and
2243there seems to be no way to save code that was entered interactively.
2244How do I create a Python program on the Mac (PC)?
Guido van Rossuma7925f11994-01-26 10:20:16 +00002245
Guido van Rossumb34e8aa1994-09-23 14:20:38 +00002246A. Use an external editor. On the Mac, BBEdit seems to be a popular
2247no-frills text editor. I work like this: start the interpreter; edit
2248a module file using BBedit; import and test it in the interpreter;
2249edit again in BBedit; then use the built-in function reload() to
2250re-read the imported module; etc.
Guido van Rossum5333c5d1994-04-11 11:06:22 +00002251
2252Regarding the same question for the PC, Kurt Wm. Hemr writes: "While
2253anyone with a pulse could certainly figure out how to do the same on
2254MS-Windows, I would recommend the NotGNU Emacs clone for MS-Windows.
2255Not only can you easily resave and "reload()" from Python after making
2256changes, but since WinNot auto-copies to the clipboard any text you
2257select, you can simply select the entire procedure (function) which
2258you changed in WinNot, switch to QWPython, and shift-ins to reenter
2259the changed program unit."