Fix project name canonicalization. (#10628)

jsirois · web-flow · commit 8ed36bd79a5a · 2020-08-16T10:41:29.000-07:00
Since we already depend on packaging, use its authoritative canonicalization
that tracks PEP-503.
diff --git a/src/python/pants/backend/python/rules/pex_from_targets.py b/src/python/pants/backend/python/rules/pex_from_targets.py
@@ -6,6 +6,7 @@
 from dataclasses import dataclass
 from typing import Iterable, Optional, Tuple
 
+from packaging.utils import canonicalize_name as canonicalize_project_name
 from pkg_resources import Requirement, parse_requirements
 
 from pants.backend.python.rules.pex import (
@@ -188,11 +189,13 @@ async def pex_from_targets(request: PexFromTargetsRequest, python_setup: PythonS
     description = request.description
 
     if python_setup.requirement_constraints:
-        # In requirement strings Foo_Bar and foo-bar refer to the same project.
-        def canonical(name: str) -> str:
-            return name.lower().replace("_", "-")
+        # In requirement strings Foo_-Bar.BAZ and foo-bar-baz refer to the same project. We let
+        # packaging canonicalize for us.
+        # See: https://www.python.org/dev/peps/pep-0503/#normalized-names
 
-        exact_req_projects = {canonical(Requirement.parse(req).project_name) for req in exact_reqs}
+        exact_req_projects = {
+            canonicalize_project_name(Requirement.parse(req).project_name) for req in exact_reqs
+        }
         constraints_file_contents = await Get(
             DigestContents,
             PathGlobs(
@@ -205,7 +208,9 @@ def canonical(name: str) -> str:
         constraints_file_reqs = set(
             parse_requirements(next(iter(constraints_file_contents)).content.decode())
         )
-        constraint_file_projects = {canonical(req.project_name) for req in constraints_file_reqs}
+        constraint_file_projects = {
+            canonicalize_project_name(req.project_name) for req in constraints_file_reqs
+        }
         unconstrained_projects = exact_req_projects - constraint_file_projects
         if unconstrained_projects:
             logger.warning(
diff --git a/src/python/pants/backend/python/rules/pex_from_targets_test.py b/src/python/pants/backend/python/rules/pex_from_targets_test.py
@@ -47,7 +47,7 @@ def test_constraints_validation(self) -> None:
             dedent(
                 """
                 python_requirement_library(name="foo",
-                    requirements=[python_requirement("foo>=0.1.2")])
+                    requirements=[python_requirement("foo-bar>=0.1.2")])
                 python_requirement_library(name="bar",
                     requirements=[ python_requirement("bar==5.5.5")])
                 python_requirement_library(name="baz",
@@ -60,7 +60,7 @@ def test_constraints_validation(self) -> None:
             "constraints1.txt",
             dedent(
                 """
-                foo==1.0.0
+                Foo._-BAR==1.0.0
                 bar==5.5.5
                 baz==2.2.2
                 qux==3.4.5
@@ -97,11 +97,11 @@ def get_pex_request(
             )
 
         pex_req1 = get_pex_request("constraints1.txt", ResolveAllConstraintsOption.NEVER)
-        assert pex_req1.requirements == PexRequirements(["foo>=0.1.2", "bar==5.5.5", "baz"])
+        assert pex_req1.requirements == PexRequirements(["foo-bar>=0.1.2", "bar==5.5.5", "baz"])
 
         pex_req2 = get_pex_request("constraints1.txt", ResolveAllConstraintsOption.ALWAYS)
         assert pex_req2.requirements == PexRequirements(
-            ["foo==1.0.0", "bar==5.5.5", "baz==2.2.2", "qux==3.4.5"]
+            ["Foo._-BAR==1.0.0", "bar==5.5.5", "baz==2.2.2", "qux==3.4.5"]
         )
 
         with self.assertRaises(ExecutionError) as err:
