Improved Nox with optional dependencies for CUDA, HIP, OpenCL and arg…

…uments to disable these

.github/workflows/test-python-package.yml

@@ -27,7 +27,7 @@ jobs:
             - uses: actions/checkout@v4
             - name: Run tests with Nox
               uses: fjwillemsen/[email protected]
-            - run: nox
+            - run: nox -- skip-gpu
             # - name: Upload Coverage report to CodeCov
             #   uses: codecov/codecov-action@v3
             #   with:

noxfile.py

@@ -6,6 +6,8 @@
 """
 
 
+import platform
+
 import nox
 
 # from nox_poetry import Session, session   # nox_poetry is a better option, but <=1.0.3 has a bug with filename-URLs
@@ -27,13 +29,78 @@
 def tests(session: nox.Session) -> None:
     """Run the tests for the specified Python versions."""
     session.install("poetry")
-    session.run("poetry", "install", "--with", "test", external=True)
 
-    # for the last Python version session:
-    if session.python == python_versions_to_test[-1]:
-        # run pytest on the package without C-extensions to generate the correct coverage report
+    # check if optional dependencies have been disabled by user arguments (e.g. `nox -- skip-gpu`, `nox -- skip-cuda`)
+    install_cuda = True
+    install_hip = True
+    install_opencl = True
+    if session.posargs:
+        for arg in session.posargs:
+            if arg.lower() == "skip-gpu":
+                install_cuda = False
+                install_hip = False
+                install_opencl = False
+                break
+            elif arg.lower() == "skip-cuda":
+                install_cuda = False
+            elif arg.lower() == "skip-hip":
+                install_hip = False
+            elif arg.lower() == "skip-opencl":
+                install_opencl = False
+            else:
+                raise ValueError(f"Unrecognized argument {arg}")
+
+    # check if there are optional dependencies that can not be installed
+    if install_hip:
+        if platform.system().lower() != 'linux':
+            session.warn("HIP is only available on Linux, disabling dependency and tests")
+            install_hip = False
+
+    # set extra arguments based on optional dependencies
+    extras_args = []
+    if install_cuda:
+        extras_args.extend(["-E", "cuda"])
+    if install_hip:
+        extras_args.extend(["-E", "hip"])
+    if install_opencl:
+        extras_args.extend(["-E", "opencl"])
+
+    # separately install optional dependencies with weird dependencies / build process
+    install_warning = """Installation failed, this likely means that the required hardware or drivers are missing.
+                  Run with `-- skip-gpu` or one of the more specific options (e.g. `-- skip-cuda`) to avoid this."""
+    if install_cuda:
+        # if we need to install the CUDA extras, first install pycuda seperately.
+        #   since version 2022.2 it has `oldest-supported-numpy` as a build dependency which doesn't work with Poetry
+        try:
+            session.install("pycuda")       # Attention: if changed, check `pycuda` in pyproject.toml as well
+        except Exception as error:
+            print(error)
+            session.warn(install_warning)
+    if install_opencl and (session.python == "3.7" or session.python == "3.8"):
+        # if we need to install the OpenCL extras, first install pyopencl seperately.
+        # it has `oldest-supported-numpy` as a build dependency which doesn't work with Poetry, but only for Python<3.9
+        try:
+            session.install("pyopencl")       # Attention: if changed, check `pyopencl` in pyproject.toml as well
+        except Exception as error:
+            print(error)
+            session.warn(install_warning)
+
+    # finally, install the dependencies, optional dependencies and the package itself
+    try:
+        session.run("poetry", "install", "--with", "test", *extras_args, external=True)
+    except Exception as error:
+        session.warn(install_warning)
+        raise error
+
+    # for the last Python version session if all optional dependencies are enabled:
+    if session.python == python_versions_to_test[-1] and install_cuda and install_hip and install_opencl:
+        # run pytest on the package to generate the correct coverage report
         session.run("pytest")
     else:
         # for the other Python version sessions:
         # run pytest without coverage reporting
         session.run("pytest", "--no-cov")
+
+    # report if no coverage report
+    if not (install_cuda and install_hip and install_opencl):
+        session.warn("Tests ran successfully, but only a subset. Coverage file not generated.")