blob: 57c6550d1d3bba11b0621d9b8076de538fe6f9c8 [file] [log] [blame]
Barry Warsaw8493c0c2013-10-29 14:14:051This is Python version 2.6.9
2============================
Guido van Rossum91447632000-04-11 17:11:093
Barry Warsaw1fbc16d2012-02-23 15:55:574Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
Barry Warsawbe1950d2013-10-01 00:34:295 2011, 2012, 2013
Barry Warsawcf0d8ab2011-05-23 19:22:566Python Software Foundation.
7All rights reserved.
Guido van Rossum67345eb2001-01-18 14:51:128
Guido van Rossumc07d5fa2000-09-01 22:50:029Copyright (c) 2000 BeOpen.com.
10All rights reserved.
11
Guido van Rossum23f7aed2001-04-12 20:53:3112Copyright (c) 1995-2001 Corporation for National Research Initiatives.
Guido van Rossumc07d5fa2000-09-01 22:50:0213All rights reserved.
14
Guido van Rossum6ebd2992000-09-03 04:47:4715Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
Guido van Rossumc07d5fa2000-09-01 22:50:0216All rights reserved.
17
Guido van Rossum4f40c2d2000-09-05 16:46:2218
Guido van Rossumc07d5fa2000-09-01 22:50:0219License information
20-------------------
21
Guido van Rossum4f40c2d2000-09-05 16:46:2222See the file "LICENSE" for information on the history of this
23software, terms & conditions for usage, and a DISCLAIMER OF ALL
24WARRANTIES.
Guido van Rossumc07d5fa2000-09-01 22:50:0225
Guido van Rossum4f40c2d2000-09-05 16:46:2226This Python distribution contains no GNU General Public Licensed
27(GPLed) code so it may be used in proprietary projects just like prior
28Python distributions. There are interfaces to some GNU code but these
29are entirely optional.
30
31All trademarks referenced herein are property of their respective
32holders.
Guido van Rossum79808261997-12-11 18:01:4733
34
Guido van Rossum8d7d4ed1996-07-30 21:41:0735What's new in this release?
36---------------------------
Guido van Rossum3ff96dd1996-07-30 18:05:0437
Guido van Rossum67345eb2001-01-18 14:51:1238See the file "Misc/NEWS".
Guido van Rossum64773801997-11-26 17:07:0239
Michael W. Hudson71dcc3e2005-02-22 15:33:2640
Guido van Rossum64773801997-11-26 17:07:0241If you don't read instructions
42------------------------------
43
44Congratulations on getting this far. :-)
45
46To start building right away (on UNIX): type "./configure" in the
Guido van Rossum2dcec0c2002-02-04 01:59:2347current directory and when it finishes, type "make". This creates an
48executable "./python"; to install in /usr/local, first do "su root"
49and then "make install".
50
Michael W. Hudson71dcc3e2005-02-22 15:33:2651The section `Build instructions' below is still recommended reading.
Guido van Rossum3ff96dd1996-07-30 18:05:0452
53
Guido van Rossum91cb9d21995-04-10 11:47:3854What is Python anyway?
55----------------------
56
Michael W. Hudson71dcc3e2005-02-22 15:33:2657Python is an interpreted, interactive object-oriented programming
58language suitable (amongst other uses) for distributed application
59development, scripting, numeric computing and system testing. Python
60is often compared to Tcl, Perl, Java, JavaScript, Visual Basic or
61Scheme. To find out more about what Python can do for you, point your
62browser to http://www.python.org/.
Guido van Rossum91cb9d21995-04-10 11:47:3863
64
Guido van Rossumf501b4e1996-10-25 14:32:4865How do I learn Python?
66----------------------
67
Fred Drake0e6444c1999-05-17 19:35:0168The official tutorial is still a good place to start; see
Michael W. Hudson71dcc3e2005-02-22 15:33:2669http://docs.python.org/ for online and downloadable versions, as well
70as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:4871
Guido van Rossumd0a42e22000-03-31 20:16:4572There's a quickly growing set of books on Python. See
Michael W. Hudsonfad46402005-06-16 15:51:2073http://wiki.python.org/moin/PythonBooks for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:2574
Guido van Rossumf501b4e1996-10-25 14:32:4875
Guido van Rossumc07d5fa2000-09-01 22:50:0276Documentation
77-------------
Guido van Rossum91cb9d21995-04-10 11:47:3878
Guido van Rossumc07d5fa2000-09-01 22:50:0279All documentation is provided online in a variety of formats. In
80order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:2281Language Reference, Extending & Embedding, and the Python/C API. The
82Library Reference is especially of immense value since much of
83Python's power is described there, including the built-in data types
84and functions!
Guido van Rossum91cb9d21995-04-10 11:47:3885
Guido van Rossum4f40c2d2000-09-05 16:46:2286All documentation is also available online at the Python web site
Benjamin Peterson9d0b6042008-03-30 19:35:1087(http://docs.python.org/, see below). It is available online for occasional
88reference, or can be downloaded in many formats for faster access. The
Georg Brandl1c88e0f2008-03-30 19:41:3989documentation is downloadable in HTML, PostScript, PDF, LaTeX, and
Benjamin Peterson9d0b6042008-03-30 19:35:1090reStructuredText (2.6+) formats; the LaTeX and reStructuredText versions are
91primarily for documentation authors, translators, and people with special
92formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:0293
94
Guido van Rossum4f40c2d2000-09-05 16:46:2295Web sites
96---------
Guido van Rossumc07d5fa2000-09-01 22:50:0297
Guido van Rossum4f40c2d2000-09-05 16:46:2298New Python releases and related technologies are published at
Guido van Rossum67345eb2001-01-18 14:51:1299http://www.python.org/. Come visit us!
Guido van Rossumc07d5fa2000-09-01 22:50:02100
Guido van Rossum4f40c2d2000-09-05 16:46:22101
102Newsgroups and Mailing Lists
103----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02104
105Read comp.lang.python, a high-volume discussion newsgroup about
106Python, or comp.lang.python.announce, a low-volume moderated newsgroup
107for Python-related announcements. These are also accessible as
Georg Brandlf004d9d2009-10-27 15:39:53108mailing lists: see http://www.python.org/community/lists/ for an
Michael W. Hudson71dcc3e2005-02-22 15:33:26109overview of these and many other Python-related mailing lists.
Guido van Rossumc07d5fa2000-09-01 22:50:02110
Anthony Baxter70e07962006-04-03 14:16:27111Archives are accessible via the Google Groups Usenet archive; see
Michael W. Hudsonbe6e0f42002-06-23 16:29:36112http://groups.google.com/. The mailing lists are also archived, see
Georg Brandlf004d9d2009-10-27 15:39:53113http://www.python.org/community/lists/ for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02114
115
116Bug reports
117-----------
118
Guido van Rossum4f40c2d2000-09-05 16:46:22119To report or search for bugs, please use the Python Bug
Georg Brandlf004d9d2009-10-27 15:39:53120Tracker at http://bugs.python.org/.
Guido van Rossumc07d5fa2000-09-01 22:50:02121
122
123Patches and contributions
124-------------------------
125
Fred Drake6caae142000-10-25 17:51:02126To submit a patch or other contribution, please use the Python Patch
Georg Brandlf004d9d2009-10-27 15:39:53127Manager at http://bugs.python.org/. Guidelines
Andrew M. Kuchling951300e2008-01-04 14:47:17128for patch submission may be found at http://www.python.org/dev/patches/.
Guido van Rossumc07d5fa2000-09-01 22:50:02129
Benjamin Petersonb2355002008-04-02 21:20:35130If you have a proposal to change Python, you may want to send an email to the
131comp.lang.python or python-ideas mailing lists for inital feedback. A Python
132Enhancement Proposal (PEP) may be submitted if your idea gains ground. All
133current PEPs, as well as guidelines for submitting a new PEP, are listed at
134http://www.python.org/dev/peps/.
Guido van Rossumc07d5fa2000-09-01 22:50:02135
136
137Questions
138---------
139
140For help, if you can't find it in the manuals or on the web site, it's
141best to post to the comp.lang.python or the Python mailing list (see
142above). If you specifically don't want to involve the newsgroup or
Guido van Rossum67345eb2001-01-18 14:51:12143mailing list, send questions to help@python.org (a group of volunteers
144who answer questions as they can). The newsgroup is the most
145efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16146
Guido van Rossum901454e2000-06-29 22:28:44147
Guido van Rossum433c8ad1994-08-01 12:07:07148Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38149==================
Guido van Rossum627b2d71993-12-24 10:39:16150
Guido van Rossum59b0b602002-02-08 22:22:35151Before you can build Python, you must first configure it.
152Fortunately, the configuration and build process has been automated
153for Unix and Linux installations, so all you usually have to do is
154type a few commands and sit back. There are some platforms where
155things are not quite as smooth; see the platform specific notes below.
156If you want to build for multiple platforms sharing the same source
157tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16158
Guido van Rossum59b0b602002-02-08 22:22:35159Start by running the script "./configure", which determines your
160system configuration and creates the Makefile. (It takes a minute or
161two -- please be patient!) You may want to pass options to the
162configure script -- see the section below on configuration options and
163variables. When it's done, you are ready to run make.
Guido van Rossum6d9cc801996-08-01 17:31:22164
Guido van Rossum59b0b602002-02-08 22:22:35165To build Python, you normally type "make" in the toplevel directory.
166If you have changed the configuration, the Makefile may have to be
Georg Brandlb6ca2d62010-05-18 23:38:50167rebuilt. In this case, you may have to run make again to correctly
Guido van Rossum59b0b602002-02-08 22:22:35168build your desired target. The interpreter executable is built in the
169top level directory.
Guido van Rossum6d9cc801996-08-01 17:31:22170
Guido van Rossum4f40c2d2000-09-05 16:46:22171Once you have built a Python interpreter, see the subsections below on
Guido van Rossum59b0b602002-02-08 22:22:35172testing and installation. If you run into trouble, see the next
173section.
174
175Previous versions of Python used a manual configuration process that
176involved editing the file Modules/Setup. While this file still exists
177and manual configuration is still supported, it is rarely needed any
178more: almost all modules are automatically built as appropriate under
179guidance of the setup.py script, which is run by Make after the
180interpreter has been built.
Guido van Rossum627b2d71993-12-24 10:39:16181
Guido van Rossum0a516c91994-09-12 10:58:40182
Guido van Rossum91cb9d21995-04-10 11:47:38183Troubleshooting
184---------------
Guido van Rossum627b2d71993-12-24 10:39:16185
Guido van Rossum6d9cc801996-08-01 17:31:22186See also the platform specific notes in the next section.
187
Michael W. Hudson71dcc3e2005-02-22 15:33:26188If you run into other trouble, see the FAQ
Georg Brandlf004d9d2009-10-27 15:39:53189(http://www.python.org/doc/faq/) for hints on what can go wrong, and
Michael W. Hudson71dcc3e2005-02-22 15:33:26190how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38191
Guido van Rossum6d9cc801996-08-01 17:31:22192If you rerun the configure script with different options, remove all
193object files by running "make clean" before rebuilding. Believe it or
194not, "make clean" sometimes helps to clean up other inexplicable
195problems as well. Try it before sending in a bug report!
196
Guido van Rossumd0fe8451996-08-26 03:02:37197If the configure script fails or doesn't seem to find things that
Michael W. Hudson71dcc3e2005-02-22 15:33:26198should be there, inspect the config.log file.
Guido van Rossumc0be2f51997-10-08 05:05:28199
200If you get a warning for every file about the -Olimit option being no
201longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22202whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28203accepted without error. On some systems, e.g. older SGI compilers, it
204is essential for performance (specifically when compiling ceval.c,
205which has more basic blocks than the default limit of 1000). If the
206warning bothers you, edit the Makefile to remove "-Olimit 1500" from
207the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37208
Guido van Rossum7ac11532000-08-29 21:36:40209If you get failures in test_long, or sys.maxint gets set to -1, you
210are probably experiencing compiler bugs, usually related to
Martin v. Löwis9cea5f52002-11-15 07:28:05211optimization. This is a common problem with some versions of gcc, and
212some vendor-supplied compilers, which can sometimes be worked around
213by turning off optimization. Consider switching to stable versions
Anthony Baxtere9d719b2004-11-30 01:49:18214(gcc 2.95.2, gcc 3.x, or contact your vendor.)
Guido van Rossum7ac11532000-08-29 21:36:40215
216From Python 2.0 onward, all Python C code is ANSI C. Compiling using
217old K&R-C-only compilers is no longer possible. ANSI C compilers are
218available for all modern systems, either in the form of updated
Martin v. Löwis9cea5f52002-11-15 07:28:05219compilers from the vendor, or one of the free compilers (gcc).
Guido van Rossum91cb9d21995-04-10 11:47:38220
Georg Brandl250755b2006-11-15 17:42:03221If "make install" fails mysteriously during the "compiling the library"
222step, make sure that you don't have any of the PYTHONPATH or PYTHONHOME
223environment variables set, as they may interfere with the newly built
224executable which is compiling the library.
225
Martin v. Löwis779ffc02002-12-02 22:17:01226Unsupported systems
227-------------------
228
Georg Brandl4f6ebc22010-06-12 06:46:31229A number of systems is not supported in Python 2.6 anymore. Some
230support code is still present, but will be removed in later versions.
Martin v. Löwis779ffc02002-12-02 22:17:01231If you still need to use current Python versions on these systems,
232please send a message to python-dev@python.org indicating that you
Martin v. Löwis8cab8b02006-07-24 05:05:22233volunteer to support this system. For a more detailed discussion
234regarding no-longer-supported and resupporting platforms, as well
235as a list of platforms that became or will be unsupported, see PEP 11.
Martin v. Löwis779ffc02002-12-02 22:17:01236
237More specifically, the following systems are not supported any
238longer:
239- SunOS 4
240- DYNIX
241- dgux
242- Minix
Martin v. Löwis8cab8b02006-07-24 05:05:22243- NeXT
Martin v. Löwis779ffc02002-12-02 22:17:01244- Irix 4 and --with-sgi-dl
245- Linux 1
246- Systems defining __d6_pthread_create (configure.in)
247- Systems defining PY_PTHREAD_D4, PY_PTHREAD_D6,
248 or PY_PTHREAD_D7 in thread_pthread.h
249- Systems using --with-dl-dld
Martin v. Löwis7e4cfcb2002-12-19 16:21:49250- Systems using --without-universal-newlines
Martin v. Löwis8cab8b02006-07-24 05:05:22251- MacOS 9
252
253The following systems are still supported in Python 2.5, but
254support will be dropped in 2.6:
255- Systems using --with-wctype-functions
256- Win9x, WinME
257
258Warning on install in Windows 98 and Windows Me
259-----------------------------------------------
260
261Following Microsoft's closing of Extended Support for
262Windows 98/ME (July 11, 2006), Python 2.6 will stop
263supporting these platforms. Python development and
264maintainability becomes easier (and more reliable) when
265platform specific code targeting OSes with few users
266and no dedicated expert developers is taken out. The
267vendor also warns that the OS versions listed above
268"can expose customers to security risks" and recommends
269upgrade.
Martin v. Löwis779ffc02002-12-02 22:17:01270
Guido van Rossum91cb9d21995-04-10 11:47:38271Platform specific notes
272-----------------------
273
Guido van Rossum0447a321995-10-08 01:22:33274(Some of these may no longer apply. If you find you can build Python
Guido van Rossum67345eb2001-01-18 14:51:12275on these platforms without the special directions mentioned here,
276submit a documentation bug report to SourceForge (see Bug Reports
277above) so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38278
Skip Montanaro6dc4a8e2003-05-02 15:27:59279Unix platforms: If your vendor still ships (and you still use) Berkeley DB
Anthony Baxter70e07962006-04-03 14:16:27280 1.85 you will need to edit Modules/Setup to build the bsddb185
281 module and add a line to sitecustomize.py which makes it the
282 default. In Modules/Setup a line like
Skip Montanaro6dc4a8e2003-05-02 15:27:59283
Anthony Baxter70e07962006-04-03 14:16:27284 bsddb185 bsddbmodule.c
Skip Montanaro6dc4a8e2003-05-02 15:27:59285
Anthony Baxter70e07962006-04-03 14:16:27286 should work. (You may need to add -I, -L or -l flags to direct the
287 compiler and linker to your include files and libraries.)
Skip Montanaro6dc4a8e2003-05-02 15:27:59288
Michael W. Hudson71dcc3e2005-02-22 15:33:26289XXX I think this next bit is out of date:
Skip Montanaro6dc4a8e2003-05-02 15:27:59290
Brett Cannondc48b742007-05-20 07:09:5029164-bit platforms: The modules audioop, and imageop don't work.
Anthony Baxter70e07962006-04-03 14:16:27292 The setup.py script disables them on 64-bit installations.
293 Don't try to enable them in the Modules/Setup file. They
294 contain code that is quite wordsize sensitive. (If you have a
295 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28296
Guido van Rossum4462e931997-01-22 21:00:32297Solaris: When using Sun's C compiler with threads, at least on Solaris
Anthony Baxter70e07962006-04-03 14:16:27298 2.5.1, you need to add the "-mt" compiler option (the simplest
299 way is probably to specify the compiler with this option as
300 the "CC" environment variable when running the configure
301 script).
Guido van Rossum4462e931997-01-22 21:00:32302
Guido van Rossum42992312002-09-23 14:02:18303 When using GCC on Solaris, beware of binutils 2.13 or GCC
304 versions built using it. This mistakenly enables the
305 -zcombreloc option which creates broken shared libraries on
306 Solaris. binutils 2.12 works, and the binutils maintainers
Skip Montanaro4de9cba2003-01-03 16:26:23307 are aware of the problem. Binutils 2.13.1 only partially
308 fixed things. It appears that 2.13.2 solves the problem
309 completely. This problem is known to occur with Solaris 2.7
310 and 2.8, but may also affect earlier and later versions of the
311 OS.
Guido van Rossum42992312002-09-23 14:02:18312
Anthony Baxter70e07962006-04-03 14:16:27313 When the dynamic loader complains about errors finding shared
314 libraries, such as
Martin v. Löwis9cea5f52002-11-15 07:28:05315
Anthony Baxter70e07962006-04-03 14:16:27316 ld.so.1: ./python: fatal: libstdc++.so.5: open failed:
317 No such file or directory
Martin v. Löwis9cea5f52002-11-15 07:28:05318
Anthony Baxter70e07962006-04-03 14:16:27319 you need to first make sure that the library is available on
320 your system. Then, you need to instruct the dynamic loader how
321 to find it. You can choose any of the following strategies:
Martin v. Löwis9cea5f52002-11-15 07:28:05322
Anthony Baxter70e07962006-04-03 14:16:27323 1. When compiling Python, set LD_RUN_PATH to the directories
324 containing missing libraries.
325 2. When running Python, set LD_LIBRARY_PATH to these directories.
326 3. Use crle(8) to extend the search path of the loader.
327 4. Modify the installed GCC specs file, adding -R options into the
328 *link: section.
Martin v. Löwis9cea5f52002-11-15 07:28:05329
Skip Montanaro9f6606a2005-11-17 18:19:39330 The complex object fails to compile on Solaris 10 with gcc 3.4 (at
331 least up to 3.4.3). To work around it, define Py_HUGE_VAL as
332 HUGE_VAL(), e.g.:
333
334 make CPPFLAGS='-D"Py_HUGE_VAL=HUGE_VAL()" -I. -I$(srcdir)/Include'
Anthony Baxter70e07962006-04-03 14:16:27335 ./python setup.py CPPFLAGS='-D"Py_HUGE_VAL=HUGE_VAL()"'
Skip Montanaro9f6606a2005-11-17 18:19:39336
Guido van Rossum7ac11532000-08-29 21:36:40337Linux: A problem with threads and fork() was tracked down to a bug in
Anthony Baxter70e07962006-04-03 14:16:27338 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
339 solves the problem. This causes the popen2 test to fail;
340 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32341
Martin v. Löwis3efa04a2003-06-14 05:29:27342Red Hat Linux: Red Hat 9 built Python2.2 in UCS-4 mode and hacked
Anthony Baxter70e07962006-04-03 14:16:27343 Tcl to support it. To compile Python2.3 with Tkinter, you will
344 need to pass --enable-unicode=ucs4 flag to ./configure.
Martin v. Löwis3efa04a2003-06-14 05:29:27345
Anthony Baxter70e07962006-04-03 14:16:27346 There's an executable /usr/bin/python which is Python
347 1.5.2 on most older Red Hat installations; several key Red Hat tools
348 require this version. Python 2.1.x may be installed as
349 /usr/bin/python2. The Makefile installs Python as
350 /usr/local/bin/python, which may or may not take precedence
351 over /usr/bin/python, depending on how you have set up $PATH.
Guido van Rossum2dcec0c2002-02-04 01:59:23352
Guido van Rossum59230501999-06-21 20:51:46353FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
Anthony Baxter70e07962006-04-03 14:16:27354 similar: When using cursesmodule, the linking is not done in
355 the correct order with the defaults. Remove "-ltermcap" from
356 the readline entry in Setup, and use as curses entry: "curses
357 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
358 called on FreeBSD) should be the name of the auxiliary library
359 required on your platform. Normally, it would be linked
360 automatically, but not necessarily in the correct order.
Guido van Rossum59230501999-06-21 20:51:46361
Anthony Baxter70e07962006-04-03 14:16:27362BSDI: BSDI versions before 4.1 have known problems with threads,
363 which can cause strange errors in a number of modules (for
364 instance, the 'test_signal' test script will hang forever.)
365 Turning off threads (with --with-threads=no) or upgrading to
366 BSDI 4.1 solves this problem.
Guido van Rossum7ac11532000-08-29 21:36:40367
368DEC Unix: Run configure with --with-dec-threads, or with
Anthony Baxter70e07962006-04-03 14:16:27369 --with-threads=no if no threads are desired (threads are on by
370 default). When using GCC, it is possible to get an internal
371 compiler error if optimization is used. This was reported for
372 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
373 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46374
Guido van Rossume1cdb161999-04-10 16:04:07375DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
Anthony Baxter70e07962006-04-03 14:16:27376 and pass SHELL=/bin/sh5 to Make when installing.
Guido van Rossume1cdb161999-04-10 16:04:07377
Anthony Baxter70e07962006-04-03 14:16:27378AIX: A complete overhaul of the shared library support is now in
379 place. See Misc/AIX-NOTES for some notes on how it's done.
380 (The optimizer bug reported at this place in previous releases
381 has been worked around by a minimal code change.) If you get
382 errors about pthread_* functions, during compile or during
383 testing, try setting CC to a thread-safe (reentrant) compiler,
384 like "cc_r". For full C++ module support, set CC="xlC_r" (or
385 CC="xlC" without thread support).
Guido van Rossum91cb9d21995-04-10 11:47:38386
Guido van Rossuma2534c82005-09-20 19:06:23387AIX 5.3: To build a 64-bit version with IBM's compiler, I used the
388 following:
389
390 export PATH=/usr/bin:/usr/vacpp/bin
Anthony Baxter70e07962006-04-03 14:16:27391 ./configure --with-gcc="xlc_r -q64" --with-cxx="xlC_r -q64" \
Guido van Rossuma2534c82005-09-20 19:06:23392 --disable-ipv6 AR="ar -X64"
Anthony Baxter70e07962006-04-03 14:16:27393 make
Guido van Rossuma2534c82005-09-20 19:06:23394
Anthony Baxter7c497472003-10-01 07:24:54395HP-UX: When using threading, you may have to add -D_REENTRANT to the
Anthony Baxter70e07962006-04-03 14:16:27396 OPT variable in the top-level Makefile; reported by Pat Knight,
397 this seems to make a difference (at least for HP-UX 10.20)
398 even though pyconfig.h defines it. This seems unnecessary when
399 using HP/UX 11 and later - threading seems to work "out of the
400 box".
Anthony Baxter7c497472003-10-01 07:24:54401
Michael W. Hudson71dcc3e2005-02-22 15:33:26402HP-UX ia64: When building on the ia64 (Itanium) platform using HP's
Anthony Baxter70e07962006-04-03 14:16:27403 compiler, some experience has shown that the compiler's
404 optimiser produces a completely broken version of python
Georg Brandlf004d9d2009-10-27 15:39:53405 (see http://bugs.python.org/814976). To work around this,
Anthony Baxter70e07962006-04-03 14:16:27406 edit the Makefile and remove -O from the OPT line.
Guido van Rossum539c6622005-09-14 17:49:54407
Anthony Baxter70e07962006-04-03 14:16:27408 To build a 64-bit executable on an Itanium 2 system using HP's
409 compiler, use these environment variables:
Guido van Rossum539c6622005-09-14 17:49:54410
Anthony Baxter70e07962006-04-03 14:16:27411 CC=cc
412 CXX=aCC
413 BASECFLAGS="+DD64"
414 LDFLAGS="+DD64 -lxnet"
Guido van Rossum539c6622005-09-14 17:49:54415
Anthony Baxter70e07962006-04-03 14:16:27416 and call configure as:
Guido van Rossum539c6622005-09-14 17:49:54417
Anthony Baxter70e07962006-04-03 14:16:27418 ./configure --without-gcc
Guido van Rossum539c6622005-09-14 17:49:54419
Anthony Baxter70e07962006-04-03 14:16:27420 then *unset* the environment variables again before running
421 make. (At least one of these flags causes the build to fail
422 if it remains set.) You still have to edit the Makefile and
423 remove -O from the OPT line.
Guido van Rossum2094e041998-05-14 15:47:35424
Georg Brandlf004d9d2009-10-27 15:39:53425HP PA-RISC 2.0: A recent bug report (http://bugs.python.org/546117)
Anthony Baxter70e07962006-04-03 14:16:27426 suggests that the C compiler in this 64-bit system has bugs
427 in the optimizer that break Python. Compiling without
428 optimization solves the problems.
Guido van Rossum4e1dd7d2002-04-23 13:06:07429
Anthony Baxter70e07962006-04-03 14:16:27430SCO: The following apply to SCO 3 only; Python builds out of the box
431 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05432
Anthony Baxter70e07962006-04-03 14:16:27433 1) Everything works much better if you add -U__STDC__ to the
434 defs. This is because all the SCO header files are broken.
435 Anything that isn't mentioned in the C standard is
436 conditionally excluded when __STDC__ is defined.
Guido van Rossum91cb9d21995-04-10 11:47:38437
Anthony Baxter70e07962006-04-03 14:16:27438 2) Due to the U.S. export restrictions, SCO broke the crypt
439 stuff out into a separate library, libcrypt_i.a so the LIBS
440 needed be set to:
Guido van Rossum91cb9d21995-04-10 11:47:38441
Anthony Baxter70e07962006-04-03 14:16:27442 LIBS=' -lsocket -lcrypt_i'
Guido van Rossum91cb9d21995-04-10 11:47:38443
Martin v. Löwis387c5472001-09-06 08:16:17444UnixWare: There are known bugs in the math library of the system, as well as
445 problems in the handling of threads (calling fork in one
446 thread may interrupt system calls in others). Therefore, test_math and
447 tests involving threads will fail until those problems are fixed.
448
Anthony Baxter70e07962006-04-03 14:16:27449QNX: Chris Herborth (chrish@qnx.com) writes:
450 configure works best if you use GNU bash; a port is available on
451 ftp.qnx.com in /usr/free. I used the following process to build,
452 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31453
Anthony Baxter70e07962006-04-03 14:16:27454 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
455 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31456
Anthony Baxter70e07962006-04-03 14:16:27457 2) edit Modules/Setup to activate everything that makes sense for
458 your system... tested here at QNX with the following modules:
Guido van Rossumb7f454d1997-12-02 19:44:31459
Anthony Baxter70e07962006-04-03 14:16:27460 array, audioop, binascii, cPickle, cStringIO, cmath,
461 crypt, curses, errno, fcntl, gdbm, grp, imageop,
462 _locale, math, md5, new, operator, parser, pcre,
Neal Norwitz90340a12007-05-20 18:06:27463 posix, pwd, readline, regex, reop,
Anthony Baxter70e07962006-04-03 14:16:27464 select, signal, socket, soundex, strop, struct,
Brett Cannondc48b742007-05-20 07:09:50465 syslog, termios, time, timing, zlib, audioop, imageop
Guido van Rossumb7f454d1997-12-02 19:44:31466
Anthony Baxter70e07962006-04-03 14:16:27467 3) make SHELL=/usr/local/bin/bash
Guido van Rossum16e809e2001-04-16 02:07:08468
Anthony Baxter70e07962006-04-03 14:16:27469 or, if you feel the need for speed:
Guido van Rossum16e809e2001-04-16 02:07:08470
Anthony Baxter70e07962006-04-03 14:16:27471 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31472
Anthony Baxter70e07962006-04-03 14:16:27473 4) make SHELL=/usr/local/bin/bash test
Guido van Rossumec95c7b1998-08-04 17:59:56474
Anthony Baxter70e07962006-04-03 14:16:27475 Using GNU readline 2.2 seems to behave strangely, but I
476 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56477
Anthony Baxter70e07962006-04-03 14:16:27478 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31479
Anthony Baxter70e07962006-04-03 14:16:27480 If you get SIGSEGVs while running Python (I haven't yet, but
481 I've only run small programs and the test cases), you're
482 probably running out of stack; the default 32k could be a
483 little tight. To increase the stack size, edit the Makefile
484 to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30485
Anthony Baxter70e07962006-04-03 14:16:27486BeOS: See Misc/BeOS-NOTES for notes about compiling/installing
487 Python on BeOS R3 or later. Note that only the PowerPC
488 platform is supported for R3; both PowerPC and x86 are
489 supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56490
Michael W. Hudson33876f52002-07-31 09:55:25491Cray T3E: Mark Hadfield (m.hadfield@niwa.co.nz) writes:
Anthony Baxter70e07962006-04-03 14:16:27492 Python can be built satisfactorily on a Cray T3E but based on
493 my experience with the NIWA T3E (2002-05-22, version 2.2.1)
494 there are a few bugs and gotchas. For more information see a
495 thread on comp.lang.python in May 2002 entitled "Building
496 Python on Cray T3E".
Michael W. Hudson33876f52002-07-31 09:55:25497
498 1) Use Cray's cc and not gcc. The latter was reported not to
499 work by Konrad Hinsen. It may work now, but it may not.
500
501 2) To set sys.platform to something sensible, pass the
502 following environment variable to the configure script:
503
504 MACHDEP=unicosmk
505
Anthony Baxter70e07962006-04-03 14:16:27506 2) Run configure with option "--enable-unicode=ucs4".
Michael W. Hudson33876f52002-07-31 09:55:25507
Anthony Baxter70e07962006-04-03 14:16:27508 3) The Cray T3E does not support dynamic linking, so extension
509 modules have to be built by adding (or uncommenting) lines
510 in Modules/Setup. The minimum set of modules is
Michael W. Hudson33876f52002-07-31 09:55:25511
Anthony Baxter70e07962006-04-03 14:16:27512 posix, new, _sre, unicodedata
Michael W. Hudson33876f52002-07-31 09:55:25513
Anthony Baxter70e07962006-04-03 14:16:27514 On NIWA's vanilla T3E system the following have also been
515 included successfully:
Michael W. Hudson33876f52002-07-31 09:55:25516
Anthony Baxter70e07962006-04-03 14:16:27517 _codecs, _locale, _socket, _symtable, _testcapi, _weakref
518 array, binascii, cmath, cPickle, crypt, cStringIO, dbm
519 errno, fcntl, grp, math, md5, operator, parser, pcre, pwd
520 regex, rotor, select, struct, strop, syslog, termios
521 time, timing, xreadlines
Michael W. Hudson33876f52002-07-31 09:55:25522
Anthony Baxter70e07962006-04-03 14:16:27523 4) Once the python executable and library have been built, make
524 will execute setup.py, which will attempt to build remaining
525 extensions and link them dynamically. Each of these attempts
526 will fail but should not halt the make process. This is
527 normal.
Michael W. Hudson33876f52002-07-31 09:55:25528
Anthony Baxter70e07962006-04-03 14:16:27529 5) Running "make test" uses a lot of resources and causes
530 problems on our system. You might want to try running tests
531 singly or in small groups.
Guido van Rossum1bf0bf41997-08-20 23:50:51532
Anthony Baxter70e07962006-04-03 14:16:27533SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
534 does not check whether a command actually changed the file it
535 is supposed to build. This means that whenever you say "make"
536 it will redo the link step. The remedy is to use SGI's much
537 smarter "smake" utility (/usr/sbin/smake), or GNU make. If
538 you set the first line of the Makefile to #!/usr/sbin/smake
539 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11540
Anthony Baxter70e07962006-04-03 14:16:27541 WARNING: There are bugs in the optimizer of some versions of
542 SGI's compilers that can cause bus errors or other strange
543 behavior, especially on numerical operations. To avoid this,
544 try building with "make OPT=".
Fred Drake0b5fb2b2000-09-29 17:45:05545
Guido van Rossum64773801997-11-26 17:07:02546OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
547 compiler installed, just change into the pc\os2vacpp directory
548 and type NMAKE. Threading and sockets are supported by default
549 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
550
Fred Drake36ed5602000-10-06 01:58:48551Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
552 uses the OBJECT_MODE={32|64} environment variable to set the
553 compilation mode to either 32-bit or 64-bit (32-bit mode is
554 the default). Presumably you want 64-bit compilation mode for
555 this 64-bit OS. As a result you must first set OBJECT_MODE=64
556 in your environment before configuring (./configure) or
557 building (make) Python on Monterey.
558
559Reliant UNIX: The thread support does not compile on Reliant UNIX, and
560 there is a (minor) problem in the configure script for that
561 platform as well. This should be resolved in time for a
562 future release.
Trent Mick635f6fb2000-08-23 21:33:05563
Barry Warsaw6a8557d2002-10-14 18:04:39564MacOSX: The tests will crash on both 10.1 and 10.2 with SEGV in
Barry Warsaw6e753642002-10-14 18:15:35565 test_re and test_sre due to the small default stack size. If
566 you set the stack size to 2048 before doing a "make test" the
Georg Brandl667eb7c2007-03-06 18:47:31567 failure can be avoided. If you're using the tcsh or csh shells,
568 use "limit stacksize 2048" and for the bash shell (the default
569 as of OSX 10.3), use "ulimit -s 2048".
Barry Warsaw06557452001-12-14 20:47:12570
Jack Jansen6a77cf12001-12-06 21:49:02571 On naked Darwin you may want to add the configure option
Jack Jansen4c398fd2001-10-08 13:21:15572 "--disable-toolbox-glue" to disable the glue code for the Carbon
Jack Jansen6a77cf12001-12-06 21:49:02573 interface modules. The modules themselves are currently only built
574 if you add the --enable-framework option, see below.
Barry Warsaw06557452001-12-14 20:47:12575
576 On a clean OSX /usr/local does not exist. Do a
Jack Jansen61fec302002-01-04 15:59:57577 "sudo mkdir -m 775 /usr/local"
Jack Jansen84a01642002-08-04 21:19:55578 before you do a make install. It is probably not a good idea to
579 do "sudo make install" which installs everything as superuser,
580 as this may later cause problems when installing distutils-based
581 additions.
Michael W. Hudson71dcc3e2005-02-22 15:33:26582
Jack Jansen84a01642002-08-04 21:19:55583 Some people have reported problems building Python after using "fink"
Anthony Baxter70e07962006-04-03 14:16:27584 to install additional unix software. Disabling fink (remove all
585 references to /sw from your .profile or .login) should solve this.
Barry Warsaw06557452001-12-14 20:47:12586
587 You may want to try the configure option "--enable-framework"
588 which installs Python as a framework. The location can be set
589 as argument to the --enable-framework option (default
Jack Jansen84a01642002-08-04 21:19:55590 /Library/Frameworks). A framework install is probably needed if you
591 want to use any Aqua-based GUI toolkit (whether Tkinter, wxPython,
592 Carbon, Cocoa or anything else).
Michael W. Hudson71dcc3e2005-02-22 15:33:26593
Georg Brandlb0885b72007-12-09 08:59:45594 You may also want to try the configure option "--enable-universalsdk"
595 which builds Python as a universal binary with support for the
596 i386 and PPC architetures. This requires Xcode 2.1 or later to build.
Ronald Oussoren988117f2006-04-29 11:31:35597
Georg Brandl3fc792b2007-12-09 08:54:02598 See Mac/README for more information on framework and
Georg Brandlb0885b72007-12-09 08:59:45599 universal builds.
Fred Drakedabed752001-02-01 19:41:13600
Michael W. Hudson1c4523f2001-12-19 19:49:58601Cygwin: With recent (relative to the time of writing, 2001-12-19)
602 Cygwin installations, there are problems with the interaction
603 of dynamic linking and fork(). This manifests itself in build
604 failures during the execution of setup.py.
Tim Peters42fc7cc2001-04-04 18:35:19605
Michael W. Hudson1c4523f2001-12-19 19:49:58606 There are two workarounds that both enable Python (albeit
607 without threading support) to build and pass all tests on
608 NT/2000 (and most likely XP as well, though reports of testing
609 on XP would be appreciated).
Guido van Rossum16e809e2001-04-16 02:07:08610
Michael W. Hudson1c4523f2001-12-19 19:49:58611 The workarounds:
612
613 (a) the band-aid fix is to link the _socket module statically
614 rather than dynamically (which is the default).
615
616 To do this, run "./configure --with-threads=no" including any
617 other options you need (--prefix, etc.). Then in Modules/Setup
Walter Dörwald7dc65d62003-02-02 23:37:05618 uncomment the lines:
Tim Peters42fc7cc2001-04-04 18:35:19619
Michael W. Hudsonbe5ce182001-12-12 11:46:52620 #SSL=/usr/local/ssl
621 #_socket socketmodule.c \
Anthony Baxter70e07962006-04-03 14:16:27622 # -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
623 # -L$(SSL)/lib -lssl -lcrypto
Guido van Rossum16e809e2001-04-16 02:07:08624
Michael W. Hudson1c4523f2001-12-19 19:49:58625 and remove "local/" from the SSL variable. Finally, just run
626 "make"!
Tim Peters42fc7cc2001-04-04 18:35:19627
Michael W. Hudsonb6554642001-12-19 22:09:09628 (b) The "proper" fix is to rebase the Cygwin DLLs to prevent
Michael W. Hudson1c4523f2001-12-19 19:49:58629 base address conflicts. Details on how to do this can be
630 found in the following mail:
631
632 http://sources.redhat.com/ml/cygwin/2001-12/msg00894.html
633
634 It is hoped that a version of this solution will be
Michael W. Hudsonb6554642001-12-19 22:09:09635 incorporated into the Cygwin distribution fairly soon.
Michael W. Hudson1c4523f2001-12-19 19:49:58636
637 Two additional problems:
638
639 (1) Threading support should still be disabled due to a known
640 bug in Cygwin pthreads that causes test_threadedtempfile to
641 hang.
642
Neal Norwitz4ebde092001-12-19 20:44:13643 (2) The _curses module does not build. This is a known
Michael W. Hudson1c4523f2001-12-19 19:49:58644 Cygwin ncurses problem that should be resolved the next time
645 that this package is released.
Guido van Rossum16e809e2001-04-16 02:07:08646
Michael W. Hudsonbe5ce182001-12-12 11:46:52647 On older versions of Cygwin, test_poll may hang and test_strftime
648 may fail.
Tim Peters42fc7cc2001-04-04 18:35:19649
Michael W. Hudson1c4523f2001-12-19 19:49:58650 The situation on 9X/Me is not accurately known at present.
651 Some time ago, there were reports that the following
652 regression tests failed:
Tim Peters42fc7cc2001-04-04 18:35:19653
654 test_pwd
655 test_select (hang)
656 test_socket
657
Michael W. Hudson1c4523f2001-12-19 19:49:58658 Due to the test_select hang on 9X/Me, one should run the
659 regression test using the following:
Tim Peters42fc7cc2001-04-04 18:35:19660
Michael W. Hudsonbe5ce182001-12-12 11:46:52661 make TESTOPTS='-l -x test_select' test
Tim Peters42fc7cc2001-04-04 18:35:19662
Michael W. Hudson1c4523f2001-12-19 19:49:58663 News regarding these platforms with more recent Cygwin
664 versions would be appreciated!
Guido van Rossum6d9cc801996-08-01 17:31:22665
Georg Brandl9b08e052009-04-05 21:21:05666Windows: When executing Python scripts on the command line using file type
667 associations (i.e. starting "script.py" instead of "python script.py"),
668 redirects may not work unless you set a specific registry key. See
669 the Knowledge Base article <http://support.microsoft.com/kb/321788>.
Skip Montanaro56d83012003-01-04 04:05:51670
671
Skip Montanaro57454e52002-06-14 20:30:31672Configuring the bsddb and dbm modules
673-------------------------------------
674
Skip Montanaro56d83012003-01-04 04:05:51675Beginning with Python version 2.3, the PyBsddb package
676<http://pybsddb.sf.net/> was adopted into Python as the bsddb package,
677exposing a set of package-level functions which provide
Gregory P. Smith3adc4aa2006-04-13 19:19:01678backwards-compatible behavior. Only versions 3.3 through 4.4 of
Skip Montanaro56d83012003-01-04 04:05:51679Sleepycat's libraries provide the necessary API, so older versions
680aren't supported through this interface. The old bsddb module has
681been retained as bsddb185, though it is not built by default. Users
682wishing to use it will have to tweak Modules/Setup to build it. The
683dbm module will still be built against the Sleepycat libraries if
Gregory P. Smith3adc4aa2006-04-13 19:19:01684other preferred alternatives (ndbm, gdbm) are not found.
Guido van Rossum62d45c02002-12-02 15:49:13685
Anthony Baxter70e07962006-04-03 14:16:27686Building the sqlite3 module
687---------------------------
688
689To build the sqlite3 module, you'll need the sqlite3 or libsqlite3
690packages installed, including the header files. Many modern operating
691systems distribute the headers in a separate package to the library -
692often it will be the same name as the main package, but with a -dev or
693-devel suffix.
694
695The version of pysqlite2 that's including in Python needs sqlite3 3.0.8
696or later. setup.py attempts to check that it can find a correct version.
Skip Montanaro57454e52002-06-14 20:30:31697
Guido van Rossumdc8a3cb1998-05-12 15:29:18698Configuring threads
699-------------------
700
Guido van Rossum7ac11532000-08-29 21:36:40701As of Python 2.0, threads are enabled by default. If you wish to
702compile without threads, or if your thread support is broken, pass the
703--with-threads=no switch to configure. Unfortunately, on some
704platforms, additional compiler and/or linker options are required for
705threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22706collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40707more, but the information below is not enough to write a patch for the
708configure.in file, so manual intervention is required. If you patch
709the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22710send in the patch. (Don't bother patching the configure script itself
Walter Dörwald7dc65d62003-02-02 23:37:05711-- it is regenerated each time the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18712
713Compiler switches for threads
714.............................
715
Martin v. Löwis1c24f9c2001-03-06 12:07:27716The definition of _REENTRANT should be configured automatically, if
717that does not work on your system, or if _REENTRANT is defined
718incorrectly, please report that as a bug.
Guido van Rossumdc8a3cb1998-05-12 15:29:18719
Martin v. Löwis1c24f9c2001-03-06 12:07:27720 OS/Compiler/threads Switches for use with threads
721 (POSIX is draft 10, DCE is draft 4) compile & link
722
723 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt
724 SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing)
Guido van Rossum16e809e2001-04-16 02:07:08725 DEC OSF/1 3.x/cc/DCE -threads
Anthony Baxter70e07962006-04-03 14:16:27726 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08727 Digital UNIX 4.x/cc/DCE -threads
Anthony Baxter70e07962006-04-03 14:16:27728 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08729 Digital UNIX 4.x/cc/POSIX -pthread
Anthony Baxter70e07962006-04-03 14:16:27730 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08731 AIX 4.1.4/cc_r/d7 (nothing)
Anthony Baxter70e07962006-04-03 14:16:27732 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08733 AIX 4.1.4/cc_r4/DCE (nothing)
Anthony Baxter70e07962006-04-03 14:16:27734 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08735 IRIX 6.2/cc/POSIX (nothing)
Anthony Baxter70e07962006-04-03 14:16:27736 (robertl@cwi.nl)
Guido van Rossumdc8a3cb1998-05-12 15:29:18737
738
739Linker (ld) libraries and flags for threads
740...........................................
741
742 OS/threads Libraries/switches for use with threads
743
744 SunOS 5.{1-5}/solaris -lthread
745 SunOS 5.5/POSIX -lpthread
Guido van Rossum16e809e2001-04-16 02:07:08746 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
Anthony Baxter70e07962006-04-03 14:16:27747 (butenhof@zko.dec.com)
Guido van Rossumdc8a3cb1998-05-12 15:29:18748 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
Anthony Baxter70e07962006-04-03 14:16:27749 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08750 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
Anthony Baxter70e07962006-04-03 14:16:27751 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08752 AIX 4.1.4/{draft7,DCE} (nothing)
Anthony Baxter70e07962006-04-03 14:16:27753 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08754 IRIX 6.2/POSIX -lpthread
Anthony Baxter70e07962006-04-03 14:16:27755 (jph@emilia.engr.sgi.com)
Guido van Rossumdc8a3cb1998-05-12 15:29:18756
757
Martin v. Löwis1142de32002-03-29 16:28:31758Building a shared libpython
759---------------------------
760
761Starting with Python 2.3, the majority of the interpreter can be built
Michael W. Hudson71dcc3e2005-02-22 15:33:26762into a shared library, which can then be used by the interpreter
Martin v. Löwis1142de32002-03-29 16:28:31763executable, and by applications embedding Python. To enable this feature,
Michael W. Hudson71dcc3e2005-02-22 15:33:26764configure with --enable-shared.
Martin v. Löwis65069672002-08-03 21:38:27765
Fred Drake55512dc2003-07-21 16:01:39766If you enable this feature, the same object files will be used to create
767a static library. In particular, the static library will contain object
768files using position-independent code (PIC) on platforms where PIC flags
769are needed for the shared library.
Martin v. Löwis1142de32002-03-29 16:28:31770
771
Guido van Rossum6d9cc801996-08-01 17:31:22772Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38773---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34774
Andrew M. Kuchlingebe30452001-02-27 03:24:24775Starting with Python 2.1, the setup.py script at the top of the source
776distribution attempts to detect which modules can be built and
777automatically compiles them. Autodetection doesn't always work, so
Guido van Rossum59b0b602002-02-08 22:22:35778you can still customize the configuration by editing the Modules/Setup
779file; but this should be considered a last resort. The rest of this
780section only applies if you decide to edit the Modules/Setup file.
781You also need this to enable static linking of certain modules (which
782is needed to enable profiling on some systems).
783
Andrew M. Kuchlingebe30452001-02-27 03:24:24784This file is initially copied from Setup.dist by the configure script;
785if it does not exist yet, create it by copying Modules/Setup.dist
786yourself (configure will never overwrite it). Never edit Setup.dist
787-- always edit Setup or Setup.local (see below). Read the comments in
788the file for information on what kind of edits are allowed. When you
789have edited Setup in the Modules directory, the interpreter will
Guido van Rossumef67ded2001-10-05 17:04:42790automatically be rebuilt the next time you run make (in the toplevel
791directory).
Guido van Rossum627b2d71993-12-24 10:39:16792
Andrew M. Kuchlingebe30452001-02-27 03:24:24793Many useful modules can be built on any Unix system, but some optional
794modules can't be reliably autodetected. Often the quickest way to
795determine whether a particular module works or not is to see if it
796will build: enable it in Setup, then if you get compilation or link
Fred Drake6caae142000-10-25 17:51:02797errors, disable it -- you're either missing support or need to adjust
798the compilation and linking parameters for that module.
Guido van Rossum6d9cc801996-08-01 17:31:22799
800On SGI IRIX, there are modules that interface to many SGI specific
Andrew M. Kuchlingebe30452001-02-27 03:24:24801system libraries, e.g. the GL library and the audio hardware. These
802modules will not be built by the setup.py script.
Guido van Rossum91cb9d21995-04-10 11:47:38803
Guido van Rossum4462e931997-01-22 21:00:32804In addition to the file Setup, you can also edit the file Setup.local.
805(the makesetup script processes both). You may find it more
806convenient to edit Setup.local and leave Setup alone. Then, when
807installing a new Python version, you can copy your old Setup.local
808file.
809
Guido van Rossum91cb9d21995-04-10 11:47:38810
811Setting the optimization/debugging options
812------------------------------------------
813
Guido van Rossum6d9cc801996-08-01 17:31:22814If you want or need to change the optimization/debugging options for
815the C compiler, assign to the OPT variable on the toplevel make
816command; e.g. "make OPT=-g" will build a debugging version of Python
817on most platforms. The default is OPT=-O; a value for OPT in the
818environment when the configure script is run overrides this default
819(likewise for CC; and the initial value for LIBS is used as the base
820set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38821
Fred Drake6caae142000-10-25 17:51:02822When compiling with GCC, the default value of OPT will also include
823the -Wall and -Wstrict-prototypes options.
824
825Additional debugging code to help debug memory management problems can
826be enabled by using the --with-pydebug option to the configure script.
827
Brett Cannon08cd5982005-04-24 22:26:38828For flags that change binary compatibility, use the EXTRA_CFLAGS
829variable.
830
Guido van Rossum91cb9d21995-04-10 11:47:38831
Guido van Rossuma68ca352001-10-04 17:00:07832Profiling
833---------
834
835If you want C profiling turned on, the easiest way is to run configure
836with the CC environment variable to the necessary compiler
837invocation. For example, on Linux, this works for profiling using
838gprof(1):
839
840 CC="gcc -pg" ./configure
841
842Note that on Linux, gprof apparently does not work for shared
843libraries. The Makefile/Setup mechanism can be used to compile and
Walter Dörwald7dc65d62003-02-02 23:37:05844link most extension modules statically.
Guido van Rossuma68ca352001-10-04 17:00:07845
846
Georg Brandl405b5f32008-05-18 11:46:51847Coverage checking
848-----------------
849
850For C coverage checking using gcov, run "make coverage". This will
851build a Python binary with profiling activated, and a ".gcno" and
852".gcda" file for every source file compiled with that option. With
853the built binary, now run the code whose coverage you want to check.
854Then, you can see coverage statistics for each individual source file
855by running gcov, e.g.
856
857 gcov -o Modules zlibmodule
858
859This will create a "zlibmodule.c.gcov" file in the current directory
860containing coverage info for that source file.
861
862This works only for source files statically compiled into the
863executable; use the Makefile/Setup mechanism to compile and link
864extension modules you want to coverage-check statically.
865
866
Guido van Rossum91cb9d21995-04-10 11:47:38867Testing
868-------
Guido van Rossum433c8ad1994-08-01 12:07:07869
Guido van Rossum4f40c2d2000-09-05 16:46:22870To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05871This runs the test set twice (once with no compiled files, once with
872the compiled files left by the previous test run). The test set
873produces some output. You can generally ignore the messages about
Guido van Rossum59b0b602002-02-08 22:22:35874skipped tests due to optional features which can't be imported.
Guido van Rossum4f40c2d2000-09-05 16:46:22875If a message is printed about a failed test or a traceback or core
876dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30877that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22878non-standard implementation of strftime() in the C library. Please
879ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07880
Georg Brandlb6ca2d62010-05-18 23:38:50881By default, tests are prevented from overusing resources like disk space and
882memory. To enable these tests, run "make testall".
883
Guido van Rossum91cb9d21995-04-10 11:47:38884IMPORTANT: If the tests fail and you decide to mail a bug report,
885*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22886failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38887
Georg Brandlb6ca2d62010-05-18 23:38:50888 ./python Lib/test/regrtest.py -v test_whatever
Guido van Rossum91cb9d21995-04-10 11:47:38889
Andrew M. Kuchling83d042d2002-03-21 23:52:20890(substituting the top of the source tree for '.' if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05891different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38892
893
894Installing
895----------
896
Guido van Rossum6d9cc801996-08-01 17:31:22897To install the Python binary, library modules, shared library modules
898(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02899just type
900
Anthony Baxter70e07962006-04-03 14:16:27901 make install
Guido van Rossum64773801997-11-26 17:07:02902
Guido van Rossum4f40c2d2000-09-05 16:46:22903This will install all platform-independent files in subdirectories of
904the directory given with the --prefix option to configure or to the
905`prefix' Make variable (default /usr/local). All binary and other
906platform-specific files will be installed in subdirectories if the
907directory given by --exec-prefix or the `exec_prefix' Make variable
908(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02909
Martin v. Löwis3b8ee082003-05-11 20:25:35910If DESTDIR is set, it will be taken as the root directory of the
911installation, and files will be installed into $(DESTDIR)$(prefix),
912$(DESTDIR)$(exec_prefix), etc.
913
Guido van Rossum64773801997-11-26 17:07:02914All subdirectories created will have Python's version number in their
915name, e.g. the library modules are installed in
Guido van Rossum67345eb2001-01-18 14:51:12916"/usr/local/lib/python<version>/" by default, where <version> is the
917<major>.<minor> release number (e.g. "2.1"). The Python binary is
918installed as "python<version>" and a hard link named "python" is
919created. The only file not installed with a version number in its
920name is the manual page, installed as "/usr/local/man/man1/python.1"
921by default.
Guido van Rossum433c8ad1994-08-01 12:07:07922
Skip Montanaro86d4e7a2008-03-05 16:41:09923If you want to install multiple versions of Python see the section below
924entitled "Installing multiple versions".
Guido van Rossum6d9cc801996-08-01 17:31:22925
926The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22927Emacs found in Misc/python-mode.el. (But then again, more recent
928versions of Emacs may already have it.) Follow the instructions that
929came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07930
Jack Jansena39ef862001-08-19 21:17:03931On Mac OS X, if you have configured Python with --enable-framework, you
932should use "make frameworkinstall" to do the installation. Note that this
933installs the Python executable in a place that is not normally on your
934PATH, you may want to set up a symlink in /usr/local/bin.
935
Guido van Rossum91cb9d21995-04-10 11:47:38936
Skip Montanaro86d4e7a2008-03-05 16:41:09937Installing multiple versions
938----------------------------
939
940On Unix and Mac systems if you intend to install multiple versions of Python
941using the same installation prefix (--prefix argument to the configure
942script) you must take care that your primary python executable is not
Ezio Melottic0fd6ff2010-03-23 13:20:39943overwritten by the installation of a different version. All files and
Skip Montanaro86d4e7a2008-03-05 16:41:09944directories installed using "make altinstall" contain the major and minor
945version and can thus live side-by-side. "make install" also creates
946${prefix}/bin/python which refers to ${prefix}/bin/pythonX.Y. If you intend
947to install multiple versions using the same prefix you must decide which
948version (if any) is your "primary" version. Install that version using
949"make install". Install all other versions using "make altinstall".
950
951For example, if you want to install Python 2.5, 2.6 and 3.0 with 2.6 being
952the primary version, you would execute "make install" in your 2.6 build
953directory and "make altinstall" in the others.
954
955
Guido van Rossum91cb9d21995-04-10 11:47:38956Configuration options and variables
957-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07958
Guido van Rossum6d9cc801996-08-01 17:31:22959Some special cases are handled by passing options to the configure
960script.
Guido van Rossum433c8ad1994-08-01 12:07:07961
Guido van Rossum6d9cc801996-08-01 17:31:22962WARNING: if you rerun the configure script with different options, you
963must run "make clean" before rebuilding. Exceptions to this rule:
964after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20965Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07966
Guido van Rossum91cb9d21995-04-10 11:47:38967--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
Anthony Baxter70e07962006-04-03 14:16:27968 it finds it. If you don't want this, or if this compiler is
969 installed but broken on your platform, pass the option
970 --without-gcc. You can also pass "CC=cc" (or whatever the
971 name of the proper C compiler is) in the environment, but the
972 advantage of using --without-gcc is that this option is
973 remembered by the config.status script for its --recheck
974 option.
Guido van Rossum76be6ed1995-01-02 18:33:54975
Guido van Rossum91cb9d21995-04-10 11:47:38976--prefix, --exec-prefix: If you want to install the binaries and the
Anthony Baxter70e07962006-04-03 14:16:27977 Python library somewhere else than in /usr/local/{bin,lib},
978 you can pass the option --prefix=DIRECTORY; the interpreter
979 binary will be installed as DIRECTORY/bin/python and the
980 library files as DIRECTORY/lib/python/*. If you pass
981 --exec-prefix=DIRECTORY (as well) this overrides the
982 installation prefix for architecture-dependent files (like the
983 interpreter binary). Note that --prefix=DIRECTORY also
984 affects the default module search path (sys.path), when
985 Modules/config.c is compiled. Passing make the option
986 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
987 prefix set at configuration time; this may be more convenient
988 than re-running the configure script if you change your mind
989 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54990
Guido van Rossum59b0b602002-02-08 22:22:35991--with-readline: This option is no longer supported. GNU
Anthony Baxter70e07962006-04-03 14:16:27992 readline is automatically enabled by setup.py when present.
Guido van Rossum91cb9d21995-04-10 11:47:38993
Guido van Rossum7ac11532000-08-29 21:36:40994--with-threads: On most Unix systems, you can now use multiple
Anthony Baxter70e07962006-04-03 14:16:27995 threads, and support for this is enabled by default. To
996 disable this, pass --with-threads=no. If the library required
997 for threads lives in a peculiar place, you can use
998 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
999 changing (either enabling or disabling) this option, or you
1000 will get link errors! Note: for DEC Unix use
1001 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:381002
1003--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
Anthony Baxter70e07962006-04-03 14:16:271004 supported by the "dl" library by Jack Jansen, which is
1005 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
1006 This is enabled (after you've ftp'ed and compiled the dl
1007 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
1008 is the absolute pathname of the dl library. (Don't bother on
1009 IRIX 5, it already has dynamic linking using SunOS style
1010 shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:381011
Guido van Rossum4f40c2d2000-09-05 16:46:221012--with-dl-dld: Dynamic loading of modules is rumored to be supported
Anthony Baxter70e07962006-04-03 14:16:271013 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
1014 Symmetry (Dynix), and Atari ST. This is done using a
1015 combination of the GNU dynamic loading package
1016 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
1017 emulation of the SGI dl library mentioned above (the emulation
1018 can be found at
1019 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
1020 enable this, ftp and compile both libraries, then call
1021 configure, passing it the option
1022 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
1023 the absolute pathname of the dl emulation library and
1024 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
1025 (Don't bother on SunOS 4 or 5, they already have dynamic
1026 linking using shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:381027
1028--with-libm, --with-libc: It is possible to specify alternative
Anthony Baxter70e07962006-04-03 14:16:271029 versions for the Math library (default -lm) and the C library
1030 (default the empty string) using the options
1031 --with-libm=STRING and --with-libc=STRING, respectively. For
1032 example, if your system requires that you pass -lc_s to the C
1033 compiler to use the shared C library, you can pass
1034 --with-libc=-lc_s. These libraries are passed after all other
1035 libraries, the C library last.
Guido van Rossum16e809e2001-04-16 02:07:081036
Guido van Rossum4f40c2d2000-09-05 16:46:221037--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
Anthony Baxter70e07962006-04-03 14:16:271038 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:011039
Martin v. Löwis0f48d982006-04-14 14:34:261040--with-cxx-main=<compiler>: If you plan to use C++ extension modules,
1041 then -- on some platforms -- you need to compile python's main()
1042 function with the C++ compiler. With this option, make will use
1043 <compiler> to compile main() *and* to link the python executable.
1044 It is likely that the resulting executable depends on the C++
1045 runtime library of <compiler>. (The default is --without-cxx-main.)
1046
1047 There are platforms that do not require you to build Python
1048 with a C++ compiler in order to use C++ extension modules.
1049 E.g., x86 Linux with ELF shared binaries and GCC 3.x, 4.x is such
1050 a platform. We recommend that you configure Python
1051 --without-cxx-main on those platforms because a mismatch
1052 between the C++ compiler version used to build Python and to
1053 build a C++ extension module is likely to cause a crash at
1054 runtime.
1055
1056 The Python installation also stores the variable CXX that
1057 determines, e.g., the C++ compiler distutils calls by default
1058 to build C++ extensions. If you set CXX on the configure command
1059 line to any string of non-zero length, then configure won't
1060 change CXX. If you do not preset CXX but pass
1061 --with-cxx-main=<compiler>, then configure sets CXX=<compiler>.
1062 In all other cases, configure looks for a C++ compiler by
1063 some common names (c++, g++, gcc, CC, cxx, cc++, cl) and sets
1064 CXX to the first compiler it finds. If it does not find any
1065 C++ compiler, then it sets CXX="".
1066
1067 Similarly, if you want to change the command used to link the
1068 python executable, then set LINKCC on the configure command line.
Martin v. Löwis2df66942000-12-13 14:14:321069
1070
Fred Drake6caae142000-10-25 17:51:021071--with-pydebug: Enable additional debugging code to help track down
Anthony Baxter70e07962006-04-03 14:16:271072 memory management problems. This allows printing a list of all
1073 live objects when the interpreter terminates.
Michael W. Hudson71dcc3e2005-02-22 15:33:261074
Jack Jansen7b8c7542002-04-14 20:12:411075--with(out)-universal-newlines: enable reading of text files with
Anthony Baxter70e07962006-04-03 14:16:271076 foreign newline convention (default: enabled). In other words,
1077 any of \r, \n or \r\n is acceptable as end-of-line character.
1078 If enabled import and execfile will automatically accept any newline
1079 in files. Python code can open a file with open(file, 'U') to
1080 read it in universal newline mode. THIS OPTION IS UNSUPPORTED.
Fred Drake6caae142000-10-25 17:51:021081
Martin v. Löwisf30d60e2004-06-08 08:17:441082--with-tsc: Profile using the Pentium timestamping counter (TSC).
Guido van Rossum76be6ed1995-01-02 18:33:541083
Martin v. Löwis9176fc12006-04-11 11:12:431084--with-system-ffi: Build the _ctypes extension module using an ffi
Georg Brandlb0885b72007-12-09 08:59:451085 library installed on the system.
Martin v. Löwis9176fc12006-04-11 11:12:431086
Michael W. Hudson71dcc3e2005-02-22 15:33:261087
Guido van Rossum433c8ad1994-08-01 12:07:071088Building for multiple architectures (using the VPATH feature)
1089-------------------------------------------------------------
1090
1091If your file system is shared between multiple architectures, it
1092usually is not necessary to make copies of the sources for each
1093architecture you want to support. If the make program supports the
1094VPATH feature, you can create an empty build directory for each
1095architecture, and in each directory run the configure script (on the
1096appropriate machine with the appropriate options). This creates the
1097necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:221098contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:371099actual sources. (On SGI systems, use "smake -J1" instead of "make" if
1100you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:071101
1102For example, the following is all you need to build a minimal Python
1103in /usr/tmp/python (assuming ~guido/src/python is the toplevel
1104directory and you want to build in /usr/tmp/python):
1105
Anthony Baxter70e07962006-04-03 14:16:271106 $ mkdir /usr/tmp/python
1107 $ cd /usr/tmp/python
1108 $ ~guido/src/python/configure
1109 [...]
1110 $ make
1111 [...]
1112 $
Guido van Rossum433c8ad1994-08-01 12:07:071113
Neil Schemenauer73f8ab22001-01-26 22:18:551114Note that configure copies the original Setup file to the build
Guido van Rossum433c8ad1994-08-01 12:07:071115directory if it finds no Setup file there. This means that you can
1116edit the Setup file for each architecture independently. For this
1117reason, subsequent changes to the original Setup file are not tracked
1118automatically, as they might overwrite local changes. To force a copy
1119of a changed original Setup file, delete the target Setup file. (The
1120makesetup script supports multiple input files, so if you want to be
1121fancy you can change the rules to create an empty Setup.local if it
1122doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
1123however this assumes that you only need to add modules.)
1124
Christian Heimes0a0e5832007-12-13 19:23:161125Also note that you can't use a workspace for VPATH and non VPATH builds. The
1126object files left behind by one version confuses the other.
1127
Guido van Rossum433c8ad1994-08-01 12:07:071128
Guido van Rossum433c8ad1994-08-01 12:07:071129Building on non-UNIX systems
1130----------------------------
1131
Martin v. Löwis2eba0d62004-12-24 08:28:281132For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 7.1, the
Tim Peters03444242000-09-19 00:38:351133project files are in PCbuild, the workspace is pcbuild.dsw. See
1134PCbuild\readme.txt for detailed instructions.
Guido van Rossum8d7d4ed1996-07-30 21:41:071135
Martin v. Löwis2eba0d62004-12-24 08:28:281136For other non-Unix Windows compilers, in particular MS VC++ 6.0 and
Guido van Rossum31ae2071999-04-12 14:47:301137for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:221138
1139For the Mac, a separate source distribution will be made available,
1140for use with the CodeWarrior compiler. If you are interested in Mac
1141development, join the PythonMac Special Interest Group
1142(http://www.python.org/sigs/pythonmac-sig/, or send email to
1143pythonmac-sig-request@python.org).
1144
1145Of course, there are also binary distributions available for these
Guido van Rossum67345eb2001-01-18 14:51:121146platforms -- see http://www.python.org/.
Guido van Rossum6d9cc801996-08-01 17:31:221147
1148To port Python to a new non-UNIX system, you will have to fake the
1149effect of running the configure script manually (for Mac and PC, this
1150has already been done for you). A good start is to copy the file
Michael W. Hudsonbe6e0f42002-06-23 16:29:361151pyconfig.h.in to pyconfig.h and edit the latter to reflect the actual
Guido van Rossum433c8ad1994-08-01 12:07:071152configuration of your system. Most symbols must simply be defined as
11531 only if the corresponding feature is present and can be left alone
Michael W. Hudsonbe6e0f42002-06-23 16:29:361154otherwise; however the *_t type symbols must be defined as some
1155variant of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:071156
Barry Warsaw06557452001-12-14 20:47:121157For all platforms, it's important that the build arrange to define the
1158preprocessor symbol NDEBUG on the compiler command line in a release
1159build of Python (else assert() calls remain in the code, hurting
1160release-build performance). The Unix, Windows and Mac builds already
1161do this.
Guido van Rossum433c8ad1994-08-01 12:07:071162
Guido van Rossum91cb9d21995-04-10 11:47:381163
1164Miscellaneous issues
1165====================
1166
Guido van Rossum91cb9d21995-04-10 11:47:381167Emacs mode
1168----------
1169
Guido van Rossumc0be2f51997-10-08 05:05:281170There's an excellent Emacs editing mode for Python code; see the file
1171Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:221172is now maintained by the equally famous Barry Warsaw (it's no
Guido van Rossum67345eb2001-01-18 14:51:121173coincidence that they now both work on the same team). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:021174version, along with various other contributed Python-related Emacs
Georg Brandlf004d9d2009-10-27 15:39:531175goodies, is online at http://www.python.org/emacs/python-mode/. And
Guido van Rossumc07d5fa2000-09-01 22:50:021176if you are planning to edit the Python C code, please pick up the
Georg Brandlf004d9d2009-10-27 15:39:531177latest version of CC Mode http://www.python.org/emacs/cc-mode/; it
Guido van Rossumc07d5fa2000-09-01 22:50:021178contains a "python" style used throughout most of the Python C source
1179files. (Newer versions of Emacs or XEmacs may already come with the
1180latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:381181
1182
Guido van Rossum59b0b602002-02-08 22:22:351183Tkinter
1184-------
Guido van Rossum91cb9d21995-04-10 11:47:381185
Guido van Rossum59b0b602002-02-08 22:22:351186The setup.py script automatically configures this when it detects a
1187usable Tcl/Tk installation. This requires Tcl/Tk version 8.0 or
Fred Drake8179a9d2000-09-28 23:28:301188higher.
Guido van Rossum6d9cc801996-08-01 17:31:221189
Guido van Rossum973e4dc2000-07-01 00:34:391190For more Tkinter information, see the Tkinter Resource page:
1191http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:281192
Michael W. Hudson71dcc3e2005-02-22 15:33:261193There are demos in the Demo/tkinter directory.
Guido van Rossum91cb9d21995-04-10 11:47:381194
1195Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:021196lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:221197(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:221198Modules/_tkinter.c. Demos and normal Tk applications import only the
Guido van Rossum59b0b602002-02-08 22:22:351199Python Tkinter module -- only the latter imports the C _tkinter
1200module. In order to find the C _tkinter module, it must be compiled
1201and linked into the Python interpreter -- the setup.py script does
1202this. In order to find the Python Tkinter module, sys.path must be
1203set correctly -- normal installation takes care of this.
Guido van Rossum84c8c7f1995-08-28 02:44:241204
Guido van Rossum91cb9d21995-04-10 11:47:381205
Guido van Rossum433c8ad1994-08-01 12:07:071206Distribution structure
1207----------------------
1208
Guido van Rossum4f40c2d2000-09-05 16:46:221209Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:071210comments.
1211
Guido van Rossum6d9cc801996-08-01 17:31:221212Demo/ Demonstration scripts, modules and programs
Georg Brandlc207c712008-02-09 21:38:541213Doc/ Documentation sources (reStructuredText)
Guido van Rossum6d9cc801996-08-01 17:31:221214Grammar/ Input for the parser generator
1215Include/ Public header files
Anthony Baxter70e07962006-04-03 14:16:271216LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:221217Lib/ Python library modules
Michael W. Hudsonbe6e0f42002-06-23 16:29:361218Mac/ Macintosh specific resources
Neil Schemenauer3f52da52001-01-24 17:49:591219Makefile.pre.in Source from which config.status creates the Makefile.pre
Guido van Rossumc0be2f51997-10-08 05:05:281220Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:221221Modules/ Implementation of most built-in modules
1222Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:021223PC/ Files specific to PC ports (DOS, Windows, OS/2)
Anthony Baxter70e07962006-04-03 14:16:271224PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:221225Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:221226Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:221227README The file you're reading now
Neal Norwitzf8519c42007-05-20 18:43:001228RISCOS/ Files specific to RISC OS port
Guido van Rossum6d9cc801996-08-01 17:31:221229Tools/ Some useful programs written in Python
Michael W. Hudsonbe6e0f42002-06-23 16:29:361230pyconfig.h.in Source from which pyconfig.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:221231configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:021232configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:221233install-sh Shell script used to install files
Anthony Baxter70e07962006-04-03 14:16:271234setup.py Python script used to build extension modules
Guido van Rossum91cb9d21995-04-10 11:47:381235
1236The following files will (may) be created in the toplevel directory by
1237the configuration and build processes:
1238
Guido van Rossum6d9cc801996-08-01 17:31:221239Makefile Build rules
Neil Schemenauer3f52da52001-01-24 17:49:591240Makefile.pre Build rules before running Modules/makesetup
Michael W. Hudsonbe6e0f42002-06-23 16:29:361241buildno Keeps track of the build number
Guido van Rossumc07d5fa2000-09-01 22:50:021242config.cache Cache of configuration variables
Michael W. Hudsonbe6e0f42002-06-23 16:29:361243pyconfig.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:281244config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:221245config.status Status from last run of the configure script
Anthony Baxter70e07962006-04-03 14:16:271246getbuildinfo.o Object file from Modules/getbuildinfo.c
1247libpython<version>.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:221248python The executable interpreter
Neal Norwitzf8519c42007-05-20 18:43:001249reflog.txt Output from running the regression suite with the -R flag
Guido van Rossum6d9cc801996-08-01 17:31:221250tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:071251
1252
Guido van Rossumc07d5fa2000-09-01 22:50:021253That's all, folks!
1254------------------
Guido van Rossum433c8ad1994-08-01 12:07:071255
1256
Guido van Rossum67345eb2001-01-18 14:51:121257--Guido van Rossum (home page: http://www.python.org/~guido/)