fix: preserve user specified name in metadata (#65)

* fix: preserve user specified name in metadata Signed-off-by: Henry Schreiner <[email protected]> * Update pyproject_metadata/__init__.py Co-authored-by: Pradyun Gedam <[email protected]> * tests: add test of canonical_name Signed-off-by: Henry Schreiner <[email protected]> --------- Signed-off-by: Henry Schreiner <[email protected]> Co-authored-by: Pradyun Gedam <[email protected]>
pypa · Nov 29, 2023 · db480f1 · db480f1
1 parent f5e1688
commit db480f1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/pyproject_metadata/__init__.py b/pyproject_metadata/__init__.py
@@ -8,7 +8,6 @@
 import os
 import os.path
 import pathlib
-import re
 import typing
 
 from collections.abc import Mapping
@@ -17,6 +16,7 @@
 import packaging.markers
 import packaging.requirements
 import packaging.specifiers
+import packaging.utils
 import packaging.version
 
 
@@ -195,9 +195,12 @@ class StandardMetadata:
     dynamic: list[str] = dataclasses.field(default_factory=list)
 
     def __post_init__(self) -> None:
-        self.name = re.sub(r'[-_.]+', '-', self.name).lower()
         self._update_dynamic(self.version)
 
+    @property
+    def canonical_name(self) -> str:
+        return packaging.utils.canonicalize_name(self.name)
+
     @classmethod
     def from_pyproject(
         cls,

diff --git a/tests/packages/full-metadata/pyproject.toml b/tests/packages/full-metadata/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = 'full-metadata'
+name = 'full_metadata'
 version = '3.2.1'
 description = 'A package with all the metadata :)'
 readme = 'README.md'

diff --git a/tests/test_standard_metadata.py b/tests/test_standard_metadata.py
@@ -504,7 +504,8 @@ def test_value(after_rfc):
         metadata.as_rfc822()
 
     assert metadata.dynamic == []
-    assert metadata.name == 'full-metadata'
+    assert metadata.name == 'full_metadata'
+    assert metadata.canonical_name == 'full-metadata'
     assert metadata.version == packaging.version.Version('3.2.1')
     assert metadata.requires_python == packaging.specifiers.Specifier('>=3.8')
     assert metadata.license.file is None
@@ -595,7 +596,7 @@ def test_as_rfc822():
     core_metadata = metadata.as_rfc822()
     assert core_metadata.headers == {
         'Metadata-Version': ['2.1'],
-        'Name': ['full-metadata'],
+        'Name': ['full_metadata'],
         'Summary': ['A package with all the metadata :)'],
         'Version': ['3.2.1'],
         'Keywords': ['trampolim,is,interesting'],