testing: Add type annotations to the python test suite

Signed-off-by: Chad Dombrova <chadrik@gmail.com>

Author: chadrik

INSTALL.md

@@ -394,6 +394,8 @@ The workflow for releasing new stubs is as follows:
 
 - Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
 - Run `make pystubs` locally to generate updated stubs in `src/python/stubs/__init__.pyi`
+- Run `make test-pystubs` locally to use mypy to test the stubs against the code in 
+  the python testsuite.
 - Commit the new stubs and push to Github
 - In CI, the stubs will be included in the wheels built by `cibuildwheel`, as defined in `.github/wheel.yml`
 - In CI, one of the `cibuildwheel` Github actions will rebuild the stubs to a 

Makefile

@@ -243,11 +243,18 @@ build: config
 	    ${CMAKE} --build . --config ${CMAKE_BUILD_TYPE} \
 	  )
 
+# generate python stubs and add them to the repo
 pystubs: config
 	@ ( cd ${build_dir} ; \
 	    ${CMAKE} --build . --config ${CMAKE_BUILD_TYPE} --target pystubs \
 	  )
 
+# run mypy on python tests to confirm the stubs are working
+test-pystubs: pystubs
+	@ ( uv export --quiet --no-dev --no-build --no-emit-project --no-hashes -o ${build_dir}/requirements.txt ; \
+	    uvx --with-requirements ${build_dir}/requirements.txt mypy==1.15.0 \
+	  )
+
 # 'make install' builds everthing and installs it in 'dist'.
 # Suppress pointless output from docs installation.
 install: build

pyproject.toml

@@ -139,5 +139,14 @@ test-requires = "mypy~=1.15.0 stubgenlib~=0.1.0"
 select = "cp311-manylinux_*64"
 inherit.test-command = "append"
 test-command = [
-    "python {project}/src/python/stubs/generate_stubs.py --out-path '/output' --validate-path '{project}/src/python/stubs/__init__.pyi'",
+    "python {project}/src/python/stubs/generate_stubs.py --out-path '/output' --validate-path '{project}/src/python/stubs/OpenImageIO/__init__.pyi'",
 ]
+
+[tool.mypy]
+files = [
+    "testsuite/python-*/src/",
+]
+mypy_path = [
+    "src/python/stubs",
+]
+check_untyped_defs = true

src/cmake/pythonutils.cmake

@@ -156,7 +156,7 @@ macro (setup_python_module)
              RUNTIME DESTINATION ${PYTHON_SITE_DIR} COMPONENT user
              LIBRARY DESTINATION ${PYTHON_SITE_DIR} COMPONENT user)
 
-    install (FILES __init__.py stubs/__init__.pyi stubs/py.typed
+    install (FILES __init__.py stubs/OpenImageIO/__init__.pyi stubs/OpenImageIO/py.typed
              DESTINATION ${PYTHON_SITE_DIR} COMPONENT user)
 
 endmacro ()

src/python/stubs/CMakeLists.txt

@@ -1,7 +1,7 @@
 
 # Setup the pystub target, which is not built by default.
 
-set (_stub_file "${CMAKE_SOURCE_DIR}/src/python/stubs/__init__.pyi")
+set (_stub_file "${CMAKE_SOURCE_DIR}/src/python/stubs/OpenImageIO/__init__.pyi")
 
 # Note: the python version must be kept in sync with `[[tool.cibuildwheel.overrides]]` in pyproject.toml.
 # The stubs are generated within a container so the version of python does not need to match

src/python/stubs/__init__.pyi src/python/stubs/OpenImageIO/__init__.pyisrc/python/stubs/__init__.pyi renamed to src/python/stubs/OpenImageIO/__init__.pyi

@@ -4,6 +4,8 @@
 # SPDX-License-Identifier: Apache-2.0
 # https://github.com/AcademySoftwareFoundation/OpenImageIO
 
+from __future__ import annotations
+
 import os
 import OpenImageIO as oiio
 

src/python/stubs/py.typed src/python/stubs/OpenImageIO/py.typedsrc/python/stubs/py.typed renamed to src/python/stubs/OpenImageIO/py.typed

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # https://github.com/AcademySoftwareFoundation/OpenImageIO
 
+from __future__ import annotations
 
 import OpenImageIO as oiio
 
@@ -15,19 +16,10 @@
 test_channames = ("R", "G", "B", "A", "Z", "Zback")
 print ("test_chantypes ", str(test_chantypes[0]), str(test_chantypes[1]), str(test_chantypes[2]), str(test_chantypes[3]), str(test_chantypes[4]), str(test_chantypes[5]))
 
-def set_dd_sample (dd, pixel, sample, vals) :
-    if dd.samples(pixel) <= sample :
-        dd.set_samples(pixel, sample+1)
-    for c in range(ib.nchannels) :
-        dd.set_value (pixel, c, sample, vals[c])
-
-def add_dd_sample (dd, pixel, sample, vals) :
-    set_dd_sample (dd, pixel, dd.samples(pixel), vale)
-
 
 # Make a simple deep image
 # Only odd pixel indes have samples, and they have #samples = pixel index.
-def make_test_deep_image () :
+def make_test_deep_image () -> oiio.DeepData:
     dd = oiio.DeepData()
     dd.init (test_xres*test_yres, test_nchannels, test_chantypes, test_channames)
     for p in range(dd.pixels) :
@@ -54,7 +46,7 @@ def make_test_deep_image () :
 
 
 
-def print_deep_image (dd, prefix="After init,") :
+def print_deep_image (dd: oiio.DeepData, prefix: str = "After init,") :
     print (prefix, "dd has", dd.pixels, "pixels,", dd.channels, "channels.")
     print ("  Channel indices: Z=", dd.Z_channel, "Zback=", dd.Zback_channel, "A=", dd.A_channel, "AR=", dd.AR_channel, "AG=", dd.AG_channel, "AB=", dd.AB_channel)
     for p in range(dd.pixels) :
@@ -68,7 +60,7 @@ def print_deep_image (dd, prefix="After init,") :
                 print ()
 
 
-def print_deep_imagebuf (buf, prefix) :
+def print_deep_imagebuf (buf: oiio.ImageBuf, prefix: str) :
     print_deep_image (buf.deepdata(), prefix)
 
 
@@ -241,13 +233,13 @@ def test_opaque_z () :
     print ()
 
 
-def set_ib_sample (ib, x, y, sample, vals) :
+def set_ib_sample (ib: oiio.ImageBuf, x: int, y: int, sample: int, vals: tuple[float, ...]) :
     if ib.deep_samples(x, y) <= sample :
         ib.set_deep_samples (x, y, 0, sample+1)
     for c in range(ib.nchannels) :
         ib.set_deep_value (x, y, 0, c, sample, vals[c])
 
-def add_ib_sample (ib, x, y, vals) :
+def add_ib_sample (ib: oiio.ImageBuf, x: int, y: int, vals: tuple[float, ...]) :
     set_ib_sample (ib, x, y, ib.deep_samples(x,y), vals)
 
 
@@ -301,13 +293,15 @@ def test_iba_deep_holdout () :
     spec.channelformats = test_chantypes
     spec.deep = True
     output = oiio.ImageOutput.create ("deeptest.exr")
+    assert output is not None
     output.open ("deeptest.exr", spec, "create")
     output.write_deep_image (dd)
     output.close ()
 
     # read the exr file and double check it
     print ("\nReading image...")
     input = oiio.ImageInput.open ("deeptest.exr")
+    assert input is not None
     ddr = input.read_native_deep_image ()
     if ddr :
         print_deep_image (ddr)

testsuite/python-colorconfig/src/test_colorconfig.py

@@ -4,14 +4,15 @@
 # SPDX-License-Identifier: Apache-2.0
 # https://github.com/AcademySoftwareFoundation/OpenImageIO
 
+from __future__ import annotations
 
 import array
 import numpy
 import OpenImageIO as oiio
 
 
 # Print the contents of an ImageSpec
-def print_imagespec (spec, subimage=0, mip=0, msg="") :
+def print_imagespec (spec: oiio.ImageSpec, subimage=0, mip=0, msg="") :
     if msg != "" :
         print (str(msg))
     if spec.depth <= 1 :
@@ -39,9 +40,9 @@ def print_imagespec (spec, subimage=0, mip=0, msg="") :
     print ("  deep = ", spec.deep)
     for attrib in spec.extra_attribs :
         if type(attrib.value) == str :
-            print (" ", attrib.name, "= \"" + attrib.value + "\"")
+            print ("  {} = \"{}\"".format(attrib.name, attrib.value))
         else :
-            print (" ", attrib.name, "=", attrib.value)
+            print ("  {} = {}".format(attrib.name,attrib.value))
     # Equivalent, using indexing rather than iterating:
     #for i in range(len(spec.extra_attribs)) :
     #    if type(spec.extra_attribs[i].value) == str :
@@ -50,7 +51,7 @@ def print_imagespec (spec, subimage=0, mip=0, msg="") :
     #        print (" ", spec.extra_attribs[i].name, "=", spec.extra_attribs[i].value)
 
 
-def write (image, filename, format=oiio.UNKNOWN) :
+def write (image, filename: str, format=oiio.UNKNOWN) :
     if not image.has_error :
         image.write (filename, format)
     if image.has_error :
@@ -118,6 +119,7 @@ def test_multiimage () :
     print ("Writing multi-image file")
     spec = oiio.ImageSpec (128, 64, 3, "float")
     out = oiio.ImageOutput.create ("multipart.exr")
+    assert out is not None
     # Open with intent to write two subimages, each with same spec
     if not out.open ("multipart.exr", (spec, spec)) :
         print ("Error on initial open:", out.geterror())