PEP-517 support #1356

orsinium · 2021-03-18T13:51:50Z

Changelog-friendly one-liner: Support for pyproject.toml as input dependency file (PEP-517).

If pyproject.toml is explicitly specified as input file, pip-compile will use it. Example:

pip-compile --output-file requirements.txt pyproject.toml

Included a simple test for flit

Closes #1047

Contributor checklist

Provided the tests for the changes.
Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

codecov · 2021-03-18T13:54:54Z

Codecov Report

Merging #1356 (6207ed9) into master (37946f2) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 6207ed9 differs from pull request most recent head e0a3b3d. Consider uploading reports for the commit e0a3b3d to get more accurate results

@@           Coverage Diff           @@
##           master    #1356   +/-   ##
=======================================
  Coverage   99.65%   99.65%           
=======================================
  Files          33       33           
  Lines        2915     2940   +25     
  Branches      308      308           
=======================================
+ Hits         2905     2930   +25     
  Misses          5        5           
  Partials        5        5

Impacted Files	Coverage Δ
piptools/scripts/compile.py	`100.00% <100.00%> (ø)`
tests/test_cli_compile.py	`100.00% <100.00%> (ø)`

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 37946f2...e0a3b3d. Read the comment docs.

piptools/scripts/compile.py

atugushev

Thanks for addressing the suggestion and adding a test 🙏🏻 A few comments below.

tests/test_cli_compile.py

tests/test_data/packages/flit_small_with_deps/module/__init__.py

tests/test_cli_compile.py

atugushev

Nice! One last thing. Could dedent be used alongside triple-quote strings? That helps to reduce extra indentations.

tests/test_cli_compile.py

atugushev · 2021-03-21T07:35:06Z

tests/test_cli_compile.py

+@pytest.mark.parametrize(
+    ("fname", "content"),
+    (
+        # setuptools


Could we use pytest.param(..., id='..') instead of comments? That improves pytest -v output.

Before:

tests/test_cli_compile.py::test_input_formats[setup.cfg-\n [metadata]\n name = sample_lib\n author = Vincent Driessen\n author_email = [email protected]\n\n [options]\n packages = find:\n install_requires =\n small-fake-a==0.1\n small-fake-b==0.2\n\n [options.extras_require]\n dev =\n small-fake-c==0.3\n small-fake-d==0.4\n test =\n small-fake-e==0.5\n small-fake-f==0.6\n ] PASSED [ 25%] tests/test_cli_compile.py::test_input_formats[setup.py-\n from setuptools import setup\n\n setup(\n name="sample_lib",\n version=0.1,\n install_requires=["small-fake-a==0.1", "small-fake-b==0.2"],\n extras_require={\n "dev": ["small-fake-c==0.3", "small-fake-d==0.4"],\n "test": ["small-fake-e==0.5", "small-fake-f==0.6"],\n },\n )\n ] PASSED [ 50%] tests/test_cli_compile.py::test_input_formats[pyproject.toml-\n [build-system]\n requires = ["flit_core >=2,<4"]\n build-backend = "flit_core.buildapi"\n\n [tool.flit.metadata]\n module = "sample_lib"\n author = "Vincent Driessen"\n author-email = "[email protected]"\n\n requires = ["small-fake-a==0.1", "small-fake-b==0.2"]\n\n [tool.flit.metadata.requires-extra]\n dev = ["small-fake-c==0.3", "small-fake-d==0.4"]\n test = ["small-fake-e==0.5", "small-fake-f==0.6"]\n ] PASSED [ 75%] tests/test_cli_compile.py::test_input_formats[pyproject.toml-\n [build-system]\n requires = ["poetry_core>=1.0.0"]\n build-backend = "poetry.core.masonry.api"\n\n [tool.poetry]\n name = "sample_lib"\n version = "0.1.0"\n description = ""\n authors = ["Vincent Driessen <[email protected]>"]\n\n [tool.poetry.dependencies]\n python = "*"\n small-fake-a = "0.1"\n small-fake-b = "0.2"\n\n small-fake-c = "0.3"\n small-fake-d = "0.4"\n small-fake-e = "0.5"\n small-fake-f = "0.6"\n\n [tool.poetry.extras]\n dev = ["small-fake-c", "small-fake-d"]\n test = ["small-fake-e", "small-fake-f"]\n ] PASSED [100%]

After:

tests/test_cli_compile.py::test_input_formats[setup.cfg] PASSED [ 25%] tests/test_cli_compile.py::test_input_formats[setup.py] PASSED tests/test_cli_compile.py::test_input_formats[flit] PASSED tests/test_cli_compile.py::test_input_formats[poetry] PASSED

Yep, great idea. Fixed 👍🏿

FYI another nice way to do this would be to add ids=('setup.cfg', 'setup.py'). Sometimes it's easier than embedding the ids into each param. But of course, it depends on the situation.

Good to know, thank you 👍🏿 I think in this situation it looks nice to have it per case.

webknjaz · 2021-03-22T12:29:43Z

tests/test_cli_compile.py

+        ),
+    ),
+)
+def test_input_formats(runner, tmpdir, fname, content):


tmpdir is sorta deprecated (well, at least there's a mention of it being replaced). It's always better to use tmp_path which does the same except it injects pathlib.Path objects instead of py.path which are nicer to work with.

Yep, I know. But all other tests in this file use tmpdir. I think it's better to keep it consistent and migrate all at once.

atugushev

LGTM 👍🏻

atugushev · 2021-03-22T16:16:17Z

@orsinium thanks for the contribution! Awesome job! 🎉

PEP-517 support

c2dc592

atugushev added enhancement Improvements to functionality setuptools Related to compiling requirements with `setuptools` build backend pep-517 Related to PEP-517 standard API labels Mar 19, 2021

atugushev reviewed Mar 19, 2021

View reviewed changes

piptools/scripts/compile.py Outdated Show resolved Hide resolved

setup.cfg support

52413f9

atugushev reviewed Mar 19, 2021

View reviewed changes

tests/test_cli_compile.py Outdated Show resolved Hide resolved

tests/test_data/packages/flit_small_with_deps/module/__init__.py Outdated Show resolved Hide resolved

tests/test_cli_compile.py Outdated Show resolved Hide resolved

parametrize tests, test poetry

b4ea45e

atugushev reviewed Mar 20, 2021

View reviewed changes

tests/test_cli_compile.py Show resolved Hide resolved

atugushev reviewed Mar 21, 2021

View reviewed changes

use pytest.param

a2d8425

webknjaz reviewed Mar 22, 2021

View reviewed changes

Merge remote-tracking branch 'jazzband/master' into pep517

58534ee

This comment has been minimized.

Sign in to view

generate fake packages

e0a3b3d

atugushev approved these changes Mar 22, 2021

View reviewed changes

webknjaz approved these changes Mar 22, 2021

View reviewed changes

atugushev added this to the 6.1.0 milestone Mar 22, 2021

atugushev merged commit bd9eab1 into jazzband:master Mar 22, 2021

orsinium deleted the pep517 branch March 23, 2021 07:21

orsinium mentioned this pull request Mar 24, 2021

Extra requirement support (extras_require) #1363

Merged

3 tasks

atugushev mentioned this pull request Mar 24, 2021

Release 6.1.0 #1362

Merged

2 tasks

kylebarron mentioned this pull request Mar 31, 2021

Remove requirements.in uber/h3-py#158

Open

atugushev mentioned this pull request Apr 4, 2021

test_input_formats failing on pypy3 #1375

Closed

orsinium mentioned this pull request Jun 22, 2021

A few corrections on deal beartype/beartype#35

Closed

flying-sheep mentioned this pull request Jul 28, 2022

New python manager for PEP621 renovatebot/renovate#10187

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PEP-517 support #1356

PEP-517 support #1356

orsinium commented Mar 18, 2021 •

edited by atugushev

Loading

codecov bot commented Mar 18, 2021 •

edited

Loading

atugushev left a comment

atugushev left a comment •

edited

Loading

atugushev Mar 21, 2021 •

edited

Loading

orsinium Mar 22, 2021

webknjaz Mar 22, 2021

orsinium Mar 22, 2021

webknjaz Mar 22, 2021

orsinium Mar 22, 2021

This comment has been minimized.

This comment has been minimized.

atugushev left a comment

atugushev commented Mar 22, 2021

PEP-517 support #1356

PEP-517 support #1356

Conversation

orsinium commented Mar 18, 2021 • edited by atugushev Loading

Contributor checklist

codecov bot commented Mar 18, 2021 • edited Loading

Codecov Report

atugushev left a comment

Choose a reason for hiding this comment

atugushev left a comment • edited Loading

Choose a reason for hiding this comment

atugushev Mar 21, 2021 • edited Loading

Choose a reason for hiding this comment

orsinium Mar 22, 2021

Choose a reason for hiding this comment

webknjaz Mar 22, 2021

Choose a reason for hiding this comment

orsinium Mar 22, 2021

Choose a reason for hiding this comment

webknjaz Mar 22, 2021

Choose a reason for hiding this comment

orsinium Mar 22, 2021

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

atugushev left a comment

Choose a reason for hiding this comment

atugushev commented Mar 22, 2021

orsinium commented Mar 18, 2021 •

edited by atugushev

Loading

codecov bot commented Mar 18, 2021 •

edited

Loading

atugushev left a comment •

edited

Loading

atugushev Mar 21, 2021 •

edited

Loading