Configure how to patch the windows files

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

Author: LecrisUT

README.md

@@ -232,6 +232,12 @@ wheel.repair.cross-wheel = false
 # A list of external library files that will be bundled in the wheel.
 wheel.repair.bundle-external = []
 
+# Automatically patch every top-level packages/modules to import the dlls on Windows wheels.
+wheel.repair.patch-imports = true
+
+# The generated file containing any necessary top-level imports.
+wheel.repair.imports-file = ""
+
 # If CMake is less than this value, backport a copy of FindPython.
 backport.find-python = "3.26.1"
 

docs/reference/configs.md

@@ -611,6 +611,18 @@ print(mk_skbuild_docs())
      This is an experimental feature gated by :confval:`experimental`
 ```
 
+```{eval-rst}
+.. confval:: wheel.repair.imports-file
+  :type: ``Path``
+
+  The generated file containing any necessary top-level imports.
+
+  This files should be imported as early as possible in all top-level modules and packages.
+
+  On Windows wheels, this file contains all ``os.add_dll_directory`` needed in the current wheel.
+  On other OS, this is an empty file.
+```
+
 ```{eval-rst}
 .. confval:: wheel.repair.in-wheel
   :type: ``bool``
@@ -619,4 +631,14 @@ print(mk_skbuild_docs())
   Patch the dynamic links to libraries installed in the current wheel.
 ```
 
+```{eval-rst}
+.. confval:: wheel.repair.patch-imports
+  :type: ``bool``
+  :default: true
+
+  Automatically patch every top-level packages/modules to import the dlls on Windows wheels.
+
+  Alternatively, set this to ``false`` and use :confval:`wheel.repair.imports-file` instead.
+```
+
 <!-- [[[end]]] -->

src/scikit_build_core/repair_wheel/windows.py

@@ -281,17 +281,20 @@ def repair_wheel(self) -> None:
             "Patching dll directories: {dll_dirs}",
             dll_dirs=self.dll_dirs,
         )
-        # TODO: Not handling namespace packages with this
-        for path in platlib.iterdir():
-            assert isinstance(path, Path)
-            if path.is_dir():
-                pkg_file = path / "__init__.py"
-                if not pkg_file.exists():
-                    logger.debug(
-                        "Ignoring non-python package: {pkg_file}",
-                        pkg_file=pkg_file,
-                    )
-                    continue
-                self.patch_python_file(pkg_file)
-            elif path.suffix == ".py":
-                self.patch_python_file(path)
+        if self.settings.wheel.repair.imports_file:
+            imports_file = platlib / self.settings.wheel.repair.imports_file
+            self.patch_python_file(imports_file)
+        else:
+            for path in platlib.iterdir():
+                assert isinstance(path, Path)
+                if path.is_dir():
+                    pkg_file = path / "__init__.py"
+                    if not pkg_file.exists():
+                        logger.debug(
+                            "Ignoring non-python package: {pkg_file}",
+                            pkg_file=pkg_file,
+                        )
+                        continue
+                    self.patch_python_file(pkg_file)
+                elif path.suffix == ".py":
+                    self.patch_python_file(path)

src/scikit_build_core/resources/scikit-build.schema.json

@@ -265,6 +265,15 @@
                 "type": "string"
               },
               "description": "A list of external library files that will be bundled in the wheel."
+            },
+            "patch-imports": {
+              "type": "boolean",
+              "default": true,
+              "description": "Automatically patch every top-level packages/modules to import the dlls on Windows wheels."
+            },
+            "imports-file": {
+              "type": "string",
+              "description": "The generated file containing any necessary top-level imports."
             }
           },
           "description": "Wheel repair options"

src/scikit_build_core/settings/skbuild_model.py

@@ -256,6 +256,23 @@ class WheelRepair:
     build. The bundled libraries are installed under ``site-packages/${name}.libs``
     """
 
+    patch_imports: bool = True
+    """
+    Automatically patch every top-level packages/modules to import the dlls on Windows wheels.
+
+    Alternatively, set this to ``false`` and use :confval:`wheel.repair.imports-file` instead.
+    """
+
+    imports_file: Optional[Path] = None
+    """
+    The generated file containing any necessary top-level imports.
+
+    This files should be imported as early as possible in all top-level modules and packages.
+
+    On Windows wheels, this file contains all ``os.add_dll_directory`` needed in the current wheel.
+    On other OS, this is an empty file.
+    """
+
 
 @dataclasses.dataclass
 class WheelSettings: