General improvements

Author: chadrik

pyproject.toml

@@ -125,11 +125,14 @@ SKBUILD_CMAKE_BUILD_TYPE = "MinSizeRel"
 SKBUILD_CMAKE_BUILD_TYPE = "MinSizeRel"
 
 [[tool.cibuildwheel.overrides]]
-# Trigger the build of the python stubs for certain platforms.  In CI, this only
-# runs on a single platform (manylinux_x86_64), but we use * here to allow local
-# tests on aarch64 without running docker in emulation (i.e. new Mac silicon).
-# If this `select` value is updated it should be reflected in wheel.yml
+# Trigger the build & validation of the python stubs for certain platforms.
+# The local entry-point for this is `make pystubs`, which will generate the
+# stubs and copy them into the git repo to be committed and reviewed.
+# In CI, this builds the stubs and validates they match what has been committed
+# to the repo.
 select = "cp311-manylinux_*64"
 test-requires = "mypy~=1.15.0 stubgenlib~=0.1.0"
 inherit.test-command = "append"
-test-command = ["python {project}/src/python/generate_stubs.py '/output' '{project}/src/python'"]
+test-command = [
+    "python {project}/src/python/generate_stubs.py --out-path '/output' --validate-path '{project}/src/python'",
+]

src/python/CMakeLists.txt

@@ -20,24 +20,28 @@ set_target_properties(PyOpenImageIO PROPERTIES
 set_source_files_properties(${python_srcs} PROPERTIES
                             UNITY_GROUP PyOpenImageIO)
 
-message("PROC: ${CMAKE_HOST_SYSTEM_PROCESSOR}")
-
-# FIXME: choose aarch vs x86_64 based on the current platform
-
-add_custom_command (
-                    COMMAND cd ${CMAKE_SOURCE_DIR} &&
-                         cibuildwheel "." --output-dir "${CMAKE_BINARY_DIR}/wheelhouse" --only "cp311-manylinux_aarch64"
+# choose aarch vs x86_64 based on the current platform
+if (CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL "arm64")
+    set(_arch, "aarch64")
+else ()
+    set(_arch, "x86_64")
+endif ()
+
+# Note: this must be kept in sync with `[[tool.cibuildwheel.overrides]]` in pyproject.toml
+set (_python_build_id, "cp311-manylinux_${_arch}")
+
+add_custom_command (COMMAND cd ${CMAKE_SOURCE_DIR} &&
+                        cibuildwheel "." --output-dir "${CMAKE_BINARY_DIR}/wheelhouse" --only
                     OUTPUT "${CMAKE_BINARY_DIR}/wheelhouse/OpenImageIO/__init__.pyi"
-                    COMMENT "pystubs: creating python wheel"
+                    COMMENT "Generating python stubs"
                     )
 
-add_custom_command (
-                    OUTPUT "${CMAKE_SOURCE_DIR}/src/python/stubs/OpenImageIO-stubs/__init__.pyi"
-                    COMMAND ${CMAKE_COMMAND} -E copy
+add_custom_command (COMMAND ${CMAKE_COMMAND} -E copy
                         "${CMAKE_BINARY_DIR}/wheelhouse/OpenImageIO/__init__.pyi"
                         "${CMAKE_SOURCE_DIR}/src/python/stubs/OpenImageIO-stubs/__init__.pyi"
+                    OUTPUT "${CMAKE_SOURCE_DIR}/src/python/stubs/OpenImageIO-stubs/__init__.pyi"
                     DEPENDS "${CMAKE_BINARY_DIR}/wheelhouse/OpenImageIO/__init__.pyi"
-                    COMMENT "pystubs: Copying generated stubs to source"
+                    COMMENT "Copying generated stubs to source"
                     )
 
 add_custom_target (pystubs

src/python/generate_stubs.py

@@ -145,15 +145,30 @@ def get_colored_diff(old_text: str, new_text: str):
 
 
 if __name__ == "__main__":
-    # FIXME: add argparse
+    import argparse
     import pathlib
     import os
     import sys
-    out_path = pathlib.Path(sys.argv[1])
-    validate_path = pathlib.Path(sys.argv[2])
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--out-path",
+        default="out",
+        help="Directory to write the stubs."
+    )
+    parser.add_argument(
+        "--validate-path",
+        default=None,
+        help="If provided, compare the generated stub to this file. Exits with code 2 if the "
+             "contents differ."
+    )
+    args = parser.parse_args()
+    out_path = pathlib.Path(args.out_path)
     print(f"Stub output directory: {out_path}")
+
     # perform import so we can see the traceback if it fails.
     import OpenImageIO
+
     sys.argv[1:] = ["-p", "OpenImageIO", "-o", str(out_path)]
     mypy.stubgen.main()
     source = out_path.joinpath("OpenImageIO", "OpenImageIO.pyi")
@@ -165,7 +180,8 @@ def get_colored_diff(old_text: str, new_text: str):
     print(f"Renaming to {dest}")
     os.rename(source, dest)
 
-    if "GITHUB_ACTIONS" in os.environ:
+    if "GITHUB_ACTIONS" in os.environ and args.validate_path:
+        validate_path = pathlib.Path(args.validate_path)
         # in CI, we don't overwrite the output path, we merely validate that what has
         # been committed to the repo is what we expect.
         old_text = validate_path.text()