🐛 Retag built wheels through wheel CLI

pythonforandroid/recipe.py

@@ -12,7 +12,7 @@
 import urllib.request
 from urllib.request import urlretrieve
 from os import listdir, unlink, environ, curdir, walk, chmod
-from sys import stdout
+from sys import executable, stdout
 from packaging.version import Version
 from multiprocessing import cpu_count
 import time
@@ -1230,6 +1230,26 @@ def get_recipe_env(self, arch, with_flags_in_cc=True):
         return env
 
 
+def retag_wheel(path, platform_tag):
+    """Retag a built wheel using wheel's CLI, including WHEEL and RECORD."""
+    result = subprocess.run(
+        [executable, '-m', 'wheel', 'tags', '--platform-tag',
+         platform_tag, '--remove', path],
+        capture_output=True, text=True,
+    )
+    if result.returncode:
+        raise RuntimeError(
+            f'wheel tags failed (exit {result.returncode}): {result.stderr.strip()}'
+        )
+    wheel_tag = result.stdout.strip()
+    if not wheel_tag or basename(wheel_tag) != wheel_tag or not wheel_tag.endswith('.whl'):
+        raise ValueError(f'Unexpected wheel tags output: {wheel_tag!r}')
+    selected_wheel = join(dirname(path), wheel_tag)
+    if not isfile(selected_wheel):
+        raise FileNotFoundError(selected_wheel)
+    return selected_wheel
+
+
 class PyProjectRecipe(PythonRecipe):
     """Recipe for projects which contain `pyproject.toml`"""
 
@@ -1339,17 +1359,12 @@ def install_prebuilt_wheel(self, arch):
 
     def install_wheel(self, arch, built_wheels):
         with patch_wheel_setuptools_logging():
-            from wheel.cli.tags import tags as wheel_tags
             from wheel.wheelfile import WheelFile
-        _wheel = built_wheels[0]
-        built_wheel_dir = dirname(_wheel)
         # Fix wheel platform tag
-        wheel_tag = wheel_tags(
-            _wheel,
-            platform_tags=self.get_wheel_platform_tag(arch.arch),
-            remove=True,
+        selected_wheel = retag_wheel(
+            built_wheels[0], self.get_wheel_platform_tag(arch.arch)
         )
-        selected_wheel = join(built_wheel_dir, wheel_tag)
+        wheel_tag = basename(selected_wheel)
         _dev_wheel_dir = environ.get("P4A_WHEEL_DIR", False)
         if _dev_wheel_dir:
             ensure_dir(_dev_wheel_dir)
@@ -1363,7 +1378,6 @@ def install_wheel(self, arch, built_wheels):
         with WheelFile(selected_wheel) as wf:
             for zinfo in wf.filelist:
                 wf.extract(zinfo, destination)
-            wf.close()
 
     def build_arch(self, arch):
         if self.check_prebuilt(arch, "skipping build_arch"):

setup.py

@@ -21,7 +21,7 @@
 install_reqs = [
     'appdirs', 'colorama>=0.3.3', 'jinja2',
     'sh>=2, <3.0; sys_platform!="win32"', 'meson', 'ninja',
-    'build', 'toml', 'packaging', 'setuptools', 'wheel~=0.43.0'
+    'build', 'toml', 'packaging', 'setuptools', 'wheel>=0.43,<0.49'
 ]
 # (build and toml are used by pythonpackage.py)
 

tests/test_recipe.py

@@ -6,10 +6,11 @@
 import unittest
 import warnings
 from unittest import mock
+from wheel.wheelfile import WheelFile
 
 from pythonforandroid.build import Context
 from pythonforandroid.recipe import (
-    MesonRecipe, Recipe, TargetPythonRecipe, import_recipe
+    MesonRecipe, PyProjectRecipe, Recipe, TargetPythonRecipe, import_recipe
 )
 from pythonforandroid.archs import ArchAarch_64
 from pythonforandroid.bootstrap import Bootstrap
@@ -228,6 +229,129 @@ def test_get_recipe_env_command_uses_env_path(self):
             assert meson("--version").strip() == "fake meson"
 
 
+@pytest.fixture
+def make_wheel(tmp_path):
+    """Create a wheel with matching filename, WHEEL tags, and RECORD hashes."""
+    def create(platform='linux_x86_64', build_tag=None):
+        wheel_dir = tmp_path / 'built wheels'
+        wheel_dir.mkdir()
+        source_dir = tmp_path / 'source'
+        (source_dir / 'demo').mkdir(parents=True)
+        (source_dir / 'demo' / '__init__.py').write_text('value = 42\n')
+        dist_info = source_dir / 'demo-1.0.dist-info'
+        dist_info.mkdir()
+        dist_info.joinpath('WHEEL').write_text(
+            'Wheel-Version: 1.0\nGenerator: p4a test\nRoot-Is-Purelib: false\n'
+            f'Tag: cp313-cp313-{platform}\n'
+            + (f'Build: {build_tag}\n' if build_tag else '')
+        )
+        parts = ['demo', '1.0']
+        if build_tag:
+            parts.append(build_tag)
+        parts.extend(['cp313', 'cp313', platform])
+        wheel_path = wheel_dir / ('-'.join(parts) + '.whl')
+        with WheelFile(wheel_path, 'w') as archive:
+            archive.write(source_dir / 'demo' / '__init__.py', 'demo/__init__.py')
+            archive.write(dist_info / 'WHEEL', 'demo-1.0.dist-info/WHEEL')
+        return wheel_path
+
+    return create
+
+
+@pytest.fixture
+def built_wheel(make_wheel):
+    return make_wheel()
+
+
+@pytest.fixture
+def wheel_install(tmp_path, monkeypatch):
+    export_dir = tmp_path / 'dev wheels'
+    saved_dir = tmp_path / 'saved wheels'
+    saved_dir.mkdir()
+    install_dir = tmp_path / 'installed packages'
+    monkeypatch.setenv('P4A_WHEEL_DIR', str(export_dir))
+    recipe = PyProjectRecipe()
+    recipe.ctx = types.SimpleNamespace(
+        ndk_api=21, save_wheel_dir=str(saved_dir),
+        get_python_install_dir=lambda arch: str(install_dir),
+    )
+    arch = types.SimpleNamespace(arch='arm64-v8a')
+    return recipe, arch, export_dir, saved_dir, install_dir
+
+
+def test_install_wheel_retags_and_exports(built_wheel, wheel_install):
+    recipe, arch, export_dir, saved_dir, install_dir = wheel_install
+    assert ' ' in str(built_wheel.parent)
+    recipe.install_wheel(arch, [str(built_wheel)])
+
+    selected = built_wheel.with_name('demo-1.0-cp313-cp313-android_21_arm64_v8a.whl')
+    assert not built_wheel.exists()
+    assert selected.is_file()
+    with WheelFile(selected) as archive:
+        assert b'Tag: cp313-cp313-android_21_arm64_v8a\n' in archive.read(
+            'demo-1.0.dist-info/WHEEL')
+        record = archive.read('demo-1.0.dist-info/RECORD')
+        assert b'demo-1.0.dist-info/WHEEL,sha256=' in record
+        assert b'demo/__init__.py,sha256=' in record
+        for entry in archive.filelist:
+            if not entry.is_dir():
+                archive.read(entry.filename)  # validates every RECORD hash
+    assert (export_dir / selected.name).read_bytes() == selected.read_bytes()
+    assert (saved_dir / selected.name).read_bytes() == selected.read_bytes()
+    assert (install_dir / 'demo' / '__init__.py').read_text() == 'value = 42\n'
+
+
+def test_install_wheel_rejects_invalid_input_before_export(built_wheel, wheel_install):
+    recipe, arch, export_dir, saved_dir, install_dir = wheel_install
+    # Renaming only the filename makes the input disagree with its WHEEL metadata.
+    invalid = built_wheel.with_name('demo-1.0-cp313-cp313-win_amd64.whl')
+    built_wheel.rename(invalid)
+    with pytest.raises(RuntimeError, match=r'(?s)wheel tags failed \(exit \d+\): .*Wheel internal tags'):
+        recipe.install_wheel(arch, [str(invalid)])
+    assert invalid.is_file()
+    assert not export_dir.exists()
+    assert list(saved_dir.iterdir()) == []
+    assert not install_dir.exists()
+
+
+def test_install_wheel_already_tagged(make_wheel, wheel_install):
+    recipe, arch, export_dir, saved_dir, install_dir = wheel_install
+    original = make_wheel(platform='android_21_arm64_v8a')
+
+    recipe.install_wheel(arch, [str(original)])
+
+    # --remove must leave the sole copy intact when the platform is unchanged.
+    assert original.is_file()
+    with WheelFile(original) as archive:
+        assert archive.read('demo-1.0.dist-info/WHEEL').count(
+            b'Tag: cp313-cp313-android_21_arm64_v8a') == 1
+        for entry in archive.filelist:
+            if not entry.is_dir():
+                archive.read(entry.filename)
+    assert (export_dir / original.name).read_bytes() == original.read_bytes()
+    assert (saved_dir / original.name).read_bytes() == original.read_bytes()
+    assert (install_dir / 'demo' / '__init__.py').read_text() == 'value = 42\n'
+
+
+def test_install_wheel_preserves_build_tag(make_wheel, wheel_install):
+    recipe, arch, export_dir, saved_dir, install_dir = wheel_install
+    original = make_wheel(build_tag='1')
+    recipe.install_wheel(arch, [str(original)])
+
+    selected = original.with_name('demo-1.0-1-cp313-cp313-android_21_arm64_v8a.whl')
+    assert not original.exists()
+    with WheelFile(selected) as archive:
+        metadata = archive.read('demo-1.0.dist-info/WHEEL')
+        assert b'Build: 1\n' in metadata
+        assert b'Tag: cp313-cp313-android_21_arm64_v8a\n' in metadata
+        for entry in archive.filelist:
+            if not entry.is_dir():
+                archive.read(entry.filename)
+    assert (export_dir / selected.name).read_bytes() == selected.read_bytes()
+    assert (saved_dir / selected.name).read_bytes() == selected.read_bytes()
+    assert (install_dir / 'demo' / '__init__.py').is_file()
+
+
 class TestLibraryRecipe(BaseClassSetupBootstrap, unittest.TestCase):
     def setUp(self):
         """