Validate package name of sdist/wheel/editable to be installed (#33)

Author: gaborbernat

pyproject.toml

@@ -38,6 +38,7 @@ dynamic = [
   "version",
 ]
 dependencies = [
+  "packaging>=23.2",
   "tox<5,>=4.14",
   "uv<1,>=0.1.15",
 ]

src/tox_uv/_installer.py

@@ -7,6 +7,7 @@
 from typing import TYPE_CHECKING, Any, Sequence, cast
 
 from packaging.requirements import Requirement
+from packaging.utils import parse_sdist_filename, parse_wheel_filename
 from tox.config.of_type import ConfigDynamicDefinition
 from tox.config.types import Command
 from tox.execute.request import StdinSource
@@ -85,7 +86,8 @@ def _install_list_of_deps(  # noqa: C901
                 groups["req"].append(str(arg))  # pragma: no cover
             elif isinstance(arg, (WheelPackage, SdistPackage, EditablePackage)):
                 groups["req"].extend(str(i) for i in arg.deps)
-                name = arg.path.name.split("-")[0]
+                parser = parse_sdist_filename if isinstance(arg, SdistPackage) else parse_wheel_filename
+                name, *_ = parser(arg.path.name)
                 groups["pkg"].append(f"{name}@{arg.path}")
             elif isinstance(arg, EditableLegacyPackage):
                 groups["req"].extend(str(i) for i in arg.deps)

tests/demo_pkg_inline/build.py

@@ -1,24 +1,20 @@
-"""
-Please keep this file Python 2.7 compatible.
-See https://tox.readthedocs.io/en/rewrite/development.html#code-style-guide
-"""
-
 from __future__ import annotations
 
 import os
+import re
 import sys
 import tarfile
 from pathlib import Path
 from textwrap import dedent
 from zipfile import ZipFile
 
-name = "demo_pkg_inline"
-pkg_name = name.replace("_", "-")
-
+name = "demo-pkg-inline" if os.environ.get("WITH_DASH") else "demo_pkg_inline"
+name_in_artifact = re.sub(r"[^\w\d.]+", "_", name, flags=re.UNICODE)  # per PEP-427
 version = "1.0.0"
-dist_info = f"{name}-{version}.dist-info"
-logic = f"{name}/__init__.py"
-plugin = f"{name}/example_plugin.py"
+dist_info = f"{name_in_artifact}-{version}.dist-info"
+module = name_in_artifact
+logic = f"{module}/__init__.py"
+plugin = f"{module}/example_plugin.py"
 entry_points = f"{dist_info}/entry_points.txt"
 metadata = f"{dist_info}/METADATA"
 wheel = f"{dist_info}/WHEEL"
@@ -42,37 +38,33 @@ def tox_register_tox_env(register: ToxEnvRegister) -> None:
                 register.add_run_env(ExampleVirtualEnvRunner)
         """,
 }
+
 metadata_files = {
     entry_points: f"""
         [tox]
-        example = {name}.example_plugin""",
-    metadata: """
+        example = {module}.example_plugin""",
+    metadata: f"""
         Metadata-Version: 2.1
-        Name: {}
-        Version: {}
+        Name: {name}
+        Version: {version}
         Summary: UNKNOWN
         Home-page: UNKNOWN
         Author: UNKNOWN
         Author-email: UNKNOWN
         License: UNKNOWN
-        {}
         Platform: UNKNOWN
 
         UNKNOWN
-       """.format(
-        pkg_name,
-        version,
-        "\n        ".join(os.environ.get("METADATA_EXTRA", "").split("\n")),
-    ),
+       """,
     wheel: f"""
         Wheel-Version: 1.0
         Generator: {name}-{version}
         Root-Is-Purelib: true
         Tag: py{sys.version_info[0]}-none-any
        """,
-    f"{dist_info}/top_level.txt": name,
+    f"{dist_info}/top_level.txt": module,
     record: f"""
-        {name}/__init__.py,,
+        {module}/__init__.py,,
         {dist_info}/METADATA,,
         {dist_info}/WHEEL,,
         {dist_info}/top_level.txt,,
@@ -86,18 +78,17 @@ def build_wheel(
     config_settings: dict[str, str] | None = None,  # noqa: ARG001
     metadata_directory: str | None = None,
 ) -> str:
-    base_name = f"{name}-{version}-py{sys.version_info[0]}-none-any.whl"
+    base_name = f"{name_in_artifact}-{version}-py{sys.version_info[0]}-none-any.whl"
     path = Path(wheel_directory) / base_name
     with ZipFile(str(path), "w") as zip_file_handler:
         for arc_name, data in content.items():  # pragma: no branch
             zip_file_handler.writestr(arc_name, dedent(data).strip())
         if metadata_directory is not None:
             for sub_directory, _, filenames in os.walk(metadata_directory):
                 for filename in filenames:
-                    zip_file_handler.write(
-                        str(Path(metadata_directory) / sub_directory / filename),
-                        str(Path(sub_directory) / filename),
-                    )
+                    src = str(Path(metadata_directory) / sub_directory / filename)
+                    dest = str(Path(sub_directory) / filename)
+                    zip_file_handler.write(src, dest)
         else:
             for arc_name, data in metadata_files.items():
                 zip_file_handler.writestr(arc_name, dedent(data).strip())
@@ -118,7 +109,7 @@ def build_editable(
 
 
 def build_sdist(sdist_directory: str, config_settings: dict[str, str] | None = None) -> str:  # noqa: ARG001
-    result = f"{name}-{version}.tar.gz"  # pragma: win32 cover
+    result = f"{name_in_artifact}-{version}.tar.gz"  # pragma: win32 cover
     with tarfile.open(str(Path(sdist_directory) / result), "w:gz") as tar:  # pragma: win32 cover
         root = Path(__file__).parent  # pragma: win32 cover
         tar.add(str(root / "build.py"), "build.py")  # pragma: win32 cover

tests/test_tox_uv_package.py

@@ -23,9 +23,15 @@ def test_uv_package_use_default_from_file(tox_project: ToxProjectCreator) -> Non
     result.assert_success()
 
 
+@pytest.mark.parametrize("with_dash", [True, False], ids=["name_dash", "name_underscore"])
 @pytest.mark.parametrize("package", ["sdist", "wheel", "editable"])
-def test_uv_package_editable(tox_project: ToxProjectCreator, package: str, demo_pkg_inline: Path) -> None:
-    project = tox_project({"tox.ini": f"[testenv]\npackage={package}"}, base=demo_pkg_inline)
+def test_uv_package_artifact(
+    tox_project: ToxProjectCreator, package: str, demo_pkg_inline: Path, with_dash: bool
+) -> None:
+    ini = f"[testenv]\npackage={package}"
+    if with_dash:
+        ini += "\n[testenv:.pkg]\nset_env = WITH_DASH = 1"
+    project = tox_project({"tox.ini": ini}, base=demo_pkg_inline)
     result = project.run()
     result.assert_success()