Merge pull request #8334 from pradyunsg/rename-parent-to-template

Author: pradyunsg

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

@@ -38,23 +38,23 @@
 logger = logging.getLogger(__name__)
 
 
-def make_install_req_from_link(link, parent):
+def make_install_req_from_link(link, template):
     # type: (Link, InstallRequirement) -> InstallRequirement
-    assert not parent.editable, "parent is editable"
-    if parent.req:
-        line = str(parent.req)
+    assert not template.editable, "template is editable"
+    if template.req:
+        line = str(template.req)
     else:
         line = link.url
     ireq = install_req_from_line(
         line,
-        comes_from=parent.comes_from,
-        use_pep517=parent.use_pep517,
-        isolated=parent.isolated,
-        constraint=parent.constraint,
+        comes_from=template.comes_from,
+        use_pep517=template.use_pep517,
+        isolated=template.isolated,
+        constraint=template.constraint,
         options=dict(
-            install_options=parent.install_options,
-            global_options=parent.global_options,
-            hashes=parent.hash_options
+            install_options=template.install_options,
+            global_options=template.global_options,
+            hashes=template.hash_options
         ),
     )
     if ireq.link is None:
@@ -63,42 +63,42 @@ def make_install_req_from_link(link, parent):
     return ireq
 
 
-def make_install_req_from_editable(link, parent):
+def make_install_req_from_editable(link, template):
     # type: (Link, InstallRequirement) -> InstallRequirement
-    assert parent.editable, "parent not editable"
+    assert template.editable, "template not editable"
     return install_req_from_editable(
         link.url,
-        comes_from=parent.comes_from,
-        use_pep517=parent.use_pep517,
-        isolated=parent.isolated,
-        constraint=parent.constraint,
+        comes_from=template.comes_from,
+        use_pep517=template.use_pep517,
+        isolated=template.isolated,
+        constraint=template.constraint,
         options=dict(
-            install_options=parent.install_options,
-            global_options=parent.global_options,
-            hashes=parent.hash_options
+            install_options=template.install_options,
+            global_options=template.global_options,
+            hashes=template.hash_options
         ),
     )
 
 
-def make_install_req_from_dist(dist, parent):
+def make_install_req_from_dist(dist, template):
     # type: (Distribution, InstallRequirement) -> InstallRequirement
     project_name = canonicalize_name(dist.project_name)
-    if parent.req:
-        line = str(parent.req)
-    elif parent.link:
-        line = "{} @ {}".format(project_name, parent.link.url)
+    if template.req:
+        line = str(template.req)
+    elif template.link:
+        line = "{} @ {}".format(project_name, template.link.url)
     else:
         line = "{}=={}".format(project_name, dist.parsed_version)
     ireq = install_req_from_line(
         line,
-        comes_from=parent.comes_from,
-        use_pep517=parent.use_pep517,
-        isolated=parent.isolated,
-        constraint=parent.constraint,
+        comes_from=template.comes_from,
+        use_pep517=template.use_pep517,
+        isolated=template.isolated,
+        constraint=template.constraint,
         options=dict(
-            install_options=parent.install_options,
-            global_options=parent.global_options,
-            hashes=parent.hash_options
+            install_options=template.install_options,
+            global_options=template.global_options,
+            hashes=template.hash_options
         ),
     )
     ireq.satisfied_by = dist
@@ -236,7 +236,7 @@ class LinkCandidate(_InstallRequirementBackedCandidate):
     def __init__(
         self,
         link,          # type: Link
-        parent,        # type: InstallRequirement
+        template,        # type: InstallRequirement
         factory,       # type: Factory
         name=None,     # type: Optional[str]
         version=None,  # type: Optional[_BaseVersion]
@@ -246,11 +246,11 @@ def __init__(
         if cache_entry is not None:
             logger.debug("Using cached wheel link: %s", cache_entry.link)
             link = cache_entry.link
-        ireq = make_install_req_from_link(link, parent)
+        ireq = make_install_req_from_link(link, template)
 
         if (cache_entry is not None and
                 cache_entry.persistent and
-                parent.link is parent.original_link):
+                template.link is template.original_link):
             ireq.original_link_is_in_wheel_cache = True
 
         super(LinkCandidate, self).__init__(
@@ -270,15 +270,15 @@ class EditableCandidate(_InstallRequirementBackedCandidate):
     def __init__(
         self,
         link,          # type: Link
-        parent,        # type: InstallRequirement
+        template,        # type: InstallRequirement
         factory,       # type: Factory
         name=None,     # type: Optional[str]
         version=None,  # type: Optional[_BaseVersion]
     ):
         # type: (...) -> None
         super(EditableCandidate, self).__init__(
             link=link,
-            ireq=make_install_req_from_editable(link, parent),
+            ireq=make_install_req_from_editable(link, template),
             factory=factory,
             name=name,
             version=version,
@@ -295,12 +295,12 @@ class AlreadyInstalledCandidate(Candidate):
     def __init__(
         self,
         dist,  # type: Distribution
-        parent,  # type: InstallRequirement
+        template,  # type: InstallRequirement
         factory,  # type: Factory
     ):
         # type: (...) -> None
         self.dist = dist
-        self._ireq = make_install_req_from_dist(dist, parent)
+        self._ireq = make_install_req_from_dist(dist, template)
         self._factory = factory
 
         # This is just logging some messages, so we can do it eagerly.

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

@@ -106,10 +106,10 @@ def _make_candidate_from_dist(
         self,
         dist,  # type: Distribution
         extras,  # type: FrozenSet[str]
-        parent,  # type: InstallRequirement
+        template,  # type: InstallRequirement
     ):
         # type: (...) -> Candidate
-        base = AlreadyInstalledCandidate(dist, parent, factory=self)
+        base = AlreadyInstalledCandidate(dist, template, factory=self)
         if extras:
             return ExtrasCandidate(base, extras)
         return base
@@ -118,23 +118,23 @@ def _make_candidate_from_link(
         self,
         link,  # type: Link
         extras,  # type: FrozenSet[str]
-        parent,  # type: InstallRequirement
+        template,  # type: InstallRequirement
         name,  # type: Optional[str]
         version,  # type: Optional[_BaseVersion]
     ):
         # type: (...) -> Candidate
         # TODO: Check already installed candidate, and use it if the link and
         # editable flag match.
-        if parent.editable:
+        if template.editable:
             if link not in self._editable_candidate_cache:
                 self._editable_candidate_cache[link] = EditableCandidate(
-                    link, parent, factory=self, name=name, version=version,
+                    link, template, factory=self, name=name, version=version,
                 )
             base = self._editable_candidate_cache[link]  # type: BaseCandidate
         else:
             if link not in self._link_candidate_cache:
                 self._link_candidate_cache[link] = LinkCandidate(
-                    link, parent, factory=self, name=name, version=version,
+                    link, template, factory=self, name=name, version=version,
                 )
             base = self._link_candidate_cache[link]
         if extras:
@@ -151,11 +151,11 @@ def _iter_found_candidates(
             return ()
 
         # The InstallRequirement implementation requires us to give it a
-        # "parent", which doesn't really fit with graph-based resolution.
-        # Here we just choose the first requirement to represent all of them.
+        # "template". Here we just choose the first requirement to represent
+        # all of them.
         # Hopefully the Project model can correct this mismatch in the future.
-        parent = ireqs[0]
-        name = canonicalize_name(parent.req.name)
+        template = ireqs[0]
+        name = canonicalize_name(template.req.name)
 
         hashes = Hashes()
         extras = frozenset()  # type: FrozenSet[str]
@@ -182,7 +182,7 @@ def _iter_found_candidates(
                 candidate = self._make_candidate_from_dist(
                     dist=installed_dist,
                     extras=extras,
-                    parent=parent,
+                    template=template,
                 )
                 candidates[installed_version] = candidate
 
@@ -197,7 +197,7 @@ def _iter_found_candidates(
             candidate = self._make_candidate_from_link(
                 link=ican.link,
                 extras=extras,
-                parent=parent,
+                template=template,
                 name=name,
                 version=ican.version,
             )
@@ -240,7 +240,7 @@ def make_requirement_from_install_req(self, ireq):
         cand = self._make_candidate_from_link(
             ireq.link,
             extras=frozenset(ireq.extras),
-            parent=ireq,
+            template=ireq,
             name=canonicalize_name(ireq.name) if ireq.name else None,
             version=None,
         )
@@ -328,15 +328,15 @@ def should_reinstall(self, candidate):
     def _report_requires_python_error(
         self,
         requirement,  # type: RequiresPythonRequirement
-        parent,  # type: Candidate
+        template,  # type: Candidate
     ):
         # type: (...) -> UnsupportedPythonVersion
-        template = (
+        message_format = (
             "Package {package!r} requires a different Python: "
             "{version} not in {specifier!r}"
         )
-        message = template.format(
-            package=parent.name,
+        message = message_format.format(
+            package=template.name,
             version=self._python_candidate.version,
             specifier=str(requirement.specifier),
         )