feat: set up delvewheel as the default repair wheel command for Windows (#2831)

* Add a default repair wheel command for Windows * Install `delvewheel` into Windows build tools * Add delvewheel to constraints file * Regenerate constraints * Docs * Suggest how to disable Windows wheel repair * Add tests * Run `delvewheel` with verbose mode as default * Add note about telling delvewheel where to look Suggested-by: Nils <nilsnolde@proton.me> * Partially revert 81374bb8fc43acefed76cb13d761a9e6cf6afa58 * Add `pip` and `uv` cases for build installations * Ignore `python-native.dll` for GraalPy * Ignore MSVC DLLs, try Windows amd64 graalpy happy * Fix last remaining Windows test failure (famous last words?) * Update constraints * Drop workaround unneeded with delvewheel v1.12.1 * Update docs/options.md Co-authored-by: Aohan Dang <adang1345@gmail.com> * Drop `test_delvewheel_default_on_windows` * Partially revert "Update constraints" This partially reverts commit 2dc4c0f4951858959e213463d90431a5ca03b96f. * Add a test case when repair command is `""` * Add back test that checks delvewheel run/disable * Add a C project with a missing DLL * Add tests for `missing_dll_project` * Partially undo virtualenv/python-discovery update * Fix test * Discard changes to cibuildwheel/resources/constraints-pyodide312.txt * Discard changes to cibuildwheel/resources/constraints-pyodide314.txt * Fix bad merge of constraints * Discard changes to cibuildwheel/resources/constraints-pyodide313.txt * Manually add more GraalPy pip markers * Dependency parsing was too naïve * Maybe a better way to invoke the compiler on Windows * Can we get away without a DLL? --------- Co-authored-by: Aohan Dang <adang1345@gmail.com>
2026-05-13 18:18:30 -04:00
parent 6d9f4c9545
commit 78869d0cf6
19 changed files with 273 additions and 29 deletions
@@ -3,6 +3,79 @@ import jinja2
 from .base import TestProject
 from .c import SPAM_C_TEMPLATE

+_SPAM_C_WITH_MISSING_DLL = """\
+#include <Python.h>
+
+int cibwtest_add(int a, int b);
+
+static PyObject *spam_filter(PyObject *self, PyObject *args)
+{
+    const char *content;
+    int sts;
+    if (!PyArg_ParseTuple(args, "s", &content))
+        return NULL;
+    sts = strcmp(content, "spam") != 0;
+    cibwtest_add(0, 0);
+    return PyLong_FromLong(sts);
+}
+
+static PyMethodDef module_methods[] = {
+    {"filter", (PyCFunction)spam_filter, METH_VARARGS, "Execute a shell command."},
+    {NULL}
+};
+
+PyMODINIT_FUNC PyInit_spam(void)
+{
+    static struct PyModuleDef moduledef = {
+        PyModuleDef_HEAD_INIT, "spam", "Example module", -1, module_methods,
+    };
+    return PyModule_Create(&moduledef);
+}
+"""
+
+_SETUP_PY_WITH_MISSING_DLL = """\
+import subprocess
+from pathlib import Path
+from setuptools import setup, Extension
+from setuptools.command.build_ext import build_ext as _orig_build_ext
+
+here = Path(__file__).parent
+dll_dir = here / "_cibwtest_dll"
+
+class build_ext(_orig_build_ext):
+    def build_extensions(self):
+        if not self.compiler.initialized:
+            self.compiler.initialize()
+        dll_dir.mkdir(exist_ok=True)
+
+        machine = {
+            "win-arm64": "ARM64",
+            "win-amd64": "X64",
+            "win32": "X86",
+        }.get(self.plat_name, "X64")
+
+        def_file = dll_dir / "cibwtest.def"
+        def_file.write_text("EXPORTS\\n    cibwtest_add\\n")
+        subprocess.check_call([
+            self.compiler.lib,
+            f"/def:{def_file}",
+            "/name:cibwtest.dll",
+            f"/out:{dll_dir / 'cibwtest.lib'}",
+            f"/machine:{machine}",
+        ])
+        super().build_extensions()
+
+setup(
+    ext_modules=[Extension(
+        "spam",
+        sources=["spam.c"],
+        libraries=["cibwtest"],
+        library_dirs=[str(dll_dir)],
+    )],
+    cmdclass={"build_ext": build_ext},
+)
+"""
+
 SETUP_PY_TEMPLATE = r"""
 import os
 import sys
@@ -38,6 +111,24 @@ version = 0.1.0
 """


+def new_c_project_with_missing_dll() -> TestProject:
+    """
+    A Windows-only test project whose extension links against cibwtest.dll, a DLL
+    built into a subdirectory that is not on PATH.  delvewheel will find the import
+    in the PE table but cannot locate the file, so repair fails by default.
+    Setting repair-wheel-command to "" disables repair and lets the build succeed.
+    """
+    project = TestProject()
+    project.files.update(
+        {
+            "spam.c": _SPAM_C_WITH_MISSING_DLL,
+            "setup.py": _SETUP_PY_WITH_MISSING_DLL,
+            "setup.cfg": jinja2.Template(SETUP_CFG_TEMPLATE),
+        }
+    )
+    return project
+
+
 def new_c_project(
    *,
    spam_c_top_level_add: str = "",