ci: add step to check wheel contents before uploading artifacts (#66)

* ci: add step to check wheel contents before uploading artifacts

* add check-wheel test

* better stub generation

* try fix _windows_dll_dirs

* try fix paths

Author: tlambert03

.github/workflows/deploy.yml

@@ -44,6 +44,9 @@ jobs:
           # distribute.
           CIBW_ENVIRONMENT_LINUX: "LDFLAGS=-Wl,--strip-debug"
 
+      - name: check-wheel-contents
+        run: uvx check-wheel-contents ./wheelhouse
+
       - uses: actions/upload-artifact@v4
         with:
           name: artifact-wheels-${{ matrix.os }}${{ matrix.macos_arch }}

.gitignore

@@ -16,3 +16,6 @@ __pycache__
 coverage/
 coverage*
 wheelhouse/
+
+# autogenerated
+src/pymmcore_nano/_pymmcore_nano.pyi

meson.build

@@ -1,11 +1,11 @@
 # replace the version by running:
 # meson rewrite kwargs set project / version $(python scripts/extract_version.py)
 project(
-  'pymmcore-nano',
-  'cpp',
-version : '11.10.0.74.0',
-  meson_version : '>=1.4.0',
-  default_options : ['cpp_std=c++17']
+    'pymmcore-nano',
+    'cpp',
+    version: '11.10.0.74.0',
+    meson_version: '>=1.4.0',
+    default_options: ['cpp_std=c++17'],
 )
 
 if host_machine.system() == 'darwin'
@@ -52,37 +52,50 @@ ext_module = py.extension_module(
 )
 
 # Create stubs using nanobind.stubgen
-custom_target(
+stub_target = custom_target(
     'generate_stubs',
-    build_by_default: true,
     input: [ext_module],
     output: '_pymmcore_nano.pyi',
     command: [
         py.full_path(),
-        meson.project_source_root() + '/scripts/build_stubs.py',
-        ext_module.full_path(),
-        meson.project_source_root()
-        + '/src/pymmcore_nano/_pymmcore_nano.pyi',
+        meson.project_source_root() / 'scripts' / 'build_stubs.py',
+        '@INPUT@', # path to built extension
+        '@OUTPUT@', # write stub to this path
     ],
+    build_by_default: true,
+    install: true,
+    install_dir: py.get_install_dir() / 'pymmcore_nano',
     depends: ext_module,
 )
 
-# install the Python package into the site-packages directory
-install_subdir(
-    'src/pymmcore_nano',
-    install_dir: py.get_install_dir() / 'pymmcore_nano',
-    strip_directory: true,
+# Copy stub to source tree for development (so Pyright can find it)
+custom_target(
+    'copy_stubs_to_src',
+    input: stub_target,
+    output: 'stub_copied_marker',
+    command: [
+        py.full_path(),
+        '-c',
+        'import shutil; shutil.copy(r"@INPUT@", r"@0@")'.format(
+            meson.project_source_root() / 'src' / 'pymmcore_nano' / '_pymmcore_nano.pyi'
+        )
+    ],
+    build_by_default: true,
+    depends: stub_target,
 )
 
-# also install the stubs into the site-packages directory
-install_data(
-    'src/pymmcore_nano/_pymmcore_nano.pyi',
-    install_dir: py.get_install_dir() / 'pymmcore_nano',
+# Install the pure-Python package bits
+py.install_sources(
+    files(
+        'src/pymmcore_nano/__init__.py',
+        'src/pymmcore_nano/py.typed',
+    ),
+    subdir: 'pymmcore_nano',
 )
 
 test(
     'test_script',
     py,
     args: ['-m', 'pytest', '--color=yes', '-v'],
     workdir: meson.current_source_dir(),
-)
+)

pyproject.toml

@@ -83,8 +83,12 @@ build-verbosity = 1
 # is specific to glibc and not available in musl-libc
 skip = ["*-manylinux_i686", "*-musllinux*", "*-win32", "pp*"]
 build = ["cp39-*", "cp310-*", "cp311-*", "cp312-*", "cp313-*"]
+test-requires = ["check-wheel-contents"]
 test-groups = ["test"]
-test-command = 'pytest "{project}/tests" -v'
+test-command = [
+    "check-wheel-contents {project}/wheelhouse",
+    "pytest {project}/tests -v",
+]
 
 [tool.cibuildwheel.macos]
 # https://cibuildwheel.readthedocs.io/en/stable/faq/#apple-silicon
@@ -128,3 +132,8 @@ ignore = [
 "examples/*.py" = ["D"]
 "_cli.py" = ["B008"]
 "docs/*.py" = ["A", "D"]
+
+[tool.check-wheel-contents]
+toplevel = "pymmcore_nano"
+package = "src/pymmcore_nano"
+ignore = ["W102"]

scripts/build_stubs.py

@@ -5,15 +5,54 @@
 """
 
 import importlib.util
+import os
 import re
 import subprocess
 import sys
+from contextlib import ExitStack, contextmanager
 from pathlib import Path
 from types import ModuleType
 
 from nanobind.stubgen import StubGen
 
 
+@contextmanager
+def _windows_dll_dirs(module_path: Path):
+    """Ensure Windows can resolve dependent DLLs for the extension import."""
+    if os.name != "nt":
+        yield
+        return
+    stack = ExitStack()
+    try:
+        # Prefer the extension's directory first (absolute paths only)
+        parent = module_path.parent.resolve()
+        candidates = [
+            parent,
+            Path(sys.base_prefix, "DLLs").resolve(),
+            Path(sys.base_prefix).resolve(),  # vcruntime*, pythonXY.dll
+        ]
+        # Deduplicate while preserving order, and filter to existing directories
+        seen = set()
+        abs_dirs = []
+        for d in candidates:
+            try:
+                d = d.resolve()
+            except Exception:
+                continue
+            if not d.exists() or not d.is_dir():
+                continue
+            if str(d) in seen:
+                continue
+            seen.add(str(d))
+            abs_dirs.append(d)
+
+        for d in abs_dirs:
+                stack.enter_context(os.add_dll_directory(str(d)))
+        yield
+    finally:
+        stack.close()
+
+
 def load_module_from_filepath(name: str, filepath: str) -> ModuleType:
     # Create a module spec
     spec = importlib.util.spec_from_file_location(name, filepath)
@@ -26,8 +65,12 @@ def load_module_from_filepath(name: str, filepath: str) -> ModuleType:
 
 
 def build_stub(module_path: Path, output_path: str):
+    module_path = module_path.resolve()
     module_name = module_path.stem.split(".")[0]
-    module = load_module_from_filepath(module_name, str(module_path))
+    # Ensure DLLs are discoverable on Windows before importing the extension
+    with _windows_dll_dirs(module_path):
+        module = load_module_from_filepath(module_name, str(module_path))
+
     s = StubGen(module, include_docstrings=True, include_private=False)
     s.put(module)
     dest = Path(output_path)