Merge pull request #547 from pdm-project/bugfix/vcs-url

Author: frostming

news/547.bugfix.md

@@ -0,0 +1 @@
+Fix the VCS url to be consistent between lock and install.

pdm/models/requirements.py

@@ -164,11 +164,7 @@ def from_req_dict(cls, name: str, req_dict: RequirementDict) -> "Requirement":
         for vcs in VCS_SCHEMA:
             if vcs in req_dict:
                 repo = cast(str, req_dict.pop(vcs, None))
-                url = (
-                    vcs
-                    + "+"
-                    + VcsRequirement._build_url_from_req_dict(name, repo, req_dict)
-                )
+                url = vcs + "+" + repo
                 return VcsRequirement.create(name=name, vcs=vcs, url=url, **req_dict)
         if "path" in req_dict or "url" in req_dict:
             return FileRequirement.create(name=name, **req_dict)
@@ -366,33 +362,39 @@ def __post_init__(self) -> None:
         if not self.vcs:
             self.vcs = self.url.split("+", 1)[0]
 
-    def as_ireq(self, **kwargs: Any) -> InstallRequirement:
-        ireq = super().as_ireq(**kwargs)
-        if not self.editable and self.revision:
-            # For non-editable VCS requirements, commit-hash should be used as the
-            # rev-options for InstallRequirement to consume.
-            parsed = urlparse.urlparse(cast(Link, ireq.link).url)
-            new_path = "@".join((parsed.path.split("@", 1)[0], self.revision))
-            new_url = urlparse.urlunparse(parsed._replace(path=new_path))
-            ireq.link = Link(new_url)
-        return ireq
+    def as_line(self) -> str:
+        project_name = f"{self.project_name}" if self.project_name else ""
+        extras = f"[{','.join(sorted(self.extras))}]" if self.extras else ""
+        marker = self._format_marker()
+        url = url_without_fragments(self.url)
+        if self.revision and not self.editable:
+            url += f"@{self.revision}"
+        elif self.ref:
+            url += f"@{self.ref}"
+        if self.editable or self.subdirectory:
+            fragments = f"egg={project_name}{extras}"
+            if self.subdirectory:
+                fragments = f"{fragments}&subdirectory={self.subdirectory}"
+            return f"{'-e ' if self.editable else ''}{url}#{fragments}{marker}"
+        delimiter = " @ " if project_name else ""
+        return f"{project_name}{extras}{delimiter}{url}{marker}"
 
     def _parse_url(self) -> None:
         vcs, url_no_vcs = self.url.split("+", 1)
         if url_no_vcs.startswith("git@"):
             url_no_vcs = add_ssh_scheme_to_git_uri(url_no_vcs)
-            self.url = f"{vcs}+{url_no_vcs}"
         if not self.name:
             self._parse_name_from_url()
-        repo = url_without_fragments(url_no_vcs)
-        ref: str | None = None
+        ref = self.ref
         parsed = urlparse.urlparse(url_no_vcs)
+        path = parsed.path
         fragments = dict(urlparse.parse_qsl(parsed.fragment))
         if "subdirectory" in fragments:
             self.subdirectory = fragments["subdirectory"]
         if "@" in parsed.path:
             path, ref = parsed.path.split("@", 1)
-            repo = urlparse.urlunparse(parsed._replace(path=path))
+        repo = urlparse.urlunparse(parsed._replace(path=path, fragment=""))
+        self.url = f"{vcs}+{repo}"
         self.repo, self.ref = repo, ref  # type: ignore
 
     @staticmethod

pdm/project/core.py

@@ -49,7 +49,7 @@ class Project:
 
     PYPROJECT_FILENAME = "pyproject.toml"
     DEPENDENCIES_RE = re.compile(r"(?:(.+?)-)?dependencies")
-    LOCKFILE_VERSION = "3"
+    LOCKFILE_VERSION = "3.1"
     GLOBAL_PROJECT = Path.home() / ".pdm" / "global-project"
 
     def __init__(
@@ -437,7 +437,7 @@ def is_lockfile_hash_match(self) -> bool:
 
     def is_lockfile_compatible(self) -> bool:
         if not self.lockfile_file.exists():
-            return False
+            return True
         lockfile_version = str(
             self.lockfile.get("metadata", {}).get("lock_version", "")
         )

tests/cli/test_add.py

@@ -1,7 +1,12 @@
+import shutil
+from pathlib import Path
+
 import pytest
 
 from pdm.cli import actions
+from pdm.models.pip_shims import Link
 from pdm.models.specifiers import PySpecSet
+from tests import FIXTURES
 
 
 @pytest.mark.usefixtures("repository")
@@ -207,3 +212,22 @@ def test_add_package_unconstrained_rewrite_specifier(project):
     locked_candidates = project.locked_repository.all_candidates
     assert locked_candidates["django"].version == "1.11.8"
     assert project.meta.dependencies[0] == "django~=1.11"
+
+
+@pytest.mark.usefixtures("repository", "working_set", "vcs")
+def test_add_cached_vcs_requirement(project, mocker):
+    url = "git+https://github.com/test-root/demo.git@1234567890abcdef#egg=demo"
+    built_path = FIXTURES / "artifacts/demo-0.0.1-py2.py3-none-any.whl"
+    wheel_cache = project.make_wheel_cache()
+    cache_path = Path(wheel_cache.get_path_for_link(Link(url)))
+    if not cache_path.exists():
+        cache_path.mkdir(parents=True)
+    shutil.copy2(built_path, cache_path)
+    actions.do_add(project, packages=[url], no_self=True)
+    lockfile_entry = next(p for p in project.lockfile["package"] if p["name"] == "demo")
+    assert lockfile_entry["revision"] == "1234567890abcdef"
+
+    downloader = mocker.patch("pdm.models.pip_shims.unpack_url")
+    builder = mocker.patch("pdm.builders.WheelBuilder.build")
+    downloader.assert_not_called()
+    builder.assert_not_called()

tests/conftest.py

@@ -73,6 +73,11 @@ def obtain(self, dest, url):
     def get_revision(cls, location):
         return "1234567890abcdef"
 
+    def is_immutable_rev_checkout(self, url: str, dest: str) -> bool:
+        if "@1234567890abcdef" in url:
+            return True
+        return super().is_immutable_rev_checkout(url, dest)
+
 
 class _FakeLink:
     is_wheel = False