Add extra_metadata build data to the wheel target (#621)

Author: ofek

backend/src/hatchling/builders/wheel.py

@@ -510,7 +510,7 @@ def write_metadata(
         self.add_licenses(archive, records)
 
         # extra_metadata/ - write last
-        self.add_extra_metadata(archive, records)
+        self.add_extra_metadata(archive, records, build_data)
 
     def write_archive_metadata(self, archive: WheelArchive, records: RecordFile, build_data: dict[str, Any]) -> None:
         from packaging.tags import parse_tag
@@ -548,8 +548,11 @@ def add_licenses(self, archive: WheelArchive, records: RecordFile) -> None:
                 record = archive.write_metadata(f'licenses/{relative_path}', f.read())
                 records.write(record)
 
-    def add_extra_metadata(self, archive: WheelArchive, records: RecordFile) -> None:
-        for extra_metadata_file in self.recurse_explicit_files(self.config.extra_metadata):
+    def add_extra_metadata(self, archive: WheelArchive, records: RecordFile, build_data: dict[str, Any]) -> None:
+        extra_metadata = dict(self.config.extra_metadata)
+        extra_metadata.update(normalize_inclusion_map(build_data['extra_metadata'], self.root))
+
+        for extra_metadata_file in self.recurse_explicit_files(extra_metadata):
             record = archive.add_extra_metadata_file(extra_metadata_file)
             records.write(record)
 
@@ -586,7 +589,13 @@ def get_default_tag(self) -> str:
         return f'{".".join(supported_python_versions)}-none-any'
 
     def get_default_build_data(self) -> dict[str, Any]:
-        return {'infer_tag': False, 'pure_python': True, 'dependencies': [], 'force_include_editable': {}}
+        return {
+            'infer_tag': False,
+            'pure_python': True,
+            'dependencies': [],
+            'force_include_editable': {},
+            'extra_metadata': {},
+        }
 
     def get_forced_inclusion_map(self, build_data: dict[str, Any]) -> dict[str, str]:
         if not build_data['force_include_editable']:

docs/history/hatchling.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ***Added:***
 
+- Add `extra_metadata` build data to the `wheel` target
 - Add more type hints
 - Store Hatchling's metadata in `pyproject.toml`
 

docs/plugins/builder/wheel.md

@@ -60,4 +60,5 @@ This is data that can be modified by [build hooks](../build-hook/reference.md).
 | `infer_tag` | `#!python False` | When `tag` is not set, this may be enabled to use the one most specific to the platform, Python interpreter, and ABI |
 | `pure_python` | `#!python True` | Whether or not to write metadata indicating that the package does not contain any platform-specific files |
 | `dependencies` | | Extra [project dependencies](../../config/metadata.md#required) |
+| `extra_metadata` | | Additional [`extra-metadata`](#options) entries, which take precedence in case of conflicts |
 | `force_include_editable` | | Similar to the [`force_include` option](../build-hook/reference.md#build-data) but specifically for the `editable` [version](#versions) and takes precedence |

tests/backend/builders/test_wheel.py

@@ -1642,6 +1642,79 @@ def test_default_extra_metadata(self, hatch, helpers, temp_dir, config_file):
         )
         helpers.assert_files(extraction_directory, expected_files)
 
+    def test_default_extra_metadata_build_data(self, hatch, helpers, temp_dir, config_file):
+        config_file.model.template.plugins['default']['src-layout'] = False
+        config_file.save()
+
+        project_name = 'My.App'
+
+        with temp_dir.as_cwd():
+            result = hatch('new', project_name)
+
+        assert result.exit_code == 0, result.output
+
+        project_path = temp_dir / 'my-app'
+
+        extra_metadata_path = temp_dir / 'data'
+        extra_metadata_path.ensure_dir_exists()
+        (extra_metadata_path / 'foo.txt').touch()
+        nested_data_path = extra_metadata_path / 'nested'
+        nested_data_path.ensure_dir_exists()
+        (nested_data_path / 'bar.txt').touch()
+
+        build_script = project_path / DEFAULT_BUILD_SCRIPT
+        build_script.write_text(
+            helpers.dedent(
+                """
+                import pathlib
+
+                from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+                class CustomHook(BuildHookInterface):
+                    def initialize(self, version, build_data):
+                        build_data['extra_metadata']['../data'] = '/'
+                """
+            )
+        )
+
+        config = {
+            'project': {'name': project_name, 'requires-python': '>3', 'dynamic': ['version']},
+            'tool': {
+                'hatch': {
+                    'version': {'path': 'my_app/__about__.py'},
+                    'build': {'targets': {'wheel': {'versions': ['standard'], 'hooks': {'custom': {}}}}},
+                },
+            },
+        }
+        builder = WheelBuilder(str(project_path), config=config)
+
+        build_path = project_path / 'dist'
+        build_path.mkdir()
+
+        with project_path.as_cwd():
+            artifacts = list(builder.build(str(build_path)))
+
+        assert len(artifacts) == 1
+        expected_artifact = artifacts[0]
+
+        build_artifacts = list(build_path.iterdir())
+        assert len(build_artifacts) == 1
+        assert expected_artifact == str(build_artifacts[0])
+
+        extraction_directory = temp_dir / '_archive'
+        extraction_directory.mkdir()
+
+        with zipfile.ZipFile(str(expected_artifact), 'r') as zip_archive:
+            zip_archive.extractall(str(extraction_directory))
+
+        metadata_directory = f'{builder.project_id}.dist-info'
+        expected_files = helpers.get_template_files(
+            'wheel.standard_default_extra_metadata',
+            project_name,
+            metadata_directory=metadata_directory,
+        )
+        helpers.assert_files(extraction_directory, expected_files)
+
     @pytest.mark.requires_unix
     def test_default_symlink(self, hatch, helpers, temp_dir, config_file):
         config_file.model.template.plugins['default']['src-layout'] = False