Add basic compatibility tests for deeplabcut-live API

Author: deruyter92

.github/workflows/testing-ci.yml

@@ -75,3 +75,40 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./coverage.xml
           fail_ci_if_error: false
+
+  dlclive-compat:
+    name: DLCLive Compatibility • ${{ matrix.label }} • py${{ matrix.python }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ['3.11']
+        include:
+          - label: pypi-1.1
+            dlclive_spec: deeplabcut-live==1.1
+          - label: github-main
+            dlclive_spec: git+https://github.com/DeepLabCut/DeepLabCut-live.git@main
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+          cache: 'pip'
+
+      - name: Install package + test dependencies
+        run: |
+          python -m pip install -U pip wheel
+          python -m pip install -e .[test]
+
+      - name: Install matrix DLCLive build
+        run: |
+          python -m pip install --upgrade --force-reinstall "${{ matrix.dlclive_spec }}"
+          python -m pip show deeplabcut-live
+
+      - name: Run DLCLive compatibility tests
+        run: |
+          python -m pytest -m dlclive_compat tests/compat/test_dlclive_package_compat.py -q

pyproject.toml

@@ -115,6 +115,7 @@ markers = [
   "unit: Unit tests for individual components",
   "integration: Integration tests for component interaction",
   "functional: Functional tests for end-to-end workflows",
+  "dlclive_compat: Package/API compatibility tests against supported dlclive versions",
   "hardware: Tests that require specific hardware, notable camera backends",
   # "slow: Tests that take a long time to run",
   "gui: Tests that require GUI interaction",

tests/compat/test_dlclive_package_compat.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+import importlib.metadata
+import inspect
+
+import pytest
+
+
+def _get_signature_params(callable_obj) -> tuple[set[str], bool]:
+    """
+    Return allowed keyword names for callable, allowing for **kwargs.
+    
+    Example:
+    >>> params, accepts_var_kw = _get_signature_params(lambda x, y, **kwargs: None, {"x", "y"})
+    >>> params == {"x", "y"}
+    True
+    >>> accepts_var_kw
+    True
+    """
+    sig = inspect.signature(callable_obj)
+    params = sig.parameters
+    accepts_var_kw = any(p.kind == inspect.Parameter.VAR_KEYWORD for p in params.values())
+    return params, accepts_var_kw
+
+
+@pytest.mark.dlclive_compat
+def test_dlclive_package_is_importable():
+    from dlclive import DLCLive  # noqa: PLC0415
+
+    assert DLCLive is not None
+    # Helpful for CI logs to confirm matrix install result.
+    _ = importlib.metadata.version("deeplabcut-live")
+
+
+@pytest.mark.dlclive_compat
+def test_dlclive_constructor_accepts_gui_expected_kwargs():
+    """
+    GUI passes these kwargs when constructing DLCLive.
+    This test catches upstream API changes that would break initialization.
+    """
+    from dlclive import DLCLive  # noqa: PLC0415
+
+    expected = {
+        "model_path",
+        "model_type",
+        "processor",
+        "dynamic",
+        "resize",
+        "precision",
+        "single_animal",
+        "device",
+    }
+    params, accepts_var_kw = _get_signature_params(DLCLive.__init__)
+    missing = {name for name in expected if name not in params}
+    assert not missing, f"DLCLive.__init__ is missing expected kwargs called by GUI: {sorted(missing)}"
+    assert accepts_var_kw, "DLCLive.__init__ should accept **kwargs" # captures current behavior
+
+
+@pytest.mark.dlclive_compat
+def test_dlclive_methods_match_gui_usage():
+    """
+    GUI expects:
+    - init_inference(frame)
+    - get_pose(frame, frame_time=<float>)
+    """
+    from dlclive import DLCLive  # noqa: PLC0415
+
+    assert hasattr(DLCLive, "init_inference"), "DLCLive must provide init_inference(frame)"
+    assert hasattr(DLCLive, "get_pose"), "DLCLive must provide get_pose(frame, frame_time=...)"
+
+    init_params, _ = _get_signature_params(DLCLive.init_inference)
+    init_missing = {name for name in {"frame"} if name not in init_params}
+    assert not init_missing, f"DLCLive.init_inference signature mismatch, missing: {sorted(init_missing)}"
+
+    get_pose_params, _ = _get_signature_params(DLCLive.get_pose)
+    get_pose_missing = {name for name in {"frame", "frame_time"} if name not in get_pose_params}
+    assert not get_pose_missing, f"DLCLive.get_pose signature mismatch, missing: {sorted(get_pose_missing)}"

tox.ini

@@ -13,7 +13,7 @@ extras = test
 
 # Keep behavior aligned with your GitHub Actions job:
 commands =
-    pytest -m "not hardware" --maxfail=1 --disable-warnings \
+    pytest -m "not hardware and not dlclive_compat" --maxfail=1 --disable-warnings \
         --cov=dlclivegui --cov-report=xml --cov-report=term-missing {posargs}
 
 # Helpful defaults for headless CI runs (Qt/OpenCV):