pyobs-aravis 2.0.0.dev10__tar.gz → 2.0.0.dev12__tar.gz

pyobs_aravis-2.0.0.dev12/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+    target-branch: "develop"
+    groups:
+      patch-and-minor:
+        update-types:
+          - "minor"
+          - "patch"
+    labels:
+      - "dependencies"

pyobs_aravis-2.0.0.dev12/.github/workflows/pyrefly.yml

@@ -0,0 +1,23 @@
+name: pyrefly
+on: push
+
+jobs:
+  pyrefly:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Install packages
+        run: uv sync --all-extras --dev
+
+      - name: Run pyrefly
+        run: uv run pyrefly check

pyobs_aravis-2.0.0.dev12/.github/workflows/pytest.yml

@@ -0,0 +1,28 @@
+name: PyTest
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Install system dependencies
+        run: sudo apt-get install -y python3-gi python3-gi-cairo gir1.2-aravis-0.8
+
+      - name: Install packages
+        run: uv venv --system-site-packages --clear .venv && uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests
+        env:
+          CI: true

{pyobs_aravis-2.0.0.dev10 → pyobs_aravis-2.0.0.dev12}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pyobs-aravis
-Version: 2.0.0.dev10
+Version: 2.0.0.dev12
 Summary: pyobs module for Aravis cameras
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT
 License-File: LICENSE
 Requires-Python: >=3.11
 Requires-Dist: numpy<3,>=2.2.5
-Requires-Dist: pyobs-core<3,>=2.0.0.dev1
+Requires-Dist: pyobs-core<3,>=2.0.0.dev48
 Provides-Extra: gui
-Requires-Dist: pyobs-core[gui]<3,>=2.0.0.dev1; extra == 'gui'
+Requires-Dist: pyobs-core[gui]<3,>=2.0.0.dev48; extra == 'gui'
 Requires-Dist: qasync>=0.28.0; extra == 'gui'

{pyobs_aravis-2.0.0.dev10 → pyobs_aravis-2.0.0.dev12}/pyobs_aravis/araviscamera.py

@@ -37,7 +37,10 @@ class AravisCamera(BaseVideo, IExposureTime):
         """Initializes a new AravisCamera.
 
         Args:
-            device: Name of camera to connect to.
+            device: Name or IP address of camera to connect to. An IP address connects directly,
+                without relying on the network's broadcast-based device discovery -- useful on
+                networks that block or drop that broadcast traffic even though unicast GVCP
+                control traffic works fine (verify with e.g. `arv-tool-0.8 -a <ip> features`).
             settings: Dictionary of camera settings to apply on connect.
             buffers: Number of acquisition buffers.
         """
@@ -58,27 +61,18 @@ class AravisCamera(BaseVideo, IExposureTime):
 
     async def open(self) -> None:
         """Open module."""
-        from . import aravis
-
         await BaseVideo.open(self)
 
-        # device discovery is a blocking, network-based scan (GigE Vision/USB3 Vision devices
-        # reply to a broadcast query) that can take multiple seconds -- run it like the other
-        # aravis/GLib calls (see _run_blocking) instead of freezing the whole module's event
-        # loop, and with it, the ability to respond to any other module, for that long
-        ids: list[str] = []
-
-        def _list_device_ids() -> None:
-            ids.extend(aravis.get_device_ids())  # type: ignore[arg-type]
-
-        if not await self._run_blocking(_list_device_ids):
-            raise TimeoutError(f"Timed out listing available cameras after {_SDK_CALL_TIMEOUT}s.")
-
-        if self._camera_device_name not in ids:
-            raise ValueError("Could not find given device name in list of available cameras.")
-
+        # connecting (see _open_camera) validates the device itself -- no separate discovery
+        # pre-check here, since that relies on a network-wide broadcast query that some networks
+        # block or drop even though unicast GVCP control traffic (i.e. the actual connection)
+        # works fine
         await self.activate_camera()
 
+        # publish initial exposure-time state -- otherwise a caller doing wait_for_state()
+        # before the first set_exposure_time() call would time out with nothing ever published
+        await self.comm.set_state(IExposureTime, ExposureTimeState(exposure_time=self._exposure_time))
+
     async def close(self) -> None:
         """Close the module."""
         await BaseVideo.close(self)
@@ -118,22 +112,30 @@ class AravisCamera(BaseVideo, IExposureTime):
 
         Returns:
             True if func completed within timeout, False if it's still running in the background.
+
+        Raises:
+            Whatever exception func() raised, if it completed within timeout.
         """
         loop = asyncio.get_running_loop()
         future: asyncio.Future[None] = loop.create_future()
+        error: list[BaseException] = []
 
         def _wrapper() -> None:
             try:
                 func()
+            except BaseException as exc:
+                error.append(exc)
             finally:
                 loop.call_soon_threadsafe(future.set_result, None)
 
         threading.Thread(target=_wrapper, daemon=True).start()
         try:
             await asyncio.wait_for(future, timeout=timeout)
-            return True
         except TimeoutError:
             return False
+        if error:
+            raise error[0]
+        return True
 
     async def _activate_camera(self) -> None:
         """Open camera on activation."""

{pyobs_aravis-2.0.0.dev10 → pyobs_aravis-2.0.0.dev12}/pyproject.toml

@@ -1,18 +1,18 @@
 [project]
 name = "pyobs-aravis"
-version = "2.0.0.dev10"
+version = "2.0.0.dev12"
 description = "pyobs module for Aravis cameras"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"
 license = "MIT"
 dependencies = [
     "numpy>=2.2.5,<3",
-    "pyobs-core>=2.0.0.dev1,<3",
+    "pyobs-core>=2.0.0.dev48,<3",
 ]
 
 [project.optional-dependencies]
 gui = [
-    "pyobs-core[gui]>=2.0.0.dev1,<3",
+    "pyobs-core[gui]>=2.0.0.dev48,<3",
     "qasync>=0.28.0",
 ]
 
@@ -21,10 +21,12 @@ aravis-gui = 'pyobs_aravis.gui:main'
 
 [dependency-groups]
 dev = [
-    "black>=25.1.0,<26",
+    "black>=25.1.0,<27",
     "ruff>=0.9.0",
     "pyrefly>=1.1.1",
     "pre-commit>=4.2.0,<5",
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.24.0",
 ]
 
 [build-system]
@@ -45,4 +47,7 @@ exclude = ["pyobs_aravis/aravis.py"]
 
 [tool.pyrefly]
 python-version = "3.11"
-project-excludes = ["pyobs_aravis/aravis.py"]
+project-excludes = ["pyobs_aravis/aravis.py", "pyobs_aravis/gui.py"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"

pyobs_aravis-2.0.0.dev12/tests/test_araviscamera.py

@@ -0,0 +1,42 @@
+"""Unit tests for the non-hardware logic in AravisCamera: the _run_blocking timeout
+wrapper. gi/Aravis are not needed for these.
+"""
+
+import asyncio
+import threading
+
+import pytest
+
+from pyobs_aravis import AravisCamera
+
+
+@pytest.mark.asyncio
+async def test_run_blocking_runs_func_and_returns_true() -> None:
+    ran: list[bool] = []
+
+    def fast() -> None:
+        ran.append(True)
+
+    assert await AravisCamera._run_blocking(fast) is True
+    assert ran == [True]
+
+
+@pytest.mark.asyncio
+async def test_run_blocking_times_out() -> None:
+    done = threading.Event()
+
+    def slow() -> None:
+        done.wait()
+
+    assert await AravisCamera._run_blocking(slow, timeout=0.01) is False
+    done.set()
+    await asyncio.sleep(0.05)
+
+
+@pytest.mark.asyncio
+async def test_run_blocking_reraises_func_exception() -> None:
+    def failing() -> None:
+        raise ValueError("camera not found")
+
+    with pytest.raises(ValueError, match="camera not found"):
+        await AravisCamera._run_blocking(failing)

pyobs_aravis-2.0.0.dev12/tests/test_import.py

@@ -0,0 +1,26 @@
+"""Smoke tests: importing the package must not require gi/Aravis; instantiating the
+driver does (AravisCamera.__init__ pulls in the vendored aravis.py -> gi -> Aravis
+typelib), so the instantiate test skips when gi isn't available.
+
+In CI the pytest workflow installs python3-gi + gir1.2-aravis-0.8 (mirroring
+ruff.yml), so the instantiate test actually runs there.
+"""
+
+import pytest
+from pyobs.interfaces import IExposureTime, IVideo
+from pyobs.modules import Module
+
+from pyobs_aravis import AravisCamera
+
+
+def test_import_module_without_native() -> None:
+    assert AravisCamera is not None
+
+
+def test_instantiate_camera() -> None:
+    pytest.importorskip("gi")
+
+    camera = AravisCamera(device="test-camera")
+    assert isinstance(camera, Module)
+    assert isinstance(camera, IExposureTime)
+    assert isinstance(camera, IVideo)