README

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