pyobs-aravis 1.1.4__tar.gz → 2.0.0.dev2__tar.gz

pyobs_aravis-2.0.0.dev2/.github/workflows/ruff.yml

@@ -0,0 +1,26 @@
+name: ruff
+on: push
+
+jobs:
+  ruff:
+    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 .venv && uv sync --all-extras --dev
+
+      - name: Run ruff
+        run: uv run --no-sync ruff check pyobs_aravis/

pyobs_aravis-2.0.0.dev2/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 25.1.0
+    hooks:
+      - id: black
+        language_version: python3.11
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+      - id: ruff

{pyobs_aravis-1.1.4 → pyobs_aravis-2.0.0.dev2}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.4
 Name: pyobs-aravis
-Version: 1.1.4
+Version: 2.0.0.dev2
 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~=1.21
-Requires-Dist: pygobject~=3.42
-Requires-Dist: pyobs-core~=1.0
+Requires-Python: <3.14,>=3.11
+Requires-Dist: numpy<3,>=2.2.5
+Requires-Dist: pyobs-core<3,>=2.0.0.dev1

pyobs_aravis-2.0.0.dev2/README.md

@@ -0,0 +1,50 @@
+*pyobs* for Aravis cameras
+==========================
+
+This is a [pyobs](https://www.pyobs.org) module for cameras supported by the
+[Aravis](https://github.com/AravisProject/aravis) library (GenICam/GigE Vision/USB3 Vision cameras).
+
+
+System dependencies
+--------------------
+Aravis and its GObject introspection bindings are not pip-installable, so they need to be installed via your
+system's package manager before installing *pyobs-aravis*.
+
+On Debian/Ubuntu:
+
+    sudo apt-get install python3-gi python3-gi-cairo gir1.2-aravis-0.8
+
+This provides:
+* **Aravis** itself, together with its GObject introspection typelib (`gir1.2-aravis-0.8`).
+* **PyGObject** (`python3-gi`, `python3-gi-cairo`), the `gi` module used to access Aravis from Python.
+
+Since these packages are installed system-wide, your virtual environment needs access to the system
+site-packages so it can find the `gi` module.
+
+
+Install *pyobs-aravis*
+-----------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-aravis.git
+    cd pyobs-aravis
+
+Create a virtual environment with access to the system site-packages and install the package with
+[uv](https://docs.astral.sh/uv/):
+
+    uv venv --system-site-packages
+    uv sync
+
+Alternatively, with plain `venv`/`pip`:
+
+    python3 -m venv --system-site-packages .venv
+    source .venv/bin/activate
+    pip install .
+
+
+Dependencies
+------------
+* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
+* [numpy](https://numpy.org/) for handling image data.
+* [Aravis](https://github.com/AravisProject/aravis) and [PyGObject](https://pygobject.readthedocs.io/) for
+  accessing the camera, installed via the system's package manager (see above).

pyobs_aravis-2.0.0.dev2/pyobs_aravis/__init__.py

@@ -0,0 +1,3 @@
+from .araviscamera import AravisCamera as AravisCamera
+
+__all__ = ["AravisCamera"]

{pyobs_aravis-1.1.4 → pyobs_aravis-2.0.0.dev2}/pyobs_aravis/araviscamera.py

@@ -1,13 +1,12 @@
 import asyncio
 import logging
 import time
-import numpy.typing as npt
-from typing import Any, Dict, Optional, List
+from typing import Any
 
-from pyobs.interfaces import IExposureTime
+import numpy.typing as npt
+from pyobs.interfaces import ExposureTimeState, IExposureTime
 from pyobs.modules.camera import BaseVideo
 
-
 log = logging.getLogger(__name__)
 
 
@@ -19,7 +18,7 @@ class AravisCamera(BaseVideo, IExposureTime):
     def __init__(
         self,
         device: str,
-        settings: Optional[Dict[str, Any]] = None,
+        settings: dict[str, Any] | None = None,
         buffers: int = 5,
         **kwargs: Any,
     ):
@@ -27,18 +26,18 @@ class AravisCamera(BaseVideo, IExposureTime):
 
         Args:
             device: Name of camera to connect to.
+            settings: Dictionary of camera settings to apply on connect.
+            buffers: Number of acquisition buffers.
         """
         BaseVideo.__init__(self, **kwargs)
         from . import aravis
 
-        # variables
         self._device_name = device
-        self._camera: Optional[aravis.Camera] = None
-        self._settings: Dict[str, Any] = {} if settings is None else settings
+        self._camera: aravis.Camera | None = None
+        self._settings: dict[str, Any] = {} if settings is None else settings
         self._camera_lock = asyncio.Lock()
         self._buffers = buffers
 
-        # thread
         if device is not None:
             self.add_background_task(self._capture)
         else:
@@ -48,15 +47,12 @@ class AravisCamera(BaseVideo, IExposureTime):
         """Open module."""
         from . import aravis
 
-        # open base
         await BaseVideo.open(self)
 
-        # list devices
-        ids: List[str] = aravis.get_device_ids()  # type: ignore
+        ids: list[str] = aravis.get_device_ids()  # type: ignore[assignment]
         if self._device_name not in ids:
             raise ValueError("Could not find given device name in list of available cameras.")
 
-        # open camera
         await self.activate_camera()
 
     async def close(self) -> None:
@@ -69,72 +65,56 @@ class AravisCamera(BaseVideo, IExposureTime):
         """Open camera."""
         from . import aravis
 
-        # open camera
         log.info("Connecting to camera %s...", self._device_name)
-        self._camera = aravis.Camera(self._device_name)  # type: ignore
+        self._camera = aravis.Camera(self._device_name)  # type: ignore[assignment]
         log.info("Connected.")
 
-        # settings
         for key, value in self._settings.items():
-            log.info(f"Setting value {key}={value}...")
-            self._camera.set_feature(key, value)  # type: ignore
+            log.info("Setting value %s=%s...", key, value)
+            self._camera.set_feature(key, value)  # type: ignore[union-attr]
 
-        # start acquisition
-        self._camera.start_acquisition_continuous(nb_buffers=self._buffers)  # type: ignore
+        self._camera.start_acquisition_continuous(nb_buffers=self._buffers)  # type: ignore[union-attr]
 
     def _close_camera(self) -> None:
         """Close camera."""
-        # stop camera
         if self._camera is not None:
             log.info("Closing camera...")
-            self._camera.stop_acquisition()  # type: ignore
-            self._camera.shutdown()  # type: ignore
+            self._camera.stop_acquisition()  # type: ignore[union-attr]
+            self._camera.shutdown()  # type: ignore[union-attr]
         self._camera = None
 
     async def _activate_camera(self) -> None:
-        """Can be overridden by derived class to implement inactivity sleep"""
+        """Open camera on activation."""
         async with self._camera_lock:
             self._open_camera()
 
     async def _deactivate_camera(self) -> None:
-        """Can be overridden by derived class to implement inactivity sleep"""
+        """Close camera on deactivation."""
         async with self._camera_lock:
             self._close_camera()
 
     async def _capture(self) -> None:
         """Take new images in loop."""
-
-        # loop until closing
         last = time.time()
         while True:
             try:
-                # no camera or not active?
                 if self._camera is None or not self.camera_active:
-                    # wait a little
                     await asyncio.sleep(0.1)
                     continue
 
-                # read frame
-                while True:
-                    frame: npt.NDArray[float] = self._camera.pop_frame()  # type: ignore
-                    if frame is None:
-                        await asyncio.sleep(0.01)
-                    else:
-                        break
+                frame: npt.NDArray[Any] = self._camera.pop_frame()  # type: ignore[union-attr]
+                while frame is None:
+                    await asyncio.sleep(0.01)
+                    frame = self._camera.pop_frame()  # type: ignore[union-attr]
 
-                # if time since last image is too short, wait a little
                 if time.time() - last < self._interval:
                     await asyncio.sleep(0.01)
                     continue
 
-                # save time
                 last = time.time()
-
-                # process it
                 await self._set_image(frame)
 
-            except:
-                # whatever happened here, we don't want the method to die
+            except Exception:
                 await asyncio.sleep(1)
 
     async def set_exposure_time(self, exposure_time: float, **kwargs: Any) -> None:
@@ -142,24 +122,10 @@ class AravisCamera(BaseVideo, IExposureTime):
 
         Args:
             exposure_time: Exposure time in seconds.
-
-        Raises:
-            ValueError: If exposure time could not be set.
-        """
-        await self.activate_camera()
-        self._camera.set_exposure_time(exposure_time * 1e6)  # type: ignore
-
-    async def get_exposure_time(self, **kwargs: Any) -> float:
-        """Returns the exposure time in seconds.
-
-        Returns:
-            Exposure time in seconds.
         """
         await self.activate_camera()
-        return self._camera.get_exposure_time() / 1e6  # type: ignore
-
-    async def get_exposure_time_left(self, **kwargs: Any) -> float:
-        return 0.0
+        self._camera.set_exposure_time(exposure_time * 1e6)  # type: ignore[union-attr]
+        await self.comm.set_state(IExposureTime, ExposureTimeState(exposure_time=exposure_time))
 
 
 __all__ = ["AravisCamera"]

pyobs_aravis-2.0.0.dev2/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "pyobs-aravis"
+version = "2.0.0.dev2"
+description = "pyobs module for Aravis cameras"
+authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
+requires-python = ">=3.11,<3.14"
+license = "MIT"
+dependencies = [
+    "numpy>=2.2.5,<3",
+    "pyobs-core>=2.0.0.dev1,<3",
+]
+
+[dependency-groups]
+dev = [
+    "black>=25.1.0,<26",
+    "ruff>=0.9.0",
+    "pyrefly>=1.1.1",
+    "pre-commit>=4.2.0,<5",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.black]
+line-length = 120
+target-version = ['py311']
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "G"]
+exclude = ["pyobs_aravis/aravis.py"]
+
+[tool.pyrefly]
+python-version = "3.11"
+project-excludes = ["pyobs_aravis/aravis.py"]