Merge pull request #2253 from shifqu/fix/remove-opt-pep517

Implement compatibility with pip 25.3

Author: webknjaz

.github/workflows/ci.yml

@@ -124,6 +124,11 @@ jobs:
         #
         # Ref: https://github.com/tox-dev/tox/issues/3193
         run: tox -vv --notest -p auto --parallel-live
+      - name: Set PYTEST_ADDOPTS for py38
+        if: matrix.python-version == '3.8'
+        shell: bash
+        run: |
+          echo "PYTEST_ADDOPTS=--cov-fail-under=98" >> $GITHUB_ENV
       - name: Test pip ${{ matrix.pip-version }}
         # NOTE: `--parallel-live` is a workaround for the regression in
         # NOTE: the upstream tox project that made the

changelog.d/2252.feature.md

@@ -0,0 +1 @@
+pip-tools is now compatible with pip 25.3 -- by {user}`shifqu`.

changelog.d/2253.feature.md

@@ -0,0 +1 @@
+2252.feature.md

piptools/resolver.py

@@ -30,6 +30,7 @@
 from .exceptions import PipToolsError
 from .logging import log
 from .utils import (
+    PIP_VERSION,
     UNSAFE_PACKAGES,
     as_tuple,
     copy_install_requirement,
@@ -605,6 +606,11 @@ def resolve(self, max_rounds: int = 10) -> set[InstallRequirement]:
             }
             preparer = self.command.make_requirement_preparer(**preparer_kwargs)
 
+            extra_resolver_kwargs = {}
+            if PIP_VERSION[:2] < (25, 3):  # pragma: <3.9 cover
+                # Ref: https://github.com/jazzband/pip-tools/issues/2252
+                extra_resolver_kwargs["use_pep517"] = self.options.use_pep517
+
             resolver = self.command.make_resolver(
                 preparer=preparer,
                 finder=self.finder,
@@ -614,8 +620,8 @@ def resolve(self, max_rounds: int = 10) -> set[InstallRequirement]:
                 ignore_installed=True,
                 ignore_requires_python=False,
                 force_reinstall=False,
-                use_pep517=self.options.use_pep517,
                 upgrade_strategy="to-satisfy-only",
+                **extra_resolver_kwargs,
             )
 
             self.command.trace_basic_info(self.finder)

piptools/scripts/_deprecations.py

@@ -0,0 +1,48 @@
+"""Module to deprecate script arguments."""
+
+from __future__ import annotations
+
+from ..logging import log
+from ..utils import PIP_VERSION
+
+
+def filter_deprecated_pip_args(args: list[str]) -> list[str]:
+    """
+    Warn about and drop pip args that are no longer supported by pip.
+
+    Currently drops:
+
+    - ``--use-pep517``
+    - ``--no-use-pep517``
+    - ``--global-option``
+    - ``--build-option``
+    """
+    if PIP_VERSION < (25, 3):  # pragma: <3.9 cover
+        return args
+
+    deprecation_mapping = {
+        "--use-pep517": "Pip always uses PEP 517 for building projects now.",
+        "--no-use-pep517": "Pip always uses PEP 517 for building projects now.",
+        "--global-option": (
+            "--config-setting is now the only way to pass options to the build backend."
+        ),
+        "--build-option": (
+            "--config-setting is now the only way to pass options to the build backend."
+        ),
+    }
+    supported_args = []
+    for arg in args:
+        opt_key = arg.split("=")[0]
+        try:
+            warn_msg = deprecation_mapping[opt_key]
+        except KeyError:
+            supported_args.append(arg)
+        else:
+            log.warning(
+                "WARNING: "
+                f"{arg} is no longer supported by pip and is deprecated in pip-tools. "
+                "This option is ignored and will result in errors in a future release. "
+                f"{warn_msg}"
+            )
+
+    return supported_args

piptools/scripts/compile.py

@@ -31,6 +31,7 @@
 )
 from ..writer import OutputWriter
 from . import options
+from ._deprecations import filter_deprecated_pip_args
 from .options import BuildTargetT
 
 DEFAULT_REQUIREMENTS_FILES = (
@@ -287,6 +288,7 @@ def cli(
     if resolver_name == "backtracking" and cache_dir:
         pip_args.extend(["--cache-dir", cache_dir])
     pip_args.extend(right_args)
+    pip_args = filter_deprecated_pip_args(pip_args)
 
     repository: BaseRepository
     repository = PyPIRepository(pip_args, cache_dir=cache_dir)

piptools/scripts/sync.py

@@ -26,6 +26,7 @@
     get_sys_path_for_python_executable,
 )
 from . import options
+from ._deprecations import filter_deprecated_pip_args
 
 DEFAULT_REQUIREMENTS_FILE = "requirements.txt"
 
@@ -141,6 +142,8 @@ def cli(
         cert=cert,
         client_cert=client_cert,
     ) + shlex.split(pip_args_str or "")
+    install_flags = filter_deprecated_pip_args(install_flags)
+
     sys.exit(
         sync.sync(
             to_install,

piptools/utils.py

@@ -500,16 +500,23 @@ def copy_install_requirement(
         "editable": template.editable,
         "link": template.link,
         "markers": template.markers,
-        "use_pep517": template.use_pep517,
         "isolated": template.isolated,
-        "global_options": template.global_options,
         "hash_options": template.hash_options,
         "constraint": template.constraint,
         "extras": template.extras,
         "user_supplied": template.user_supplied,
     }
+    if PIP_VERSION[:2] < (25, 3):  # pragma: <3.9 cover
+        # Ref: https://github.com/jazzband/pip-tools/issues/2252
+        kwargs["use_pep517"] = template.use_pep517
+        kwargs["global_options"] = template.global_options
     kwargs.update(extra_kwargs)
 
+    if PIP_VERSION[:2] >= (25, 3):  # pragma: >=3.9 cover
+        # Ref: https://github.com/jazzband/pip-tools/issues/2252
+        kwargs.pop("use_pep517", None)
+        kwargs.pop("global_options", None)
+
     if PIP_VERSION[:2] <= (23, 0):
         kwargs["install_options"] = template.install_options
 

tests/conftest.py

@@ -3,6 +3,7 @@
 import json
 import os
 import platform
+import shutil
 import subprocess
 import sys
 from contextlib import contextmanager
@@ -266,26 +267,26 @@ def _make_pip_conf(content):
 
 
 @pytest.fixture
-def pip_conf(make_pip_conf):
+def pip_conf(make_pip_conf, minimal_wheels_path):
     return make_pip_conf(
         dedent(
             f"""\
             [global]
             no-index = true
-            find-links = {MINIMAL_WHEELS_PATH}
+            find-links = {minimal_wheels_path.as_posix()}
             """
         )
     )
 
 
 @pytest.fixture
-def pip_with_index_conf(make_pip_conf):
+def pip_with_index_conf(make_pip_conf, minimal_wheels_path):
     return make_pip_conf(
         dedent(
             f"""\
             [global]
             index-url = http://example.com
-            find-links = {MINIMAL_WHEELS_PATH}
+            find-links = {minimal_wheels_path.as_posix()}
             """
         )
     )
@@ -524,3 +525,32 @@ def _maker(
         return cast(Path, config_file.relative_to(tmpdir_cwd))
 
     return _maker
+
+
+@pytest.fixture(scope="session")
+def setuptools_wheel_path(tmp_path_factory):
+    """
+    Ensure setuptools is downloaded and return the path to the download directory.
+    """
+    tmp_wheels_path = tmp_path_factory.mktemp("tmp_wheels")
+    subprocess.check_call(
+        [
+            sys.executable,
+            "-Im",
+            "pip",
+            "download",
+            f"--dest={tmp_wheels_path.as_posix()}",
+            "--no-deps",
+            "setuptools",
+        ],
+    )
+    return tmp_wheels_path
+
+
+@pytest.fixture(scope="session")
+def minimal_wheels_path(setuptools_wheel_path):
+    """
+    Ensure minimal wheels and setuptools are downloaded and return the path.
+    """
+    shutil.copytree(MINIMAL_WHEELS_PATH, setuptools_wheel_path, dirs_exist_ok=True)
+    return setuptools_wheel_path

tests/test_cli_compile.py

@@ -5,6 +5,7 @@
 import os
 import pathlib
 import re
+import shlex
 import shutil
 import subprocess
 import sys
@@ -165,7 +166,7 @@ def test_command_line_overrides_pip_conf(pip_with_index_conf, runner):
     ),
 )
 def test_command_line_setuptools_read(
-    runner, make_package, install_requires, expected_output
+    runner, make_package, minimal_wheels_path, install_requires, expected_output
 ):
     package_dir = make_package(
         name="fake-setuptools-a",
@@ -177,7 +178,7 @@ def test_command_line_setuptools_read(
         (
             str(package_dir / "setup.py"),
             "--find-links",
-            MINIMAL_WHEELS_PATH,
+            minimal_wheels_path.as_posix(),
             "--no-build-isolation",
         ),
     )
@@ -1794,6 +1795,41 @@ def test_forwarded_args(PyPIRepository, runner):
     assert set(pip_args).issubset(set(args[0]))
 
 
+@pytest.mark.parametrize(
+    "pip_args",
+    (
+        pytest.param(
+            ("--use-pep517", "--global-option=build_ext"),
+            id="use-pep517 and global-option",
+        ),
+        pytest.param(
+            ("--no-use-pep517", "--build-option=build_ext"),
+            id="no-use-pep517 and build-option",
+        ),
+    ),
+)
+@mock.patch("piptools.scripts.compile.PyPIRepository")
+def test_forwarded_args_filter_deprecated(PyPIRepository, runner, pip_args):
+    """
+    Test the cli args (``--pip-args 'arg...'``) are filtered out if pip no longer supports them.
+    """
+    pathlib.Path("requirements.in").write_text("", encoding="utf-8")
+
+    cli_args = ("--no-annotate", "--generate-hashes")
+    runner.invoke(cli, [*cli_args, "--pip-args", shlex.join(pip_args)])
+    pip_option_keys = {pip_arg.split("=")[0] for pip_arg in pip_args}
+
+    (first_posarg, *_tail_args), _kwargs = PyPIRepository.call_args
+
+    pip_current_version = get_pip_version_for_python_executable(sys.executable)
+    pip_breaking_version = Version("25.3")
+
+    if pip_current_version >= pip_breaking_version:  # pragma: >=3.9 cover
+        assert set(first_posarg) ^ pip_option_keys
+    else:
+        assert set(first_posarg) & pip_option_keys
+
+
 @pytest.mark.parametrize(
     ("cli_option", "infile_option", "expected_package"),
     (
@@ -3430,7 +3466,12 @@ def test_pass_pip_cache_to_pip_args(tmpdir, runner, current_resolver):
 
 
 @backtracking_resolver_only
-def test_compile_recursive_extras_static(runner, tmp_path, current_resolver):
+def test_compile_recursive_extras_static(
+    runner,
+    tmp_path,
+    minimal_wheels_path,
+    current_resolver,
+):
     (tmp_path / "pyproject.toml").write_text(
         dedent(
             """
@@ -3454,7 +3495,7 @@ def test_compile_recursive_extras_static(runner, tmp_path, current_resolver):
             "--extra",
             "dev",
             "--find-links",
-            os.fspath(MINIMAL_WHEELS_PATH),
+            minimal_wheels_path.as_posix(),
             os.fspath(tmp_path / "pyproject.toml"),
             "--output-file",
             "-",
@@ -3474,7 +3515,9 @@ def test_compile_recursive_extras_static(runner, tmp_path, current_resolver):
 
 
 @backtracking_resolver_only
-def test_compile_recursive_extras_build_targets(runner, tmp_path, current_resolver):
+def test_compile_recursive_extras_build_targets(
+    runner, tmp_path, minimal_wheels_path, current_resolver
+):
     (tmp_path / "pyproject.toml").write_text(
         dedent(
             """
@@ -3500,7 +3543,7 @@ def test_compile_recursive_extras_build_targets(runner, tmp_path, current_resolv
             "--build-deps-for",
             "wheel",
             "--find-links",
-            os.fspath(MINIMAL_WHEELS_PATH),
+            minimal_wheels_path.as_posix(),
             os.fspath(tmp_path / "pyproject.toml"),
             "--output-file",
             "-",
@@ -3526,6 +3569,7 @@ def test_compile_recursive_extras_build_targets(runner, tmp_path, current_resolv
 def test_compile_build_targets_setuptools_no_wheel_dep(
     runner,
     tmp_path,
+    minimal_wheels_path,
     current_resolver,
 ):
     """Check that user requests apply to build dependencies.
@@ -3566,7 +3610,7 @@ def test_compile_build_targets_setuptools_no_wheel_dep(
             "--build-deps-for",
             "wheel",
             "--find-links",
-            os.fspath(MINIMAL_WHEELS_PATH),
+            minimal_wheels_path.as_posix(),
             os.fspath(tmp_path / "pyproject.toml"),
             "--constraint",
             os.fspath(tmp_path / "constraints.txt"),