-r pylock: handle relative paths

Author: sbidoul

src/pip/_internal/req/constructors.py

@@ -31,6 +31,13 @@
 from pip._internal.utils.filetypes import is_archive_file
 from pip._internal.utils.misc import is_installable_dir
 from pip._internal.utils.packaging import get_requirement
+from pip._internal.utils.pylock import (
+    package_archive_url,
+    package_directory_url,
+    package_sdist_url,
+    package_vcs_url,
+    package_wheel_url,
+)
 from pip._internal.utils.urls import path_to_url
 from pip._internal.vcs import is_url, vcs
 
@@ -572,34 +579,6 @@ def install_req_extend_extras(
     return result
 
 
-def _url_from_path_and_url(path: str | None, url: str | None) -> str:
-    if path:
-        return path_to_url(path)
-    else:
-        assert url  # guaranteed by pylock validation
-        return url
-
-
-def _url_from_package_vcs(package_vcs: pylock.PackageVcs) -> str:
-    url = (
-        package_vcs.type
-        + "+"
-        + _url_from_path_and_url(package_vcs.path, package_vcs.url)
-        + "@"
-        + package_vcs.commit_id
-    )
-    if package_vcs.subdirectory:
-        url += "#" + package_vcs.subdirectory
-    return url
-
-
-def _url_from_package_archive(package_archive: pylock.PackageArchive) -> str:
-    url = _url_from_path_and_url(package_archive.path, package_archive.url)
-    if package_archive.subdirectory:
-        url += "#" + package_archive.subdirectory
-    return url
-
-
 def _pylock_hashes_to_hash_options(hashes: Mapping[str, str]) -> dict[str, list[str]]:
     return {k: [v] for k, v in hashes.items()}
 
@@ -613,33 +592,37 @@ def install_req_from_pylock_package(
         | pylock.PackageSdist
         | pylock.PackageWheel
     ),
-    comes_from: str | None,
+    comes_from: str,
 ) -> InstallRequirement:
     pass
-    # TODO no binary -> use package.sdist
-    # TODO package.index
-    # TODO user_supplied
-    # TODO validate file size?
+    # TODO: no binary -> use package.sdist
+    # TODO: package.index
+    # TODO: user_supplied
+    # TODO: validate file size?
     if isinstance(package_dist, pylock.PackageVcs):
         return InstallRequirement(
-            req=Requirement(f"{package.name} @ {_url_from_package_vcs(package_dist)}"),
+            req=Requirement(
+                f"{package.name} @ {package_vcs_url(comes_from, package_dist)}"
+            ),
             comes_from=comes_from,
         )
     elif isinstance(package_dist, pylock.PackageArchive):
         return InstallRequirement(
             req=Requirement(
-                f"{package.name} @ {_url_from_package_archive(package_dist)}"
+                f"{package.name} @ {package_archive_url(comes_from, package_dist)}"
             ),
             comes_from=comes_from,
             hash_options=_pylock_hashes_to_hash_options(package_dist.hashes),
         )
     elif isinstance(package_dist, pylock.PackageDirectory):
-        # TODO subdirectory
         if package_dist.editable:
-            return install_req_from_editable(package_dist.path, comes_from=comes_from)
+            return install_req_from_editable(
+                package_directory_url(comes_from, package_dist), comes_from=comes_from
+            )
         else:
-            # TODO this may interpret the path as a requirement
-            return install_req_from_line(package_dist.path, comes_from=comes_from)
+            return install_req_from_line(
+                package_directory_url(comes_from, package_dist), comes_from=comes_from
+            )
     elif isinstance(package_dist, pylock.PackageSdist):
         if package.version:
             version = package.version
@@ -648,7 +631,7 @@ def install_req_from_pylock_package(
         ireq = InstallRequirement(
             req=Requirement(f"{package.name}=={str(version)}"),
             comes_from=comes_from,
-            link=Link(_url_from_path_and_url(package_dist.path, package_dist.url)),
+            link=Link(package_sdist_url(comes_from, package_dist)),
             hash_options=_pylock_hashes_to_hash_options(package_dist.hashes),
         )
         ireq.original_link = None  # not a direct URL
@@ -661,7 +644,7 @@ def install_req_from_pylock_package(
         ireq = InstallRequirement(
             req=Requirement(f"{package.name}=={str(version)}"),
             comes_from=comes_from,
-            link=Link(_url_from_path_and_url(package_dist.path, package_dist.url)),
+            link=Link(package_wheel_url(comes_from, package_dist)),
             hash_options=_pylock_hashes_to_hash_options(package_dist.hashes),
         )
         ireq.original_link = None  # not a direct URL

src/pip/_internal/utils/pylock.py

@@ -1,5 +1,10 @@
+from __future__ import annotations
+
+import os
+import re
 from collections.abc import Iterable
 from pathlib import Path
+from urllib.parse import urljoin
 
 from pip._vendor.packaging.pylock import (
     Package,
@@ -15,7 +20,7 @@
 from pip._internal.models.direct_url import ArchiveInfo, DirInfo, VcsInfo
 from pip._internal.models.link import Link
 from pip._internal.req.req_install import InstallRequirement
-from pip._internal.utils.urls import url_to_path
+from pip._internal.utils.urls import path_to_url, url_to_path
 
 
 def _pylock_package_from_install_requirement(
@@ -114,3 +119,87 @@ def pylock_from_install_requirements(
             key=lambda p: p.name,
         ),
     )
+
+
+_SCHEME_RE = re.compile("^(http|https|file)://", re.IGNORECASE)
+
+
+def _is_url(s: str) -> bool:
+    return bool(_SCHEME_RE.match(s))
+
+
+def _package_dist_url(
+    pylock_filename_or_url: str,
+    path: str | None,
+    url: str | None,
+) -> str:
+    """Compute an url from a Pylock package path and url.
+
+    Give priority to path over url. If path is relative,
+    compute an url using the pylock file location as base.
+    """
+    if path is not None:
+        if not os.path.isabs(path):
+            if _is_url(pylock_filename_or_url):
+                return urljoin(pylock_filename_or_url, path)
+            else:
+                return path_to_url(
+                    os.path.join(os.path.dirname(pylock_filename_or_url), path)
+                )
+        else:
+            return path_to_url(path)
+    else:
+        assert url is not None  # guaranteed by packaging.pylock validation
+        return url
+
+
+def package_vcs_url(pylock_filename_or_url: str, package_vcs: PackageVcs) -> str:
+    url = (
+        package_vcs.type
+        + "+"
+        + _package_dist_url(pylock_filename_or_url, package_vcs.path, package_vcs.url)
+        + "@"
+        + package_vcs.commit_id
+    )
+    if package_vcs.subdirectory:
+        assert "#" not in url  # TODO: prorper exception
+        url += "#" + package_vcs.subdirectory
+    return url
+
+
+def package_archive_url(
+    pylock_filename_or_url: str, package_archive: PackageArchive
+) -> str:
+    url = _package_dist_url(
+        pylock_filename_or_url, package_archive.path, package_archive.url
+    )
+    if package_archive.subdirectory:
+        assert "#" not in url  # TODO: prorper exception
+        url += "#" + package_archive.subdirectory
+    return url
+
+
+def package_directory_url(
+    pylock_filename_or_url: str, package_directory: PackageDirectory
+) -> str:
+    url = _package_dist_url(pylock_filename_or_url, package_directory.path, None)
+    assert url.startswith("file://")  # TODO: proper exception
+    if not url.endswith("/"):
+        url += "/"
+    if package_directory.subdirectory:
+        url += package_directory.subdirectory
+        if not url.endswith("/"):
+            url += "/"
+    return url
+
+
+def package_sdist_url(pylock_filename_or_url: str, package_sdist: PackageSdist) -> str:
+    return _package_dist_url(
+        pylock_filename_or_url, package_sdist.path, package_sdist.url
+    )
+
+
+def package_wheel_url(pylock_filename_or_url: str, package_wheel: PackageWheel) -> str:
+    return _package_dist_url(
+        pylock_filename_or_url, package_wheel.path, package_wheel.url
+    )

tests/data/lockfiles/pylock.directory.toml

@@ -0,0 +1,6 @@
+lock-version = "1.0"
+created-by = "pip"
+packages = [
+    { name = "simplewheel", directory = { path = "../src/simplewheel-2.0", editable = true } },
+    { name = "singlemodule", directory = { path = "../src/singlemodule" } },
+]

tests/data/lockfiles/pylock.toml

@@ -0,0 +1,33 @@
+lock-version = "1.0"
+created-by = "pip"
+
+[[packages]]
+name = "simple"
+version = "2.0"
+
+[packages.sdist]
+name = "simple-2.0.tar.gz"
+path = "../packages/simple-2.0.tar.gz"
+
+[packages.sdist.hashes]
+sha256 = "3a084929238d13bcd3bb928af04f3bac7ca2357d419e29f01459dc848e2d69a4"
+
+[[packages]]
+name = "simple2"
+
+[packages.archive]
+path = "../packages/simple2-3.0.tar.gz"
+
+[packages.archive.hashes]
+sha256 = "3ad45e1e9aa48b4462af0123f6a7e44a9115db1ef945d4d92c123dfe21815a06"
+
+[[packages]]
+name = "simplewheel"
+version = "2.0"
+
+[[packages.wheels]]
+name = "simplewheel-2.0-1-py2.py3-none-any.whl"
+path = "../packages/simplewheel-2.0-1-py2.py3-none-any.whl"
+
+[packages.wheels.hashes]
+sha256 = "71e1ca6b16ae3382a698c284013f66504f2581099b2ce4801f60e9536236ceee"

tests/unit/test_utils_pylock.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import pytest
+
+from pip._internal.utils.pylock import _package_dist_url
+from pip._internal.utils.urls import path_to_url
+
+
+@pytest.mark.parametrize(
+    "pylock_filename_or_url,path,url,expected",
+    [
+        (
+            # URL, no path
+            "pylock.toml",
+            None,
+            "https://example.com/foo.tar.gz",
+            "https://example.com/foo.tar.gz",
+        ),
+        (
+            # path over URL, joined with pylock.toml dir
+            "/base/pylock.toml",
+            "foo.tar.gz",
+            "https://example.com/foo.tar.gz",
+            "file:///base/foo.tar.gz",
+        ),
+        (
+            # absolute path over URL, not joined with pylock.toml dir
+            "/base/pylock.toml",
+            "/there/foo.tar.gz",
+            "https://example.com/foo.tar.gz",
+            "file:///there/foo.tar.gz",
+        ),
+        (
+            # relative path joined with pylock.toml http url
+            "https://example.com/pylock.toml",
+            "./there/foo.tar.gz",
+            None,
+            "https://example.com/there/foo.tar.gz",
+        ),
+    ],
+)
+def test_package_dist_url(
+    pylock_filename_or_url: str,
+    path: str | None,
+    url: str | None,
+    expected: str,
+) -> None:
+    if expected.startswith("file:///"):
+        expected = expected.replace("file:///", path_to_url("/"))
+    assert _package_dist_url(pylock_filename_or_url, path, url) == expected