canonicalized extras names (#123)

Author: radoering

src/poetry_plugin_export/command.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 
 from cleo.helpers import option
+from packaging.utils import canonicalize_name
 from poetry.console.commands.group_command import GroupCommand
 from poetry.core.packages.dependency_group import MAIN_GROUP
 
@@ -87,9 +88,13 @@ def handle(self) -> None:
 
         # Checking extras
         extras = {
-            extra for extra_opt in self.option("extras") for extra in extra_opt.split()
+            canonicalize_name(extra)
+            for extra_opt in self.option("extras")
+            for extra in extra_opt.split()
+        }
+        invalid_extras = extras - {
+            canonicalize_name(extra) for extra in self.poetry.package.extras
         }
-        invalid_extras = extras - self.poetry.package.extras.keys()
         if invalid_extras:
             raise ValueError(
                 f"Extra [{', '.join(sorted(invalid_extras))}] is not specified."

src/poetry_plugin_export/exporter.py

@@ -16,6 +16,7 @@
 if TYPE_CHECKING:
     from pathlib import Path
 
+    from packaging.utils import NormalizedName
     from poetry.poetry import Poetry
 
 
@@ -38,14 +39,14 @@ def __init__(self, poetry: Poetry) -> None:
         self._with_hashes = True
         self._with_credentials = False
         self._with_urls = True
-        self._extras: bool | list[str] | None = []
+        self._extras: bool | list[NormalizedName] | None = []
         self._groups: Iterable[str] = [MAIN_GROUP]
 
     @classmethod
     def is_format_supported(cls, fmt: str) -> bool:
         return fmt in cls.EXPORT_METHODS
 
-    def with_extras(self, extras: bool | list[str] | None) -> Exporter:
+    def with_extras(self, extras: bool | list[NormalizedName] | None) -> Exporter:
         self._extras = extras
 
         return self

src/poetry_plugin_export/walker.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING
 
+from packaging.utils import canonicalize_name
 from poetry.core.semver.util import constraint_regions
 from poetry.core.version.markers import AnyMarker
 from poetry.core.version.markers import SingleMarker
@@ -14,6 +15,7 @@
     from collections.abc import Iterator
     from collections.abc import Sequence
 
+    from packaging.utils import NormalizedName
     from poetry.core.packages.dependency import Dependency
     from poetry.core.packages.package import Package
     from poetry.core.version.markers import BaseMarker
@@ -51,7 +53,7 @@ def get_project_dependency_packages(
     locker: Locker,
     project_requires: list[Dependency],
     project_python_marker: BaseMarker | None = None,
-    extras: bool | Sequence[str] | None = None,
+    extras: bool | Sequence[NormalizedName] | None = None,
 ) -> Iterator[DependencyPackage]:
     # Apply the project python marker to all requirements.
     if project_python_marker is not None:
@@ -68,10 +70,16 @@ def get_project_dependency_packages(
     extra_package_names: set[str] | None = None
 
     if extras is not True:
+        locked_extras = {
+            canonicalize_name(extra): [
+                canonicalize_name(dependency) for dependency in dependencies
+            ]
+            for extra, dependencies in locker.lock_data.get("extras", {}).items()
+        }
         extra_package_names = set(
             get_extra_package_names(
                 repository.packages,
-                locker.lock_data.get("extras", {}),
+                locked_extras,  # type: ignore[arg-type]
                 extras or (),
             )
         )

tests/command/test_command_export.py

@@ -214,7 +214,7 @@ def test_export_includes_extras_by_flag(
 def test_export_reports_invalid_extras(tester: CommandTester, do_lock: None) -> None:
     with pytest.raises(ValueError) as error:
         tester.execute("--format requirements.txt --extras 'SUS AMONGUS'")
-    expected = "Extra [AMONGUS, SUS] is not specified."
+    expected = "Extra [amongus, sus] is not specified."
     assert str(error.value) == expected
 
 

tests/test_exporter.py

@@ -36,6 +36,7 @@
 
 
 if TYPE_CHECKING:
+    from packaging.utils import NormalizedName
     from poetry.poetry import Poetry
 
     from tests.conftest import Config
@@ -905,7 +906,7 @@ def test_exporter_exports_requirements_txt_without_optional_packages(
             ],
         ),
         (
-            ["feature_bar"],
+            ["feature-bar"],
             [
                 f"bar==4.5.6 ; {MARKER_PY}",
                 f"foo==1.2.3 ; {MARKER_PY}",
@@ -917,7 +918,7 @@ def test_exporter_exports_requirements_txt_without_optional_packages(
 def test_exporter_exports_requirements_txt_with_optional_packages(
     tmp_path: Path,
     poetry: Poetry,
-    extras: bool | list[str] | None,
+    extras: bool | list[NormalizedName] | None,
     lines: list[str],
 ) -> None:
     poetry.locker.mock_lock_data(  # type: ignore[attr-defined]