Use uv as a task runner

Author: chadrik

.github/workflows/build-steps.yml

@@ -106,6 +106,10 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: '0'
+        - name: Install uv
+          uses: astral-sh/setup-uv@v5
+          with:
+            version: "0.6.13"
       - name: Prepare ccache timestamp
         id: ccache_cache_keys
         shell: bash

src/cmake/pythonutils.cmake

@@ -161,28 +161,48 @@ macro (setup_python_module)
     install(FILES __init__.py DESTINATION ${PYTHON_SITE_DIR} COMPONENT user)
 
     # Create the __init__.pyi stub file
-
-    # Run stub generation process
-    set(_stub_file "${CMAKE_BINARY_DIR}/lib/python/site-packages/OpenImageIO.pyi")
-    # FIXME: is this the right location to use?  the source gets copied to build/src
-    set(_stub_gen "${CMAKE_SOURCE_DIR}/src/python/generate_stubs.py")
-    add_custom_command(
-        COMMAND pipx run ${_stub_gen} ${PYTHON_BUILD_SITE}
-        OUTPUT ${_stub_file}
-        DEPENDS ${_stub_gen}
-        COMMENT "Creating python stubs"
-    )
-    install(FILES ${_stub_file} DESTINATION ${PYTHON_SITE_DIR} RENAME __init__.pyi COMPONENT user)
-    # install the marker file
-    file(WRITE "${CMAKE_BINARY_DIR}/lib/python/site-packages/py.typed" "")
-    install(FILES "${CMAKE_BINARY_DIR}/lib/python/site-packages/py.typed" DESTINATION ${PYTHON_SITE_DIR} COMPONENT user)
-
-    # Ensure this runs after PyOpenImageIO
-    add_custom_target(
-        PyOpenImageIO_stubs ALL 
-        DEPENDS ${_stub_file} "${CMAKE_BINARY_DIR}/lib/python/site-packages/py.typed"
-    )
-    add_dependencies(PyOpenImageIO_stubs PyOpenImageIO)
+    if (PYTHON_VERSION_FOUND VERSION_GREATER_EQUAL "3.9")
+        # A modern version of python is required for the necessary version of mypy
+
+        # Run stub generation process
+        set (_stub_file "${CMAKE_BINARY_DIR}/lib/python/site-packages/OpenImageIO.pyi")
+        # FIXME: is this the right location to use?  the source gets copied to build/src
+        set (_stub_gen "${CMAKE_SOURCE_DIR}/src/python/generate_stubs.py")
+
+        find_program (UV_EXE NAMES uv uv.exe)
+
+        if (NOT UV_EXE)
+            # add_custom_command (
+            #     COMMAND ${Python3_EXECUTABLE} -m venv "${PYTHON_VENV_DIR}"
+            #     COMMAND ${PYTHON_VENV_EXE} -m pip install uv
+            #     OUTPUT "${PYTHON_VENV_DIR}/bin/activate"
+            #     COMMENT "Creating virtualenv at ${PYTHON_VENV_DIR}"
+            # )
+            execute_process (
+                COMMAND ${Python3_EXECUTABLE} -m venv "${PYTHON_VENV_DIR}"
+                COMMAND ${PYTHON_VENV_EXE} -m pip install uv
+                COMMAND_ERROR_IS_FATAL ANY
+            )
+            find_program (UV_EXE NAMES uv uv.exe)
+        endif()
+
+        add_custom_command (
+            COMMAND ${UV_EXE} run --python=${Python3_EXECUTABLE} ${_stub_gen} ${PYTHON_BUILD_SITE}
+            OUTPUT ${_stub_file}
+            DEPENDS ${_stub_gen}
+            COMMENT "Creating python stubs")
+        install (FILES ${_stub_file} DESTINATION ${PYTHON_SITE_DIR} RENAME __init__.pyi COMPONENT user)
+        # install the marker file
+        file (WRITE "${CMAKE_BINARY_DIR}/lib/python/site-packages/py.typed" "")
+        install (FILES "${CMAKE_BINARY_DIR}/lib/python/site-packages/py.typed"
+                DESTINATION ${PYTHON_SITE_DIR} COMPONENT user)
+
+        # Ensure this runs after PyOpenImageIO
+        add_custom_target (
+            PyOpenImageIO_stubs ALL
+            DEPENDS ${_stub_file} "${CMAKE_BINARY_DIR}/lib/python/site-packages/py.typed")
+        add_dependencies (PyOpenImageIO_stubs PyOpenImageIO)
+    endif()
 
 endmacro ()
 

src/python/generate_stubs.py

@@ -60,19 +60,22 @@ class OIIOSignatureGenerator(AdvancedSignatureGenerator):
             ("*.ImageInput.open", "object"): "ImageInput | None",
 
             # ("*.TextureSystem.imagespec", "object"): "ImageSpec | None",
-            # ("*.ImageInput.read_native_deep_*", "object"): "DeepData | None",
 
-            # pybind11 has special support, so it may be possible to get it to emit these types
+            # if you return an uninitialized unique_ptr to pybind11 it will convert to `None` (see #4685)
+            ("*.ImageInput.read_native_deep_*", "DeepData"): "DeepData | None",
+
+            # pybind11 has numpy support, so it may be possible to get it to emit these types
             # by using py::numpy in our wrapper code.
             ("*.ImageInput.read_*", "object"): "numpy.ndarray | None",
             ("*", "Buffer"): "numpy.ndarray",
             ("*.get_pixels", "object"): "numpy.ndarray | None",
 
-            # For results, object is too restrictive (produces spurious errors during type analysis)
+            # For results, `object` is too restrictive (produces spurious errors during type analysis)
             ("*.getattribute", "object"): "Any",
             ("*.ImageSpec.get", "object"): "Any",
 
-            # pybind11 does not have a way to emit tuple[T, ...], e.g. from std:vector<T>.
+            # pybind11 treats std:vector<T> as list[T], but we want tuple[T, ...]
+            # our custom code to convert vector to tuple obscures the contained type.
             ("*.ImageBufAlgo.histogram", "tuple"): "tuple[int, ...]",
             ("*.ImageBufAlgo.isConstantColor", "*"): "tuple[float, ...] | None",
             ("*.ImageBufAlgo.color_range_check", "*"): "tuple[int, ...] | None",