Merge pull request #2260 from sirosen/improve-relpath-handling

Fix pip-compile handling of `-r` paths which are not subpaths of the cwd

Author: webknjaz

changelog.d/2231.bugfix.md

@@ -0,0 +1,2 @@
+Fixed `pip-compile` to handle relative path includes which are not subpaths of
+the current working directory -- by {user}`sirosen`.

changelog.d/2260.bugfix.md

@@ -0,0 +1 @@
+2231.bugfix.md

piptools/_compat/path_compat.py

@@ -0,0 +1,27 @@
+"""
+Compatibility helpers for working with paths and :mod:`pathlib` across platforms
+and Python versions.
+"""
+
+from __future__ import annotations
+
+import os.path
+import pathlib
+import sys
+
+__all__ = ("relative_to_walk_up",)
+
+
+def relative_to_walk_up(path: pathlib.Path, start: pathlib.Path) -> pathlib.Path:
+    """
+    Compute a relative path allowing for the input to not be a subpath of the start.
+
+    This is a compatibility helper for ``pathlib.Path.relative_to(..., walk_up=True)``
+    on all Python versions. (``walk_up: bool`` is Python 3.12+)
+    """
+    # prefer `pathlib.Path.relative_to` where available
+    if sys.version_info >= (3, 12):
+        return path.relative_to(start, walk_up=True)
+
+    str_result = os.path.relpath(path, start=start)
+    return pathlib.Path(str_result)

piptools/_compat/pip_compat.py

@@ -18,6 +18,8 @@
 from pip._internal.req.constructors import install_req_from_parsed_requirement
 from pip._vendor.pkg_resources import Requirement
 
+from .path_compat import relative_to_walk_up
+
 # The Distribution interface has changed between pkg_resources and
 # importlib.metadata, so this compat layer allows for a consistent access
 # pattern. In pip 22.1, importlib.metadata became the default on Python 3.11
@@ -152,7 +154,7 @@ def _relativize_comes_from_location(original_comes_from: str, /) -> str:
         return f"{prefix} {file_path.as_posix()}"
 
     # make it relative to the current working dir
-    suffix = file_path.relative_to(pathlib.Path.cwd()).as_posix()
+    suffix = relative_to_walk_up(file_path, pathlib.Path.cwd()).as_posix()
     return f"{prefix}{space_sep}{suffix}"
 
 

tests/test_cli_compile.py

@@ -65,9 +65,11 @@ class TestFilesCollection:
     """
 
     # the name for the collection of files
-    name: str
+    name: str = "<unnamed test file collection>"
     # static or computed contents
-    contents: dict[str, str | typing.Callable[[pathlib.Path], str]]
+    contents: dict[str, str | typing.Callable[[pathlib.Path], str]] = dataclasses.field(
+        default_factory=dict
+    )
 
     def __str__(self) -> str:
         return self.name
@@ -4047,6 +4049,50 @@ def test_second_order_requirements_relative_path_in_separate_dir(
     )
 
 
+def test_second_order_requirements_can_be_in_parent_of_cwd(
+    pip_conf,
+    runner,
+    tmp_path,
+    monkeypatch,
+    pip_produces_absolute_paths,
+):
+    """
+    Test handling of ``-r`` includes when the included requirements file is in the
+    parent of the current working directory.
+    """
+    test_files_collection = TestFilesCollection(
+        contents={
+            "subdir1/requirements.in": "-r ../requirements2.in\n",
+            "requirements2.in": "small-fake-a\n",
+        }
+    )
+    test_files_collection.populate(tmp_path)
+
+    with monkeypatch.context() as revertable_ctx:
+        # cd into the subdir where the initial requirements are
+        revertable_ctx.chdir(tmp_path / "subdir1")
+        out = runner.invoke(
+            cli,
+            [
+                "--output-file",
+                "-",
+                "--quiet",
+                "--no-header",
+                "--no-emit-options",
+                "-r",
+                "requirements.in",
+            ],
+        )
+
+    assert out.exit_code == 0
+    assert out.stdout == dedent(
+        """\
+        small-fake-a==0.2
+            # via -r ../requirements2.in
+        """
+    )
+
+
 @pytest.mark.parametrize(
     "input_path_absolute", (True, False), ids=("absolute-input", "relative-input")
 )