Set python3 as default interpreter #3581

stsewd · 2018-02-06T22:08:40Z

This closes #3070

stsewd · 2018-02-06T22:14:35Z

Do I need to run migrations for this? If that is the case, probably we want to do another PR with the missing migrations right now before this one.

stsewd · 2018-02-06T22:31:15Z

readthedocs/projects/models.py

@@ -196,7 +196,7 @@ class Project(models.Model):
        _('Python Interpreter'),
        max_length=20,
        choices=constants.PYTHON_CHOICES,
-        default='python',
+        default='python3',
        help_text=_('(Beta) The Python interpreter used to create the virtual '


Can I remove the help text about being a beta feature?

Oh yeah, this copy should definitely change :)

agjohnson · 2018-02-09T13:20:26Z

This is a change we've been wanting to make for a while now, but it is blocked more on the operations and support side. If we don't want to jump into this change just yet, we can at least keep this PR sidelined for when we are close.

I think we want to eventually just force 3.6 (at least). So perhaps the order of how we merge things would look like:

Make our latest docker image the new 3.0 and make that the default. This image has 3.6
Update this PR to make 3.6 the default python interpreter
Merge and deploy this

There is also likely a change we should coordinate here with our configuration handling and we should make 3.6 the default there too.

humitos · 2018-03-23T18:19:27Z

Blocked on readthedocs/readthedocs-docker-images#62

agjohnson · 2018-06-08T20:51:43Z

Not blocked on readthedocs/readthedocs-docker-images#62, but this is blocked on making a change to our default image.

agjohnson · 2018-06-19T18:01:40Z

So, this will change the default interpreter for new projects, which is probably a safe place to start. We probably need to define a few more things though:

This will make the default database field 'python3', but have we tested what projects will get by default with the config parsing step? We do some weird things in both the rtd config parsing and the rtd-build config parsing where we rely on the default of the respective field value to assume the user hasn't defined anything special. Do we need to change anything here?
Do we need a default null value in this field instead?
Do we want to leave existing projects alone? I don't think there is any way we can determine whether a project is purposely selecting python as the interpreter or if it was just the default.
It sounds like we're waiting until at least the docker 3.0 image is selectable, we could probably target 3.6 instead of 3.5

ericholscher · 2018-06-26T13:54:23Z

Do we want to leave existing projects alone? I don't think there is any way we can determine whether a project is purposely selecting python as the interpreter or if it was just the default.

Yes. This should only be for projects going forward, not a change of existing configurations.

stsewd · 2018-08-22T17:58:23Z

With the config file v2, the default version is python3, v1 would respect the setting in the admin panel. This only affects new projects.

stsewd · 2018-08-22T18:03:32Z

docs/yaml-config.rst

@@ -135,7 +135,7 @@ used for building documentation.
 python.version
 ``````````````

-* Default: ``2.7``
+* Default: ``3.5``


This will be difficult to express... The actual default value here is the one from the admin panel

3.5 has some issues (#5051) we may want to default to 3.6 or even 3.7.x because

Python 3.6.8 is planned to be the last bugfix release for 3.6.x. Following the release of 3.6.8, we plan to provide security fixes for Python 3.6 as needed through 2021, five years following its initial release.

from https://www.python.org/downloads/release/python-368/

This is also a good excuse to upgrade our Docker images.

With our current release of docker images:

3.0 will default to py3.5

4.0 to py3.5

5.0rc1 to py3.6

So, I think we are fine here.

codecov · 2018-10-24T17:23:50Z

Codecov Report

Merging #3581 into master will decrease coverage by 0.48%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3581      +/-   ##
==========================================
- Coverage   76.74%   76.26%   -0.49%     
==========================================
  Files         158      158              
  Lines        9951    10034      +83     
  Branches     1244     1267      +23     
==========================================
+ Hits         7637     7652      +15     
- Misses       1980     2039      +59     
- Partials      334      343       +9

Impacted Files	Coverage Δ
readthedocs/projects/models.py	`84.07% <ø> (-1.49%)`	⬇️
readthedocs/builds/views.py	`85.71% <0%> (-10.29%)`	⬇️
readthedocs/builds/forms.py	`87.87% <0%> (-7.96%)`	⬇️
readthedocs/restapi/client.py	`82.35% <0%> (-5.53%)`	⬇️
readthedocs/vcs_support/backends/hg.py	`59.09% <0%> (-5.43%)`	⬇️
readthedocs/projects/utils.py	`54.54% <0%> (-4.55%)`	⬇️
readthedocs/restapi/views/integrations.py	`87.23% <0%> (-4.54%)`	⬇️
readthedocs/builds/models.py	`75.98% <0%> (-2.85%)`	⬇️
readthedocs/vcs_support/base.py	`88.67% <0%> (-1.89%)`	⬇️
readthedocs/vcs_support/backends/svn.py	`27.69% <0%> (-1.82%)`	⬇️
... and 38 more

stsewd · 2018-12-17T23:13:06Z

Sphinx 2.0 is deprecating python2 http://www.sphinx-doc.org/en/master/changes.html#incompatible-changes. Just a note in case we update sphinx first.

humitos

I want this to go out sooner than later.

This is a safe change considering that it will only affect new projects and won't touch existing ones.

Although, I'd prefer to upgrade our docker images before this PR gets merged and use 3.6 or probably 3.7 as default instead of 3.5.

humitos · 2019-01-02T09:48:28Z

docs/yaml-config.rst

@@ -135,7 +135,7 @@ used for building documentation.
 python.version
 ``````````````

-* Default: ``2.7``
+* Default: ``3.5``


3.5 has some issues (#5051) we may want to default to 3.6 or even 3.7.x because

Python 3.6.8 is planned to be the last bugfix release for 3.6.x. Following the release of 3.6.8, we plan to provide security fixes for Python 3.6 as needed through 2021, five years following its initial release.

from https://www.python.org/downloads/release/python-368/

This is also a good excuse to upgrade our Docker images.

humitos · 2019-01-02T14:21:01Z

Although, I'd prefer to upgrade our docker images before this PR gets merged and use 3.6 or probably 3.7 as default instead of 3.5.

I'm proposing some direction to achieve this goal at readthedocs/readthedocs-docker-images#84 but it involves some months before we get 3.7 working on the docker image (we have to release 4.0 first).

So, I suppose we can do this a smooth migration: first go with 3.6 and then with 3.7. Also, since we are setting only 3 as Python default version here, it will use the default python3 for the image itself. So, to upgrade to 3.7 we will only need to change the pyenv global (which currently is 3.6 https://github.com/rtfd/readthedocs-docker-images/blob/releases/3.x/Dockerfile#L84-L89 but it will be 3.7 after merging my PR)

davidfischer · 2019-01-02T16:50:40Z

Sphinx 2.0 is deprecating python2

Sphinx2 is doing a lot of things and I suspect there will be a number of incompatibilities (with our theme possibly but also lots of folks' docs). We will probably have to test this pretty extensively and perhaps have a milestone for it.

humitos · 2019-01-15T09:51:15Z

docs/yaml-config.rst

@@ -135,7 +135,7 @@ used for building documentation.
 python.version
 ``````````````

-* Default: ``2.7``
+* Default: ``3.5``
 * Options: ``2.7``, ``2``, ``3.5``, ``3``


I suppose that we should update this line to support 3.6 also.

humitos · 2019-01-15T09:54:56Z

I think we are almost ready to merge this PR.

new docker images shipped
default python in documentation is accurate
update docs for possible values with 3.6 (Config file v2 docs #4451)
update python code (YAML schema and Config object) to accept 3.6 as a value (Use latest docker images as default #5155)

Am I missing anything else here?

ericholscher

Everything looks good here 👍

humitos

I think that after updating the docs about the possible values for build.image we are ready to merge.

What I'm reading in the code does not match what we have written in the docs, but maybe I'm wrong.

docs/config-file/v1.rst

stsewd commented Feb 6, 2018

View reviewed changes

RichardLitt added the Status: blocked Issue is blocked on another issue label Feb 9, 2018

agjohnson added this to the 2.7 milestone Jun 8, 2018

stsewd force-pushed the python3-default-env branch from a72d1f2 to a4406db Compare June 14, 2018 17:15

agjohnson added the Needed: design decision A core team decision is required label Jun 19, 2018

stsewd force-pushed the python3-default-env branch from a4406db to 29e4fa0 Compare August 22, 2018 18:00

stsewd commented Aug 22, 2018

View reviewed changes

humitos mentioned this pull request Sep 6, 2018

Python3 as default interpreter for new projects #4613

Closed

stsewd force-pushed the python3-default-env branch from 8ba63f9 to 9198fbc Compare September 6, 2018 16:15

stsewd force-pushed the python3-default-env branch from 9198fbc to 03723df Compare October 4, 2018 19:32

stsewd added 4 commits October 24, 2018 12:14

Set python3 as default environment

2cf1478

Update tests

95b6379

Update docs

385c83e

Update test

4f4fd67

stsewd force-pushed the python3-default-env branch from 03723df to 4f4fd67 Compare October 24, 2018 17:14

stsewd mentioned this pull request Oct 27, 2018

Deprecation list Jan 2019 & RTD v3.0 #4594

Closed

agjohnson modified the milestones: 2.10, 3.0 Nov 10, 2018

Merge branch 'master' into python3-default-env

69e5457

Add migration

5c8852a

humitos reviewed Jan 2, 2019

View reviewed changes

humitos mentioned this pull request Jan 3, 2019

Support Sphinx2 #5064

Closed

This was referenced Jan 13, 2019

Post on defaulting to Python 3 readthedocs/blog#57

Merged

Default to py3 for new conda projects readthedocs/readthedocs-docker-images#86

Closed

humitos reviewed Jan 15, 2019

View reviewed changes

humitos added Accepted Accepted issue on our roadmap and removed Needed: design decision A core team decision is required Status: blocked Issue is blocked on another issue labels Jan 15, 2019

stsewd added 2 commits January 22, 2019 18:46

Merge branch 'master' into python3-default-env

87d4b5c

Fix migration

08f118b

agjohnson modified the milestones: 3.0, 3.2 Jan 25, 2019

stsewd added 3 commits February 4, 2019 11:27

Merge branch 'master' into python3-default-env

fb32062

Update versions

b202b1e

Fix test

5406896

ericholscher previously approved these changes Feb 4, 2019

View reviewed changes

humitos requested changes Feb 5, 2019

View reviewed changes

docs/config-file/v1.rst Show resolved Hide resolved

docs/config-file/v1.rst Outdated Show resolved Hide resolved

Only list stable and latest for config v1

d4441c6

stsewd dismissed ericholscher’s stale review via d4441c6 February 6, 2019 15:48

stsewd requested a review from a team February 6, 2019 16:09

humitos approved these changes Feb 6, 2019

View reviewed changes

stsewd merged commit 5e2c781 into readthedocs:master Feb 6, 2019

stsewd deleted the python3-default-env branch February 6, 2019 16:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set python3 as default interpreter #3581

Set python3 as default interpreter #3581

stsewd commented Feb 6, 2018

stsewd commented Feb 6, 2018

stsewd Feb 6, 2018

agjohnson Feb 13, 2018

agjohnson commented Feb 9, 2018

humitos commented Mar 23, 2018

agjohnson commented Jun 8, 2018

agjohnson commented Jun 19, 2018

ericholscher commented Jun 26, 2018

stsewd commented Aug 22, 2018

stsewd Aug 22, 2018

humitos Jan 2, 2019

humitos Jan 15, 2019

codecov bot commented Oct 24, 2018 •

edited

Loading

stsewd commented Dec 17, 2018

humitos left a comment

humitos Jan 2, 2019

humitos commented Jan 2, 2019

davidfischer commented Jan 2, 2019

humitos Jan 15, 2019

humitos commented Jan 15, 2019 •

edited by ericholscher

Loading

ericholscher left a comment

humitos left a comment

Set python3 as default interpreter #3581

Set python3 as default interpreter #3581

Conversation

stsewd commented Feb 6, 2018

stsewd commented Feb 6, 2018

stsewd Feb 6, 2018

Choose a reason for hiding this comment

agjohnson Feb 13, 2018

Choose a reason for hiding this comment

agjohnson commented Feb 9, 2018

humitos commented Mar 23, 2018

agjohnson commented Jun 8, 2018

agjohnson commented Jun 19, 2018

ericholscher commented Jun 26, 2018

stsewd commented Aug 22, 2018

stsewd Aug 22, 2018

Choose a reason for hiding this comment

humitos Jan 2, 2019

Choose a reason for hiding this comment

humitos Jan 15, 2019

Choose a reason for hiding this comment

codecov bot commented Oct 24, 2018 • edited Loading

Codecov Report

stsewd commented Dec 17, 2018

humitos left a comment

Choose a reason for hiding this comment

humitos Jan 2, 2019

Choose a reason for hiding this comment

humitos commented Jan 2, 2019

davidfischer commented Jan 2, 2019

humitos Jan 15, 2019

Choose a reason for hiding this comment

humitos commented Jan 15, 2019 • edited by ericholscher Loading

ericholscher left a comment

Choose a reason for hiding this comment

humitos left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 24, 2018 •

edited

Loading

humitos commented Jan 15, 2019 •

edited by ericholscher

Loading