pylock: support requires-python

Author: sbidoul

src/pip/_internal/models/pylock.py

@@ -18,6 +18,7 @@
 
 from pip._vendor import tomli_w
 from pip._vendor.packaging.markers import InvalidMarker, Marker
+from pip._vendor.packaging.specifiers import InvalidSpecifier, SpecifierSet
 from pip._vendor.packaging.version import InvalidVersion, Version
 from pip._vendor.typing_extensions import Self
 
@@ -49,7 +50,7 @@ def _toml_key(key: str) -> str:
 
 
 def _toml_value(value: T) -> Union[str, T]:
-    if isinstance(value, (Version, Marker)):
+    if isinstance(value, (Version, Marker, SpecifierSet)):
         return str(value)
     return value
 
@@ -109,6 +110,16 @@ def _get_marker(d: Dict[str, Any], key: str) -> Optional[Marker]:
         raise PylockValidationError(f"invalid marker {value!r}")
 
 
+def _get_specifier_set(d: Dict[str, Any], key: str) -> Optional[SpecifierSet]:
+    value = _get(d, str, key)
+    if value is None:
+        return None
+    try:
+        return SpecifierSet(value)
+    except InvalidSpecifier:
+        raise PylockValidationError(f"invalid version specifier {value!r}")
+
+
 def _get_object(
     d: Dict[str, Any], expected_type: Type[PylockDataClassT], key: str
 ) -> Optional[PylockDataClassT]:
@@ -286,7 +297,7 @@ class Package:
     name: str
     version: Optional[Version] = None
     marker: Optional[Marker] = None
-    # (not supported) requires_python: Optional[str]
+    requires_python: Optional[SpecifierSet] = None
     # (not supported) dependencies
     vcs: Optional[PackageVcs] = None
     directory: Optional[PackageDirectory] = None
@@ -307,6 +318,7 @@ def from_dict(cls, d: Dict[str, Any]) -> Self:
         package = cls(
             name=_get_required(d, str, "name"),
             version=_get_version(d, "version"),
+            requires_python=_get_specifier_set(d, "requires-python"),
             marker=_get_marker(d, "marker"),
             vcs=_get_object(d, PackageVcs, "vcs"),
             directory=_get_object(d, PackageDirectory, "directory"),
@@ -394,6 +406,7 @@ def from_install_requirement(cls, ireq: InstallRequirement, base_dir: Path) -> S
             name=dist.canonical_name,
             version=package_version,
             marker=None,
+            requires_python=None,
             vcs=package_vcs,
             directory=package_directory,
             archive=package_archive,
@@ -406,7 +419,7 @@ def from_install_requirement(cls, ireq: InstallRequirement, base_dir: Path) -> S
 class Pylock:
     lock_version: Version = Version("1.0")
     # (not supported) environments: Optional[List[str]]
-    # (not supported) requires_python: Optional[str]
+    requires_python: Optional[SpecifierSet] = None
     # (not supported) extras: List[str] = []
     # (not supported) dependency_groups: List[str] = []
     created_by: str = "pip"
@@ -434,6 +447,7 @@ def from_dict(cls, d: Dict[str, Any]) -> Self:
         return cls(
             lock_version=_get_required_version(d, "lock-version"),
             created_by=_get_required(d, str, "created-by"),
+            requires_python=_get_specifier_set(d, "requires-python"),
             packages=_get_required_list_of_objects(d, Package, "packages"),
         )
 

tests/unit/test_pylock.py

@@ -1,6 +1,7 @@
 import pytest
 
 from pip._vendor.packaging.markers import Marker
+from pip._vendor.packaging.specifiers import SpecifierSet
 from pip._vendor.packaging.version import Version
 
 from pip._internal.models.pylock import (
@@ -89,11 +90,13 @@ def test_pylock_basic_package() -> None:
     data = {
         "lock-version": "1.0",
         "created-by": "pip",
+        "requires-python": ">=3.10",
         "packages": [
             {
                 "name": "example",
                 "version": "1.0",
                 "marker": 'os_name == "posix"',
+                "requires-python": "!=3.10.1,>=3.10",
                 "directory": {
                     "path": ".",
                     "editable": False,
@@ -105,4 +108,5 @@ def test_pylock_basic_package() -> None:
     package = pylock.packages[0]
     assert package.version == Version("1.0")
     assert package.marker == Marker('os_name == "posix"')
+    assert package.requires_python == SpecifierSet(">=3.10, !=3.10.1")
     assert pylock.to_dict() == data