Add finite check and improve compatibility tests

dlc_processor: broaden validate_pose_array signature to accept source_backend as PoseBackends|str and add a check_finite option (default True) that raises on non-finite values to catch invalid pose outputs early.

tests: make torch stubbing more robust by using importlib.util.find_spec in tests/compat/conftest.py; update tests/compat/test_dlclive_package_compat.py to refine _get_signature_params typing, import Parameter, and handle constructors that accept **kwargs more gracefully (provide clearer diagnostic when expected GUI kwargs may be passed through).

tox.ini: add a [testenv:dlclive] passenv block for DLCLIVE test env vars and propagate that passenv to dlclive-pypi and dlclive-github envs so DLCLive compatibility tests pick up required environment variables.

Author: C-Achard

dlclivegui/services/dlc_processor.py

@@ -61,7 +61,9 @@ class PosePacket:
     raw: Any | None = None
 
 
-def validate_pose_array(pose: Any, *, source_backend: PoseBackends = PoseBackends.DLC_LIVE) -> np.ndarray:
+def validate_pose_array(
+    pose: Any, *, source_backend: PoseBackends | str = PoseBackends.DLC_LIVE, check_finite: bool = True
+) -> np.ndarray:
     """
     Validate pose output shape and dtype.
 
@@ -101,6 +103,9 @@ def validate_pose_array(pose: Any, *, source_backend: PoseBackends = PoseBackend
             f"{source_backend} returned an invalid pose output format: expected numeric values, got dtype={arr.dtype}"
         )
 
+    if check_finite and not np.isfinite(arr).all():
+        raise ValueError(f"{source_backend} returned an invalid pose output format: contains non-finite values")
+
     return arr
 
 

tests/compat/conftest.py

@@ -1,10 +1,11 @@
 # tests/compat/conftest.py
+import importlib.util
 import sys
 import types
 
 # Stub out torch imports to avoid ImportError when torch is not installed in DLCLive package.
 # This allows testing of DLCLive API compatibility without requiring torch.
 # Ideally imports should be guarded in the package itself, but this is a pragmatic solution for now.
 # IMPORTANT NOTE: This should ideally be removed and replaced whenever possible.
-if "torch" not in sys.modules:
+if importlib.util.find_spec("torch") is None:
     sys.modules["torch"] = types.ModuleType("torch")

tests/compat/test_dlclive_package_compat.py

@@ -3,20 +3,22 @@
 import importlib.metadata
 import inspect
 import os
+from collections.abc import Mapping
+from inspect import Parameter
 from pathlib import Path
 
 import numpy as np
 import pytest
 
 
-def _get_signature_params(callable_obj) -> tuple[set[str], bool]:
+def _get_signature_params(callable_obj) -> tuple[Mapping[str, Parameter], bool]:
     """
-    Return allowed keyword names for callable, allowing for **kwargs.
+    Return allowed keyword names for callable and whether it accepts **kwargs.
 
     Example:
     >>> params, accepts_var_kw = _get_signature_params(lambda x, y, **kwargs: None, {"x", "y"})
-    >>> params == {"x", "y"}
-    True
+    >>> sorted(params)
+    ['x', 'y', 'kwargs']
     >>> accepts_var_kw
     True
     """
@@ -53,13 +55,20 @@ def test_dlclive_constructor_accepts_gui_expected_kwargs():
         "single_animal",
         "device",
     }
-    params, _ = _get_signature_params(DLCLive.__init__)
+    params, accepts_var_kw = _get_signature_params(DLCLive.__init__)
     params = {
         name
         for name, p in params.items()
         if p.kind in (inspect.Parameter.KEYWORD_ONLY, inspect.Parameter.POSITIONAL_OR_KEYWORD)
     }
     missing = {name for name in expected if name not in params}
+    if missing and accepts_var_kw:
+        # DLCLive.__init__ accepts **kwargs, so GUI-passed kwargs are still supported.
+        raise AssertionError(
+            f"DLCLive.__init__ is missing expected kwargs called by GUI: {sorted(missing)}, "
+            "but accepts **kwargs so may still be compatible. "
+            "Please verify that these kwargs are passed through and update this test if so."
+        )
     assert not missing, f"DLCLive.__init__ is missing expected kwargs called by GUI: {sorted(missing)}"
 
 

tox.ini

@@ -47,9 +47,16 @@ passenv =
 ;     ruff check .
 ;     ruff format --check .
 
+[testenv:dlclive]
+passenv =
+    DLCLIVE_TEST_MODEL_PATH
+    DLCLIVE_TEST_MODEL_TYPE
+
 # Run locally : tox -e dlclive-pypi
 [testenv:dlclive-pypi]
 description = DLCLive compatibility tests against specific PyPi release
+passenv =
+    {[testenv:dlclive]passenv}
 deps =
     deeplabcut-live==1.1
 commands =
@@ -58,6 +65,8 @@ commands =
 # Run locally : tox -e dlclive-github
 [testenv:dlclive-github]
 description = DLCLive compatibility tests against GitHub main
+passenv =
+    {[testenv:dlclive]passenv}
 deps =
     git+https://github.com/DeepLabCut/DeepLabCut-live.git@main
 commands =