add support for printing dependency info to the resolution json!

Author: cosmicexplorer

src/pip/_internal/commands/download.py

@@ -182,6 +182,9 @@ def run(self, options: Values, args: List[str]) -> int:
                 for candidate in requirement_set.candidates.mapping.values():
                     # This will occur for the python version requirement, for example.
                     if candidate.name not in requirement_set.requirements:
+                        assert (
+                            tuple(candidate.iter_dependencies(with_requires=True)) == ()
+                        )
                         download_infos.implicit_requirements.append(
                             candidate.as_serializable_requirement()
                         )
@@ -190,10 +193,21 @@ def run(self, options: Values, args: List[str]) -> int:
                     assert req.name is not None
                     assert req.link is not None
                     assert req.name not in download_infos.resolution
+
+                    dependencies: List[Requirement] = []
+                    for maybe_dep in candidate.iter_dependencies(with_requires=True):
+                        if maybe_dep is None:
+                            continue
+                        maybe_req = maybe_dep.as_serializable_requirement()
+                        if maybe_req is None:
+                            continue
+                        dependencies.append(maybe_req)
+
                     download_infos.resolution[
                         req.name
-                    ] = RequirementDownloadInfo.from_req_and_link(
+                    ] = RequirementDownloadInfo.from_req_and_link_and_deps(
                         req=candidate.as_serializable_requirement(),
+                        dependencies=dependencies,
                         link=req.link,
                     )
             else:

src/pip/_internal/models/link.py

@@ -7,7 +7,17 @@
 import urllib.parse
 import xml.etree.ElementTree
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, Optional, Tuple, Union
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Dict,
+    Iterable,
+    List,
+    NamedTuple,
+    Optional,
+    Tuple,
+    Union,
+)
 
 from pip._vendor.packaging.requirements import Requirement
 
@@ -395,18 +405,21 @@ def as_json(self) -> Dict[str, Union[str, Optional[Dict[str, str]]]]:
 class RequirementDownloadInfo:
     req: Requirement
     url: str
+    dependencies: Tuple[Requirement, ...]
     file_hash: Optional[LinkHash]
     dist_info_metadata: Optional[DistInfoMetadata]
 
     @classmethod
-    def from_req_and_link(
+    def from_req_and_link_and_deps(
         cls,
         req: Requirement,
+        dependencies: Iterable[Requirement],
         link: Link,
     ) -> "RequirementDownloadInfo":
         return cls(
             req=req,
             url=link.url,
+            dependencies=tuple(dependencies),
             file_hash=link.get_link_hash(),
             dist_info_metadata=DistInfoMetadata.from_link(link),
         )
@@ -416,6 +429,7 @@ def as_json(self) -> Dict[str, Any]:
             "req": str(self.req),
             "url": self.url,
             "hash": self.file_hash and self.file_hash.as_json(),
+            "dependencies": {dep.name: str(dep) for dep in self.dependencies},
             "dist_info_metadata": (
                 self.dist_info_metadata and self.dist_info_metadata.as_json()
             ),

src/pip/_internal/resolution/resolvelib/base.py

@@ -90,6 +90,10 @@ def get_candidate_lookup(self) -> CandidateLookup:
     def format_for_error(self) -> str:
         ...
 
+    @abc.abstractmethod
+    def as_serializable_requirement(self) -> Optional[PkgRequirement]:
+        ...
+
 
 def _match_link(link: Link, candidate: "Candidate") -> bool:
     if candidate.source_link:

src/pip/_internal/resolution/resolvelib/requirements.py

@@ -1,3 +1,6 @@
+from typing import Optional
+
+from pip._vendor.packaging.requirements import Requirement as PkgRequirement
 from pip._vendor.packaging.specifiers import SpecifierSet
 from pip._vendor.packaging.utils import NormalizedName, canonicalize_name
 
@@ -29,6 +32,9 @@ def name(self) -> str:
         # No need to canonicalize - the candidate did this
         return self.candidate.name
 
+    def as_serializable_requirement(self) -> PkgRequirement:
+        return self.candidate.as_serializable_requirement()
+
     def format_for_error(self) -> str:
         return self.candidate.format_for_error()
 
@@ -77,6 +83,9 @@ def format_for_error(self) -> str:
 
         return ", ".join(parts[:-1]) + " and " + parts[-1]
 
+    def as_serializable_requirement(self) -> Optional[PkgRequirement]:
+        return self._ireq.req
+
     def get_candidate_lookup(self) -> CandidateLookup:
         return None, self._ireq
 
@@ -120,6 +129,9 @@ def name(self) -> str:
     def format_for_error(self) -> str:
         return str(self)
 
+    def as_serializable_requirement(self) -> PkgRequirement:
+        return self._candidate.as_serializable_requirement()
+
     def get_candidate_lookup(self) -> CandidateLookup:
         if self.specifier.contains(self._candidate.version, prereleases=True):
             return self._candidate, None
@@ -159,6 +171,9 @@ def name(self) -> str:
     def format_for_error(self) -> str:
         return str(self)
 
+    def as_serializable_requirement(self) -> Optional[PkgRequirement]:
+        raise NotImplementedError()
+
     def get_candidate_lookup(self) -> CandidateLookup:
         return None, None
 

tests/unit/test_collector.py

@@ -528,6 +528,7 @@ def test_parse_links__yanked_reason(anchor_html: str, expected: Optional[str]) -
             RequirementDownloadInfo(
                 _pkg1_requirement,
                 "https://example.com/pkg1-1.0.tar.gz",
+                (),
                 None,
                 None,
             ),
@@ -544,6 +545,7 @@ def test_parse_links__yanked_reason(anchor_html: str, expected: Optional[str]) -
             RequirementDownloadInfo(
                 _pkg1_requirement,
                 "https://example.com/pkg1-1.0.tar.gz",
+                (),
                 None,
                 DistInfoMetadata(
                     metadata_url="https://example.com/pkg1-1.0.tar.gz.metadata",
@@ -563,6 +565,7 @@ def test_parse_links__yanked_reason(anchor_html: str, expected: Optional[str]) -
             RequirementDownloadInfo(
                 _pkg1_requirement,
                 "https://example.com/pkg1-1.0.tar.gz",
+                (),
                 None,
                 DistInfoMetadata(
                     metadata_url="https://example.com/pkg1-1.0.tar.gz.metadata",
@@ -582,6 +585,7 @@ def test_parse_links__yanked_reason(anchor_html: str, expected: Optional[str]) -
             RequirementDownloadInfo(
                 _pkg1_requirement,
                 "https://example.com/pkg1-1.0.tar.gz#sha512=abc132409cb",
+                (),
                 LinkHash(name="sha512", value="abc132409cb"),
                 DistInfoMetadata(
                     metadata_url="https://example.com/pkg1-1.0.tar.gz.metadata",
@@ -600,7 +604,10 @@ def test_parse_links__dist_info_metadata(
 ) -> None:
     link = _test_parse_links_data_attribute(anchor_html, "dist_info_metadata", expected)
     assert DistInfoMetadata.from_link(link) == dist_info_metadata
-    assert RequirementDownloadInfo.from_req_and_link(req, link) == download_info
+    assert (
+        RequirementDownloadInfo.from_req_and_link_and_deps(req, (), link)
+        == download_info
+    )
 
 
 def test_parse_links_caches_same_page_by_url() -> None: