blob: cce60fa10f95f7a7a375658eff413abeba692f60 [file] [log] [blame]
Anthony Baxterc560a002005-01-25 12:40:01 +00001This is Python version 2.5 alpha 0
Skip Montanarobff63f02004-03-05 14:33:21 +00002==================================
Guido van Rossum91447632000-04-11 17:11:09 +00003
Georg Brandlb69406d2006-02-11 15:30:36 +00004Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation.
Guido van Rossum67345eb2001-01-18 14:51:12 +00005All rights reserved.
6
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00007Copyright (c) 2000 BeOpen.com.
8All rights reserved.
9
Guido van Rossum23f7aed2001-04-12 20:53:31 +000010Copyright (c) 1995-2001 Corporation for National Research Initiatives.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000011All rights reserved.
12
Guido van Rossum6ebd2992000-09-03 04:47:47 +000013Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000014All rights reserved.
15
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000016
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000017License information
18-------------------
19
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000020See the file "LICENSE" for information on the history of this
21software, terms & conditions for usage, and a DISCLAIMER OF ALL
22WARRANTIES.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000023
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000024This Python distribution contains no GNU General Public Licensed
25(GPLed) code so it may be used in proprietary projects just like prior
26Python distributions. There are interfaces to some GNU code but these
27are entirely optional.
28
29All trademarks referenced herein are property of their respective
30holders.
Guido van Rossum79808261997-12-11 18:01:47 +000031
32
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +000033What's new in this release?
34---------------------------
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000035
Guido van Rossum67345eb2001-01-18 14:51:12 +000036See the file "Misc/NEWS".
Guido van Rossum64773801997-11-26 17:07:02 +000037
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000038
Guido van Rossum64773801997-11-26 17:07:02 +000039If you don't read instructions
40------------------------------
41
42Congratulations on getting this far. :-)
43
44To start building right away (on UNIX): type "./configure" in the
Guido van Rossum2dcec0c2002-02-04 01:59:23 +000045current directory and when it finishes, type "make". This creates an
46executable "./python"; to install in /usr/local, first do "su root"
47and then "make install".
48
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000049The section `Build instructions' below is still recommended reading.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000050
51
Guido van Rossum91cb9d21995-04-10 11:47:38 +000052What is Python anyway?
53----------------------
54
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000055Python is an interpreted, interactive object-oriented programming
56language suitable (amongst other uses) for distributed application
57development, scripting, numeric computing and system testing. Python
58is often compared to Tcl, Perl, Java, JavaScript, Visual Basic or
59Scheme. To find out more about what Python can do for you, point your
60browser to http://www.python.org/.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000061
62
Guido van Rossumf501b4e1996-10-25 14:32:48 +000063How do I learn Python?
64----------------------
65
Fred Drake0e6444c1999-05-17 19:35:01 +000066The official tutorial is still a good place to start; see
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000067http://docs.python.org/ for online and downloadable versions, as well
68as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48 +000069
Guido van Rossumd0a42e22000-03-31 20:16:45 +000070There's a quickly growing set of books on Python. See
Michael W. Hudsonfad46402005-06-16 15:51:20 +000071http://wiki.python.org/moin/PythonBooks for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25 +000072
Guido van Rossumf501b4e1996-10-25 14:32:48 +000073
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000074Documentation
75-------------
Guido van Rossum91cb9d21995-04-10 11:47:38 +000076
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000077All documentation is provided online in a variety of formats. In
78order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000079Language Reference, Extending & Embedding, and the Python/C API. The
80Library Reference is especially of immense value since much of
81Python's power is described there, including the built-in data types
82and functions!
Guido van Rossum91cb9d21995-04-10 11:47:38 +000083
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000084All documentation is also available online at the Python web site
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000085(http://docs.python.org/, see below). It is available online for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000086occasional reference, or can be downloaded in many formats for faster
Fred Drake6caae142000-10-25 17:51:02 +000087access. The documentation is available in HTML, PostScript, PDF, and
88LaTeX formats; the LaTeX version is primarily for documentation
89authors, translators, and people with special formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000090
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000091Unfortunately, new-style classes (new in Python 2.2) have not yet been
92integrated into Python's standard documention. A collection of
93pointers to what has been written is at:
Barry Warsaw06557452001-12-14 20:47:12 +000094
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +000095 http://www.python.org/doc/newstyle.html
Barry Warsaw06557452001-12-14 20:47:12 +000096
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000097
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000098Web sites
99---------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000100
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000101New Python releases and related technologies are published at
Guido van Rossum67345eb2001-01-18 14:51:12 +0000102http://www.python.org/. Come visit us!
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000103
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +0000104There's also a Python community web site at
105http://starship.python.net/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000106
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000107
108Newsgroups and Mailing Lists
109----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000110
111Read comp.lang.python, a high-volume discussion newsgroup about
112Python, or comp.lang.python.announce, a low-volume moderated newsgroup
113for Python-related announcements. These are also accessible as
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000114mailing lists: see http://www.python.org/community/lists.html for an
115overview of these and many other Python-related mailing lists.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000116
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +0000117Archives are accessible via the Google Groups usenet archive; see
118http://groups.google.com/. The mailing lists are also archived, see
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000119http://www.python.org/community/lists.html for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000120
121
122Bug reports
123-----------
124
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000125To report or search for bugs, please use the Python Bug
126Tracker at http://sourceforge.net/bugs/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000127
128
129Patches and contributions
130-------------------------
131
Fred Drake6caae142000-10-25 17:51:02 +0000132To submit a patch or other contribution, please use the Python Patch
133Manager at http://sourceforge.net/patch/?group_id=5470. Guidelines
134for patch submission may be found at http://www.python.org/patches/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000135
136If you have a proposal to change Python, it's best to submit a Python
137Enhancement Proposal (PEP) first. All current PEPs, as well as
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000138guidelines for submitting a new PEP, are listed at
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000139http://www.python.org/peps/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000140
141
142Questions
143---------
144
145For help, if you can't find it in the manuals or on the web site, it's
146best to post to the comp.lang.python or the Python mailing list (see
147above). If you specifically don't want to involve the newsgroup or
Guido van Rossum67345eb2001-01-18 14:51:12 +0000148mailing list, send questions to help@python.org (a group of volunteers
149who answer questions as they can). The newsgroup is the most
150efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000151
Guido van Rossum901454e2000-06-29 22:28:44 +0000152
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000153Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000154==================
Guido van Rossum627b2d71993-12-24 10:39:16 +0000155
Guido van Rossum59b0b602002-02-08 22:22:35 +0000156Before you can build Python, you must first configure it.
157Fortunately, the configuration and build process has been automated
158for Unix and Linux installations, so all you usually have to do is
159type a few commands and sit back. There are some platforms where
160things are not quite as smooth; see the platform specific notes below.
161If you want to build for multiple platforms sharing the same source
162tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000163
Guido van Rossum59b0b602002-02-08 22:22:35 +0000164Start by running the script "./configure", which determines your
165system configuration and creates the Makefile. (It takes a minute or
166two -- please be patient!) You may want to pass options to the
167configure script -- see the section below on configuration options and
168variables. When it's done, you are ready to run make.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000169
Guido van Rossum59b0b602002-02-08 22:22:35 +0000170To build Python, you normally type "make" in the toplevel directory.
171If you have changed the configuration, the Makefile may have to be
172rebuilt. In this case you may have to run make again to correctly
173build your desired target. The interpreter executable is built in the
174top level directory.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000175
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000176Once you have built a Python interpreter, see the subsections below on
Guido van Rossum59b0b602002-02-08 22:22:35 +0000177testing and installation. If you run into trouble, see the next
178section.
179
180Previous versions of Python used a manual configuration process that
181involved editing the file Modules/Setup. While this file still exists
182and manual configuration is still supported, it is rarely needed any
183more: almost all modules are automatically built as appropriate under
184guidance of the setup.py script, which is run by Make after the
185interpreter has been built.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000186
Guido van Rossum0a516c91994-09-12 10:58:40 +0000187
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000188Troubleshooting
189---------------
Guido van Rossum627b2d71993-12-24 10:39:16 +0000190
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000191See also the platform specific notes in the next section.
192
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000193If you run into other trouble, see the FAQ
194(http://www.python.org/doc/faq) for hints on what can go wrong, and
195how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000196
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000197If you rerun the configure script with different options, remove all
198object files by running "make clean" before rebuilding. Believe it or
199not, "make clean" sometimes helps to clean up other inexplicable
200problems as well. Try it before sending in a bug report!
201
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000202If the configure script fails or doesn't seem to find things that
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000203should be there, inspect the config.log file.
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000204
205If you get a warning for every file about the -Olimit option being no
206longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000207whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000208accepted without error. On some systems, e.g. older SGI compilers, it
209is essential for performance (specifically when compiling ceval.c,
210which has more basic blocks than the default limit of 1000). If the
211warning bothers you, edit the Makefile to remove "-Olimit 1500" from
212the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000213
Guido van Rossum7ac11532000-08-29 21:36:40 +0000214If you get failures in test_long, or sys.maxint gets set to -1, you
215are probably experiencing compiler bugs, usually related to
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000216optimization. This is a common problem with some versions of gcc, and
217some vendor-supplied compilers, which can sometimes be worked around
218by turning off optimization. Consider switching to stable versions
Anthony Baxtere9d719b2004-11-30 01:49:18 +0000219(gcc 2.95.2, gcc 3.x, or contact your vendor.)
Guido van Rossum7ac11532000-08-29 21:36:40 +0000220
221From Python 2.0 onward, all Python C code is ANSI C. Compiling using
222old K&R-C-only compilers is no longer possible. ANSI C compilers are
223available for all modern systems, either in the form of updated
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000224compilers from the vendor, or one of the free compilers (gcc).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000225
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000226Unsupported systems
227-------------------
228
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000229XXX This section is out of date!
230
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000231A number of features are not supported in Python 2.3 anymore. Some
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000232support code is still present, but will be removed in Python 2.4.
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000233If you still need to use current Python versions on these systems,
234please send a message to python-dev@python.org indicating that you
235volunteer to support this system.
236
237More specifically, the following systems are not supported any
238longer:
239- SunOS 4
240- DYNIX
241- dgux
242- Minix
243- Irix 4 and --with-sgi-dl
244- Linux 1
245- Systems defining __d6_pthread_create (configure.in)
246- Systems defining PY_PTHREAD_D4, PY_PTHREAD_D6,
247 or PY_PTHREAD_D7 in thread_pthread.h
248- Systems using --with-dl-dld
Martin v. Löwis7e4cfcb2002-12-19 16:21:49 +0000249- Systems using --without-universal-newlines
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000250
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000251Platform specific notes
252-----------------------
253
Guido van Rossum0447a321995-10-08 01:22:33 +0000254(Some of these may no longer apply. If you find you can build Python
Guido van Rossum67345eb2001-01-18 14:51:12 +0000255on these platforms without the special directions mentioned here,
256submit a documentation bug report to SourceForge (see Bug Reports
257above) so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000258
Skip Montanaro6dc4a8e2003-05-02 15:27:59 +0000259Unix platforms: If your vendor still ships (and you still use) Berkeley DB
260 1.85 you will need to edit Modules/Setup to build the bsddb185
261 module and add a line to sitecustomize.py which makes it the
262 default. In Modules/Setup a line like
263
264 bsddb185 bsddbmodule.c
265
266 should work. (You may need to add -I, -L or -l flags to direct the
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000267 compiler and linker to your include files and libraries.)
Skip Montanaro6dc4a8e2003-05-02 15:27:59 +0000268
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000269XXX I think this next bit is out of date:
Skip Montanaro6dc4a8e2003-05-02 15:27:59 +0000270
Guido van Rossumc0be2f51997-10-08 05:05:28 +000027164-bit platforms: The modules audioop, imageop and rgbimg don't work.
Guido van Rossum59b0b602002-02-08 22:22:35 +0000272 The setup.py script disables them on 64-bit installations.
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000273 Don't try to enable them in the Modules/Setup file. They
274 contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000275 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000276
Guido van Rossum4462e931997-01-22 21:00:32 +0000277Solaris: When using Sun's C compiler with threads, at least on Solaris
278 2.5.1, you need to add the "-mt" compiler option (the simplest
279 way is probably to specify the compiler with this option as
280 the "CC" environment variable when running the configure
281 script).
282
Guido van Rossum42992312002-09-23 14:02:18 +0000283 When using GCC on Solaris, beware of binutils 2.13 or GCC
284 versions built using it. This mistakenly enables the
285 -zcombreloc option which creates broken shared libraries on
286 Solaris. binutils 2.12 works, and the binutils maintainers
Skip Montanaro4de9cba2003-01-03 16:26:23 +0000287 are aware of the problem. Binutils 2.13.1 only partially
288 fixed things. It appears that 2.13.2 solves the problem
289 completely. This problem is known to occur with Solaris 2.7
290 and 2.8, but may also affect earlier and later versions of the
291 OS.
Guido van Rossum42992312002-09-23 14:02:18 +0000292
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000293 When the dynamic loader complains about errors finding shared
294 libraries, such as
295
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000296 ld.so.1: ./python: fatal: libstdc++.so.5: open failed:
297 No such file or directory
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000298
299 you need to first make sure that the library is available on
300 your system. Then, you need to instruct the dynamic loader how
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000301 to find it. You can choose any of the following strategies:
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000302
303 1. When compiling Python, set LD_RUN_PATH to the directories
304 containing missing libraries.
305 2. When running Python, set LD_LIBRARY_PATH to these directories.
306 3. Use crle(8) to extend the search path of the loader.
307 4. Modify the installed GCC specs file, adding -R options into the
308 *link: section.
309
Skip Montanaro9f6606a2005-11-17 18:19:39 +0000310 The complex object fails to compile on Solaris 10 with gcc 3.4 (at
311 least up to 3.4.3). To work around it, define Py_HUGE_VAL as
312 HUGE_VAL(), e.g.:
313
314 make CPPFLAGS='-D"Py_HUGE_VAL=HUGE_VAL()" -I. -I$(srcdir)/Include'
Skip Montanaroa5389922005-11-17 18:31:09 +0000315 ./python setup.py CPPFLAGS='-D"Py_HUGE_VAL=HUGE_VAL()"'
Skip Montanaro9f6606a2005-11-17 18:19:39 +0000316
Guido van Rossum7ac11532000-08-29 21:36:40 +0000317Linux: A problem with threads and fork() was tracked down to a bug in
318 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
319 solves the problem. This causes the popen2 test to fail;
320 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32 +0000321
Martin v. Löwis3efa04a2003-06-14 05:29:27 +0000322Red Hat Linux: Red Hat 9 built Python2.2 in UCS-4 mode and hacked
323 Tcl to support it. To compile Python2.3 with Tkinter, you will
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000324 need to pass --enable-unicode=ucs4 flag to ./configure.
Martin v. Löwis3efa04a2003-06-14 05:29:27 +0000325
326 There's an executable /usr/bin/python which is Python
327 1.5.2 on most older Red Hat installations; several key Red Hat tools
Guido van Rossum2dcec0c2002-02-04 01:59:23 +0000328 require this version. Python 2.1.x may be installed as
329 /usr/bin/python2. The Makefile installs Python as
330 /usr/local/bin/python, which may or may not take precedence
331 over /usr/bin/python, depending on how you have set up $PATH.
332
Guido van Rossum59230501999-06-21 20:51:46 +0000333FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
334 similar: When using cursesmodule, the linking is not done in
335 the correct order with the defaults. Remove "-ltermcap" from
336 the readline entry in Setup, and use as curses entry: "curses
337 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
338 called on FreeBSD) should be the name of the auxiliary library
339 required on your platform. Normally, it would be linked
340 automatically, but not necessarily in the correct order.
341
Guido van Rossum7ac11532000-08-29 21:36:40 +0000342BSDI: BSDI versions before 4.1 have known problems with threads,
343 which can cause strange errors in a number of modules (for
344 instance, the 'test_signal' test script will hang forever.)
345 Turning off threads (with --with-threads=no) or upgrading to
346 BSDI 4.1 solves this problem.
347
348DEC Unix: Run configure with --with-dec-threads, or with
349 --with-threads=no if no threads are desired (threads are on by
350 default). When using GCC, it is possible to get an internal
351 compiler error if optimization is used. This was reported for
352 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
353 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46 +0000354
Guido van Rossume1cdb161999-04-10 16:04:07 +0000355DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
356 and pass SHELL=/bin/sh5 to Make when installing.
357
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000358AIX: A complete overhaul of the shared library support is now in
Guido van Rossum16e809e2001-04-16 02:07:08 +0000359 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000360 (The optimizer bug reported at this place in previous releases
Thomas Wouters8ee06142001-02-15 11:45:29 +0000361 has been worked around by a minimal code change.) If you get
Fred Drake59518b02002-05-11 03:36:26 +0000362 errors about pthread_* functions, during compile or during
Thomas Wouters8ee06142001-02-15 11:45:29 +0000363 testing, try setting CC to a thread-safe (reentrant) compiler,
364 like "cc_r". For full C++ module support, set CC="xlC_r" (or
365 CC="xlC" without thread support).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000366
Guido van Rossuma2534c82005-09-20 19:06:23 +0000367AIX 5.3: To build a 64-bit version with IBM's compiler, I used the
368 following:
369
370 export PATH=/usr/bin:/usr/vacpp/bin
371 ./configure --with-gcc="xlc_r -q64" --with-cxx="xlC_r -q64" \
372 --disable-ipv6 AR="ar -X64"
373 make
374
Anthony Baxter7c497472003-10-01 07:24:54 +0000375HP-UX: When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000376 OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum59a88f41999-04-12 18:16:09 +0000377 this seems to make a difference (at least for HP-UX 10.20)
Anthony Baxter7c497472003-10-01 07:24:54 +0000378 even though pyconfig.h defines it. This seems unnecessary when
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000379 using HP/UX 11 and later - threading seems to work "out of the
Anthony Baxter7c497472003-10-01 07:24:54 +0000380 box".
381
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000382HP-UX ia64: When building on the ia64 (Itanium) platform using HP's
383 compiler, some experience has shown that the compiler's
384 optimiser produces a completely broken version of python
385 (see http://www.python.org/sf/814976). To work around this,
Guido van Rossuma2534c82005-09-20 19:06:23 +0000386 edit the Makefile and remove -O from the OPT line.
Guido van Rossum539c6622005-09-14 17:49:54 +0000387
388 To build a 64-bit executable on an Itanium 2 system using HP's
389 compiler, use these environment variables:
390
391 CC=cc
392 CXX=aCC
393 BASECFLAGS="+DD64"
394 LDFLAGS="+DD64 -lxnet"
395
396 and call configure as:
397
398 ./configure --without-gcc
399
400 then *unset* the environment variables again before running
401 make. (At least one of these flags causes the build to fail
Guido van Rossuma2534c82005-09-20 19:06:23 +0000402 if it remains set.) You still have to edit the Makefile and
403 remove -O from the OPT line.
Guido van Rossum2094e041998-05-14 15:47:35 +0000404
Guido van Rossum4e1dd7d2002-04-23 13:06:07 +0000405HP PA-RISC 2.0: A recent bug report (http://www.python.org/sf/546117)
406 suggests that the C compiler in this 64-bit system has bugs
407 in the optimizer that break Python. Compiling without
408 optimization solves the problems.
409
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000410SCO: The following apply to SCO 3 only; Python builds out of the box
411 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05 +0000412
413 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000414 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02 +0000415 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000416 conditionally excluded when __STDC__ is defined.
417
418 2) Due to the U.S. export restrictions, SCO broke the crypt
419 stuff out into a separate library, libcrypt_i.a so the LIBS
420 needed be set to:
421
422 LIBS=' -lsocket -lcrypt_i'
423
Martin v. Löwis387c5472001-09-06 08:16:17 +0000424UnixWare: There are known bugs in the math library of the system, as well as
425 problems in the handling of threads (calling fork in one
426 thread may interrupt system calls in others). Therefore, test_math and
427 tests involving threads will fail until those problems are fixed.
428
Guido van Rossum7ac11532000-08-29 21:36:40 +0000429SunOS 4.x: When using the SunPro C compiler, you may want to use the
Guido van Rossum64773801997-11-26 17:07:02 +0000430 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
431 Sunisms.
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000432 THIS SYSTEM IS NO LONGER SUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000433
Jack Jansena39ef862001-08-19 21:17:03 +0000434NeXT: Not supported anymore. Start with the MacOSX/Darwin code if you
435 want to revive it.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000436
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000437QNX: Chris Herborth (chrish@qnx.com) writes:
438 configure works best if you use GNU bash; a port is available on
439 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01 +0000440 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000441
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000442 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
443 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000444
Fred Drake80078492000-10-26 17:13:19 +0000445 2) edit Modules/Setup to activate everything that makes sense for
446 your system... tested here at QNX with the following modules:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000447
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000448 array, audioop, binascii, cPickle, cStringIO, cmath,
449 crypt, curses, errno, fcntl, gdbm, grp, imageop,
450 _locale, math, md5, new, operator, parser, pcre,
451 posix, pwd, readline, regex, reop, rgbimg, rotor,
452 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01 +0000453 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000454
Guido van Rossum16e809e2001-04-16 02:07:08 +0000455 3) make SHELL=/usr/local/bin/bash
456
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000457 or, if you feel the need for speed:
Guido van Rossum16e809e2001-04-16 02:07:08 +0000458
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000459 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000460
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000461 4) make SHELL=/usr/local/bin/bash test
462
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000463 Using GNU readline 2.2 seems to behave strangely, but I
464 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000465
466 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000467
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000468 If you get SIGSEGVs while running Python (I haven't yet, but
469 I've only run small programs and the test cases), you're
470 probably running out of stack; the default 32k could be a
471 little tight. To increase the stack size, edit the Makefile
Neil Schemenauer73f8ab22001-01-26 22:18:55 +0000472 to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30 +0000473
Skip Montanaro2d98db62003-01-06 17:23:37 +0000474BeOS: See Misc/BeOS-NOTES for notes about compiling/installing
475 Python on BeOS R3 or later. Note that only the PowerPC
476 platform is supported for R3; both PowerPC and x86 are
477 supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000478
Michael W. Hudson33876f52002-07-31 09:55:25 +0000479Cray T3E: Mark Hadfield (m.hadfield@niwa.co.nz) writes:
480 Python can be built satisfactorily on a Cray T3E but based on
481 my experience with the NIWA T3E (2002-05-22, version 2.2.1)
482 there are a few bugs and gotchas. For more information see a
483 thread on comp.lang.python in May 2002 entitled "Building
484 Python on Cray T3E".
485
486 1) Use Cray's cc and not gcc. The latter was reported not to
487 work by Konrad Hinsen. It may work now, but it may not.
488
489 2) To set sys.platform to something sensible, pass the
490 following environment variable to the configure script:
491
492 MACHDEP=unicosmk
493
494 2) Run configure with option "--enable-unicode=ucs4".
495
496 3) The Cray T3E does not support dynamic linking, so extension
497 modules have to be built by adding (or uncommenting) lines
498 in Modules/Setup. The minimum set of modules is
499
500 posix, new, _sre, unicodedata
501
502 On NIWA's vanilla T3E system the following have also been
503 included successfully:
504
505 _codecs, _locale, _socket, _symtable, _testcapi, _weakref
506 array, binascii, cmath, cPickle, crypt, cStringIO, dbm
507 errno, fcntl, grp, math, md5, operator, parser, pcre, pwd
508 regex, rotor, select, struct, strop, syslog, termios
509 time, timing, xreadlines
510
511 4) Once the python executable and library have been built, make
512 will execute setup.py, which will attempt to build remaining
513 extensions and link them dynamically. Each of these attempts
514 will fail but should not halt the make process. This is
515 normal.
516
517 5) Running "make test" uses a lot of resources and causes
518 problems on our system. You might want to try running tests
519 singly or in small groups.
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000520
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000521SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
522 does not check whether a command actually changed the file it
523 is supposed to build. This means that whenever you say "make"
524 it will redo the link step. The remedy is to use SGI's much
Guido van Rossum7be8ca02001-04-14 13:09:53 +0000525 smarter "smake" utility (/usr/sbin/smake), or GNU make. If
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000526 you set the first line of the Makefile to #!/usr/sbin/smake
527 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000528
Guido van Rossum7be8ca02001-04-14 13:09:53 +0000529 WARNING: There are bugs in the optimizer of some versions of
530 SGI's compilers that can cause bus errors or other strange
531 behavior, especially on numerical operations. To avoid this,
532 try building with "make OPT=".
Fred Drake0b5fb2b2000-09-29 17:45:05 +0000533
Guido van Rossum64773801997-11-26 17:07:02 +0000534OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
535 compiler installed, just change into the pc\os2vacpp directory
536 and type NMAKE. Threading and sockets are supported by default
537 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
538
Fred Drake36ed5602000-10-06 01:58:48 +0000539Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
540 uses the OBJECT_MODE={32|64} environment variable to set the
541 compilation mode to either 32-bit or 64-bit (32-bit mode is
542 the default). Presumably you want 64-bit compilation mode for
543 this 64-bit OS. As a result you must first set OBJECT_MODE=64
544 in your environment before configuring (./configure) or
545 building (make) Python on Monterey.
546
547Reliant UNIX: The thread support does not compile on Reliant UNIX, and
548 there is a (minor) problem in the configure script for that
549 platform as well. This should be resolved in time for a
550 future release.
Trent Mick635f6fb2000-08-23 21:33:05 +0000551
Barry Warsaw6a8557d2002-10-14 18:04:39 +0000552MacOSX: The tests will crash on both 10.1 and 10.2 with SEGV in
Barry Warsaw6e753642002-10-14 18:15:35 +0000553 test_re and test_sre due to the small default stack size. If
554 you set the stack size to 2048 before doing a "make test" the
555 failure can be avoided. If you're using the tcsh (the default
556 on OSX), or csh shells use "limit stacksize 2048" and for the
557 bash shell, use "ulimit -s 2048".
Barry Warsaw06557452001-12-14 20:47:12 +0000558
Jack Jansen6a77cf12001-12-06 21:49:02 +0000559 On naked Darwin you may want to add the configure option
Jack Jansen4c398fd2001-10-08 13:21:15 +0000560 "--disable-toolbox-glue" to disable the glue code for the Carbon
Jack Jansen6a77cf12001-12-06 21:49:02 +0000561 interface modules. The modules themselves are currently only built
562 if you add the --enable-framework option, see below.
Barry Warsaw06557452001-12-14 20:47:12 +0000563
564 On a clean OSX /usr/local does not exist. Do a
Jack Jansen61fec302002-01-04 15:59:57 +0000565 "sudo mkdir -m 775 /usr/local"
Jack Jansen84a01642002-08-04 21:19:55 +0000566 before you do a make install. It is probably not a good idea to
567 do "sudo make install" which installs everything as superuser,
568 as this may later cause problems when installing distutils-based
569 additions.
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000570
Jack Jansen84a01642002-08-04 21:19:55 +0000571 Some people have reported problems building Python after using "fink"
572 to install additional unix software. Disabling fink (remove all references
573 to /sw from your .profile or .login) should solve this.
Barry Warsaw06557452001-12-14 20:47:12 +0000574
575 You may want to try the configure option "--enable-framework"
576 which installs Python as a framework. The location can be set
577 as argument to the --enable-framework option (default
Jack Jansen84a01642002-08-04 21:19:55 +0000578 /Library/Frameworks). A framework install is probably needed if you
579 want to use any Aqua-based GUI toolkit (whether Tkinter, wxPython,
580 Carbon, Cocoa or anything else).
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000581
Jack Jansen84a01642002-08-04 21:19:55 +0000582 See Mac/OSX/README for more information on framework builds.
Fred Drakedabed752001-02-01 19:41:13 +0000583
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000584Cygwin: With recent (relative to the time of writing, 2001-12-19)
585 Cygwin installations, there are problems with the interaction
586 of dynamic linking and fork(). This manifests itself in build
587 failures during the execution of setup.py.
Tim Peters42fc7cc2001-04-04 18:35:19 +0000588
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000589 There are two workarounds that both enable Python (albeit
590 without threading support) to build and pass all tests on
591 NT/2000 (and most likely XP as well, though reports of testing
592 on XP would be appreciated).
Guido van Rossum16e809e2001-04-16 02:07:08 +0000593
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000594 The workarounds:
595
596 (a) the band-aid fix is to link the _socket module statically
597 rather than dynamically (which is the default).
598
599 To do this, run "./configure --with-threads=no" including any
600 other options you need (--prefix, etc.). Then in Modules/Setup
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000601 uncomment the lines:
Tim Peters42fc7cc2001-04-04 18:35:19 +0000602
Michael W. Hudsonbe5ce182001-12-12 11:46:52 +0000603 #SSL=/usr/local/ssl
604 #_socket socketmodule.c \
605 # -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
606 # -L$(SSL)/lib -lssl -lcrypto
Guido van Rossum16e809e2001-04-16 02:07:08 +0000607
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000608 and remove "local/" from the SSL variable. Finally, just run
609 "make"!
Tim Peters42fc7cc2001-04-04 18:35:19 +0000610
Michael W. Hudsonb6554642001-12-19 22:09:09 +0000611 (b) The "proper" fix is to rebase the Cygwin DLLs to prevent
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000612 base address conflicts. Details on how to do this can be
613 found in the following mail:
614
615 http://sources.redhat.com/ml/cygwin/2001-12/msg00894.html
616
617 It is hoped that a version of this solution will be
Michael W. Hudsonb6554642001-12-19 22:09:09 +0000618 incorporated into the Cygwin distribution fairly soon.
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000619
620 Two additional problems:
621
622 (1) Threading support should still be disabled due to a known
623 bug in Cygwin pthreads that causes test_threadedtempfile to
624 hang.
625
Neal Norwitz4ebde092001-12-19 20:44:13 +0000626 (2) The _curses module does not build. This is a known
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000627 Cygwin ncurses problem that should be resolved the next time
628 that this package is released.
Guido van Rossum16e809e2001-04-16 02:07:08 +0000629
Michael W. Hudsonbe5ce182001-12-12 11:46:52 +0000630 On older versions of Cygwin, test_poll may hang and test_strftime
631 may fail.
Tim Peters42fc7cc2001-04-04 18:35:19 +0000632
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000633 The situation on 9X/Me is not accurately known at present.
634 Some time ago, there were reports that the following
635 regression tests failed:
Tim Peters42fc7cc2001-04-04 18:35:19 +0000636
637 test_pwd
638 test_select (hang)
639 test_socket
640
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000641 Due to the test_select hang on 9X/Me, one should run the
642 regression test using the following:
Tim Peters42fc7cc2001-04-04 18:35:19 +0000643
Michael W. Hudsonbe5ce182001-12-12 11:46:52 +0000644 make TESTOPTS='-l -x test_select' test
Tim Peters42fc7cc2001-04-04 18:35:19 +0000645
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000646 News regarding these platforms with more recent Cygwin
647 versions would be appreciated!
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000648
Skip Montanaro56d83012003-01-04 04:05:51 +0000649AtheOS: From Octavian Cerna <tavy at ylabs.com>:
650
651 Before building:
652
653 Make sure you have shared versions of the libraries you
654 want to use with Python. You will have to compile them
655 yourself, or download precompiled packages.
656
657 Recommended libraries:
658
659 ncurses-4.2
660 readline-4.2a
661 zlib-1.1.4
662
663 Build:
664
665 $ ./configure --prefix=/usr/python
666 $ make
667
668 Python is always built as a shared library, otherwise
669 dynamic loading would not work.
670
671 Testing:
672
673 $ make test
674
675 Install:
676
677 # make install
678 # pkgmanager -a /usr/python
679
680
681 AtheOS issues:
682
683 - large file support: due to a stdio bug in glibc/libio,
684 access to large files may not work correctly. fseeko()
685 tries to seek to a negative offset. ftello() returns a
686 negative offset, it looks like a 32->64bit
687 sign-extension issue. The lowlevel functions (open,
688 lseek, etc) are OK.
689 - sockets: AF_UNIX is defined in the C library and in
690 Python, but not implemented in the system.
691 - select: poll is available in the C library, but does not
692 work (It does not return POLLNVAL for bad fds and
693 hangs).
694 - posix: statvfs and fstatvfs always return ENOSYS.
695 - disabled modules:
696 - mmap: not yet implemented in AtheOS
697 - nis: broken (on an unconfigured system
698 yp_get_default_domain() returns junk instead of
699 error)
700 - dl: dynamic loading doesn't work via dlopen()
701 - resource: getrimit and setrlimit are not yet
702 implemented
703
704 - if you are getting segmentation faults, you probably are
705 low on memory. AtheOS doesn't handle very well an
706 out-of-memory condition and simply SEGVs the process.
707
708 Tested on:
709
710 AtheOS-0.3.7
711 gcc-2.95
712 binutils-2.10
713 make-3.78
714
715
Skip Montanaro57454e52002-06-14 20:30:31 +0000716Configuring the bsddb and dbm modules
717-------------------------------------
718
Skip Montanaro56d83012003-01-04 04:05:51 +0000719Beginning with Python version 2.3, the PyBsddb package
720<http://pybsddb.sf.net/> was adopted into Python as the bsddb package,
721exposing a set of package-level functions which provide
722backwards-compatible behavior. Only versions 3.1 through 4.1 of
723Sleepycat's libraries provide the necessary API, so older versions
724aren't supported through this interface. The old bsddb module has
725been retained as bsddb185, though it is not built by default. Users
726wishing to use it will have to tweak Modules/Setup to build it. The
727dbm module will still be built against the Sleepycat libraries if
728other preferred alternatives (ndbm, gdbm) are not found, though
729versions of the Sleepycat library prior to 3.1 are not considered.
Guido van Rossum62d45c02002-12-02 15:49:13 +0000730
Skip Montanaro57454e52002-06-14 20:30:31 +0000731
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000732Configuring threads
733-------------------
734
Guido van Rossum7ac11532000-08-29 21:36:40 +0000735As of Python 2.0, threads are enabled by default. If you wish to
736compile without threads, or if your thread support is broken, pass the
737--with-threads=no switch to configure. Unfortunately, on some
738platforms, additional compiler and/or linker options are required for
739threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000740collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40 +0000741more, but the information below is not enough to write a patch for the
742configure.in file, so manual intervention is required. If you patch
743the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000744send in the patch. (Don't bother patching the configure script itself
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000745-- it is regenerated each time the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000746
747Compiler switches for threads
748.............................
749
Martin v. Löwis1c24f9c2001-03-06 12:07:27 +0000750The definition of _REENTRANT should be configured automatically, if
751that does not work on your system, or if _REENTRANT is defined
752incorrectly, please report that as a bug.
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000753
Martin v. Löwis1c24f9c2001-03-06 12:07:27 +0000754 OS/Compiler/threads Switches for use with threads
755 (POSIX is draft 10, DCE is draft 4) compile & link
756
757 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt
758 SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000759 DEC OSF/1 3.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000760 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000761 Digital UNIX 4.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000762 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000763 Digital UNIX 4.x/cc/POSIX -pthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000764 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000765 AIX 4.1.4/cc_r/d7 (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000766 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000767 AIX 4.1.4/cc_r4/DCE (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000768 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000769 IRIX 6.2/cc/POSIX (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000770 (robertl@cwi.nl)
771
772
773Linker (ld) libraries and flags for threads
774...........................................
775
776 OS/threads Libraries/switches for use with threads
777
778 SunOS 5.{1-5}/solaris -lthread
779 SunOS 5.5/POSIX -lpthread
Guido van Rossum16e809e2001-04-16 02:07:08 +0000780 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000781 (butenhof@zko.dec.com)
782 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
783 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000784 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000785 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000786 AIX 4.1.4/{draft7,DCE} (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000787 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000788 IRIX 6.2/POSIX -lpthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000789 (jph@emilia.engr.sgi.com)
790
791
Martin v. Löwis1142de32002-03-29 16:28:31 +0000792Building a shared libpython
793---------------------------
794
795Starting with Python 2.3, the majority of the interpreter can be built
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000796into a shared library, which can then be used by the interpreter
Martin v. Löwis1142de32002-03-29 16:28:31 +0000797executable, and by applications embedding Python. To enable this feature,
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +0000798configure with --enable-shared.
Martin v. Löwis65069672002-08-03 21:38:27 +0000799
Fred Drake55512dc2003-07-21 16:01:39 +0000800If you enable this feature, the same object files will be used to create
801a static library. In particular, the static library will contain object
802files using position-independent code (PIC) on platforms where PIC flags
803are needed for the shared library.
Martin v. Löwis1142de32002-03-29 16:28:31 +0000804
805
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000806Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000807---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34 +0000808
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000809Starting with Python 2.1, the setup.py script at the top of the source
810distribution attempts to detect which modules can be built and
811automatically compiles them. Autodetection doesn't always work, so
Guido van Rossum59b0b602002-02-08 22:22:35 +0000812you can still customize the configuration by editing the Modules/Setup
813file; but this should be considered a last resort. The rest of this
814section only applies if you decide to edit the Modules/Setup file.
815You also need this to enable static linking of certain modules (which
816is needed to enable profiling on some systems).
817
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000818This file is initially copied from Setup.dist by the configure script;
819if it does not exist yet, create it by copying Modules/Setup.dist
820yourself (configure will never overwrite it). Never edit Setup.dist
821-- always edit Setup or Setup.local (see below). Read the comments in
822the file for information on what kind of edits are allowed. When you
823have edited Setup in the Modules directory, the interpreter will
Guido van Rossumef67ded2001-10-05 17:04:42 +0000824automatically be rebuilt the next time you run make (in the toplevel
825directory).
Guido van Rossum627b2d71993-12-24 10:39:16 +0000826
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000827Many useful modules can be built on any Unix system, but some optional
828modules can't be reliably autodetected. Often the quickest way to
829determine whether a particular module works or not is to see if it
830will build: enable it in Setup, then if you get compilation or link
Fred Drake6caae142000-10-25 17:51:02 +0000831errors, disable it -- you're either missing support or need to adjust
832the compilation and linking parameters for that module.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000833
834On SGI IRIX, there are modules that interface to many SGI specific
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000835system libraries, e.g. the GL library and the audio hardware. These
836modules will not be built by the setup.py script.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000837
Guido van Rossum4462e931997-01-22 21:00:32 +0000838In addition to the file Setup, you can also edit the file Setup.local.
839(the makesetup script processes both). You may find it more
840convenient to edit Setup.local and leave Setup alone. Then, when
841installing a new Python version, you can copy your old Setup.local
842file.
843
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000844
845Setting the optimization/debugging options
846------------------------------------------
847
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000848If you want or need to change the optimization/debugging options for
849the C compiler, assign to the OPT variable on the toplevel make
850command; e.g. "make OPT=-g" will build a debugging version of Python
851on most platforms. The default is OPT=-O; a value for OPT in the
852environment when the configure script is run overrides this default
853(likewise for CC; and the initial value for LIBS is used as the base
854set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000855
Fred Drake6caae142000-10-25 17:51:02 +0000856When compiling with GCC, the default value of OPT will also include
857the -Wall and -Wstrict-prototypes options.
858
859Additional debugging code to help debug memory management problems can
860be enabled by using the --with-pydebug option to the configure script.
861
Brett Cannon08cd5982005-04-24 22:26:38 +0000862For flags that change binary compatibility, use the EXTRA_CFLAGS
863variable.
864
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000865
Guido van Rossuma68ca352001-10-04 17:00:07 +0000866Profiling
867---------
868
869If you want C profiling turned on, the easiest way is to run configure
870with the CC environment variable to the necessary compiler
871invocation. For example, on Linux, this works for profiling using
872gprof(1):
873
874 CC="gcc -pg" ./configure
875
876Note that on Linux, gprof apparently does not work for shared
877libraries. The Makefile/Setup mechanism can be used to compile and
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000878link most extension modules statically.
Guido van Rossuma68ca352001-10-04 17:00:07 +0000879
880
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000881Testing
882-------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000883
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000884To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000885This runs the test set twice (once with no compiled files, once with
886the compiled files left by the previous test run). The test set
887produces some output. You can generally ignore the messages about
Guido van Rossum59b0b602002-02-08 22:22:35 +0000888skipped tests due to optional features which can't be imported.
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000889If a message is printed about a failed test or a traceback or core
890dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30 +0000891that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000892non-standard implementation of strftime() in the C library. Please
893ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000894
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000895IMPORTANT: If the tests fail and you decide to mail a bug report,
896*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000897failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000898
Andrew M. Kuchling83d042d2002-03-21 23:52:20 +0000899 ./python ./Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000900
Andrew M. Kuchling83d042d2002-03-21 23:52:20 +0000901(substituting the top of the source tree for '.' if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000902different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000903
904
905Installing
906----------
907
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000908To install the Python binary, library modules, shared library modules
909(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02 +0000910just type
911
912 make install
913
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000914This will install all platform-independent files in subdirectories of
915the directory given with the --prefix option to configure or to the
916`prefix' Make variable (default /usr/local). All binary and other
917platform-specific files will be installed in subdirectories if the
918directory given by --exec-prefix or the `exec_prefix' Make variable
919(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02 +0000920
Martin v. Löwis3b8ee082003-05-11 20:25:35 +0000921If DESTDIR is set, it will be taken as the root directory of the
922installation, and files will be installed into $(DESTDIR)$(prefix),
923$(DESTDIR)$(exec_prefix), etc.
924
Guido van Rossum64773801997-11-26 17:07:02 +0000925All subdirectories created will have Python's version number in their
926name, e.g. the library modules are installed in
Guido van Rossum67345eb2001-01-18 14:51:12 +0000927"/usr/local/lib/python<version>/" by default, where <version> is the
928<major>.<minor> release number (e.g. "2.1"). The Python binary is
929installed as "python<version>" and a hard link named "python" is
930created. The only file not installed with a version number in its
931name is the manual page, installed as "/usr/local/man/man1/python.1"
932by default.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000933
Neil Schemenauer0e91dc72001-02-16 04:18:08 +0000934If you have a previous installation of Python that you don't
Guido van Rossum64773801997-11-26 17:07:02 +0000935want to replace yet, use
936
937 make altinstall
938
939This installs the same set of files as "make install" except it
Guido van Rossum67345eb2001-01-18 14:51:12 +0000940doesn't create the hard link to "python<version>" named "python" and
941it doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000942
943The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000944Emacs found in Misc/python-mode.el. (But then again, more recent
945versions of Emacs may already have it.) Follow the instructions that
946came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000947
Jack Jansena39ef862001-08-19 21:17:03 +0000948On Mac OS X, if you have configured Python with --enable-framework, you
949should use "make frameworkinstall" to do the installation. Note that this
950installs the Python executable in a place that is not normally on your
951PATH, you may want to set up a symlink in /usr/local/bin.
952
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000953
954Configuration options and variables
955-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000956
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000957Some special cases are handled by passing options to the configure
958script.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000959
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000960WARNING: if you rerun the configure script with different options, you
961must run "make clean" before rebuilding. Exceptions to this rule:
962after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20 +0000963Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000964
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000965--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
966 it finds it. If you don't want this, or if this compiler is
967 installed but broken on your platform, pass the option
968 --without-gcc. You can also pass "CC=cc" (or whatever the
969 name of the proper C compiler is) in the environment, but the
970 advantage of using --without-gcc is that this option is
971 remembered by the config.status script for its --recheck
972 option.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000973
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000974--prefix, --exec-prefix: If you want to install the binaries and the
975 Python library somewhere else than in /usr/local/{bin,lib},
976 you can pass the option --prefix=DIRECTORY; the interpreter
977 binary will be installed as DIRECTORY/bin/python and the
978 library files as DIRECTORY/lib/python/*. If you pass
979 --exec-prefix=DIRECTORY (as well) this overrides the
980 installation prefix for architecture-dependent files (like the
981 interpreter binary). Note that --prefix=DIRECTORY also
982 affects the default module search path (sys.path), when
983 Modules/config.c is compiled. Passing make the option
984 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
985 prefix set at configuration time; this may be more convenient
986 than re-running the configure script if you change your mind
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000987 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000988
Guido van Rossum59b0b602002-02-08 22:22:35 +0000989--with-readline: This option is no longer supported. GNU
990 readline is automatically enabled by setup.py when present.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000991
Guido van Rossum7ac11532000-08-29 21:36:40 +0000992--with-threads: On most Unix systems, you can now use multiple
993 threads, and support for this is enabled by default. To
994 disable this, pass --with-threads=no. If the library required
995 for threads lives in a peculiar place, you can use
996 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
997 changing (either enabling or disabling) this option, or you
998 will get link errors! Note: for DEC Unix use
Guido van Rossum0e13da91998-02-22 04:36:34 +0000999 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001000
1001--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
1002 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001003 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001004 This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001005 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001006 is the absolute pathname of the dl library. (Don't bother on
1007 IRIX 5, it already has dynamic linking using SunOS style
Martin v. Löwis779ffc02002-12-02 22:17:01 +00001008 shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001009
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001010--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001011 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
1012 Symmetry (Dynix), and Atari ST. This is done using a
1013 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001014 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001015 emulation of the SGI dl library mentioned above (the emulation
1016 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001017 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum16e809e2001-04-16 02:07:08 +00001018 enable this, ftp and compile both libraries, then call
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001019 configure, passing it the option
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001020 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
1021 the absolute pathname of the dl emulation library and
1022 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
1023 (Don't bother on SunOS 4 or 5, they already have dynamic
Martin v. Löwis779ffc02002-12-02 22:17:01 +00001024 linking using shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001025
1026--with-libm, --with-libc: It is possible to specify alternative
1027 versions for the Math library (default -lm) and the C library
1028 (default the empty string) using the options
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001029 --with-libm=STRING and --with-libc=STRING, respectively. For
1030 example, if your system requires that you pass -lc_s to the C
1031 compiler to use the shared C library, you can pass
1032 --with-libc=-lc_s. These libraries are passed after all other
1033 libraries, the C library last.
Guido van Rossum16e809e2001-04-16 02:07:08 +00001034
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001035--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
1036 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:01 +00001037
Martin v. Löwis2df66942000-12-13 14:14:32 +00001038--with-cxx=<compiler>: Some C++ compilers require that main() is
1039 compiled with the C++ if there is any C++ code in the application.
1040 Specifically, g++ on a.out systems may require that to support
1041 construction of global objects. With this option, the main() function
1042 of Python will be compiled with <compiler>; use that only if you
1043 plan to use C++ extension modules, and if your compiler requires
1044 compilation of main() as a C++ program.
1045
1046
Fred Drake6caae142000-10-25 17:51:02 +00001047--with-pydebug: Enable additional debugging code to help track down
1048 memory management problems. This allows printing a list of all
1049 live objects when the interpreter terminates.
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +00001050
Jack Jansen7b8c7542002-04-14 20:12:41 +00001051--with(out)-universal-newlines: enable reading of text files with
1052 foreign newline convention (default: enabled). In other words,
1053 any of \r, \n or \r\n is acceptable as end-of-line character.
1054 If enabled import and execfile will automatically accept any newline
1055 in files. Python code can open a file with open(file, 'U') to
Martin v. Löwis7e4cfcb2002-12-19 16:21:49 +00001056 read it in universal newline mode. THIS OPTION IS UNSUPPORTED.
Fred Drake6caae142000-10-25 17:51:02 +00001057
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001058--with-tsc: Profile using the Pentium timestamping counter (TSC).
Guido van Rossum76be6ed1995-01-02 18:33:54 +00001059
Georg Brandl81299ad2006-02-20 10:24:06 +00001060--with-fpectl: Enable building the ``fpectl'' module which can be used
1061 to control the generation of SIGFPE and its conversion into a
1062 Python exception. Note: this module is dangerous or useless
1063 except in the hands of experts.
1064
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +00001065
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001066Building for multiple architectures (using the VPATH feature)
1067-------------------------------------------------------------
1068
1069If your file system is shared between multiple architectures, it
1070usually is not necessary to make copies of the sources for each
1071architecture you want to support. If the make program supports the
1072VPATH feature, you can create an empty build directory for each
1073architecture, and in each directory run the configure script (on the
1074appropriate machine with the appropriate options). This creates the
1075necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001076contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37 +00001077actual sources. (On SGI systems, use "smake -J1" instead of "make" if
1078you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001079
1080For example, the following is all you need to build a minimal Python
1081in /usr/tmp/python (assuming ~guido/src/python is the toplevel
1082directory and you want to build in /usr/tmp/python):
1083
1084 $ mkdir /usr/tmp/python
1085 $ cd /usr/tmp/python
1086 $ ~guido/src/python/configure
1087 [...]
1088 $ make
1089 [...]
1090 $
1091
Neil Schemenauer73f8ab22001-01-26 22:18:55 +00001092Note that configure copies the original Setup file to the build
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001093directory if it finds no Setup file there. This means that you can
1094edit the Setup file for each architecture independently. For this
1095reason, subsequent changes to the original Setup file are not tracked
1096automatically, as they might overwrite local changes. To force a copy
1097of a changed original Setup file, delete the target Setup file. (The
1098makesetup script supports multiple input files, so if you want to be
1099fancy you can change the rules to create an empty Setup.local if it
1100doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
1101however this assumes that you only need to add modules.)
1102
1103
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001104Building on non-UNIX systems
1105----------------------------
1106
Martin v. Löwis2eba0d62004-12-24 08:28:28 +00001107For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 7.1, the
Tim Peters03444242000-09-19 00:38:35 +00001108project files are in PCbuild, the workspace is pcbuild.dsw. See
1109PCbuild\readme.txt for detailed instructions.
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +00001110
Martin v. Löwis2eba0d62004-12-24 08:28:28 +00001111For other non-Unix Windows compilers, in particular MS VC++ 6.0 and
Guido van Rossum31ae2071999-04-12 14:47:30 +00001112for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001113
1114For the Mac, a separate source distribution will be made available,
1115for use with the CodeWarrior compiler. If you are interested in Mac
1116development, join the PythonMac Special Interest Group
1117(http://www.python.org/sigs/pythonmac-sig/, or send email to
1118pythonmac-sig-request@python.org).
1119
1120Of course, there are also binary distributions available for these
Guido van Rossum67345eb2001-01-18 14:51:12 +00001121platforms -- see http://www.python.org/.
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001122
1123To port Python to a new non-UNIX system, you will have to fake the
1124effect of running the configure script manually (for Mac and PC, this
1125has already been done for you). A good start is to copy the file
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001126pyconfig.h.in to pyconfig.h and edit the latter to reflect the actual
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001127configuration of your system. Most symbols must simply be defined as
11281 only if the corresponding feature is present and can be left alone
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001129otherwise; however the *_t type symbols must be defined as some
1130variant of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001131
Barry Warsaw06557452001-12-14 20:47:12 +00001132For all platforms, it's important that the build arrange to define the
1133preprocessor symbol NDEBUG on the compiler command line in a release
1134build of Python (else assert() calls remain in the code, hurting
1135release-build performance). The Unix, Windows and Mac builds already
1136do this.
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001137
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001138
1139Miscellaneous issues
1140====================
1141
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001142Emacs mode
1143----------
1144
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001145There's an excellent Emacs editing mode for Python code; see the file
1146Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001147is now maintained by the equally famous Barry Warsaw (it's no
Guido van Rossum67345eb2001-01-18 14:51:12 +00001148coincidence that they now both work on the same team). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001149version, along with various other contributed Python-related Emacs
Guido van Rossum67345eb2001-01-18 14:51:12 +00001150goodies, is online at http://www.python.org/emacs/python-mode. And
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001151if you are planning to edit the Python C code, please pick up the
Guido van Rossum67345eb2001-01-18 14:51:12 +00001152latest version of CC Mode http://www.python.org/emacs/cc-mode; it
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001153contains a "python" style used throughout most of the Python C source
1154files. (Newer versions of Emacs or XEmacs may already come with the
1155latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001156
1157
Guido van Rossum59b0b602002-02-08 22:22:35 +00001158Tkinter
1159-------
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001160
Guido van Rossum59b0b602002-02-08 22:22:35 +00001161The setup.py script automatically configures this when it detects a
1162usable Tcl/Tk installation. This requires Tcl/Tk version 8.0 or
Fred Drake8179a9d2000-09-28 23:28:30 +00001163higher.
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001164
Guido van Rossum973e4dc2000-07-01 00:34:39 +00001165For more Tkinter information, see the Tkinter Resource page:
1166http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001167
Michael W. Hudson71dcc3e2005-02-22 15:33:26 +00001168There are demos in the Demo/tkinter directory.
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001169
1170Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001171lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001172(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001173Modules/_tkinter.c. Demos and normal Tk applications import only the
Guido van Rossum59b0b602002-02-08 22:22:35 +00001174Python Tkinter module -- only the latter imports the C _tkinter
1175module. In order to find the C _tkinter module, it must be compiled
1176and linked into the Python interpreter -- the setup.py script does
1177this. In order to find the Python Tkinter module, sys.path must be
1178set correctly -- normal installation takes care of this.
Guido van Rossum84c8c7f1995-08-28 02:44:24 +00001179
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001180
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001181Distribution structure
1182----------------------
1183
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001184Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001185comments.
1186
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001187.cvsignore Additional filename matching patterns for CVS to ignore
1188BeOS/ Files specific to the BeOS port
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001189Demo/ Demonstration scripts, modules and programs
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001190Doc/ Documentation sources (LaTeX)
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001191Grammar/ Input for the parser generator
1192Include/ Public header files
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001193LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001194Lib/ Python library modules
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001195Mac/ Macintosh specific resources
Neil Schemenauer3f52da52001-01-24 17:49:59 +00001196Makefile.pre.in Source from which config.status creates the Makefile.pre
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001197Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001198Modules/ Implementation of most built-in modules
1199Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001200PC/ Files specific to PC ports (DOS, Windows, OS/2)
1201PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001202Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001203Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001204README The file you're reading now
1205Tools/ Some useful programs written in Python
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001206pyconfig.h.in Source from which pyconfig.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001207configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001208configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001209install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001210
1211The following files will (may) be created in the toplevel directory by
1212the configuration and build processes:
1213
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001214Makefile Build rules
Neil Schemenauer3f52da52001-01-24 17:49:59 +00001215Makefile.pre Build rules before running Modules/makesetup
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001216buildno Keeps track of the build number
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001217config.cache Cache of configuration variables
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001218pyconfig.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001219config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001220config.status Status from last run of the configure script
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001221getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum67345eb2001-01-18 14:51:12 +00001222libpython<version>.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001223python The executable interpreter
1224tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001225
1226
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001227That's all, folks!
1228------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001229
1230
Guido van Rossum67345eb2001-01-18 14:51:12 +00001231--Guido van Rossum (home page: http://www.python.org/~guido/)