Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --all-extras flag to pip-compile #1630

Merged
merged 4 commits into from Oct 5, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 10 additions & 2 deletions piptools/scripts/compile.py
Expand Up @@ -401,6 +401,8 @@ def cli(
# Parsing/collecting initial requirements
###

extras = tuple(itertools.chain.from_iterable(ex.split(",") for ex in extras))

constraints: List[InstallRequirement] = []
setup_file_found = False
for src_file in src_files:
Expand Down Expand Up @@ -442,6 +444,14 @@ def cli(
for req in metadata.get_all("Requires-Dist") or []
]
)
# Since "*" is not a valid extra there is no risk confusing an actual extra
# for the wildcard.
# https://peps.python.org/pep-0508/#grammar
if "*" in extras:
atugushev marked this conversation as resolved.
Show resolved Hide resolved
if len(extras) != 1:
msg = "--extra=* only makes sense if it is the only --extra"
raise click.BadParameter(msg)
extras = tuple(metadata.get_all("Provides-Extra"))
else:
constraints.extend(
parse_requirements(
Expand All @@ -452,8 +462,6 @@ def cli(
)
)

extras = tuple(itertools.chain.from_iterable(ex.split(",") for ex in extras))

if extras and not setup_file_found:
msg = "--extra has effect only with setup.py and PEP-517 input formats"
raise click.BadParameter(msg)
Expand Down
38 changes: 38 additions & 0 deletions tests/test_cli_compile.py
Expand Up @@ -2190,6 +2190,44 @@ def test_multiple_extras(fake_dists, runner, make_module, fname, content, extra_
assert "extra ==" not in out.stderr


@pytest.mark.network
@pytest.mark.parametrize(("fname", "content"), METADATA_TEST_CASES)
def test_wildcard_extras(fake_dists, runner, make_module, fname, content):
"""
Test passing wildcard `--extra` includes all applicable extras.
"""
meta_path = make_module(fname=fname, content=content)
out = runner.invoke(
cli,
[
"-n",
"--extra",
"*",
"--find-links",
fake_dists,
"--no-annotate",
"--no-emit-options",
"--no-header",
meta_path,
],
)
assert out.exit_code == 0, out.stderr
assert (
dedent(
"""\
small-fake-a==0.1
small-fake-b==0.2
small-fake-c==0.3
small-fake-d==0.4
small-fake-e==0.5
small-fake-f==0.6
Dry-run, so nothing updated.
"""
ssbarnea marked this conversation as resolved.
Show resolved Hide resolved
)
== out.stderr
)


def test_extras_fail_with_requirements_in(runner, tmpdir):
"""
Test that passing `--extra` with `requirements.in` input file fails.
Expand Down