Merge pull request #13585 from notatallshaw/remove-remove-unnecessary-canonicalize-name-calls

Minor: Remove unnecessary `canonicalize_name` calls and validate via `NormalizedName` type

Author: notatallshaw

src/pip/_internal/cache.py

@@ -143,7 +143,7 @@ def get(
                 wheel = Wheel(wheel_name)
             except InvalidWheelFilename:
                 continue
-            if canonicalize_name(wheel.name) != canonical_package_name:
+            if wheel.name != canonical_package_name:
                 logger.debug(
                     "Ignoring cached wheel %s for %s as it "
                     "does not match the expected distribution name %s.",

src/pip/_internal/index/package_finder.py

@@ -17,7 +17,7 @@
 
 from pip._vendor.packaging import specifiers
 from pip._vendor.packaging.tags import Tag
-from pip._vendor.packaging.utils import canonicalize_name
+from pip._vendor.packaging.utils import NormalizedName, canonicalize_name
 from pip._vendor.packaging.version import InvalidVersion, _BaseVersion
 from pip._vendor.packaging.version import parse as parse_version
 
@@ -127,7 +127,7 @@ class LinkEvaluator:
     def __init__(
         self,
         project_name: str,
-        canonical_name: str,
+        canonical_name: NormalizedName,
         formats: frozenset[str],
         target_python: TargetPython,
         allow_yanked: bool,
@@ -201,7 +201,7 @@ def evaluate_link(self, link: Link) -> tuple[LinkType, str]:
                         LinkType.format_invalid,
                         "invalid wheel filename",
                     )
-                if canonicalize_name(wheel.name) != self._canonical_name:
+                if wheel.name != self._canonical_name:
                     reason = f"wrong project name (not {self.project_name})"
                     return (LinkType.different_project, reason)
 

src/pip/_internal/metadata/__init__.py

@@ -4,13 +4,16 @@
 import functools
 import os
 import sys
-from typing import Literal, Protocol, cast
+from typing import TYPE_CHECKING, Literal, Protocol, cast
 
 from pip._internal.utils.deprecation import deprecated
 from pip._internal.utils.misc import strtobool
 
 from .base import BaseDistribution, BaseEnvironment, FilesystemWheel, MemoryWheel, Wheel
 
+if TYPE_CHECKING:
+    from pip._vendor.packaging.utils import NormalizedName
+
 __all__ = [
     "BaseDistribution",
     "BaseEnvironment",
@@ -131,7 +134,9 @@ def get_directory_distribution(directory: str) -> BaseDistribution:
     return select_backend().Distribution.from_directory(directory)
 
 
-def get_wheel_distribution(wheel: Wheel, canonical_name: str) -> BaseDistribution:
+def get_wheel_distribution(
+    wheel: Wheel, canonical_name: NormalizedName
+) -> BaseDistribution:
     """Get the representation of the specified wheel's distribution metadata.
 
     This returns a Distribution instance from the chosen backend based on

src/pip/_internal/network/lazy_wheel.py

@@ -11,7 +11,7 @@
 from typing import Any
 from zipfile import BadZipFile, ZipFile
 
-from pip._vendor.packaging.utils import canonicalize_name
+from pip._vendor.packaging.utils import NormalizedName
 from pip._vendor.requests.models import CONTENT_CHUNK_SIZE, Response
 
 from pip._internal.metadata import BaseDistribution, MemoryWheel, get_wheel_distribution
@@ -23,7 +23,9 @@ class HTTPRangeRequestUnsupported(Exception):
     pass
 
 
-def dist_from_wheel_url(name: str, url: str, session: PipSession) -> BaseDistribution:
+def dist_from_wheel_url(
+    name: NormalizedName, url: str, session: PipSession
+) -> BaseDistribution:
     """Return a distribution object from the given wheel URL.
 
     This uses HTTP range requests to only fetch the portion of the wheel
@@ -37,7 +39,7 @@ def dist_from_wheel_url(name: str, url: str, session: PipSession) -> BaseDistrib
         wheel = MemoryWheel(zf.name, zf)  # type: ignore
         # After context manager exit, wheel.name
         # is an invalid file by intention.
-        return get_wheel_distribution(wheel, canonicalize_name(name))
+        return get_wheel_distribution(wheel, name)
 
 
 class LazyZipOverHTTP:

src/pip/_internal/operations/prepare.py

@@ -444,7 +444,7 @@ def _fetch_metadata_using_lazy_wheel(
             return None
 
         wheel = Wheel(link.filename)
-        name = canonicalize_name(wheel.name)
+        name = wheel.name
         logger.info(
             "Obtaining dependency information from %s %s",
             name,

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

@@ -283,7 +283,7 @@ def __init__(
         assert ireq.link == link
         if ireq.link.is_wheel and not ireq.link.is_file:
             wheel = Wheel(ireq.link.filename)
-            wheel_name = canonicalize_name(wheel.name)
+            wheel_name = wheel.name
             assert name == wheel_name, f"{name!r} != {wheel_name!r} for wheel"
             # Version may not be present for PEP 508 direct URLs
             if version is not None:

src/pip/_internal/wheel_builder.py

@@ -118,7 +118,7 @@ def _get_cache_dir(
 def _verify_one(req: InstallRequirement, wheel_path: str) -> None:
     canonical_name = canonicalize_name(req.name or "")
     w = Wheel(os.path.basename(wheel_path))
-    if canonicalize_name(w.name) != canonical_name:
+    if w.name != canonical_name:
         raise InvalidWheelFilename(
             f"Wheel has unexpected file name: expected {canonical_name!r}, "
             f"got {w.name!r}",

tests/lib/wheel.py

@@ -21,6 +21,7 @@
 )
 from zipfile import ZipFile
 
+from pip._vendor.packaging.utils import canonicalize_name
 from pip._vendor.requests.structures import CaseInsensitiveDict
 
 from pip._internal.metadata import BaseDistribution, MemoryWheel, get_wheel_distribution
@@ -281,7 +282,9 @@ def as_zipfile(self) -> ZipFile:
 
     def as_distribution(self, name: str) -> BaseDistribution:
         stream = BytesIO(self.as_bytes())
-        return get_wheel_distribution(MemoryWheel(self._name, stream), name)
+        return get_wheel_distribution(
+            MemoryWheel(self._name, stream), canonicalize_name(name)
+        )
 
 
 def make_wheel(

tests/unit/metadata/test_metadata.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from pip._vendor.packaging.utils import NormalizedName
+from pip._vendor.packaging.utils import NormalizedName, canonicalize_name
 
 from pip._internal.metadata import (
     BaseDistribution,
@@ -102,7 +102,7 @@ def test_metadata_dict(tmp_path: Path) -> None:
     """
     wheel_path = make_wheel(name="pkga", version="1.0.1").save_to_dir(tmp_path)
     wheel = FilesystemWheel(wheel_path)
-    dist = get_wheel_distribution(wheel, "pkga")
+    dist = get_wheel_distribution(wheel, canonicalize_name("pkga"))
     metadata_dict = dist.metadata_dict
     assert metadata_dict["name"] == "pkga"
     assert metadata_dict["version"] == "1.0.1"

tests/unit/test_finder.py

@@ -6,6 +6,7 @@
 
 from pip._vendor.packaging.specifiers import SpecifierSet
 from pip._vendor.packaging.tags import Tag
+from pip._vendor.packaging.utils import canonicalize_name
 from pip._vendor.packaging.version import parse as parse_version
 
 import pip._internal.utils.compatibility_tags
@@ -481,7 +482,7 @@ def make_test_link_evaluator(self, formats: Iterable[str]) -> LinkEvaluator:
         target_python = TargetPython()
         return LinkEvaluator(
             project_name="pytest",
-            canonical_name="pytest",
+            canonical_name=canonicalize_name("pytest"),
             formats=frozenset(formats),
             target_python=target_python,
             allow_yanked=True,