Add skeleton for WheelRepairer

Signed-off-by: Cristian Le <[email protected]>

Author: LecrisUT

docs/api/scikit_build_core.repair_wheel.rst

@@ -0,0 +1,34 @@
+scikit\_build\_core.repair\_wheel package
+=========================================
+
+.. automodule:: scikit_build_core.repair_wheel
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+scikit\_build\_core.repair\_wheel.darwin module
+-----------------------------------------------
+
+.. automodule:: scikit_build_core.repair_wheel.darwin
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+scikit\_build\_core.repair\_wheel.linux module
+----------------------------------------------
+
+.. automodule:: scikit_build_core.repair_wheel.linux
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+scikit\_build\_core.repair\_wheel.windows module
+------------------------------------------------
+
+.. automodule:: scikit_build_core.repair_wheel.windows
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/api/scikit_build_core.rst

@@ -18,6 +18,7 @@ Subpackages
    scikit_build_core.file_api
    scikit_build_core.hatch
    scikit_build_core.metadata
+   scikit_build_core.repair_wheel
    scikit_build_core.resources
    scikit_build_core.settings
    scikit_build_core.setuptools

src/scikit_build_core/build/wheel.py

@@ -20,6 +20,7 @@
 from ..cmake import CMake, CMaker
 from ..errors import FailedLiveProcessError
 from ..format import pyproject_format
+from ..repair_wheel import WheelRepairer
 from ..settings.skbuild_read_settings import SettingsReader
 from ._editable import editable_redirect, libdir_to_installed, mapping_to_modules
 from ._init import setup_logging
@@ -515,6 +516,12 @@ def _build_wheel_impl_impl(
                     f"_{normalized_name}_editable.pth",
                     "\n".join(str_pkgs).encode(),
                 )
+            if settings.wheel.repair:
+                repairer = WheelRepairer.get_wheel_repairer(
+                    wheel=wheel,
+                    builder=builder,
+                )
+                repairer.repair_wheel()
 
     if metadata_directory is not None:
         dist_info_contents = wheel.dist_info_contents()

src/scikit_build_core/repair_wheel/__init__.py

@@ -0,0 +1,94 @@
+"""
+Repair wheel
+"""
+
+from __future__ import annotations
+
+import dataclasses
+import platform
+from abc import ABC, abstractmethod
+from importlib import import_module
+from typing import TYPE_CHECKING, ClassVar, Final
+
+from .._logging import logger
+
+if TYPE_CHECKING:
+    from ..build._wheelfile import WheelWriter
+    from ..builder.builder import Builder
+
+
+__all__ = [
+    "WheelRepairer",
+]
+
+
+@dataclasses.dataclass()
+class WheelRepairer(ABC):
+    """Abstract wheel repairer."""
+
+    wheel: WheelWriter
+    """The current wheel creator."""
+    builder: Builder
+    """CMake builder used."""
+    _platform_repairers: ClassVar[dict[str, type[WheelRepairer]]] = {}
+    """Dictionary of platform specific repairers"""
+    _platform: ClassVar[str | None] = None
+    """The ``platform.system()`` corresponding to the current repairer."""
+    _initialized: Final[bool] = False
+    """Whether all ``WheelRepairer`` have been initialized."""
+
+    def __init_subclass__(cls) -> None:
+        if cls._platform:
+            WheelRepairer._platform_repairers[cls._platform] = cls
+
+    @abstractmethod
+    def repair_wheel(self) -> None:
+        """Repair the current wheel."""
+
+    @classmethod
+    def get_wheel_repairer(
+        cls,
+        wheel: WheelWriter,
+        builder: Builder,
+    ) -> WheelRepairer:
+        """Construct the platform specific wheel repairer"""
+        WheelRepairer.initialize()
+        if not (
+            repairer_cls := WheelRepairer._platform_repairers.get(platform.system())
+        ):
+            return NoopWheelRepairer(
+                wheel=wheel,
+                builder=builder,
+            )
+        return repairer_cls(
+            wheel=wheel,
+            builder=builder,
+        )
+
+    @classmethod
+    def initialize(cls) -> None:
+        """Get all known wheel repairers."""
+        if cls._initialized:
+            return
+        # TODO: Allow for other wheel repairers defined as entry-points
+        try:
+            if (platform_system := platform.system().lower()) in (
+                "linux",
+                "darwin",
+                "windows",
+            ):
+                import_module(f".{platform_system}", package=__name__)
+        except ImportError:
+            logger.error(
+                "Could not load the platform specific wheel repairer. Make sure you include "
+                "the optional dependency [wheel-repair] in the build-system.requires"
+            )
+            raise
+
+
+class NoopWheelRepairer(WheelRepairer):
+    """Dummy wheel repairer that just shows a warning."""
+
+    def repair_wheel(self) -> None:
+        # Do nothing
+        logger.warning("Unknown platform {}. Not doing any repair.", platform.system())

src/scikit_build_core/repair_wheel/darwin.py

@@ -0,0 +1,22 @@
+"""
+Repair MacOS RPATH
+"""
+
+from __future__ import annotations
+
+import macholib  # noqa: F401
+
+from . import WheelRepairer
+
+__all__ = ["MacOSWheelRepairer"]
+
+
+class MacOSWheelRepairer(WheelRepairer):
+    """
+    Adjust the RPATH with @loader_path.
+    """
+
+    _platform = "Darwin"
+
+    def repair_wheel(self) -> None:
+        raise NotImplementedError

src/scikit_build_core/repair_wheel/linux.py

@@ -0,0 +1,22 @@
+"""
+Repair Linux RPATH
+"""
+
+from __future__ import annotations
+
+import elftools  # noqa: F401
+
+from . import WheelRepairer
+
+__all__ = ["LinuxWheelRepairer"]
+
+
+class LinuxWheelRepairer(WheelRepairer):
+    """
+    Adjust the RPATH with $ORIGIN.
+    """
+
+    _platform = "Linux"
+
+    def repair_wheel(self) -> None:
+        raise NotImplementedError

src/scikit_build_core/repair_wheel/windows.py

@@ -0,0 +1,22 @@
+"""
+Repair Windows dll path
+"""
+
+from __future__ import annotations
+
+import pefile  # noqa: F401
+
+from . import WheelRepairer
+
+__all__ = ["WindowsWheelRepairer"]
+
+
+class WindowsWheelRepairer(WheelRepairer):
+    """
+    Do some windows specific magic.
+    """
+
+    _platform = "Windows"
+
+    def repair_wheel(self) -> None:
+        raise NotImplementedError