README

   1 This is Python version 3.1 Release Candidate 2
   2 ==============================================
   3
   4 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
   5 Python Software Foundation.
   6 All rights reserved.
   7
   8 Python 3.x is a new version of the language, which is incompatible with the
   9 2.x line of releases.  The language is mostly the same, but many details,
  10 especially how built-in objects like dictionaries and strings work, have
  11 changed considerably, and a lot of deprecated features have finally been
  12 removed.
  13
  14
  15 Release Schedule
  16 ----------------
  17
  18 See PEP 375 for release details: http://www.python.org/dev/peps/pep-0375/
  19
  20
  21 Documentation
  22 -------------
  23
  24 Documentation for Python 3.1 is online, updated twice a day:
  25
  26     http://docs.python.org/dev/3.1/
  27
  28 All documentation is also available online at the Python web site
  29 (http://docs.python.org/, see below).  It is available online for
  30 occasional reference, or can be downloaded in many formats for faster
  31 access.  The documentation is downloadable in HTML, PostScript, PDF,
  32 LaTeX (through 2.5), and reStructuredText (2.6+) formats; the LaTeX and
  33 reStructuredText versions are primarily for documentation authors,
  34 translators, and people with special formatting requirements.
  35
  36
  37 What's New
  38 ----------
  39
  40 We try to have a comprehensive overview of the changes in the "What's New in
  41 Python 3.1" document, found at
  42
  43     http://docs.python.org/dev/3.1/whatsnew/3.1.html
  44
  45 Please help write it!
  46
  47 For a more detailed change log, read Misc/NEWS (though this file, too,
  48 is incomplete, and also doesn't list anything merged in from the 2.7
  49 release under development).
  50
  51 If you want to install multiple versions of Python see the section below
  52 entitled "Installing multiple versions".
  53
  54
  55 Proposals for enhancement
  56 -------------------------
  57
  58 If you have a proposal to change Python, you may want to send an email to the
  59 comp.lang.python or python-ideas mailing lists for inital feedback. A Python
  60 Enhancement Proposal (PEP) may be submitted if your idea gains ground. All
  61 current PEPs, as well as guidelines for submitting a new PEP, are listed at
  62 http://www.python.org/dev/peps/.
  63
  64
  65 Converting From Python 2.x to 3.x
  66 ---------------------------------
  67
  68 Python starting with 2.6 will contain features to help locating code that
  69 needs to be changed, such as optional warnings when deprecated features are
  70 used, and backported versions of certain key Python 3.x features.
  71
  72
  73 Testing
  74 -------
  75
  76 To test the interpreter, type "make test" in the top-level directory.
  77 This runs the test set twice (once with no compiled files, once with
  78 the compiled files left by the previous test run).  The test set
  79 produces some output.  You can generally ignore the messages about
  80 skipped tests due to optional features which can't be imported.
  81 If a message is printed about a failed test or a traceback or core
  82 dump is produced, something is wrong.  On some Linux systems (those
  83 that are not yet using glibc 6), test_strftime fails due to a
  84 non-standard implementation of strftime() in the C library. Please
  85 ignore this, or upgrade to glibc version 6.
  86
  87 By default, tests are prevented from overusing resources like disk space and
  88 memory.  To enable these tests, run "make testall".
  89
  90 IMPORTANT: If the tests fail and you decide to mail a bug report,
  91 *don't* include the output of "make test".  It is useless.  Run the
  92 failing test manually, as follows:
  93
  94         ./python Lib/test/regrtest.py -v test_whatever
  95
  96 (substituting the top of the source tree for '.' if you built in a
  97 different directory).  This runs the test in verbose mode.
  98
  99
 100 Installing multiple versions
 101 ----------------------------
 102
 103 On Unix and Mac systems if you intend to install multiple versions of Python
 104 using the same installation prefix (--prefix argument to the configure
 105 script) you must take care that your primary python executable is not
 106 overwritten by the installation of a different versio.  All files and
 107 directories installed using "make altinstall" contain the major and minor
 108 version and can thus live side-by-side.  "make install" also creates
 109 ${prefix}/bin/python3 which refers to ${prefix}/bin/pythonX.Y.  If you intend
 110 to install multiple versions using the same prefix you must decide which
 111 version (if any) is your "primary" version.  Install that version using
 112 "make install".  Install all other versions using "make altinstall".
 113
 114 For example, if you want to install Python 2.5, 2.6 and 3.0 with 2.6 being
 115 the primary version, you would execute "make install" in your 2.6 build
 116 directory and "make altinstall" in the others.
 117
 118
 119 Configuration options and variables
 120 -----------------------------------
 121
 122 A source-to-source translation tool, "2to3", can take care of the
 123 mundane task of converting large amounts of source code.  It is not a
 124 complete solution but is complemented by the deprecation warnings in
 125 2.6.  This tool is currently available via the Subversion sandbox:
 126
 127     http://svn.python.org/view/sandbox/trunk/2to3/
 128
 129
 130 Issue Tracker and Mailing List
 131 ------------------------------
 132
 133 We're soliciting bug reports about all aspects of the language.  Fixes
 134 are also welcome, preferable in unified diff format.  Please use the
 135 issue tracker:
 136
 137     http://bugs.python.org/
 138
 139 If you're not sure whether you're dealing with a bug or a feature, use
 140 the mailing list:
 141
 142     python-dev@python.org
 143
 144 To subscribe to the list, use the mailman form:
 145
 146     http://mail.python.org/mailman/listinfo/python-dev/
 147
 148
 149 Build Instructions
 150 ------------------
 151
 152 On Unix, Linux, BSD, OSX, and Cygwin:
 153
 154     ./configure
 155     make
 156     make test
 157     sudo make install
 158
 159 You can pass many options to the configure script; run "./configure
 160 --help" to find out more.  On OSX and Cygwin, the executable is called
 161 python.exe; elsewhere it's just python.
 162
 163 On Mac OS X, if you have configured Python with --enable-framework,
 164 you should use "make frameworkinstall" to do the installation.  Note
 165 that this installs the Python executable in a place that is not
 166 normally on your PATH, you may want to set up a symlink in
 167 /usr/local/bin.
 168
 169 On Windows, see PCbuild/readme.txt.
 170
 171 If you wish, you can create a subdirectory and invoke configure from
 172 there.  For example:
 173
 174     mkdir debug
 175     cd debug
 176     ../configure --with-pydebug
 177     make
 178     make test
 179
 180 (This will fail if you *also* built at the top-level directory.  You
 181 should do a "make clean" at the toplevel first.)
 182
 183
 184 Copyright and License Information
 185 ---------------------------------
 186
 187 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
 188 Python Software Foundation.
 189 All rights reserved.
 190
 191 Copyright (c) 2000 BeOpen.com.
 192 All rights reserved.
 193
 194 Copyright (c) 1995-2001 Corporation for National Research Initiatives.
 195 All rights reserved.
 196
 197 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
 198 All rights reserved.
 199
 200 See the file "LICENSE" for information on the history of this
 201 software, terms & conditions for usage, and a DISCLAIMER OF ALL
 202 WARRANTIES.
 203
 204 This Python distribution contains *no* GNU General Public License
 205 (GPL) code, so it may be used in proprietary projects.  There are
 206 interfaces to some GNU code but these are entirely optional.
 207
 208 All trademarks referenced herein are property of their respective
 209 holders.