README

   1 This is Python version 2.2
   2 ==========================
   3
   4 Copyright (c) 2001 Python Software Foundation.
   5 All rights reserved.
   6
   7 Copyright (c) 2000 BeOpen.com.
   8 All rights reserved.
   9
  10 Copyright (c) 1995-2001 Corporation for National Research Initiatives.
  11 All rights reserved.
  12
  13 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
  14 All rights reserved.
  15
  16
  17 License information
  18 -------------------
  19
  20 See the file "LICENSE" for information on the history of this
  21 software, terms & conditions for usage, and a DISCLAIMER OF ALL
  22 WARRANTIES.
  23
  24 This Python distribution contains no GNU General Public Licensed
  25 (GPLed) code so it may be used in proprietary projects just like prior
  26 Python distributions.  There are interfaces to some GNU code but these
  27 are entirely optional.
  28
  29 All trademarks referenced herein are property of their respective
  30 holders.
  31
  32
  33 What's new in this release?
  34 ---------------------------
  35
  36 See the file "Misc/NEWS".
  37
  38 If you don't read instructions
  39 ------------------------------
  40
  41 Congratulations on getting this far. :-)
  42
  43 To start building right away (on UNIX): type "./configure" in the
  44 current directory and when it finishes, type "make".  The section
  45 `Build Instructions' below is still recommended reading, especially
  46 the part on customizing Modules/Setup.
  47
  48
  49 What is Python anyway?
  50 ----------------------
  51
  52 Python is an interpreted object-oriented programming language suitable
  53 (amongst other uses) for distributed application development,
  54 scripting, numeric computing and system testing.  Python is often
  55 compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme.  To
  56 find out more about what Python can do for you, point your browser to
  57 http://www.python.org/.
  58
  59
  60 How do I learn Python?
  61 ----------------------
  62
  63 The official tutorial is still a good place to start; see
  64 http://www.python.org/doc/ for online and downloadable versions, as
  65 well as a list of other introductions, and reference documentation.
  66
  67 There's a quickly growing set of books on Python.  See
  68 http://www.python.org/psa/bookstore/ for a list.
  69
  70
  71 Documentation
  72 -------------
  73
  74 All documentation is provided online in a variety of formats.  In
  75 order of importance for new users: Tutorial, Library Reference,
  76 Language Reference, Extending & Embedding, and the Python/C API.  The
  77 Library Reference is especially of immense value since much of
  78 Python's power is described there, including the built-in data types
  79 and functions!
  80
  81 All documentation is also available online at the Python web site
  82 (http://www.python.org/doc/, see below).  It is available online for
  83 occasional reference, or can be downloaded in many formats for faster
  84 access.  The documentation is available in HTML, PostScript, PDF, and
  85 LaTeX formats; the LaTeX version is primarily for documentation
  86 authors, translators, and people with special formatting requirements.
  87
  88 The best documentation for the new (in Python 2.2) type/class unification
  89 features is Guido's tutorial introduction, at
  90
  91     http://www.python.org/2.2/descrintro.html
  92
  93
  94 Web sites
  95 ---------
  96
  97 New Python releases and related technologies are published at
  98 http://www.python.org/.  Come visit us!
  99
 100 There's also a Python community web site at http://starship.python.net/.
 101
 102
 103 Newsgroups and Mailing Lists
 104 ----------------------------
 105
 106 Read comp.lang.python, a high-volume discussion newsgroup about
 107 Python, or comp.lang.python.announce, a low-volume moderated newsgroup
 108 for Python-related announcements.  These are also accessible as
 109 mailing lists: see http://www.python.org/psa/MailingLists.html for an
 110 overview of the many Python-related mailing lists.
 111
 112 Archives are accessible via Deja.com Usenet News: see
 113 http://www.deja.com/usenet.  The mailing lists are also archived, see
 114 http://www.python.org/psa/MailingLists.html for details.
 115
 116
 117 Bug reports
 118 -----------
 119
 120 To report or search for bugs, please use the Python Bug
 121 Tracker at http://sourceforge.net/bugs/?group_id=5470.
 122
 123
 124 Patches and contributions
 125 -------------------------
 126
 127 To submit a patch or other contribution, please use the Python Patch
 128 Manager at http://sourceforge.net/patch/?group_id=5470.  Guidelines
 129 for patch submission may be found at http://www.python.org/patches/.
 130
 131 If you have a proposal to change Python, it's best to submit a Python
 132 Enhancement Proposal (PEP) first.  All current PEPs, as well as
 133 guidelines for submitting a new PEP, are list at
 134 http://python.sourceforge.net/peps/.
 135
 136
 137 Questions
 138 ---------
 139
 140 For help, if you can't find it in the manuals or on the web site, it's
 141 best to post to the comp.lang.python or the Python mailing list (see
 142 above).  If you specifically don't want to involve the newsgroup or
 143 mailing list, send questions to help@python.org (a group of volunteers
 144 who answer questions as they can).  The newsgroup is the most
 145 efficient way to ask public questions.
 146
 147
 148 Build instructions
 149 ==================
 150
 151 Before you can build Python, you must first configure it.  Fortunately,
 152 the configuration and build process has been streamlined for most Unix
 153 installations, so all you have to do is type a few commands,
 154 optionally edit one file, and sit back.  There are some platforms
 155 where things are not quite as smooth; see the platform specific notes
 156 below.  If you want to build for multiple platforms sharing the same
 157 source tree, see the section on VPATH below.
 158
 159 Start by running the script "./configure", which determines your system
 160 configuration and creates the Makefile.  (It takes a minute or two --
 161 please be patient!)  You may want to pass options to the configure
 162 script or edit the Modules/Setup file after running configure -- see the
 163 section below on configuration options and variables.  When it's done,
 164 you are ready to run make.
 165
 166 To build Python, you normally type "make" in the toplevel directory.  If
 167 you have changed the configuration or have modified Modules/Setup, the
 168 Makefile may have to be rebuilt.  In this case you may have to run make
 169 again to correctly build your desired target.  The interpreter
 170 executable is built in the top level directory.
 171
 172 Once you have built a Python interpreter, see the subsections below on
 173 testing, configuring additional modules, and installation.  If you run
 174 into trouble, see the next section.  Editing the Modules/Setup file
 175 after running make is supported; just run "make" again after making
 176 the desired changes.
 177
 178
 179 Troubleshooting
 180 ---------------
 181
 182 See also the platform specific notes in the next section.
 183
 184 If you run into other trouble, see section 3 of the FAQ
 185 (http://www.python.org/cgi-bin/faqw.py or
 186 http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
 187 and how to fix it.
 188
 189 If you rerun the configure script with different options, remove all
 190 object files by running "make clean" before rebuilding.  Believe it or
 191 not, "make clean" sometimes helps to clean up other inexplicable
 192 problems as well.  Try it before sending in a bug report!
 193
 194 If the configure script fails or doesn't seem to find things that
 195 should be there, inspect the config.log file.  When you fix a
 196 configure problem, be sure to remove config.cache!
 197
 198 If you get a warning for every file about the -Olimit option being no
 199 longer supported, you can ignore it.  There's no foolproof way to know
 200 whether this option is needed; all we can do is test whether it is
 201 accepted without error.  On some systems, e.g. older SGI compilers, it
 202 is essential for performance (specifically when compiling ceval.c,
 203 which has more basic blocks than the default limit of 1000).  If the
 204 warning bothers you, edit the Makefile to remove "-Olimit 1500" from
 205 the OPT variable.
 206
 207 If you get failures in test_long, or sys.maxint gets set to -1, you
 208 are probably experiencing compiler bugs, usually related to
 209 optimization.  This is a common problem with some versions of gcc and
 210 egcs, and some vendor-supplied compilers, which can sometimes be
 211 worked around by turning off optimization.  Consider switching to
 212 stable versions (gcc 2.7.2.3, egcs 1.1.2, or contact your vendor.)
 213
 214 From Python 2.0 onward, all Python C code is ANSI C.  Compiling using
 215 old K&R-C-only compilers is no longer possible.  ANSI C compilers are
 216 available for all modern systems, either in the form of updated
 217 compilers from the vendor, or one of the free compilers (gcc, egcs).
 218
 219 Platform specific notes
 220 -----------------------
 221
 222 (Some of these may no longer apply.  If you find you can build Python
 223 on these platforms without the special directions mentioned here,
 224 submit a documentation bug report to SourceForge (see Bug Reports
 225 above) so we can remove them!)
 226
 227 64-bit platforms: The modules audioop, imageop and rgbimg don't work.
 228         Don't try to enable them in the Modules/Setup file.  They
 229         contain code that is quite wordsize sensitive.  (If you have a
 230         fix, let us know!)
 231
 232 Solaris: When using Sun's C compiler with threads, at least on Solaris
 233         2.5.1, you need to add the "-mt" compiler option (the simplest
 234         way is probably to specify the compiler with this option as
 235         the "CC" environment variable when running the configure
 236         script).
 237
 238 Linux:  A problem with threads and fork() was tracked down to a bug in
 239         the pthreads code in glibc version 2.0.5; glibc version 2.0.7
 240         solves the problem.  This causes the popen2 test to fail;
 241         problem and solution reported by Pablo Bleyer.
 242
 243         Under Linux systems using GNU libc 2 (aka libc6), the crypt
 244         module now needs the -lcrypt option.  Uncomment this flag in
 245         Modules/Setup, or comment out the crypt module in the same
 246         file. Most modern Linux systems use glibc2.
 247
 248 FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
 249         similar: When using cursesmodule, the linking is not done in
 250         the correct order with the defaults.  Remove "-ltermcap" from
 251         the readline entry in Setup, and use as curses entry: "curses
 252         cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
 253         called on FreeBSD) should be the name of the auxiliary library
 254         required on your platform.  Normally, it would be linked
 255         automatically, but not necessarily in the correct order.
 256
 257 BSDI:   BSDI versions before 4.1 have known problems with threads,
 258         which can cause strange errors in a number of modules (for
 259         instance, the 'test_signal' test script will hang forever.)
 260         Turning off threads (with --with-threads=no) or upgrading to
 261         BSDI 4.1 solves this problem.
 262
 263 DEC Unix: Run configure with --with-dec-threads, or with
 264         --with-threads=no if no threads are desired (threads are on by
 265         default).  When using GCC, it is possible to get an internal
 266         compiler error if optimization is used.  This was reported for
 267         GCC 2.7.2.3 on selectmodule.c.  Manually compile the affected
 268         file without optimization to solve the problem.
 269
 270 DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
 271         and pass SHELL=/bin/sh5 to Make when installing.
 272
 273 AIX:    A complete overhaul of the shared library support is now in
 274         place.  See Misc/AIX-NOTES for some notes on how it's done.
 275         (The optimizer bug reported at this place in previous releases
 276         has been worked around by a minimal code change.) If you get
 277         errors about ptread_* functions, during compile or during
 278         testing, try setting CC to a thread-safe (reentrant) compiler,
 279         like "cc_r".  For full C++ module support, set CC="xlC_r" (or
 280         CC="xlC" without thread support).
 281
 282 HP-UX:  Please read the file Misc/HPUX-NOTES for shared libraries.
 283         When using threading, you may have to add -D_REENTRANT to the
 284         OPT variable in the top-level Makefile; reported by Pat Knight,
 285         this seems to make a difference (at least for HP-UX 10.20)
 286         even though config.h defines it.
 287
 288 Minix:  When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
 289
 290 SCO:    The following apply to SCO 3 only; Python builds out of the box
 291         on SCO 5 (or so we've heard).
 292
 293         1) Everything works much better if you add -U__STDC__ to the
 294         defs.  This is because all the SCO header files are broken.
 295         Anything that isn't mentioned in the C standard is
 296         conditionally excluded when __STDC__ is defined.
 297
 298         2) Due to the U.S. export restrictions, SCO broke the crypt
 299         stuff out into a separate library, libcrypt_i.a so the LIBS
 300         needed be set to:
 301
 302                 LIBS=' -lsocket -lcrypt_i'
 303
 304 UnixWare: There are known bugs in the math library of the system, as well as
 305         problems in the handling of threads (calling fork in one
 306         thread may interrupt system calls in others). Therefore, test_math and
 307         tests involving threads will fail until those problems are fixed.
 308
 309 SunOS 4.x: When using the SunPro C compiler, you may want to use the
 310         '-Xa' option instead of '-Xc', to enable some needed non-ANSI
 311         Sunisms.
 312
 313 NeXT:   Not supported anymore. Start with the MacOSX/Darwin code if you
 314         want to revive it.
 315
 316 QNX:    Chris Herborth (chrish@qnx.com) writes:
 317         configure works best if you use GNU bash; a port is available on
 318         ftp.qnx.com in /usr/free.  I used the following process to build,
 319         test and install Python 1.5.x under QNX:
 320
 321         1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
 322             ./configure --verbose --without-gcc --with-libm=""
 323
 324         2) edit Modules/Setup to activate everything that makes sense for
 325            your system... tested here at QNX with the following modules:
 326
 327                 array, audioop, binascii, cPickle, cStringIO, cmath,
 328                 crypt, curses, errno, fcntl, gdbm, grp, imageop,
 329                 _locale, math, md5, new, operator, parser, pcre,
 330                 posix, pwd, readline, regex, reop, rgbimg, rotor,
 331                 select, signal, socket, soundex, strop, struct,
 332                 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
 333
 334         3) make SHELL=/usr/local/bin/bash
 335
 336            or, if you feel the need for speed:
 337
 338            make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
 339
 340         4) make SHELL=/usr/local/bin/bash test
 341
 342            Using GNU readline 2.2 seems to behave strangely, but I
 343            think that's a problem with my readline 2.2 port.  :-\
 344
 345         5) make SHELL=/usr/local/bin/bash install
 346
 347         If you get SIGSEGVs while running Python (I haven't yet, but
 348         I've only run small programs and the test cases), you're
 349         probably running out of stack; the default 32k could be a
 350         little tight.  To increase the stack size, edit the Makefile
 351         to read: LDFLAGS = -N 48k
 352
 353 BeOS:   Chris Herborth (chrish@qnx.com) writes:
 354         See BeOS/README for notes about compiling/installing Python on
 355         BeOS R3 or later.  Note that only the PowerPC platform is
 356         supported for R3; both PowerPC and x86 are supported for R4.
 357
 358 Cray T3E: Konrad Hinsen writes:
 359         1) Don't use gcc. It compiles Python/graminit.c into something
 360            that the Cray assembler doesn't like. Cray's cc seems to work
 361            fine.
 362         2) Comment out modules md5 (won't compile) and audioop (will
 363            crash the interpreter during the test suite).
 364         If you run the test suite, two tests will fail (rotate and
 365         binascii), but these are not the modules you'd expect to need
 366         on a Cray.
 367
 368 SGI:    SGI's standard "make" utility (/bin/make or /usr/bin/make)
 369         does not check whether a command actually changed the file it
 370         is supposed to build.  This means that whenever you say "make"
 371         it will redo the link step.  The remedy is to use SGI's much
 372         smarter "smake" utility (/usr/sbin/smake), or GNU make.  If
 373         you set the first line of the Makefile to #!/usr/sbin/smake
 374         smake will be invoked by make (likewise for GNU make).
 375
 376         WARNING: There are bugs in the optimizer of some versions of
 377         SGI's compilers that can cause bus errors or other strange
 378         behavior, especially on numerical operations.  To avoid this,
 379         try building with "make OPT=".
 380
 381 OS/2:   If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
 382         compiler installed, just change into the pc\os2vacpp directory
 383         and type NMAKE.  Threading and sockets are supported by default
 384         in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
 385
 386 Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
 387         uses the OBJECT_MODE={32|64} environment variable to set the
 388         compilation mode to either 32-bit or 64-bit (32-bit mode is
 389         the default).  Presumably you want 64-bit compilation mode for
 390         this 64-bit OS.  As a result you must first set OBJECT_MODE=64
 391         in your environment before configuring (./configure) or
 392         building (make) Python on Monterey.
 393
 394 Reliant UNIX: The thread support does not compile on Reliant UNIX, and
 395         there is a (minor) problem in the configure script for that
 396         platform as well.  This should be resolved in time for a
 397         future release.
 398
 399 Mac OS X 10: One of the regular expression tests fails
 400         with a SEGV due to the small stack size used by default, if you do
 401         "limit stacksize 2048" before "make test" it should work.
 402
 403         On naked Darwin you may want to add the configure option
 404         "--disable-toolbox-glue" to disable the glue code for the Carbon
 405         interface modules. The modules themselves are currently only built
 406         if you add the --enable-framework option, see below.
 407
 408         On a clean OSX /usr/local does not exist. Do a "sudo mkdir -m 775 /usr/local"
 409         before you do a make install. Alternatively, do "sudo make install"
 410         which installs everything as superuser.
 411
 412         You may want to try the configure option "--enable-framework" which
 413         installs Python as a framework. The location can be set as argument
 414         to the --enable-framework option (default /Library/Frameworks). You may
 415         also want to check out ./Mac/OSX for building a Python.app. You may also
 416         want to manually install a symlink in /usr/local/bin/python to the
 417         executable deep down in the framework.
 418
 419 Cygwin: With recent (relative to the time of writing, 2001-12-11)
 420         Cygwin installations, Python builds and passes all tests on
 421         NT/2000 if the _socket module is linked statically.  If the
 422         _socket module is linked dynamically (the default), then
 423         failures can occur under certain conditions related to fork().
 424         This is a known Cygwin problem that may be resolved by rebasing
 425         the necessary DLLs to prevent base address conflicts.
 426
 427         Threads support should still be disable due to a known bug in
 428         Cygwin pthreads that causes test_threadedtempfile to hang.
 429
 430         To workaround the above, run "./configure --with-threads=no" and
 431         include any other options you need (--prefix, etc.).  Then in
 432         Modules/Setup uncomment the lines:
 433
 434         #SSL=/usr/local/ssl
 435         #_socket socketmodule.c \
 436         #       -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
 437         #       -L$(SSL)/lib -lssl -lcrypto
 438
 439         and remove "local/" from the SSL variable.  And finally, just
 440         run "make"!
 441
 442         The _curses module does not build.  This is an known Cygwin
 443         ncurses problem that should be resolved the next time that this
 444         package is released.
 445
 446         On older versions of Cygwin, test_poll may hang and test_strftime
 447         may fail.
 448
 449         The situation on 9X/Me/XP is not accurately known at present.
 450         However, it is expected that XP should be the same (or at least
 451         very similar to) NT/2000.  Some time ago, there were reports that
 452         the following regression tests failed on 9X/Me:
 453
 454             test_pwd
 455             test_select (hang)
 456             test_socket
 457
 458         Due to the test_select hang on 9X/Me, one should run the regression
 459         test using the following:
 460
 461             make TESTOPTS='-l -x test_select' test
 462
 463         News regarding these platforms with more recent Cygwin verions would
 464         be appreciated!
 465
 466 Configuring threads
 467 -------------------
 468
 469 As of Python 2.0, threads are enabled by default.  If you wish to
 470 compile without threads, or if your thread support is broken, pass the
 471 --with-threads=no switch to configure.  Unfortunately, on some
 472 platforms, additional compiler and/or linker options are required for
 473 threads to work properly.  Below is a table of those options,
 474 collected by Bill Janssen.  We would love to automate this process
 475 more, but the information below is not enough to write a patch for the
 476 configure.in file, so manual intervention is required.  If you patch
 477 the configure.in file and are confident that the patch works, please
 478 send in the patch.  (Don't bother patching the configure script itself
 479 -- it is regenerated each the configure.in file changes.)
 480
 481 Compiler switches for threads
 482 .............................
 483
 484 The definition of _REENTRANT should be configured automatically, if
 485 that does not work on your system, or if _REENTRANT is defined
 486 incorrectly, please report that as a bug.
 487
 488     OS/Compiler/threads                     Switches for use with threads
 489     (POSIX is draft 10, DCE is draft 4)     compile & link
 490
 491     SunOS 5.{1-5}/{gcc,SunPro cc}/solaris   -mt
 492     SunOS 5.5/{gcc,SunPro cc}/POSIX         (nothing)
 493     DEC OSF/1 3.x/cc/DCE                    -threads
 494             (butenhof@zko.dec.com)
 495     Digital UNIX 4.x/cc/DCE                 -threads
 496             (butenhof@zko.dec.com)
 497     Digital UNIX 4.x/cc/POSIX               -pthread
 498             (butenhof@zko.dec.com)
 499     AIX 4.1.4/cc_r/d7                       (nothing)
 500             (buhrt@iquest.net)
 501     AIX 4.1.4/cc_r4/DCE                     (nothing)
 502             (buhrt@iquest.net)
 503     IRIX 6.2/cc/POSIX                       (nothing)
 504             (robertl@cwi.nl)
 505
 506
 507 Linker (ld) libraries and flags for threads
 508 ...........................................
 509
 510     OS/threads                          Libraries/switches for use with threads
 511
 512     SunOS 5.{1-5}/solaris               -lthread
 513     SunOS 5.5/POSIX                     -lpthread
 514     DEC OSF/1 3.x/DCE                   -lpthreads -lmach -lc_r -lc
 515             (butenhof@zko.dec.com)
 516     Digital UNIX 4.x/DCE                -lpthreads -lpthread -lmach -lexc -lc
 517             (butenhof@zko.dec.com)
 518     Digital UNIX 4.x/POSIX              -lpthread -lmach -lexc -lc
 519             (butenhof@zko.dec.com)
 520     AIX 4.1.4/{draft7,DCE}              (nothing)
 521             (buhrt@iquest.net)
 522     IRIX 6.2/POSIX                      -lpthread
 523             (jph@emilia.engr.sgi.com)
 524
 525
 526 Configuring additional built-in modules
 527 ---------------------------------------
 528
 529 Starting with Python 2.1, the setup.py script at the top of the source
 530 distribution attempts to detect which modules can be built and
 531 automatically compiles them.  Autodetection doesn't always work, so
 532 you can customize the configuration by editing the Modules/Setup file.
 533 This file is initially copied from Setup.dist by the configure script;
 534 if it does not exist yet, create it by copying Modules/Setup.dist
 535 yourself (configure will never overwrite it).  Never edit Setup.dist
 536 -- always edit Setup or Setup.local (see below).  Read the comments in
 537 the file for information on what kind of edits are allowed.  When you
 538 have edited Setup in the Modules directory, the interpreter will
 539 automatically be rebuilt the next time you run make (in the toplevel
 540 directory).
 541
 542 Many useful modules can be built on any Unix system, but some optional
 543 modules can't be reliably autodetected.  Often the quickest way to
 544 determine whether a particular module works or not is to see if it
 545 will build: enable it in Setup, then if you get compilation or link
 546 errors, disable it -- you're either missing support or need to adjust
 547 the compilation and linking parameters for that module.
 548
 549 On SGI IRIX, there are modules that interface to many SGI specific
 550 system libraries, e.g. the GL library and the audio hardware.  These
 551 modules will not be built by the setup.py script.
 552
 553 In addition to the file Setup, you can also edit the file Setup.local.
 554 (the makesetup script processes both).  You may find it more
 555 convenient to edit Setup.local and leave Setup alone.  Then, when
 556 installing a new Python version, you can copy your old Setup.local
 557 file.
 558
 559
 560 Setting the optimization/debugging options
 561 ------------------------------------------
 562
 563 If you want or need to change the optimization/debugging options for
 564 the C compiler, assign to the OPT variable on the toplevel make
 565 command; e.g. "make OPT=-g" will build a debugging version of Python
 566 on most platforms.  The default is OPT=-O; a value for OPT in the
 567 environment when the configure script is run overrides this default
 568 (likewise for CC; and the initial value for LIBS is used as the base
 569 set of libraries to link with).
 570
 571 When compiling with GCC, the default value of OPT will also include
 572 the -Wall and -Wstrict-prototypes options.
 573
 574 Additional debugging code to help debug memory management problems can
 575 be enabled by using the --with-pydebug option to the configure script.
 576
 577
 578 Profiling
 579 ---------
 580
 581 If you want C profiling turned on, the easiest way is to run configure
 582 with the CC environment variable to the necessary compiler
 583 invocation.  For example, on Linux, this works for profiling using
 584 gprof(1):
 585
 586     CC="gcc -pg" ./configure
 587
 588 Note that on Linux, gprof apparently does not work for shared
 589 libraries.  The Makefile/Setup mechanism can be used to compile and
 590 link most extension module statically.
 591
 592
 593 Testing
 594 -------
 595
 596 To test the interpreter, type "make test" in the top-level directory.
 597 This runs the test set twice (once with no compiled files, once with
 598 the compiled files left by the previous test run).  The test set
 599 produces some output.  You can generally ignore the messages about
 600 skipped tests due to optional features which can't be imported.  (If
 601 you want to test those modules, edit Modules/Setup to configure them.)
 602 If a message is printed about a failed test or a traceback or core
 603 dump is produced, something is wrong.  On some Linux systems (those
 604 that are not yet using glibc 6), test_strftime fails due to a
 605 non-standard implementation of strftime() in the C library. Please
 606 ignore this, or upgrade to glibc version 6.
 607
 608 IMPORTANT: If the tests fail and you decide to mail a bug report,
 609 *don't* include the output of "make test".  It is useless.  Run the
 610 failing test manually, as follows:
 611
 612         python ../Lib/test/test_whatever.py
 613
 614 (substituting the top of the source tree for .. if you built in a
 615 different directory).  This runs the test in verbose mode.
 616
 617
 618 Installing
 619 ----------
 620
 621 To install the Python binary, library modules, shared library modules
 622 (see below), include files, configuration files, and the manual page,
 623 just type
 624
 625         make install
 626
 627 This will install all platform-independent files in subdirectories of
 628 the directory given with the --prefix option to configure or to the
 629 `prefix' Make variable (default /usr/local).  All binary and other
 630 platform-specific files will be installed in subdirectories if the
 631 directory given by --exec-prefix or the `exec_prefix' Make variable
 632 (defaults to the --prefix directory) is given.
 633
 634 All subdirectories created will have Python's version number in their
 635 name, e.g. the library modules are installed in
 636 "/usr/local/lib/python<version>/" by default, where <version> is the
 637 <major>.<minor> release number (e.g. "2.1").  The Python binary is
 638 installed as "python<version>" and a hard link named "python" is
 639 created.  The only file not installed with a version number in its
 640 name is the manual page, installed as "/usr/local/man/man1/python.1"
 641 by default.
 642
 643 If you have a previous installation of Python that you don't
 644 want to replace yet, use
 645
 646         make altinstall
 647
 648 This installs the same set of files as "make install" except it
 649 doesn't create the hard link to "python<version>" named "python" and
 650 it doesn't install the manual page at all.
 651
 652 Alpha/beta revision levels are stripped from the executable and
 653 library filenames during installation. For example, Python2.1a2 will
 654 install as python2.1, overwriting the previous python2.1. To avoid
 655 this, you could set the Makefile VERSION variable manually
 656 (e.g. VERSION=2.1a2) before running "make install" or "make altinstall".
 657
 658 The only thing you may have to install manually is the Python mode for
 659 Emacs found in Misc/python-mode.el.  (But then again, more recent
 660 versions of Emacs may already have it.)  Follow the instructions that
 661 came with Emacs for installation of site-specific files.
 662
 663 On Mac OS X, if you have configured Python with --enable-framework, you
 664 should use "make frameworkinstall" to do the installation. Note that this
 665 installs the Python executable in a place that is not normally on your
 666 PATH, you may want to set up a symlink in /usr/local/bin.
 667
 668
 669 Configuration options and variables
 670 -----------------------------------
 671
 672 Some special cases are handled by passing options to the configure
 673 script.
 674
 675 WARNING: if you rerun the configure script with different options, you
 676 must run "make clean" before rebuilding.  Exceptions to this rule:
 677 after changing --prefix or --exec-prefix, all you need to do is remove
 678 Modules/getpath.o.
 679
 680 --with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
 681         it finds it.  If you don't want this, or if this compiler is
 682         installed but broken on your platform, pass the option
 683         --without-gcc.  You can also pass "CC=cc" (or whatever the
 684         name of the proper C compiler is) in the environment, but the
 685         advantage of using --without-gcc is that this option is
 686         remembered by the config.status script for its --recheck
 687         option.
 688
 689 --prefix, --exec-prefix: If you want to install the binaries and the
 690         Python library somewhere else than in /usr/local/{bin,lib},
 691         you can pass the option --prefix=DIRECTORY; the interpreter
 692         binary will be installed as DIRECTORY/bin/python and the
 693         library files as DIRECTORY/lib/python/*.  If you pass
 694         --exec-prefix=DIRECTORY (as well) this overrides the
 695         installation prefix for architecture-dependent files (like the
 696         interpreter binary).  Note that --prefix=DIRECTORY also
 697         affects the default module search path (sys.path), when
 698         Modules/config.c is compiled.  Passing make the option
 699         prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
 700         prefix set at configuration time; this may be more convenient
 701         than re-running the configure script if you change your mind
 702         about the install prefix.
 703
 704 --with-readline: This option is no longer supported.  To use GNU
 705         readline, enable module "readline" in the Modules/Setup file.
 706
 707 --with-threads: On most Unix systems, you can now use multiple
 708         threads, and support for this is enabled by default.  To
 709         disable this, pass --with-threads=no.  If the library required
 710         for threads lives in a peculiar place, you can use
 711         --with-thread=DIRECTORY.  IMPORTANT: run "make clean" after
 712         changing (either enabling or disabling) this option, or you
 713         will get link errors!  Note: for DEC Unix use
 714         --with-dec-threads instead.
 715
 716 --with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
 717         supported by the "dl" library by Jack Jansen, which is
 718         ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
 719         This is enabled (after you've ftp'ed and compiled the dl
 720         library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
 721         is the absolute pathname of the dl library.  (Don't bother on
 722         IRIX 5, it already has dynamic linking using SunOS style
 723         shared libraries.)  Support for this feature is deprecated.
 724
 725 --with-dl-dld: Dynamic loading of modules is rumored to be supported
 726         on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
 727         Symmetry (Dynix), and Atari ST.  This is done using a
 728         combination of the GNU dynamic loading package
 729         (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
 730         emulation of the SGI dl library mentioned above (the emulation
 731         can be found at
 732         ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z).  To
 733         enable this, ftp and compile both libraries, then call
 734         configure, passing it the option
 735         --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
 736         the absolute pathname of the dl emulation library and
 737         DLD_DIRECTORY is the absolute pathname of the GNU dld library.
 738         (Don't bother on SunOS 4 or 5, they already have dynamic
 739         linking using shared libraries.)  Support for this feature is
 740         deprecated.
 741
 742 --with-libm, --with-libc: It is possible to specify alternative
 743         versions for the Math library (default -lm) and the C library
 744         (default the empty string) using the options
 745         --with-libm=STRING and --with-libc=STRING, respectively.  For
 746         example, if your system requires that you pass -lc_s to the C
 747         compiler to use the shared C library, you can pass
 748         --with-libc=-lc_s. These libraries are passed after all other
 749         libraries, the C library last.
 750
 751 --with-libs='libs': Add 'libs' to the LIBS that the python interpreter
 752         is linked against.
 753
 754 --with-cxx=<compiler>: Some C++ compilers require that main() is
 755         compiled with the C++ if there is any C++ code in the application.
 756         Specifically, g++ on a.out systems may require that to support
 757         construction of global objects. With this option, the main() function
 758         of Python will be compiled with <compiler>; use that only if you
 759         plan to use C++ extension modules, and if your compiler requires
 760         compilation of main() as a C++ program.
 761
 762
 763 --with-pydebug:  Enable additional debugging code to help track down
 764         memory management problems.  This allows printing a list of all
 765         live objects when the interpreter terminates.
 766
 767
 768 Building for multiple architectures (using the VPATH feature)
 769 -------------------------------------------------------------
 770
 771 If your file system is shared between multiple architectures, it
 772 usually is not necessary to make copies of the sources for each
 773 architecture you want to support.  If the make program supports the
 774 VPATH feature, you can create an empty build directory for each
 775 architecture, and in each directory run the configure script (on the
 776 appropriate machine with the appropriate options).  This creates the
 777 necessary subdirectories and the Makefiles therein.  The Makefiles
 778 contain a line VPATH=... which points to a directory containing the
 779 actual sources.  (On SGI systems, use "smake -J1" instead of "make" if
 780 you use VPATH -- don't try gnumake.)
 781
 782 For example, the following is all you need to build a minimal Python
 783 in /usr/tmp/python (assuming ~guido/src/python is the toplevel
 784 directory and you want to build in /usr/tmp/python):
 785
 786         $ mkdir /usr/tmp/python
 787         $ cd /usr/tmp/python
 788         $ ~guido/src/python/configure
 789         [...]
 790         $ make
 791         [...]
 792         $
 793
 794 Note that configure copies the original Setup file to the build
 795 directory if it finds no Setup file there.  This means that you can
 796 edit the Setup file for each architecture independently.  For this
 797 reason, subsequent changes to the original Setup file are not tracked
 798 automatically, as they might overwrite local changes.  To force a copy
 799 of a changed original Setup file, delete the target Setup file.  (The
 800 makesetup script supports multiple input files, so if you want to be
 801 fancy you can change the rules to create an empty Setup.local if it
 802 doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
 803 however this assumes that you only need to add modules.)
 804
 805
 806 Building on non-UNIX systems
 807 ----------------------------
 808
 809 For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the
 810 project files are in PCbuild, the workspace is pcbuild.dsw.  See
 811 PCbuild\readme.txt for detailed instructions.
 812
 813 For other non-Unix Windows compilers, in particular Windows 3.1 and
 814 for OS/2, enter the directory "PC" and read the file "readme.txt".
 815
 816 For the Mac, a separate source distribution will be made available,
 817 for use with the CodeWarrior compiler.  If you are interested in Mac
 818 development, join the PythonMac Special Interest Group
 819 (http://www.python.org/sigs/pythonmac-sig/, or send email to
 820 pythonmac-sig-request@python.org).
 821
 822 Of course, there are also binary distributions available for these
 823 platforms -- see http://www.python.org/.
 824
 825 To port Python to a new non-UNIX system, you will have to fake the
 826 effect of running the configure script manually (for Mac and PC, this
 827 has already been done for you).  A good start is to copy the file
 828 config.h.in to config.h and edit the latter to reflect the actual
 829 configuration of your system.  Most symbols must simply be defined as
 830 1 only if the corresponding feature is present and can be left alone
 831 otherwise; however the *_t type symbols must be defined as some variant
 832 of int if they need to be defined at all.
 833
 834 For all platforms, it's important that the build arrange to define the
 835 preprocessor symbol NDEBUG on the compiler command line in a release
 836 build of Python (else assert() calls remain in the code, hurting
 837 release-build performance).  The Unix, Windows and Mac builds already
 838 do this.
 839
 840
 841 Miscellaneous issues
 842 ====================
 843
 844 Emacs mode
 845 ----------
 846
 847 There's an excellent Emacs editing mode for Python code; see the file
 848 Misc/python-mode.el.  Originally written by the famous Tim Peters, it
 849 is now maintained by the equally famous Barry Warsaw (it's no
 850 coincidence that they now both work on the same team).  The latest
 851 version, along with various other contributed Python-related Emacs
 852 goodies, is online at http://www.python.org/emacs/python-mode.  And
 853 if you are planning to edit the Python C code, please pick up the
 854 latest version of CC Mode http://www.python.org/emacs/cc-mode; it
 855 contains a "python" style used throughout most of the Python C source
 856 files.  (Newer versions of Emacs or XEmacs may already come with the
 857 latest version of python-mode.)
 858
 859
 860 The Tk interface
 861 ----------------
 862
 863 Tk (the user interface component of John Ousterhout's Tcl language) is
 864 also usable from Python.  Since this requires that you first build and
 865 install Tcl/Tk, the Tk interface is not enabled by default when
 866 building Python from source.  Python supports Tcl/Tk version 8.0 and
 867 higher.
 868
 869 See http://dev.ajubasolutions.com/ for more info on Tcl/Tk, including
 870 the on-line manual pages.
 871
 872
 873 To enable the Python/Tk interface, once you've built and installed
 874 Tcl/Tk, load the file Modules/Setup into your favorite text editor and
 875 search for the string "_tkinter".  Then follow the instructions found
 876 there.  If you have installed Tcl/Tk or X11 in unusual places, you
 877 will have to edit the first line to fix or add the -I and -L options.
 878 (Also see the general instructions at the top of that file.)
 879
 880 For more Tkinter information, see the Tkinter Resource page:
 881 http://www.python.org/topics/tkinter/
 882
 883 There are demos in the Demo/tkinter directory, in the subdirectories
 884 guido, matt and www (the matt and guido subdirectories have been
 885 overhauled to use more recent Tkinter coding conventions).
 886
 887 Note that there's a Python module called "Tkinter" (capital T) which
 888 lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
 889 (lower case t and leading underscore) which lives in
 890 Modules/_tkinter.c.  Demos and normal Tk applications import only the
 891 Python Tkinter module -- the latter uses the C _tkinter module
 892 directly.  In order to find the C _tkinter module, it must be compiled
 893 and linked into the Python interpreter -- the _tkinter line in the
 894 Setup file does this.  In order to find the Python Tkinter module,
 895 sys.path must be set correctly -- the TKPATH assignment in the Setup
 896 file takes care of this, but only if you install Python properly
 897 ("make install libinstall").  (You can also use dynamic loading for
 898 the C _tkinter module, in which case you must manually fix up sys.path
 899 or set $PYTHONPATH for the Python Tkinter module.)
 900
 901
 902 Distribution structure
 903 ----------------------
 904
 905 Most subdirectories have their own README files.  Most files have
 906 comments.
 907
 908 .cvsignore      Additional filename matching patterns for CVS to ignore
 909 BeOS/           Files specific to the BeOS port
 910 Demo/           Demonstration scripts, modules and programs
 911 Doc/            Documentation sources (LaTeX)
 912 Grammar/        Input for the parser generator
 913 Include/        Public header files
 914 LICENSE         Licensing information
 915 Lib/            Python library modules
 916 Makefile.pre.in Source from which config.status creates the Makefile.pre
 917 Misc/           Miscellaneous useful files
 918 Modules/        Implementation of most built-in modules
 919 Objects/        Implementation of most built-in object types
 920 PC/             Files specific to PC ports (DOS, Windows, OS/2)
 921 PCbuild/        Build directory for Microsoft Visual C++
 922 Parser/         The parser and tokenizer and their input handling
 923 Python/         The byte-compiler and interpreter
 924 README          The file you're reading now
 925 Tools/          Some useful programs written in Python
 926 acconfig.h      Additional input for the GNU autoheader program
 927 config.h.in     Source from which config.h is created (GNU autoheader output)
 928 configure       Configuration shell script (GNU autoconf output)
 929 configure.in    Configuration specification (input for GNU autoconf)
 930 install-sh      Shell script used to install files
 931
 932 The following files will (may) be created in the toplevel directory by
 933 the configuration and build processes:
 934
 935 Makefile        Build rules
 936 Makefile.pre    Build rules before running Modules/makesetup
 937 buildno         Keeps track of the build number
 938 config.cache    Cache of configuration variables
 939 config.h        Configuration header
 940 config.log      Log from last configure run
 941 config.status   Status from last run of the configure script
 942 getbuildinfo.o  Object file from Modules/getbuildinfo.c
 943 libpython<version>.a    The library archive
 944 python          The executable interpreter
 945 tags, TAGS      Tags files for vi and Emacs
 946
 947
 948 That's all, folks!
 949 ------------------
 950
 951
 952 --Guido van Rossum (home page: http://www.python.org/~guido/)