pyobs-alpaca 2.0.0.dev2__tar.gz → 2.0.0.dev4__tar.gz

pyobs_alpaca-2.0.0.dev4/.flake8

@@ -0,0 +1,14 @@
+[flake8]
+ignore =
+    E203, E266, E501, W503, F403,
+    # E704: Multiple statements on one line (def)
+    E704,
+    # E722: do not use bare 'except'
+    E722
+    # E701: multiple statements on one line (colon)
+    E701
+per-file-ignores = __init__.py:F401
+max-line-length = 120
+max-complexity = 30
+select = B, C, E, F, W, T4, B9
+exclude = .git,.venv,__pycache__,docs,build,dist

pyobs_alpaca-2.0.0.dev4/.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_alpaca-2.0.0.dev4/.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_alpaca-2.0.0.dev4/.github/workflows/pytest.yml

@@ -0,0 +1,25 @@
+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 packages
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests
+        env:
+          CI: true

{pyobs_alpaca-2.0.0.dev2 → pyobs_alpaca-2.0.0.dev4}/.readthedocs.yml

@@ -12,3 +12,4 @@ python:
   install:
     - method: pip
       path: .
+    - requirements: docs/requirements.txt

{pyobs_alpaca-2.0.0.dev2 → pyobs_alpaca-2.0.0.dev4}/PKG-INFO

@@ -1,10 +1,10 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pyobs-alpaca
-Version: 2.0.0.dev2
+Version: 2.0.0.dev4
 Summary: pyobs module for ASCOM Alpaca
 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

pyobs_alpaca-2.0.0.dev4/README.md

@@ -0,0 +1,65 @@
+ASCOM Alpaca wrapper for *pyobs*
+================================
+
+This is a [pyobs](https://www.pyobs.org) module for wrapping devices accessible via
+[ASCOM Alpaca](https://ascom-standards.org/AlpacaDeveloper/), a HTTP proxy for ASCOM. It provides
+telescope, focuser and dome implementations.
+
+
+Install *pyobs-alpaca*
+-----------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-alpaca.git
+    cd pyobs-alpaca
+
+Install it with [uv](https://docs.astral.sh/uv/):
+
+    uv sync
+
+Alternatively, with plain `venv`/`pip`:
+
+    python3 -m venv .venv
+    source .venv/bin/activate
+    pip install .
+
+
+Configuration
+-------------
+This is an example configuration for a telescope:
+
+    class: pyobs_alpaca.AlpacaTelescope
+    name: ASCOM Telescope
+    server: 1.2.3.4
+    port: 11111
+    device_type: telescope
+    device: 0
+    wait_for_dome: dome
+    weather: weather
+    alive_parameter: Name
+
+And for a focusing unit:
+
+    class: pyobs_alpaca.AlpacaFocuser
+    name: ASCOM Focuser
+    server: 1.2.3.4
+    port: 11111
+    device_type: focuser
+    device: 0
+    alive_parameter: Position
+
+And finally, for a dome:
+
+    class: pyobs_alpaca.AlpacaDome
+    server: 1.2.3.4
+    port: 11111
+    device_type: dome
+    device: 0
+    follow: telescope
+    weather: weather
+
+
+Dependencies
+------------
+* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
+* [NumPy](https://numpy.org/) for array handling.

pyobs_alpaca-2.0.0.dev4/docs/requirements.txt

@@ -0,0 +1 @@
+sphinx-rtd-theme

{pyobs_alpaca-2.0.0.dev2 → pyobs_alpaca-2.0.0.dev4}/pyobs_alpaca/focuser.py

@@ -2,7 +2,7 @@ import asyncio
 import logging
 from typing import Any
 
-from pyobs.interfaces import FocuserState, IFitsHeaderBefore, IFocuser, IReady, ReadyState
+from pyobs.interfaces import FitsHeaderEntry, FocuserState, IFitsHeaderBefore, IFocuser, IReady, ReadyState
 from pyobs.mixins import MotionStatusMixin
 from pyobs.modules import Module, timeout
 from pyobs.utils import exceptions as exc
@@ -34,7 +34,7 @@ class AlpacaFocuser(MotionStatusMixin, IFocuser, IFitsHeaderBefore, Module):
         MotionStatusMixin.__init__(self, motion_status_interfaces=["IFocuser"])
 
         # register exception
-        exc.register_exception(exc.MotionError, 3, timespan=600, callback=self._default_remote_error_callback)
+        self._register_exception(exc.MotionError, 3, timespan=600, callback=self._default_remote_error_callback)
 
     async def open(self) -> None:
         """Open module."""
@@ -57,13 +57,13 @@ class AlpacaFocuser(MotionStatusMixin, IFocuser, IFitsHeaderBefore, Module):
 
     async def get_fits_header_before(
         self, namespaces: list[str] | None = None, **kwargs: Any
-    ) -> dict[str, tuple[Any, str]]:
+    ) -> dict[str, FitsHeaderEntry]:
         """Returns FITS header for the current status of this module."""
 
         try:
             pos = await self._device.get("Position")
             step = await self._device.get("StepSize") * 1000.0
-            return {"TEL-FOCU": (pos / step, "Focus of telescope [mm]")}
+            return {"TEL-FOCU": FitsHeaderEntry(pos / step, "Focus of telescope [mm]")}
         except ConnectionError as e:
             log.warning("Could not determine focus position: %s", e)
             return {}

{pyobs_alpaca-2.0.0.dev2 → pyobs_alpaca-2.0.0.dev4}/pyobs_alpaca/telescope.py

@@ -6,6 +6,7 @@ import numpy as np
 from pyobs.events import OffsetsRaDecEvent
 from pyobs.interfaces import (
     AltAzState,
+    FitsHeaderEntry,
     IFitsHeaderBefore,
     IOffsetsRaDec,
     IPointingAltAz,
@@ -219,6 +220,10 @@ class AlpacaTelescope(BaseTelescope, FitsNamespaceMixin, IFitsHeaderBefore, IOff
             await self.stop_motion()
             raise exc.MoveError("Could not move telescope to RA/Dec.")
 
+    async def _set_tracking_rate(self, ra_rate: float, dec_rate: float) -> None:
+        """Tracking rates are not supported by the Alpaca telescope driver."""
+        raise NotImplementedError
+
     @timeout(10000)
     async def set_offsets_radec(self, dra: float, ddec: float, **kwargs: Any) -> None:
         """Move an RA/Dec offset."""
@@ -295,14 +300,14 @@ class AlpacaTelescope(BaseTelescope, FitsNamespaceMixin, IFitsHeaderBefore, IOff
 
     async def get_fits_header_before(
         self, namespaces: list[str] | None = None, **kwargs: Any
-    ) -> dict[str, tuple[Any, str]]:
+    ) -> dict[str, FitsHeaderEntry]:
         """Returns FITS header for the current status of this module."""
 
         hdr = await BaseTelescope.get_fits_header_before(self)
 
         try:
-            hdr["RAOFF"] = (self._offset_ra, "RA offset [deg]")
-            hdr["DECOFF"] = (self._offset_dec, "Dec offset [deg]")
+            hdr["RAOFF"] = FitsHeaderEntry(self._offset_ra, "RA offset [deg]")
+            hdr["DECOFF"] = FitsHeaderEntry(self._offset_dec, "Dec offset [deg]")
             return self._filter_fits_namespace(hdr, namespaces=namespaces, **kwargs)
         except ConnectionError:
             return {}

{pyobs_alpaca-2.0.0.dev2 → pyobs_alpaca-2.0.0.dev4}/pyproject.toml

@@ -1,21 +1,23 @@
 [project]
 name = "pyobs-alpaca"
-version = "2.0.0.dev2"
+version = "2.0.0.dev4"
 description = "pyobs module for ASCOM Alpaca"
 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",
 ]
 
 [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]
@@ -35,3 +37,6 @@ select = ["E", "F", "W", "I", "UP", "G"]
 
 [tool.pyrefly]
 python-version = "3.11"
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"

pyobs_alpaca-2.0.0.dev4/tests/test_device.py

@@ -0,0 +1,68 @@
+"""Unit tests for the pure, non-hardware logic in AlpacaDevice.
+
+Hardware I/O (open/close, talking to the ASCOM server) is out of scope here; these cover
+URL construction, version validation, the connection guard, and the connected-state
+transition logic.
+"""
+
+from typing import Any
+
+import pytest
+
+from pyobs_alpaca.device import AlpacaDevice
+
+_ARGS = dict(server="myserver", port=11111, device_type="telescope", device=3)
+
+
+def test_build_alpaca_url() -> None:
+    device = AlpacaDevice(**_ARGS)
+    assert device._build_alpaca_url("RightAscension") == ("http://myserver:11111/api/v1/telescope/3/rightascension")
+
+
+def test_only_v1_supported() -> None:
+    with pytest.raises(ValueError):
+        AlpacaDevice(**_ARGS, version="v2")
+
+
+def test_starts_disconnected() -> None:
+    device = AlpacaDevice(**_ARGS)
+    assert device.connected is False
+
+
+@pytest.mark.asyncio
+async def test_get_requires_connection() -> None:
+    device = AlpacaDevice(**_ARGS)
+    with pytest.raises(ConnectionError):
+        await device.get("RightAscension")
+
+
+@pytest.mark.asyncio
+async def test_put_requires_connection() -> None:
+    device = AlpacaDevice(**_ARGS)
+    with pytest.raises(ConnectionError):
+        await device.put("Tracking", Tracking=False)
+
+
+@pytest.mark.asyncio
+async def test_check_connected_sets_flag_on_success(monkeypatch: pytest.MonkeyPatch) -> None:
+    device = AlpacaDevice(**_ARGS)
+
+    async def fake_get(name: str) -> Any:
+        return True
+
+    monkeypatch.setattr(device, "_get", fake_get)
+    await device._check_connected()
+    assert device.connected is True
+
+
+@pytest.mark.asyncio
+async def test_check_connected_clears_flag_on_connection_error(monkeypatch: pytest.MonkeyPatch) -> None:
+    device = AlpacaDevice(**_ARGS)
+    device._connected = True
+
+    async def fake_get(name: str) -> Any:
+        raise ConnectionError
+
+    monkeypatch.setattr(device, "_get", fake_get)
+    await device._check_connected()
+    assert device.connected is False

pyobs_alpaca-2.0.0.dev4/tests/test_import.py

@@ -0,0 +1,47 @@
+"""Smoke tests: import every public module and instantiate each driver class with a
+missing/mocked hardware connection, asserting it loads and advertises the interfaces it
+claims.
+
+No real hardware or ASCOM server is involved: instantiation only registers background
+tasks, which never start until open() is called.
+"""
+
+from pyobs.interfaces import (
+    IDome,
+    IFitsHeaderBefore,
+    IFocuser,
+    IOffsetsRaDec,
+    ISyncTarget,
+    ITelescope,
+)
+from pyobs.object import Object
+
+from pyobs_alpaca import AlpacaDome, AlpacaFocuser, AlpacaTelescope
+from pyobs_alpaca.device import AlpacaDevice
+
+_TELESCOPE_ARGS = dict(server="localhost", port=11111, device_type="telescope", device=0)
+
+
+def test_import_device_and_instantiate() -> None:
+    device = AlpacaDevice(**_TELESCOPE_ARGS)
+    assert isinstance(device, Object)
+    assert not device.connected
+
+
+def test_import_telescope_and_instantiate() -> None:
+    telescope = AlpacaTelescope(**_TELESCOPE_ARGS)
+    assert isinstance(telescope, ITelescope)
+    assert isinstance(telescope, IFitsHeaderBefore)
+    assert isinstance(telescope, IOffsetsRaDec)
+    assert isinstance(telescope, ISyncTarget)
+
+
+def test_import_focuser_and_instantiate() -> None:
+    focuser = AlpacaFocuser(server="localhost", port=11111, device_type="focuser", device=0)
+    assert isinstance(focuser, IFocuser)
+    assert isinstance(focuser, IFitsHeaderBefore)
+
+
+def test_import_dome_and_instantiate() -> None:
+    dome = AlpacaDome(server="localhost", port=11111, device_type="dome", device=0)
+    assert isinstance(dome, IDome)