fix: Fix stubgen to order members properly (#45)

* fix: fix stubgen

* update stubs

Author: tlambert03

.gitignore

@@ -15,4 +15,3 @@ __pycache__
 .coverage
 coverage/
 coverage*
-site

meson.build

@@ -10,6 +10,9 @@ version : '11.3.0.71.1',
 py = import('python').find_installation(pure: false)
 nanobind_dep = dependency('nanobind', static: true)
 
+# patch nanobind stubgen until https://github.com/wjakob/nanobind/pull/938
+_ = run_command(py.full_path(), 'scripts/patch_nanobind.py').stdout().strip()
+
 # Run a command to get the Python include path
 python_include_path = run_command(
     py.full_path(), ['-c', 'import sysconfig; print(sysconfig.get_paths()["include"])']

scripts/build_stubs.py

@@ -48,21 +48,24 @@ def build_stub(module_path: Path, output_path: str):
     ruff = Path(sys.executable).parent / "ruff"
     _ruff = str(ruff) if ruff.exists() else "ruff"
     subprocess.run([_ruff, "format", output_path], check=True)
-    subprocess.run([_ruff, "check", "--fix-only", output_path])
+    subprocess.run(
+        [
+            _ruff,
+            "check",
+            "--fix-only",
+            "--unsafe-fixes",
+            "--ignore=D",
+            output_path,
+        ]
+    )
 
 
 if __name__ == "__main__":
     if len(sys.argv) > 1:
         module_path = Path(sys.argv[1])
     else:
-        build_dir = Path(__file__).parent.parent / "build"
-        try:
-            pydir = next(build_dir.glob("cp*"))
-        except StopIteration:
-            raise RuntimeError(
-                "Project must be built before you can build stubs.\nRun `just install`."
-            )
-        module_path = next(x for x in pydir.glob("_pymmcore_nano.*") if x.is_file())
+        build_dir = Path(__file__).parent.parent / "builddir"
+        module_path = next(x for x in build_dir.glob("_pymmcore_nano.*") if x.is_file())
 
     if len(sys.argv) > 2:
         output = Path(sys.argv[2])

scripts/patch_nanobind.py

@@ -0,0 +1,28 @@
+"""Apply https://github.com/wjakob/nanobind/pull/938"""
+
+import re
+from pathlib import Path
+import nanobind.stubgen
+
+PATTERN = re.compile(r"^(\s*)(for name, child in getmembers\(value\):)", re.MULTILINE)
+
+
+def replace_getmembers_in_file(path: str) -> None:
+    """Replaces 'for name, child in getmembers(value):' with the desired sorted version in a file."""
+    file_path = Path(path)
+    content = file_path.read_text()
+    if "sorted(getmembers(value)" in content:
+        return
+
+    def replacement(match: re.Match) -> str:
+        indent = match.group(1)
+        return (
+            f"{indent}order_map = {{name: index for index, name in enumerate(value.__dict__.keys())}}\n"
+            f"{indent}for name, child in sorted(getmembers(value), key=lambda i: order_map.get(i[0], float('inf'))):"
+        )
+
+    modified_content = PATTERN.sub(replacement, content)
+    file_path.write_text(modified_content)
+
+
+replace_getmembers_in_file(nanobind.stubgen.__file__)