feat: wip: add import-names and import-namespaces support in wheel metadata

Author: finswimmer

src/poetry/core/masonry/builders/builder.py

@@ -290,6 +290,20 @@ def get_metadata_content(self) -> str:
         if self._meta.description is not None:
             content += f"\n{self._meta.description}\n"
 
+        if self._meta.import_names is not None:
+            if len(self._meta.import_names) == 0:
+                content += "Import-Name: \n"
+
+            for import_name in self._meta.import_names:
+                content += f"Import-Name: {import_name}\n"
+
+        if self._meta.import_namespaces is not None:
+            if len(self._meta.import_namespaces) == 0:
+                content += "Import-Namespace: \n"
+
+            for namespace in self._meta.import_namespaces:
+                content += f"Import-Namespace: {namespace}\n"
+
         return content
 
     def convert_entry_points(self) -> dict[str, list[str]]:

src/poetry/core/masonry/metadata.py

@@ -12,9 +12,11 @@
 
     from poetry.core.packages.project_package import ProjectPackage
 
+METADATA_VERSION = "2.5"
+
 
 class Metadata:
-    metadata_version = "2.4"
+    metadata_version = METADATA_VERSION
     # version 1.0
     name: str | None = None
     version: str
@@ -51,6 +53,10 @@ class Metadata:
     license_expression: str | None = None
     license_files: tuple[str, ...] = ()
 
+    # Version 2.5
+    import_names: list[str] | None = None
+    import_namespaces: list[str] | None = None
+
     @classmethod
     def from_package(cls, package: ProjectPackage) -> Metadata:
         from poetry.core.version.helpers import format_python_constraint
@@ -128,6 +134,9 @@ def from_package(cls, package: ProjectPackage) -> Metadata:
             f"{name}, {url}" for name, url in package.urls.items()
         )
 
+        meta.import_names = package.import_names
+        meta.import_namespaces = package.import_namespaces
+
         return meta
 
     @classmethod

tests/masonry/builders/fixtures/with-import-names/another_package/a/__init__.py

@@ -0,0 +1,20 @@
+[project]
+name = "with-import-names"
+version = "1.2.3"
+description = "Some description."
+requires-python = ">=3.6,<4.0"
+authors = [
+    { "name" = "Sébastien Eustace", "email" = "sebastien@eustace.io" }
+]
+license = "MIT"
+
+keywords = ["packaging", "dependency", "poetry"]
+dependencies = []
+
+import-namespaces = ["my_package", "another_package"]
+import-names = ["my_package.a", "another_package.b"]
+
+[tool.poetry]
+packages = [
+    { include = "my_package" },
+]

tests/masonry/builders/fixtures/with-import-names/my_package/b/__init__.py

@@ -10,6 +10,7 @@
 
 from poetry.core.factory import Factory
 from poetry.core.masonry.builders.builder import Builder
+from poetry.core.masonry.metadata import METADATA_VERSION
 from poetry.core.utils._compat import tomllib
 
 
@@ -116,7 +117,7 @@ def test_get_metadata_content(project: str) -> None:
     p = Parser()
     parsed = p.parsestr(metadata)
 
-    assert parsed["Metadata-Version"] == "2.4"
+    assert parsed["Metadata-Version"] == METADATA_VERSION
     assert parsed["Name"] == "my-package"
     assert parsed["Version"] == "1.2.3"
     assert parsed["Summary"] == "Some description."
@@ -176,6 +177,12 @@ def test_get_metadata_content(project: str) -> None:
         "Repository, https://github.com/python-poetry/poetry",
     ]
 
+    import_names = parsed.get_all("Import-Name", False)
+    assert import_names is False
+
+    import_namespaces = parsed.get_all("Import-Namespace", False)
+    assert import_namespaces is False
+
 
 def test_metadata_pretty_name() -> None:
     builder = Builder(

tests/masonry/builders/fixtures/with-import-names/pyproject.toml

@@ -18,6 +18,7 @@
 from poetry.core.factory import Factory
 from poetry.core.masonry.builders.sdist import SdistBuilder
 from poetry.core.masonry.builders.wheel import WheelBuilder
+from poetry.core.masonry.metadata import METADATA_VERSION
 from tests.masonry.builders.test_wheel import WHEEL_TAG_REGEX
 
 
@@ -180,8 +181,8 @@ def test_complete(project: str, no_vcs: bool) -> None:
         )
 
         metadata = zipf.read("my_package-1.2.3.dist-info/METADATA").decode()
-        expected_metadata = """\
-Metadata-Version: 2.4
+        expected_metadata = f"""\
+Metadata-Version: {METADATA_VERSION}
 Name: my-package
 Version: 1.2.3
 Summary: Some description.

tests/masonry/builders/test_builder.py

@@ -11,6 +11,7 @@
 
 from poetry.core import __version__
 from poetry.core.masonry import api
+from poetry.core.masonry.metadata import METADATA_VERSION
 from poetry.core.utils.helpers import temporary_directory
 from tests.testutils import validate_sdist_contents
 from tests.testutils import validate_wheel_contents
@@ -175,8 +176,8 @@ def test_prepare_metadata_for_build_wheel(project: str) -> None:
 Root-Is-Purelib: true
 Tag: py3-none-any
 """
-    metadata = """\
-Metadata-Version: 2.4
+    metadata = f"""\
+Metadata-Version: {METADATA_VERSION}
 Name: my-package
 Version: 1.2.3
 Summary: Some description.
@@ -262,7 +263,7 @@ def test_prepare_metadata_for_build_wheel_with_local_version() -> None:
 Tag: py3-none-any
 """
     metadata = f"""\
-Metadata-Version: 2.4
+Metadata-Version: {METADATA_VERSION}
 Name: my-package
 Version: 1.2.3+{local_version}
 Summary: Some description.
@@ -339,8 +340,8 @@ def test_prepare_metadata_excludes_optional_without_extras() -> None:
         with (dist_info / "METADATA").open(encoding="utf-8") as f:
             assert (
                 f.read()
-                == """\
-Metadata-Version: 2.4
+                == f"""\
+Metadata-Version: {METADATA_VERSION}
 Name: my-packager
 Version: 0.1
 Summary: Something
@@ -371,6 +372,46 @@ def test_prepare_metadata_for_build_wheel_with_bad_path_dep_succeeds(
     assert "does not exist" in record.message
 
 
+def test_prepare_metadata_with_import_names() -> None:
+    with (
+        temporary_directory() as tmp_dir,
+        cwd(fixtures / "with-import-names"),
+    ):
+        dirname = api.prepare_metadata_for_build_wheel(str(tmp_dir))
+        dist_info = Path(tmp_dir, dirname)
+        assert (dist_info / "METADATA").exists()
+
+        with (dist_info / "METADATA").open(encoding="utf-8") as f:
+            assert (
+                f.read()
+                == f"""\
+Metadata-Version: {METADATA_VERSION}
+Name: with-import-names
+Version: 1.2.3
+Summary: Some description.
+License-Expression: MIT
+Keywords: packaging,dependency,poetry
+Author: Sébastien Eustace
+Author-email: sebastien@eustace.io
+Requires-Python: >=3.6,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Import-Name: my_package.a
+Import-Name: another_package.b
+Import-Namespace: my_package
+Import-Namespace: another_package
+"""
+            )
+
+
 @pytest.mark.parametrize("project", ["complete", "complete_new", "complete_dynamic"])
 def test_build_editable_wheel(project: str) -> None:
     pkg_dir = fixtures / project

tests/masonry/builders/test_complete.py

@@ -205,6 +205,28 @@ def test_from_package_multiple_readmes(package: ProjectPackage) -> None:
     assert metadata.description == "Description 1\nDescription 2"
 
 
+@pytest.mark.parametrize(
+    ["import_names", "import_namespaces"],
+    [
+        (["my_package.a", "my_package.b"], ["my_package"]),
+        (None, None),
+        ([], []),
+    ],
+)
+def test_from_package_import_names(
+    import_names: list[str] | None,
+    import_namespaces: list[str] | None,
+    package: ProjectPackage,
+) -> None:
+    package.import_names = import_names
+    package.import_namespaces = import_namespaces
+
+    metadata = Metadata.from_package(package)
+
+    assert metadata.import_names == import_names
+    assert metadata.import_namespaces == import_namespaces
+
+
 @pytest.mark.parametrize(
     ("exception", "message"),
     [