pylock: refactor

Move conversion of install requirements to pylock to utils namespace,
so model.pylock has no pip dependencies.

Author: sbidoul

src/pip/_internal/commands/lock.py

@@ -10,7 +10,7 @@
     with_cleanup,
 )
 from pip._internal.cli.status_codes import SUCCESS
-from pip._internal.models.pylock import Pylock, is_valid_pylock_file_name
+from pip._internal.models.pylock import is_valid_pylock_file_name
 from pip._internal.operations.build.build_tracker import get_build_tracker
 from pip._internal.req.req_install import (
     check_legacy_setup_py_options,
@@ -19,6 +19,7 @@
 from pip._internal.utils.misc import (
     get_pip_version,
 )
+from pip._internal.utils.pylock import pylock_from_install_requirements
 from pip._internal.utils.temp_dir import TempDirectory
 
 logger = getLogger(__name__)
@@ -160,7 +161,7 @@ def run(self, options: Values, args: List[str]) -> int:
                     output_file_path,
                 )
             base_dir = output_file_path.parent
-        pylock_toml = Pylock.from_install_requirements(
+        pylock_toml = pylock_from_install_requirements(
             requirement_set.requirements.values(), base_dir=base_dir
         ).as_toml()
         if options.output_file == "-":

src/pip/_internal/models/pylock.py

@@ -23,11 +23,6 @@
 from pip._vendor.packaging.specifiers import SpecifierSet
 from pip._vendor.packaging.version import Version
 
-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
-
 if TYPE_CHECKING:
     if sys.version_info >= (3, 11):
         from typing import Self
@@ -381,97 +376,6 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         )
         return package
 
-    @classmethod
-    def from_install_requirement(
-        cls, ireq: InstallRequirement, base_dir: Path
-    ) -> "Self":
-        base_dir = base_dir.resolve()
-        dist = ireq.get_dist()
-        download_info = ireq.download_info
-        assert download_info
-        package_version = None
-        package_vcs = None
-        package_directory = None
-        package_archive = None
-        package_sdist = None
-        package_wheels = None
-        if ireq.is_direct:
-            if isinstance(download_info.info, VcsInfo):
-                package_vcs = PackageVcs(
-                    type=download_info.info.vcs,
-                    url=download_info.url,
-                    path=None,
-                    requested_revision=download_info.info.requested_revision,
-                    commit_id=download_info.info.commit_id,
-                    subdirectory=download_info.subdirectory,
-                )
-            elif isinstance(download_info.info, DirInfo):
-                package_directory = PackageDirectory(
-                    path=(
-                        Path(url_to_path(download_info.url))
-                        .resolve()
-                        .relative_to(base_dir)
-                        .as_posix()
-                    ),
-                    editable=(
-                        download_info.info.editable
-                        if download_info.info.editable
-                        else None
-                    ),
-                    subdirectory=download_info.subdirectory,
-                )
-            elif isinstance(download_info.info, ArchiveInfo):
-                if not download_info.info.hashes:
-                    raise NotImplementedError()
-                package_archive = PackageArchive(
-                    url=download_info.url,
-                    path=None,
-                    size=None,  # not supported
-                    hashes=download_info.info.hashes,
-                    subdirectory=download_info.subdirectory,
-                )
-            else:
-                # should never happen
-                raise NotImplementedError()
-        else:
-            package_version = dist.version
-            if isinstance(download_info.info, ArchiveInfo):
-                if not download_info.info.hashes:
-                    raise NotImplementedError()
-                link = Link(download_info.url)
-                if link.is_wheel:
-                    package_wheels = [
-                        PackageWheel(
-                            name=link.filename,
-                            url=download_info.url,
-                            path=None,
-                            size=None,  # not supported
-                            hashes=download_info.info.hashes,
-                        )
-                    ]
-                else:
-                    package_sdist = PackageSdist(
-                        name=link.filename,
-                        url=download_info.url,
-                        path=None,
-                        size=None,  # not supported
-                        hashes=download_info.info.hashes,
-                    )
-            else:
-                # should never happen
-                raise NotImplementedError()
-        return cls(
-            name=dist.canonical_name,
-            version=package_version,
-            marker=None,  # not supported
-            requires_python=None,  # not supported
-            vcs=package_vcs,
-            directory=package_directory,
-            archive=package_archive,
-            sdist=package_sdist,
-            wheels=package_wheels,
-        )
-
 
 @dataclass
 class Pylock:
@@ -509,21 +413,3 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
             requires_python=_get_as(d, str, SpecifierSet, "requires-python"),
             packages=_get_required_list_of_objects(d, Package, "packages"),
         )
-
-    @classmethod
-    def from_install_requirements(
-        cls, install_requirements: Iterable[InstallRequirement], base_dir: Path
-    ) -> "Self":
-        return cls(
-            lock_version=Version("1.0"),
-            environments=None,  # not supported
-            requires_python=None,  # not supported
-            created_by="pip",
-            packages=sorted(
-                (
-                    Package.from_install_requirement(ireq, base_dir)
-                    for ireq in install_requirements
-                ),
-                key=lambda p: p.name,
-            ),
-        )

src/pip/_internal/utils/pylock.py

@@ -0,0 +1,125 @@
+from pathlib import Path
+from typing import Iterable
+
+from pip._vendor.packaging.version import Version
+
+from pip._internal.models.direct_url import ArchiveInfo, DirInfo, VcsInfo
+from pip._internal.models.link import Link
+from pip._internal.models.pylock import (
+    Package,
+    PackageArchive,
+    PackageDirectory,
+    PackageSdist,
+    PackageVcs,
+    PackageWheel,
+    Pylock,
+)
+from pip._internal.req.req_install import InstallRequirement
+from pip._internal.utils.urls import url_to_path
+
+
+def _pylock_package_from_install_requirement(
+    ireq: InstallRequirement, base_dir: Path
+) -> Package:
+    base_dir = base_dir.resolve()
+    dist = ireq.get_dist()
+    download_info = ireq.download_info
+    assert download_info
+    package_version = None
+    package_vcs = None
+    package_directory = None
+    package_archive = None
+    package_sdist = None
+    package_wheels = None
+    if ireq.is_direct:
+        if isinstance(download_info.info, VcsInfo):
+            package_vcs = PackageVcs(
+                type=download_info.info.vcs,
+                url=download_info.url,
+                path=None,
+                requested_revision=download_info.info.requested_revision,
+                commit_id=download_info.info.commit_id,
+                subdirectory=download_info.subdirectory,
+            )
+        elif isinstance(download_info.info, DirInfo):
+            package_directory = PackageDirectory(
+                path=(
+                    Path(url_to_path(download_info.url))
+                    .resolve()
+                    .relative_to(base_dir)
+                    .as_posix()
+                ),
+                editable=(
+                    download_info.info.editable if download_info.info.editable else None
+                ),
+                subdirectory=download_info.subdirectory,
+            )
+        elif isinstance(download_info.info, ArchiveInfo):
+            if not download_info.info.hashes:
+                raise NotImplementedError()
+            package_archive = PackageArchive(
+                url=download_info.url,
+                path=None,
+                size=None,  # not supported
+                hashes=download_info.info.hashes,
+                subdirectory=download_info.subdirectory,
+            )
+        else:
+            # should never happen
+            raise NotImplementedError()
+    else:
+        package_version = dist.version
+        if isinstance(download_info.info, ArchiveInfo):
+            if not download_info.info.hashes:
+                raise NotImplementedError()
+            link = Link(download_info.url)
+            if link.is_wheel:
+                package_wheels = [
+                    PackageWheel(
+                        name=link.filename,
+                        url=download_info.url,
+                        path=None,
+                        size=None,  # not supported
+                        hashes=download_info.info.hashes,
+                    )
+                ]
+            else:
+                package_sdist = PackageSdist(
+                    name=link.filename,
+                    url=download_info.url,
+                    path=None,
+                    size=None,  # not supported
+                    hashes=download_info.info.hashes,
+                )
+        else:
+            # should never happen
+            raise NotImplementedError()
+    return Package(
+        name=dist.canonical_name,
+        version=package_version,
+        marker=None,  # not supported
+        requires_python=None,  # not supported
+        vcs=package_vcs,
+        directory=package_directory,
+        archive=package_archive,
+        sdist=package_sdist,
+        wheels=package_wheels,
+    )
+
+
+def pylock_from_install_requirements(
+    install_requirements: Iterable[InstallRequirement], base_dir: Path
+) -> Pylock:
+    return Pylock(
+        lock_version=Version("1.0"),
+        environments=None,  # not supported
+        requires_python=None,  # not supported
+        created_by="pip",
+        packages=sorted(
+            (
+                _pylock_package_from_install_requirement(ireq, base_dir)
+                for ireq in install_requirements
+            ),
+            key=lambda p: p.name,
+        ),
+    )