pylock: tune dataclasses

Author: sbidoul

src/pip/_internal/models/pylock.py

@@ -256,14 +256,14 @@ class PylockUnsupportedVersionError(PylockValidationError):
     pass
 
 
-@dataclass
+@dataclass(kw_only=True)
 class PackageVcs:
     type: str
-    url: Optional[str]
-    path: Optional[str]
-    requested_revision: Optional[str]
+    url: Optional[str] = None
+    path: Optional[str] = None
+    requested_revision: Optional[str] = None
     commit_id: str
-    subdirectory: Optional[str]
+    subdirectory: Optional[str] = None
 
     def __post_init__(self) -> None:
         _validate_path_url(self.path, self.url)
@@ -280,11 +280,11 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         )
 
 
-@dataclass
+@dataclass(kw_only=True)
 class PackageDirectory:
     path: str
-    editable: Optional[bool]
-    subdirectory: Optional[str]
+    editable: Optional[bool] = None
+    subdirectory: Optional[str] = None
 
     @classmethod
     def from_dict(cls, d: Dict[str, Any]) -> "Self":
@@ -295,14 +295,14 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         )
 
 
-@dataclass
+@dataclass(kw_only=True)
 class PackageArchive:
-    url: Optional[str]
-    path: Optional[str]
-    size: Optional[int]
-    upload_time: Optional[datetime]
+    url: Optional[str] = None
+    path: Optional[str] = None
+    size: Optional[int] = None
+    upload_time: Optional[datetime] = None
     hashes: Dict[str, str]
-    subdirectory: Optional[str]
+    subdirectory: Optional[str] = None
 
     def __post_init__(self) -> None:
         _validate_path_url(self.path, self.url)
@@ -320,13 +320,13 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         )
 
 
-@dataclass
+@dataclass(kw_only=True)
 class PackageSdist:
     name: str
-    upload_time: Optional[datetime]
-    url: Optional[str]
-    path: Optional[str]
-    size: Optional[int]
+    upload_time: Optional[datetime] = None
+    url: Optional[str] = None
+    path: Optional[str] = None
+    size: Optional[int] = None
     hashes: Dict[str, str]
 
     def __post_init__(self) -> None:
@@ -345,13 +345,13 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         )
 
 
-@dataclass
+@dataclass(kw_only=True)
 class PackageWheel:
     name: str
-    upload_time: Optional[datetime]
-    url: Optional[str]
-    path: Optional[str]
-    size: Optional[int]
+    upload_time: Optional[datetime] = None
+    url: Optional[str] = None
+    path: Optional[str] = None
+    size: Optional[int] = None
     hashes: Dict[str, str]
 
     def __post_init__(self) -> None:
@@ -371,21 +371,21 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         return wheel
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Package:
     name: str
-    version: Optional[Version]
-    marker: Optional[Marker]
-    requires_python: Optional[SpecifierSet]
-    dependencies: Optional[List[Dict[str, Any]]]
-    vcs: Optional[PackageVcs]
-    directory: Optional[PackageDirectory]
-    archive: Optional[PackageArchive]
-    index: Optional[str]
-    sdist: Optional[PackageSdist]
-    wheels: Optional[List[PackageWheel]]
-    attestation_identities: Optional[List[Dict[str, Any]]]
-    tool: Optional[Dict[str, Any]]
+    version: Optional[Version] = None
+    marker: Optional[Marker] = None
+    requires_python: Optional[SpecifierSet] = None
+    dependencies: Optional[List[Dict[str, Any]]] = None
+    vcs: Optional[PackageVcs] = None
+    directory: Optional[PackageDirectory] = None
+    archive: Optional[PackageArchive] = None
+    index: Optional[str] = None
+    sdist: Optional[PackageSdist] = None
+    wheels: Optional[List[PackageWheel]] = None
+    attestation_identities: Optional[List[Dict[str, Any]]] = None
+    tool: Optional[Dict[str, Any]] = None
 
     def __post_init__(self) -> None:
         if self.sdist or self.wheels:
@@ -422,17 +422,17 @@ def from_dict(cls, d: Dict[str, Any]) -> "Self":
         return package
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Pylock:
     lock_version: Version
-    environments: Optional[List[Marker]]
-    requires_python: Optional[SpecifierSet]
-    extras: List[str]
-    dependency_groups: List[str]
-    default_groups: List[str]
+    environments: Optional[List[Marker]] = None
+    requires_python: Optional[SpecifierSet] = None
+    extras: List[str] = dataclasses.field(default_factory=list)
+    dependency_groups: List[str] = dataclasses.field(default_factory=list)
+    default_groups: List[str] = dataclasses.field(default_factory=list)
     created_by: str
     packages: List[Package]
-    tool: Optional[Dict[str, Any]]
+    tool: Optional[Dict[str, Any]] = None
 
     def __post_init__(self) -> None:
         if self.lock_version < Version("1") or self.lock_version >= Version("2"):

src/pip/_internal/utils/pylock.py

@@ -61,8 +61,6 @@ def _pylock_package_from_install_requirement(
             package_archive = PackageArchive(
                 url=download_info.url,
                 path=None,
-                size=None,  # not supported
-                upload_time=None,  # not supported
                 hashes=download_info.info.hashes,
                 subdirectory=download_info.subdirectory,
             )
@@ -79,20 +77,14 @@ def _pylock_package_from_install_requirement(
                 package_wheels = [
                     PackageWheel(
                         name=link.filename,
-                        upload_time=None,  # not supported
                         url=download_info.url,
-                        path=None,
-                        size=None,  # not supported
                         hashes=download_info.info.hashes,
                     )
                 ]
             else:
                 package_sdist = PackageSdist(
                     name=link.filename,
-                    upload_time=None,  # not supported
                     url=download_info.url,
-                    path=None,
-                    size=None,  # not supported
                     hashes=download_info.info.hashes,
                 )
         else:
@@ -101,17 +93,11 @@ def _pylock_package_from_install_requirement(
     return Package(
         name=dist.canonical_name,
         version=package_version,
-        marker=None,  # not supported
-        requires_python=None,  # not supported
-        dependencies=None,  # not supported
         vcs=package_vcs,
         directory=package_directory,
         archive=package_archive,
-        index=None,  # not supported
         sdist=package_sdist,
         wheels=package_wheels,
-        attestation_identities=None,  # not supported
-        tool=None,
     )
 
 
@@ -120,11 +106,6 @@ def pylock_from_install_requirements(
 ) -> Pylock:
     return Pylock(
         lock_version=Version("1.0"),
-        environments=None,  # not supported
-        requires_python=None,  # not supported
-        extras=[],  # not supported
-        dependency_groups=[],  # not supported
-        default_groups=[],  # not supported
         created_by="pip",
         packages=sorted(
             (
@@ -133,7 +114,6 @@ def pylock_from_install_requirements(
             ),
             key=lambda p: p.name,
         ),
-        tool=None,
     )