Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 1 | This is Python version 3.6.0 alpha 1 |
| 2 | ==================================== |
Guido van Rossum | 9144763 | 2000-04-11 17:11:09 +0000 | [diff] [blame] | 3 | |
Benjamin Peterson | f606e68 | 2011-12-31 22:42:26 -0600 | [diff] [blame] | 4 | Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, |
Benjamin Peterson | 75e3630 | 2016-01-01 10:23:45 -0600 | [diff] [blame] | 5 | 2012, 2013, 2014, 2015, 2016 Python Software Foundation. All rights reserved. |
Guido van Rossum | 4405cf3 | 2007-08-30 17:16:55 +0000 | [diff] [blame] | 6 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 7 | Python 3.x is a new version of the language, which is incompatible with the |
| 8 | 2.x line of releases. The language is mostly the same, but many details, |
| 9 | especially how built-in objects like dictionaries and strings work, |
| 10 | have changed considerably, and a lot of deprecated features have finally |
| 11 | been removed. |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | 50e9fb9 | 2006-08-17 05:42:55 +0000 | [diff] [blame] | 13 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 14 | Build Instructions |
| 15 | ------------------ |
Guido van Rossum | 3ff96dd | 1996-07-30 18:05:04 +0000 | [diff] [blame] | 16 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 17 | On Unix, Linux, BSD, OSX, and Cygwin: |
| 18 | |
| 19 | ./configure |
| 20 | make |
| 21 | make test |
| 22 | sudo make install |
| 23 | |
| 24 | This will install Python as python3. |
| 25 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 26 | You can pass many options to the configure script; run "./configure --help" to |
| 27 | find out more. On OSX and Cygwin, the executable is called python.exe; |
| 28 | elsewhere it's just python. |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 29 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 30 | On Mac OS X, if you have configured Python with --enable-framework, you should |
| 31 | use "make frameworkinstall" to do the installation. Note that this installs the |
| 32 | Python executable in a place that is not normally on your PATH, you may want to |
| 33 | set up a symlink in /usr/local/bin. |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 34 | |
| 35 | On Windows, see PCbuild/readme.txt. |
| 36 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 37 | If you wish, you can create a subdirectory and invoke configure from there. |
| 38 | For example: |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 39 | |
| 40 | mkdir debug |
| 41 | cd debug |
| 42 | ../configure --with-pydebug |
| 43 | make |
| 44 | make test |
| 45 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 46 | (This will fail if you *also* built at the top-level directory. |
| 47 | You should do a "make clean" at the toplevel first.) |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 48 | |
Brett Cannon | 7188a3e | 2015-09-18 15:13:44 -0700 | [diff] [blame] | 49 | If you need an optimized version of Python, you type "make profile-opt" in the |
| 50 | top level directory. This will rebuild the interpreter executable using Profile |
| 51 | Guided Optimization (PGO). For more details, see the section bellow. |
| 52 | |
| 53 | |
| 54 | Profile Guided Optimization |
| 55 | --------------------------- |
| 56 | |
| 57 | PGO takes advantage of recent versions of the GCC or Clang compilers. |
| 58 | If ran, the "profile-opt" rule will do several steps. |
| 59 | |
| 60 | First, the entire Python directory is cleaned of temporary files that |
| 61 | may resulted in a previous compilation. |
| 62 | |
| 63 | Then, an instrumented version of the interpreter is built, using suitable |
| 64 | compiler flags for each flavour. Note that this is just an intermediary |
| 65 | step and the binary resulted after this step is not good for real life |
| 66 | workloads, as it has profiling instructions embedded inside. |
| 67 | |
| 68 | After this instrumented version of the interpreter is built, the Makefile |
| 69 | will automatically run a training workload. This is necessary in order to |
| 70 | profile the interpreter execution. Note also that any output, both stdout |
| 71 | and stderr, that may appear at this step is supressed. |
| 72 | |
| 73 | Finally, the last step is to rebuild the interpreter, using the information |
Martin Panter | cc71a79 | 2016-04-05 06:19:42 +0000 | [diff] [blame] | 74 | collected in the previous one. The end result will be a Python binary |
Brett Cannon | 7188a3e | 2015-09-18 15:13:44 -0700 | [diff] [blame] | 75 | that is optimized and suitable for distribution or production installation. |
| 76 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 77 | |
| 78 | What's New |
| 79 | ---------- |
| 80 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 81 | We have a comprehensive overview of the changes in the "What's New in |
Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 82 | Python 3.6" document, found at |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 83 | |
Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 84 | http://docs.python.org/3.6/whatsnew/3.6.html |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 85 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 86 | For a more detailed change log, read Misc/NEWS (though this file, too, |
| 87 | is incomplete, and also doesn't list anything merged in from the 2.7 |
| 88 | release under development). |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 89 | |
| 90 | If you want to install multiple versions of Python see the section below |
| 91 | entitled "Installing multiple versions". |
Guido van Rossum | 8d90f9d | 1997-05-22 20:13:25 +0000 | [diff] [blame] | 92 | |
Guido van Rossum | f501b4e | 1996-10-25 14:32:48 +0000 | [diff] [blame] | 93 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 +0000 | [diff] [blame] | 94 | Documentation |
| 95 | ------------- |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 +0000 | [diff] [blame] | 96 | |
Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 97 | Documentation for Python 3.6 is online, updated daily: |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 +0000 | [diff] [blame] | 98 | |
Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 99 | http://docs.python.org/3.6/ |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 +0000 | [diff] [blame] | 100 | |
Georg Brandl | 62069d3 | 2010-07-31 08:56:11 +0000 | [diff] [blame] | 101 | It can also be downloaded in many formats for faster access. The documentation |
| 102 | is downloadable in HTML, PDF, and reStructuredText formats; the latter version |
| 103 | is primarily for documentation authors, translators, and people with special |
| 104 | formatting requirements. |
Benjamin Peterson | 2a691a8 | 2008-03-31 01:51:45 +0000 | [diff] [blame] | 105 | |
Ezio Melotti | 802bf8a | 2013-08-16 21:32:25 +0300 | [diff] [blame] | 106 | If you would like to contribute to the development of Python, relevant |
| 107 | documentation is available at: |
| 108 | |
| 109 | http://docs.python.org/devguide/ |
| 110 | |
| 111 | For information about building Python's documentation, refer to Doc/README.txt. |
| 112 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 +0000 | [diff] [blame] | 113 | |
Barry Warsaw | 97f005d | 2008-12-03 16:46:14 +0000 | [diff] [blame] | 114 | Converting From Python 2.x to 3.x |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 115 | --------------------------------- |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 +0000 | [diff] [blame] | 116 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 117 | Python starting with 2.6 contains features to help locating code that needs to |
| 118 | be changed, such as optional warnings when deprecated features are used, and |
| 119 | backported versions of certain key Python 3.x features. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 +0000 | [diff] [blame] | 120 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 121 | A source-to-source translation tool, "2to3", can take care of the mundane task |
| 122 | of converting large amounts of source code. It is not a complete solution but |
| 123 | is complemented by the deprecation warnings in 2.6. See |
Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 124 | http://docs.python.org/3.6/library/2to3.html for more information. |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 125 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 126 | |
Benjamin Peterson | ad3d5c2 | 2009-02-26 03:38:59 +0000 | [diff] [blame] | 127 | Testing |
| 128 | ------- |
| 129 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 130 | To test the interpreter, type "make test" in the top-level directory. |
| 131 | The test set produces some output. You can generally ignore the messages |
| 132 | about skipped tests due to optional features which can't be imported. |
| 133 | If a message is printed about a failed test or a traceback or core dump |
| 134 | is produced, something is wrong. |
Benjamin Peterson | ad3d5c2 | 2009-02-26 03:38:59 +0000 | [diff] [blame] | 135 | |
| 136 | By default, tests are prevented from overusing resources like disk space and |
| 137 | memory. To enable these tests, run "make testall". |
| 138 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 139 | IMPORTANT: If the tests fail and you decide to mail a bug report, *don't* |
| 140 | include the output of "make test". It is useless. Run the failing test |
| 141 | manually, as follows: |
Benjamin Peterson | ad3d5c2 | 2009-02-26 03:38:59 +0000 | [diff] [blame] | 142 | |
Antoine Pitrou | e7fed67 | 2010-12-14 22:06:10 +0000 | [diff] [blame] | 143 | ./python -m test -v test_whatever |
Benjamin Peterson | ad3d5c2 | 2009-02-26 03:38:59 +0000 | [diff] [blame] | 144 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 145 | (substituting the top of the source tree for '.' if you built in a different |
| 146 | directory). This runs the test in verbose mode. |
Benjamin Peterson | ad3d5c2 | 2009-02-26 03:38:59 +0000 | [diff] [blame] | 147 | |
| 148 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 149 | Installing multiple versions |
| 150 | ---------------------------- |
| 151 | |
| 152 | On Unix and Mac systems if you intend to install multiple versions of Python |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 153 | using the same installation prefix (--prefix argument to the configure script) |
| 154 | you must take care that your primary python executable is not overwritten by the |
| 155 | installation of a different version. All files and directories installed using |
| 156 | "make altinstall" contain the major and minor version and can thus live |
| 157 | side-by-side. "make install" also creates ${prefix}/bin/python3 which refers to |
| 158 | ${prefix}/bin/pythonX.Y. If you intend to install multiple versions using the |
| 159 | same prefix you must decide which version (if any) is your "primary" version. |
| 160 | Install that version using "make install". Install all other versions using |
| 161 | "make altinstall". |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 162 | |
Ned Deily | ffb40e5 | 2015-05-27 22:00:46 -0700 | [diff] [blame] | 163 | For example, if you want to install Python 2.6, 2.7 and 3.6 with 2.7 being the |
Georg Brandl | fa2c61a | 2011-02-20 10:41:31 +0000 | [diff] [blame] | 164 | primary version, you would execute "make install" in your 2.7 build directory |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 165 | and "make altinstall" in the others. |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 166 | |
| 167 | |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 168 | Issue Tracker and Mailing List |
| 169 | ------------------------------ |
Michael W. Hudson | 71dcc3e | 2005-02-22 15:33:26 +0000 | [diff] [blame] | 170 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 171 | We're soliciting bug reports about all aspects of the language. Fixes are also |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 172 | welcome, preferably in unified diff format. Please use the issue tracker: |
Fred Drake | 6caae14 | 2000-10-25 17:51:02 +0000 | [diff] [blame] | 173 | |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 174 | http://bugs.python.org/ |
Guido van Rossum | 76be6ed | 1995-01-02 18:33:54 +0000 | [diff] [blame] | 175 | |
Georg Brandl | a02607e | 2010-07-31 11:00:47 +0000 | [diff] [blame] | 176 | If you're not sure whether you're dealing with a bug or a feature, use the |
| 177 | mailing list: |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 178 | |
Mark Dickinson | b9ebd04 | 2009-02-06 16:39:11 +0000 | [diff] [blame] | 179 | python-dev@python.org |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 180 | |
| 181 | To subscribe to the list, use the mailman form: |
| 182 | |
Mark Dickinson | b9ebd04 | 2009-02-06 16:39:11 +0000 | [diff] [blame] | 183 | http://mail.python.org/mailman/listinfo/python-dev/ |
Georg Brandl | 81299ad | 2006-02-20 10:24:06 +0000 | [diff] [blame] | 184 | |
Michael W. Hudson | 71dcc3e | 2005-02-22 15:33:26 +0000 | [diff] [blame] | 185 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 186 | Proposals for enhancement |
| 187 | ------------------------- |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 +0000 | [diff] [blame] | 188 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 189 | If you have a proposal to change Python, you may want to send an email to the |
Raymond Hettinger | a648339 | 2016-04-17 21:21:01 -0700 | [diff] [blame] | 190 | comp.lang.python or python-ideas mailing lists for initial feedback. A Python |
Georg Brandl | 260a788 | 2011-02-20 10:29:04 +0000 | [diff] [blame] | 191 | Enhancement Proposal (PEP) may be submitted if your idea gains ground. All |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 192 | current PEPs, as well as guidelines for submitting a new PEP, are listed at |
| 193 | http://www.python.org/dev/peps/. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 +0000 | [diff] [blame] | 194 | |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 195 | |
Benjamin Peterson | 1da43e5 | 2009-06-26 13:21:52 +0000 | [diff] [blame] | 196 | Release Schedule |
| 197 | ---------------- |
Guido van Rossum | 1c896e3 | 2007-08-29 23:03:30 +0000 | [diff] [blame] | 198 | |
Larry Hastings | 45d1c00 | 2015-08-25 14:21:59 -0700 | [diff] [blame] | 199 | See PEP 494 for release details: http://www.python.org/dev/peps/pep-0494/ |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 200 | |
| 201 | |
| 202 | Copyright and License Information |
| 203 | --------------------------------- |
| 204 | |
Georg Brandl | a7d2f00 | 2013-03-23 16:06:13 +0100 | [diff] [blame] | 205 | Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, |
Benjamin Peterson | f1dcdd9 | 2016-01-01 11:53:14 -0600 | [diff] [blame] | 206 | 2012, 2013, 2014, 2015, 2016 Python Software Foundation. All rights reserved. |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 207 | |
Georg Brandl | 260a788 | 2011-02-20 10:29:04 +0000 | [diff] [blame] | 208 | Copyright (c) 2000 BeOpen.com. All rights reserved. |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 209 | |
Georg Brandl | 260a788 | 2011-02-20 10:29:04 +0000 | [diff] [blame] | 210 | Copyright (c) 1995-2001 Corporation for National Research Initiatives. All |
| 211 | rights reserved. |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 212 | |
Georg Brandl | 260a788 | 2011-02-20 10:29:04 +0000 | [diff] [blame] | 213 | Copyright (c) 1991-1995 Stichting Mathematisch Centrum. All rights reserved. |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 214 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 215 | See the file "LICENSE" for information on the history of this software, |
| 216 | terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES. |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 217 | |
Larry Hastings | f92f6c8 | 2015-09-12 17:28:39 +0100 | [diff] [blame] | 218 | This Python distribution contains *no* GNU General Public License (GPL) code, |
| 219 | so it may be used in proprietary projects. There are interfaces to some GNU |
| 220 | code but these are entirely optional. |
Guido van Rossum | ef0f129 | 2007-08-30 14:51:05 +0000 | [diff] [blame] | 221 | |
Georg Brandl | 260a788 | 2011-02-20 10:29:04 +0000 | [diff] [blame] | 222 | All trademarks referenced herein are property of their respective holders. |