Groundwork for supporting PEP-518/`pyproject.toml` #577

ntninja · 2017-08-14T19:24:21Z

This PR currently adds two new options:

install_setuptools (defaulting to True) to the per-testenv settings
venvsdist (defaulting to False) to the global tox settings

When venvsdist is True and a sdist is to be created then tox will provision a new virtual environment and run ./setup.py sdist in there. All settings for that environment (except changedir, commands & list_dependencies_command) can be tweaked using the new toxenv:sdist configuration section.

(All new introduced names are ofc subject to change at your leisure.)

.

Here's a quick checklist of things that will be done once the current set of changes has been ACK'ed:

Make sure to include one or more tests for your change;
if an enhancement PR please create docs and at best an example
Add yourself to CONTRIBUTORS;
make a descriptive Pull Request text (it will be used for changelog)

gaborbernat · 2017-08-14T21:44:56Z

@Alexander255 it's hard to accept this without any unit tests to demonstrate the new features

ntninja · 2017-08-14T22:01:33Z

I didn't ask you to, but I first want a confirmation that these changes will be accepted in principle (or comments on how to improve the current design), before I go through the trouble of writing tests & documentation.

gaborbernat

I would say looks good at a high level; but would want to not have groundwork but instead one PR adding the support as a whole. Will review and support with the testing, so go ahead and add tests.

gaborbernat · 2017-08-17T16:53:44Z

tox/config.py

@@ -809,10 +840,11 @@ def _list_section_factors(self, section):
                factors.update(*mapcat(_split_factor_expr, exprs))
        return factors

-    def make_envconfig(self, name, section, subs, config, replace=True):
+    def make_envconfig(self, name, section, subs, config, replace=True,


note that the list here is globally change-able; you probably want to default to None, and if it's none then locally swap to "testenv"

gaborbernat · 2017-08-17T16:56:07Z

tox/venv.py

@@ -178,7 +186,7 @@ def update(self, action):
                self.envconfig.deps, v)

    def _getliveconfig(self):
-        python = self.envconfig.python_info.executable
+        python = str(self.envconfig.python_info.executable)


care to detail why you need to wrap?

Not sure why this was necessary, but I cannot reproduce the test failure that had been fixed during development of this comment. Thanks for pointing this out!

obestwalter · 2017-09-09T23:04:30Z

I have been thinkiing a lot recently about how we can make tox live long and prosper and IMHO extending the core to provide more hooks to make extensions like this possible is the way to go. That way the core won't get bloated and there is lots of room to experiment and extend without having to wait for PRs merged. I will concentrate on making that possible and so I would not merge this PR but rather work towards that functionality like this can be implemented fully as a plugin.

The essence of this PR could then be used to implement this functionality.

gaborbernat · 2017-12-01T10:05:29Z

@Alexander255 I've recently got into the details of PEP-518 and PEP-517, so I'll partner on with this. Can you fixup the merge conflicts? And let's see how we can do this.

…ools` & `wheel` will be installed into a given environment

…v.CreationConfig`

…p.py sdist` command sandboxed into a `virtualenv`

codecov · 2017-12-07T13:22:15Z

Codecov Report

Merging #577 into master will increase coverage by 2.37%.
The diff coverage is 74.02%.

@@            Coverage Diff             @@
##           master     #577      +/-   ##
==========================================
+ Coverage    89.5%   91.88%   +2.37%     
==========================================
  Files          11       11              
  Lines        2383     2441      +58     
  Branches      405      419      +14     
==========================================
+ Hits         2133     2243     +110     
- Misses        175      198      +23     
+ Partials       75        0      -75

Impacted Files	Coverage Δ
tox/session.py	`91.42% <64%> (-0.22%)`	⬇️
tox/venv.py	`95.45% <92.3%> (+2.93%)`	⬆️
tox/config.py	`97.42% <92.85%> (+2.52%)`	⬆️
tox/__main__.py	`0% <0%> (ø)`	⬆️
tox/interpreters.py	`61.71% <0%> (+2.34%)`	⬆️
tox/_pytestplugin.py	`93.92% <0%> (+4.04%)`	⬆️
tox/_quickstart.py	`82.75% <0%> (+5.13%)`	⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9bbcabd...5ccad40. Read the comment docs.

gaborbernat · 2017-12-15T15:01:26Z

I've been pondering over this the last few weeks, and the more I think about this I think conceptually neither PEP-517 and PEP-518 are tox responsibility.

They fall into the pip and setuptools. tox is about creating the virtual environments and running the commands. How the package is built is handled by setuptools, how the packages are installed is handled by pip. So instead adding it to our project I think we should focus on adding these to those projects.

@obestwalter what do you think?

obestwalter · 2017-12-15T16:00:37Z

Hi @gaborbernat, might be the case, but I would have to look at what this PR is actually trying to accomplish in detail. I would not merge this into core though even when it makes sense. I would rather work towards making it possible to have this as a plugin. core is already messy enough.

How the package is built is handled by setuptools, how the packages are installed is handled by pip. So instead adding it to our project I think we should focus on adding these to those projects.

To that I agree - or to say it more generalized: How the package is built is handled by the build tool (e.g. setuptools) how the packages are installed is handled by the package manager (e.g. pip or conda). So instead adding it to our project I think we should focus on adding these to those projects.

aragilar · 2017-12-17T22:41:31Z

The main problem I run into when setting up tox is dealing with non-setuptools build systems (primarily numpy.distutils, but widespread use of flit is also blocked by this). Pip (or conda) doesn't solve this either, as it's always the sdist component that is problematic (as sdist->wheel/install can be worked around by adding build deps to envs), not the install part. There's a bunch of related issues, which are solved by supporting PEP-518 (e.g. #573, #507, #350, #232). As long as there's no hooks or options to control the sdist process, tox blocks progress in making python packaging better. I'm happy to help with adding hooks and other improvements, but as an outsider I can't see any kind of plan to fix this, and the suggestion to implement this as a plugin seems to gloss over how much this is going to affect (e.g. what happens when use_develop specified)?

gaborbernat · 2017-12-17T23:31:25Z

@aragilar you are correct; and thinking this through here's my current plan:

PEP-518 is for build dependencies
for build system choice the solution is PEP-517 (flit, numpy.distutils) etc.

From tox side now we use ``python setup.py sdist``` to build and then install that with pip into the envs. Instead what we would need to do, first create a venv for building, do PEP-518 file support, install build dependencies; then use the API defined in PEP-517 to create the package, and then feed that to pip, as we do beforehand.

A small side note, build requires is the build tool itself (e.g. flint, setuptools). The build systems may then install further dependencies to build, these are the packages of setup requires (e.g. setuptools_scm). I'm going to create a POC for these the next week inside tox.

gaborbernat · 2017-12-22T10:35:17Z

For anyone wondering on the status of this, as a POC (either a playground to test out the rough edges of what this would mean for tox, or as a separate project) I've started doing tox3. It contains a lot of divergences from this (e.g. venv support - fallback to virtualenv, pyproject.toml configuration instead of tox.ini, PEP 517/518 support, asyncio driver - yeah Python 3.6 only runner, but can create python 2 envs) but will come back once I have something usable. WIP - https://github.com/gaborbernat/toxn.

gaborbernat · 2018-04-15T11:01:07Z

Drawing from the experience implementing this in toxn (and with pip 10 coming out with PEP-518 support too), I'll add support for this in the next month via another PR. Given the merge conflicts I think it's easier to start clean. For people interested can follow via #573.

ntninja force-pushed the master branch from 245da5b to 65eb3cb Compare August 14, 2017 19:40

ntninja mentioned this pull request Aug 14, 2017

Add support for PEP-517 #573

Closed

gaborbernat requested changes Aug 17, 2017

View reviewed changes

obestwalter added the feature:new something does not exist yet, but should label Aug 22, 2017

ntninja force-pushed the master branch 2 times, most recently from 6a4d3c8 to 9f3df33 Compare August 23, 2017 20:23

obestwalter added the needs:work for PRs: not quite there and needs some changes label Sep 4, 2017

gaborbernat assigned ntninja and gaborbernat Dec 1, 2017

ntninja added 3 commits December 7, 2017 13:06

Add the install_setuptools testenv option to manage whether `setupt…

bb92fdb

…ools` & `wheel` will be installed into a given environment

Add debugging string representation for config.TestenvConfig & `ven…

9f6ec0b

…v.CreationConfig`

Add the global venvsdist option that will run the project's `./setu…

7df1611

…p.py sdist` command sandboxed into a `virtualenv`

ntninja force-pushed the master branch from 9f3df33 to 23204cf Compare December 7, 2017 12:53

Add test for the install_setuptools testenv option

5ccad40

ntninja force-pushed the master branch from 23204cf to 5ccad40 Compare December 7, 2017 13:22

gaborbernat closed this Apr 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Groundwork for supporting PEP-518/`pyproject.toml` #577

Groundwork for supporting PEP-518/`pyproject.toml` #577

ntninja commented Aug 14, 2017

gaborbernat commented Aug 14, 2017

ntninja commented Aug 14, 2017

gaborbernat left a comment

gaborbernat Aug 17, 2017

ntninja Aug 23, 2017

gaborbernat Aug 17, 2017

ntninja Aug 23, 2017

obestwalter commented Sep 9, 2017 •

edited

Loading

gaborbernat commented Dec 1, 2017

codecov bot commented Dec 7, 2017 •

edited

Loading

gaborbernat commented Dec 15, 2017 •

edited

Loading

obestwalter commented Dec 15, 2017

aragilar commented Dec 17, 2017

gaborbernat commented Dec 17, 2017

gaborbernat commented Dec 22, 2017 •

edited

Loading

gaborbernat commented Apr 15, 2018

Groundwork for supporting PEP-518/pyproject.toml #577

Groundwork for supporting PEP-518/pyproject.toml #577

Conversation

ntninja commented Aug 14, 2017

gaborbernat commented Aug 14, 2017

ntninja commented Aug 14, 2017

gaborbernat left a comment

Choose a reason for hiding this comment

gaborbernat Aug 17, 2017

Choose a reason for hiding this comment

ntninja Aug 23, 2017

Choose a reason for hiding this comment

gaborbernat Aug 17, 2017

Choose a reason for hiding this comment

ntninja Aug 23, 2017

Choose a reason for hiding this comment

obestwalter commented Sep 9, 2017 • edited Loading

gaborbernat commented Dec 1, 2017

codecov bot commented Dec 7, 2017 • edited Loading

Codecov Report

gaborbernat commented Dec 15, 2017 • edited Loading

obestwalter commented Dec 15, 2017

aragilar commented Dec 17, 2017

gaborbernat commented Dec 17, 2017

gaborbernat commented Dec 22, 2017 • edited Loading

gaborbernat commented Apr 15, 2018

Groundwork for supporting PEP-518/`pyproject.toml` #577

Groundwork for supporting PEP-518/`pyproject.toml` #577

obestwalter commented Sep 9, 2017 •

edited

Loading

codecov bot commented Dec 7, 2017 •

edited

Loading

gaborbernat commented Dec 15, 2017 •

edited

Loading

gaborbernat commented Dec 22, 2017 •

edited

Loading