README.rst 9.1 KB
Newer Older
Ned Deily's avatar
Ned Deily committed
1 2
This is Python version 3.7.0 alpha 1
====================================
3

4 5 6 7
.. image:: https://travis-ci.org/python/cpython.svg?branch=master
   :alt: CPython build status on Travis CI
   :target: https://travis-ci.org/python/cpython

Zachary Ware's avatar
Zachary Ware committed
8 9 10 11
.. image:: https://ci.appveyor.com/api/projects/status/4mew1a93xdkbf5ua/branch/master?svg=true
   :alt: CPython build status on Appveyor
   :target: https://ci.appveyor.com/project/python/cpython/branch/master

12 13 14 15
.. image:: https://codecov.io/gh/python/cpython/branch/master/graph/badge.svg
   :alt: CPython code coverage on Codecov
   :target: https://codecov.io/gh/python/cpython

16
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011,
17 18
2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation.  All rights
reserved.
19

20 21
See the end of this file for further copyright and license information.

22 23
.. contents::

24 25 26 27 28 29 30
General Information
-------------------

- Website: https://www.python.org
- Source code: https://github.com/python/cpython
- Issue tracker: https://bugs.python.org
- Documentation: https://docs.python.org
31
- Developer's Guide: https://devguide.python.org/
32

33 34 35 36 37 38
Contributing to CPython
-----------------------

For more complete instructions on contributing to CPython development,
see the `Developer Guide`_.

39
.. _Developer Guide: https://devguide.python.org/
40

41 42 43 44 45 46 47 48
Using Python
------------

Installable Python kits, and information about using Python, are available at
`python.org`_.

.. _python.org: https://www.python.org/

49 50
Build Instructions
------------------
51

52
On Unix, Linux, BSD, macOS, and Cygwin::
Guido van Rossum's avatar
Guido van Rossum committed
53

54 55 56 57
    ./configure
    make
    make test
    sudo make install
58

59
This will install Python as python3.
60

61
You can pass many options to the configure script; run ``./configure --help``
62
to find out more.  On macOS and Cygwin, the executable is called ``python.exe``;
63
elsewhere it's just ``python``.
64

65
On macOS, if you have configured Python with ``--enable-framework``, you
66 67 68
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``.
69

70 71
On Windows, see `PCbuild/readme.txt
<https://github.com/python/cpython/blob/master/PCbuild/readme.txt>`_.
72

73
If you wish, you can create a subdirectory and invoke configure from there.
74
For example::
75 76 77 78 79 80 81

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

82 83
(This will fail if you *also* built at the top-level directory.  You should do
a ``make clean`` at the toplevel first.)
84

85 86 87 88 89
To get an optimized build of Python, ``configure --enable-optimizations``
before you run ``make``.  This sets the default make targets up to enable
Profile Guided Optimization (PGO) and may be used to auto-enable Link Time
Optimization (LTO) on some platforms.  For more details, see the sections
below.
90 91 92


Profile Guided Optimization
93
^^^^^^^^^^^^^^^^^^^^^^^^^^^
94

95 96
PGO takes advantage of recent versions of the GCC or Clang compilers.  If ran,
``make profile-opt`` will do several steps.
97

98 99
First, the entire Python directory is cleaned of temporary files that may have
resulted in a previous compilation.
100 101

Then, an instrumented version of the interpreter is built, using suitable
102 103 104
compiler flags for each flavour. Note that this is just an intermediary step
and the binary resulted after this step is not good for real life workloads, as
it has profiling instructions embedded inside.
105

106 107 108 109
After this instrumented version of the interpreter is built, the Makefile will
automatically run a training workload. This is necessary in order to profile
the interpreter execution. Note also that any output, both stdout and stderr,
that may appear at this step is suppressed.
110 111

Finally, the last step is to rebuild the interpreter, using the information
112 113
collected in the previous one. The end result will be a Python binary that is
optimized and suitable for distribution or production installation.
114

115

116
Link Time Optimization
117
^^^^^^^^^^^^^^^^^^^^^^
118

119 120 121 122
Enabled via configure's ``--with-lto`` flag.  LTO takes advantage of the
ability of recent compiler toolchains to optimize across the otherwise
arbitrary ``.o`` file boundary when building final executables or shared
libraries for additional performance gains.
123 124


125
What's New
126 127
----------

128 129 130
We have a comprehensive overview of the changes in the `What's New in Python
3.7 <https://docs.python.org/3.7/whatsnew/3.7.html>`_ document.  For a more
detailed change log, read `Misc/NEWS
131
<https://github.com/python/cpython/blob/master/Misc/NEWS.d>`_, but a full
132 133
accounting of changes can only be gleaned from the `commit history
<https://github.com/python/cpython/commits/master>`_.
134

135 136 137 138
If you want to install multiple versions of Python see the section below
entitled "Installing multiple versions".


139 140
Documentation
-------------
141

142 143
`Documentation for Python 3.7 <https://docs.python.org/3.7/>`_ is online,
updated daily.
144

145 146 147 148
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.
149

150 151
For information about building Python's documentation, refer to `Doc/README.rst
<https://github.com/python/cpython/blob/master/Doc/README.rst>`_.
152

153

Barry Warsaw's avatar
Barry Warsaw committed
154
Converting From Python 2.x to 3.x
155
---------------------------------
156

157 158 159 160
Significant backward incompatible changes were made for the release of Python
3.0, which may cause programs written for Python 2 to fail when run with Python
3.  For more information about porting your code from Python 2 to Python 3, see
the `Porting HOWTO <https://docs.python.org/3/howto/pyporting.html>`_.
161

Christian Heimes's avatar
Christian Heimes committed
162

163 164 165
Testing
-------

166 167 168 169 170
To test the interpreter, type ``make test`` in the top-level directory.  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 or core dump is produced,
something is wrong.
171 172

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

175
If any tests fail, you can re-run the failing test(s) in verbose mode::
176

177
    make test TESTOPTS="-v test_that_failed"
178

179 180 181
If the failure persists and appears to be a problem with Python rather than
your environment, you can `file a bug report <https://bugs.python.org>`_ and
include relevant output from that command to show the issue.
182 183


Christian Heimes's avatar
Christian Heimes committed
184 185 186 187
Installing multiple versions
----------------------------

On Unix and Mac systems if you intend to install multiple versions of Python
188 189 190 191 192 193 194 195 196
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
197

198
For example, if you want to install Python 2.7, 3.6, and 3.7 with 3.7 being the
199 200
primary version, you would execute ``make install`` in your 3.7 build directory
and ``make altinstall`` in the others.
Christian Heimes's avatar
Christian Heimes committed
201 202


203 204
Issue Tracker and Mailing List
------------------------------
205

206 207 208
Bug reports are welcome!  You can use the `issue tracker
<https://bugs.python.org>`_ to report bugs, and/or submit pull requests `on
GitHub <https://github.com/python/cpython>`_.
209

210 211
You can also follow development discussion on the `python-dev mailing list
<https://mail.python.org/mailman/listinfo/python-dev/>`_.
212

213

214 215
Proposals for enhancement
-------------------------
216

217
If you have a proposal to change Python, you may want to send an email to the
218 219 220
comp.lang.python or `python-ideas`_ mailing lists for initial feedback.  A
Python Enhancement Proposal (PEP) may be submitted if your idea gains ground.
All current PEPs, as well as guidelines for submitting a new PEP, are listed at
221
`python.org/dev/peps/ <https://www.python.org/dev/peps/>`_.
222

223
.. _python-ideas: https://mail.python.org/mailman/listinfo/python-ideas/
224

225

226 227
Release Schedule
----------------
228

229
See :pep:`537` for Python 3.7 release details.
230 231 232 233 234


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

Georg Brandl's avatar
Georg Brandl committed
235
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011,
236 237
2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation.  All rights
reserved.
238

239
Copyright (c) 2000 BeOpen.com.  All rights reserved.
240

241 242
Copyright (c) 1995-2001 Corporation for National Research Initiatives.  All
rights reserved.
243

244
Copyright (c) 1991-1995 Stichting Mathematisch Centrum.  All rights reserved.
245

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

249 250 251
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.
252

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