README 6.45 KB
Newer Older
Georg Brandl's avatar
Georg Brandl committed
1 2
This is Python version 3.2.1
============================
3

4
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5
Python Software Foundation.  All rights reserved.
6

Georg Brandl's avatar
Georg Brandl committed
7 8 9 10
Python 3.x is a new version of the language, which is incompatible with the 2.x
line of releases.  The language is mostly the same, but many details, especially
how built-in objects like dictionaries and strings work, have changed
considerably, and a lot of deprecated features have finally been removed.
11

12

13 14
Build Instructions
------------------
15

16
On Unix, Linux, BSD, OSX, and Cygwin:
Guido van Rossum's avatar
Guido van Rossum committed
17

18 19 20 21
    ./configure
    make
    make test
    sudo make install
22

23
This will install Python as python3.
24

Georg Brandl's avatar
Georg Brandl committed
25 26 27
You can pass many options to the configure script; run "./configure --help" to
find out more.  On OSX and Cygwin, the executable is called python.exe;
elsewhere it's just python.
28

Georg Brandl's avatar
Georg Brandl committed
29 30 31 32
On Mac OS X, if you have configured Python with --enable-framework, you should
use "make frameworkinstall" to do the installation.  Note that this installs the
Python executable in a place that is not normally on your PATH, you may want to
set up a symlink in /usr/local/bin.
33

34 35
On Windows, see PCbuild/readme.txt.

Georg Brandl's avatar
Georg Brandl committed
36 37
If you wish, you can create a subdirectory and invoke configure from there.  For
example:
38 39 40 41 42 43 44

    mkdir debug
    cd debug
    ../configure --with-pydebug
    make
    make test

Georg Brandl's avatar
Georg Brandl committed
45 46
(This will fail if you *also* built at the top-level directory.  You should do a
"make clean" at the toplevel first.)
47

48

49
What's New
50 51
----------

52
We try to have a comprehensive overview of the changes in the "What's New in
53
Python 3.2" document, found at
54

55
    http://docs.python.org/3.2/whatsnew/3.2.html
56

Georg Brandl's avatar
Georg Brandl committed
57 58 59
For a more detailed change log, read Misc/NEWS (though this file, too, is
incomplete, and also doesn't list anything merged in from the 2.7 release under
development).
60

61 62 63 64
If you want to install multiple versions of Python see the section below
entitled "Installing multiple versions".


65 66
Documentation
-------------
67

68
Documentation for Python 3.2 is online, updated daily:
69

70
    http://docs.python.org/3.2/
71

72 73 74 75
It can also be downloaded in many formats for faster access.  The documentation
is downloadable in HTML, PDF, and reStructuredText formats; the latter version
is primarily for documentation authors, translators, and people with special
formatting requirements.
76

77

Barry Warsaw's avatar
Barry Warsaw committed
78
Converting From Python 2.x to 3.x
79
---------------------------------
80

Georg Brandl's avatar
Georg Brandl committed
81 82 83
Python starting with 2.6 contains features to help locating code that needs to
be changed, such as optional warnings when deprecated features are used, and
backported versions of certain key Python 3.x features.
84

85 86 87
A source-to-source translation tool, "2to3", can take care of the mundane task
of converting large amounts of source code.  It is not a complete solution but
is complemented by the deprecation warnings in 2.6.  See
88
http://docs.python.org/3.2/library/2to3.html for more information.
89

Christian Heimes's avatar
Christian Heimes committed
90

91 92 93
Testing
-------

Georg Brandl's avatar
Georg Brandl committed
94 95 96 97 98
To test the interpreter, type "make test" in the top-level directory.  This runs
the test set twice (once with no compiled files, once with the compiled files
left by the previous test run).  The test set produces some output.  You can
generally ignore the messages about skipped tests due to optional features which
can't be imported.  If a message is printed about a failed test or a traceback
Antoine Pitrou's avatar
Antoine Pitrou committed
99
or core dump is produced, something is wrong.
100 101 102 103

By default, tests are prevented from overusing resources like disk space and
memory.  To enable these tests, run "make testall".

Georg Brandl's avatar
Georg Brandl committed
104 105 106
IMPORTANT: If the tests fail and you decide to mail a bug report, *don't*
include the output of "make test".  It is useless.  Run the failing test
manually, as follows:
107

Antoine Pitrou's avatar
Antoine Pitrou committed
108
        ./python -m test -v test_whatever
109

Georg Brandl's avatar
Georg Brandl committed
110 111
(substituting the top of the source tree for '.' if you built in a different
directory).  This runs the test in verbose mode.
112 113


Christian Heimes's avatar
Christian Heimes committed
114 115 116 117
Installing multiple versions
----------------------------

On Unix and Mac systems if you intend to install multiple versions of Python
Georg Brandl's avatar
Georg Brandl committed
118 119 120 121 122 123 124 125 126
using the same installation prefix (--prefix argument to the configure script)
you must take care that your primary python executable is not overwritten by the
installation of a different version.  All files and directories installed using
"make altinstall" contain the major and minor version and can thus live
side-by-side.  "make install" also creates ${prefix}/bin/python3 which refers to
${prefix}/bin/pythonX.Y.  If you intend to install multiple versions using the
same prefix you must decide which version (if any) is your "primary" version.
Install that version using "make install".  Install all other versions using
"make altinstall".
Christian Heimes's avatar
Christian Heimes committed
127

Georg Brandl's avatar
Georg Brandl committed
128 129 130
For example, if you want to install Python 2.5, 2.6 and 3.2 with 2.6 being the
primary version, you would execute "make install" in your 2.6 build directory
and "make altinstall" in the others.
Christian Heimes's avatar
Christian Heimes committed
131 132


133 134
Issue Tracker and Mailing List
------------------------------
135

Georg Brandl's avatar
Georg Brandl committed
136 137
We're soliciting bug reports about all aspects of the language.  Fixes are also
welcome, preferable in unified diff format.  Please use the issue tracker:
138

139
    http://bugs.python.org/
140

Georg Brandl's avatar
Georg Brandl committed
141 142
If you're not sure whether you're dealing with a bug or a feature, use the
mailing list:
143

144
    python-dev@python.org
145

146
To subscribe to the list, use the mailman form:
Guido van Rossum's avatar
Guido van Rossum committed
147

148
    http://mail.python.org/mailman/listinfo/python-dev/
149

150

151 152
Proposals for enhancement
-------------------------
153

154
If you have a proposal to change Python, you may want to send an email to the
155 156
comp.lang.python or python-ideas mailing lists for inital feedback.  A Python
Enhancement Proposal (PEP) may be submitted if your idea gains ground.  All
157 158
current PEPs, as well as guidelines for submitting a new PEP, are listed at
http://www.python.org/dev/peps/.
159

160

161 162
Release Schedule
----------------
163

164
See PEP 392 for release details: http://www.python.org/dev/peps/pep-0392/
165 166 167 168 169


Copyright and License Information
---------------------------------

170 171
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
Python Software Foundation.  All rights reserved.
172

173
Copyright (c) 2000 BeOpen.com.  All rights reserved.
174

175 176
Copyright (c) 1995-2001 Corporation for National Research Initiatives.  All
rights reserved.
177

178
Copyright (c) 1991-1995 Stichting Mathematisch Centrum.  All rights reserved.
179

180 181
See the file "LICENSE" for information on the history of this software, terms &
conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.
182

183 184 185
This Python distribution contains *no* GNU General Public License (GPL) code, so
it may be used in proprietary projects.  There are interfaces to some GNU code
but these are entirely optional.
186

187
All trademarks referenced herein are property of their respective holders.