ophyd-async 0.8.0a6__py3-none-any.whl → 0.9.0__py3-none-any.whl

ophyd_async/plan_stubs/_nd_attributes.py

@@ -50,11 +50,13 @@ def setup_ndattributes(
 
 
 def setup_ndstats_sum(detector: Device):
-    hdf = getattr(detector, "hdf", None)
-    assert isinstance(hdf, NDFileHDFIO), (
-        f"Expected {detector.name} to have 'hdf' attribute that is an NDFilHDFIO, "
-        f"got {hdf}"
-    )
+    hdf = getattr(detector, "fileio", None)
+    if not isinstance(hdf, NDFileHDFIO):
+        msg = (
+            f"Expected {detector.name} to have 'fileio' attribute that is an "
+            f"NDFileHDFIO, got {hdf}"
+        )
+        raise TypeError(msg)
     yield from (
         setup_ndattributes(
             hdf,

ophyd_async/plan_stubs/_panda.py

@@ -0,0 +1,13 @@
+from bluesky.utils import MsgGenerator, plan
+
+from ophyd_async.core import Settings
+from ophyd_async.fastcs import panda
+
+from ._settings import apply_settings
+
+
+@plan
+def apply_panda_settings(settings: Settings[panda.HDFPanda]) -> MsgGenerator[None]:
+    units, others = settings.partition(lambda signal: signal.name.endswith("_units"))
+    yield from apply_settings(units)
+    yield from apply_settings(others)

ophyd_async/plan_stubs/_settings.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+
+import asyncio
+from collections.abc import Callable, Mapping
+from typing import Any
+
+import bluesky.plan_stubs as bps
+import numpy as np
+from bluesky.utils import MsgGenerator, plan
+
+from ophyd_async.core import (
+    Device,
+    Settings,
+    SettingsProvider,
+    SignalRW,
+    T,
+    walk_rw_signals,
+)
+from ophyd_async.core._table import Table
+
+from ._wait_for_awaitable import wait_for_awaitable
+
+
+@plan
+def _get_values_of_signals(
+    signals: Mapping[T, SignalRW],
+) -> MsgGenerator[dict[T, Any]]:
+    coros = [sig.get_value() for sig in signals.values()]
+    values = yield from wait_for_awaitable(asyncio.gather(*coros))
+    named_values = dict(zip(signals, values, strict=True))
+    return named_values
+
+
+@plan
+def get_current_settings(device: Device) -> MsgGenerator[Settings]:
+    signals = walk_rw_signals(device)
+    named_values = yield from _get_values_of_signals(signals)
+    signal_values = {signals[name]: value for name, value in named_values.items()}
+    return Settings(device, signal_values)
+
+
+@plan
+def store_settings(
+    provider: SettingsProvider, name: str, device: Device
+) -> MsgGenerator[None]:
+    """Walk a Device for SignalRWs and store their values with a provider associated
+    with the given name.
+    """
+    signals = walk_rw_signals(device)
+    named_values = yield from _get_values_of_signals(signals)
+    yield from wait_for_awaitable(provider.store(name, named_values))
+
+
+@plan
+def retrieve_settings(
+    provider: SettingsProvider, name: str, device: Device
+) -> MsgGenerator[Settings]:
+    """Retrieve named Settings for a Device from a provider."""
+    named_values = yield from wait_for_awaitable(provider.retrieve(name))
+    signals = walk_rw_signals(device)
+    unknown_names = set(named_values) - set(signals)
+    if unknown_names:
+        raise NameError(f"Unknown signal names {sorted(unknown_names)}")
+    signal_values = {signals[name]: value for name, value in named_values.items()}
+    return Settings(device, signal_values)
+
+
+@plan
+def apply_settings(settings: Settings) -> MsgGenerator[None]:
+    """Set every SignalRW to the given value in Settings. If value is None ignore it."""
+    signal_values = {
+        signal: value for signal, value in settings.items() if value is not None
+    }
+    if signal_values:
+        for signal, value in signal_values.items():
+            yield from bps.abs_set(signal, value, group="apply_settings")
+        yield from bps.wait("apply_settings")
+
+
+@plan
+def apply_settings_if_different(
+    settings: Settings,
+    apply_plan: Callable[[Settings], MsgGenerator[None]],
+    current_settings: Settings | None = None,
+) -> MsgGenerator[None]:
+    """Set every SignalRW in settings to its given value if it is different to the
+    current value.
+
+    Parameters
+    ----------
+    apply_plan:
+        A device specific plan which takes the Settings to apply and applies them to
+        the Device. Used to add device specific ordering to setting the signals.
+    current_settings:
+        If given, should be a superset of settings containing the current value of
+        the Settings in the Device. If not given it will be created by reading just
+        the signals given in settings.
+    """
+    if current_settings is None:
+        # If we aren't give the current settings, then get the
+        # values of just the signals we were asked to change.
+        # This allows us to use this plan with Settings for a subset
+        # of signals in the Device without retrieving them all
+        signal_values = yield from _get_values_of_signals(
+            {sig: sig for sig in settings}
+        )
+        current_settings = Settings(settings.device, signal_values)
+
+    def _is_different(current, required) -> bool:
+        if isinstance(current, Table):
+            current = current.model_dump()
+            if isinstance(required, Table):
+                required = required.model_dump()
+            return current.keys() != required.keys() or any(
+                _is_different(current[k], required[k]) for k in current
+            )
+        elif isinstance(current, np.ndarray):
+            return not np.array_equal(current, required)
+        else:
+            return current != required
+
+    settings_to_change, _ = settings.partition(
+        lambda sig: _is_different(current_settings[sig], settings[sig])
+    )
+    yield from apply_plan(settings_to_change)

ophyd_async/plan_stubs/_wait_for_awaitable.py

@@ -0,0 +1,13 @@
+from collections.abc import Awaitable
+
+import bluesky.plan_stubs as bps
+from bluesky.utils import MsgGenerator, plan
+
+from ophyd_async.core import T
+
+
+@plan
+def wait_for_awaitable(coro: Awaitable[T]) -> MsgGenerator[T]:
+    """Wait for a single awaitable to complete, and return the result."""
+    (task,) = yield from bps.wait_for([lambda: coro])
+    return task.result()

ophyd_async/sim/__init__.py

@@ -0,0 +1,19 @@
+from ._pattern_detector import (
+    DATA_PATH,
+    SUM_PATH,
+    PatternDetector,
+    PatternDetectorController,
+    PatternDetectorWriter,
+    PatternGenerator,
+)
+from ._sim_motor import SimMotor
+
+__all__ = [
+    "DATA_PATH",
+    "SUM_PATH",
+    "PatternGenerator",
+    "PatternDetector",
+    "PatternDetectorController",
+    "PatternDetectorWriter",
+    "SimMotor",
+]

ophyd_async/sim/{demo/_pattern_detector → _pattern_detector}/_pattern_detector_controller.py

@@ -27,8 +27,15 @@ class PatternDetectorController(DetectorController):
         )
 
     async def arm(self):
-        assert self._trigger_info.livetime
-        assert self.period
+        if not hasattr(self, "_trigger_info"):
+            msg = "TriggerInfo information is missing, has 'prepare' been called?"
+            raise RuntimeError(msg)
+        if not self._trigger_info.livetime:
+            msg = "Livetime information is missing in trigger info"
+            raise ValueError(msg)
+        if not self.period:
+            msg = "Period is not set"
+            raise ValueError(msg)
         self.task = asyncio.create_task(
             self._coroutine_for_image_writing(
                 self._trigger_info.livetime,

ophyd_async/sim/{demo/_pattern_detector → _pattern_detector}/_pattern_generator.py

@@ -67,11 +67,14 @@ class PatternGenerator:
 
     def write_data_to_dataset(self, path: str, data_shape: tuple[int, ...], data):
         """Write data to named dataset, resizing to fit and flushing after."""
-        assert self._handle_for_h5_file, "no file has been opened!"
+        if not self._handle_for_h5_file:
+            msg = "No file has been opened!"
+            raise OSError(msg)
+
         dset = self._handle_for_h5_file[path]
-        assert isinstance(
-            dset, h5py.Dataset
-        ), f"Expected {path} to be dataset, got {dset}"
+        if not isinstance(dset, h5py.Dataset):
+            msg = f"Expected {path} to be a dataset, got {type(dset).__name__}"
+            raise TypeError(msg)
         dset.resize((self.image_counter + 1,) + data_shape)
         dset[self.image_counter] = data
         dset.flush()
@@ -114,7 +117,9 @@ class PatternGenerator:
 
         self._handle_for_h5_file = h5py.File(self.target_path, "w", libver="latest")
 
-        assert self._handle_for_h5_file, "not loaded the file right"
+        if not self._handle_for_h5_file:
+            msg = f"Problem opening file {self.target_path}"
+            raise OSError(msg)
 
         self._handle_for_h5_file.create_dataset(
             name=DATA_PATH,
@@ -184,7 +189,9 @@ class PatternGenerator:
             # cannot get the full filename the HDF writer will write
             # until the first frame comes in
             if not self._hdf_stream_provider:
-                assert self.target_path, "open file has not been called"
+                if self.target_path is None:
+                    msg = "open file has not been called"
+                    raise RuntimeError(msg)
                 self._hdf_stream_provider = HDFFile(
                     self.target_path,
                     self._datasets,

ophyd_async/sim/{demo/_sim_motor.py → _sim_motor.py}

@@ -2,6 +2,7 @@ import asyncio
 import contextlib
 import time
 
+import numpy as np
 from bluesky.protocols import Movable, Stoppable
 
 from ophyd_async.core import (
@@ -44,22 +45,20 @@ class SimMotor(StandardReadable, Movable, Stoppable):
 
     async def _move(self, old_position: float, new_position: float, move_time: float):
         start = time.monotonic()
-        distance = abs(new_position - old_position)
-        while True:
-            time_elapsed = round(time.monotonic() - start, 2)
-
-            # update position based on time elapsed
-            if time_elapsed >= move_time:
-                # successfully reached our target position
-                self._user_readback_set(new_position)
-                break
-            else:
-                current_position = old_position + distance * time_elapsed / move_time
-
-            self._user_readback_set(current_position)
-
-            # 10hz update loop
-            await asyncio.sleep(0.1)
+        # Make an array of relative update times at 10Hz intervals
+        update_times = np.arange(0.1, move_time, 0.1)
+        # With the end position appended
+        update_times = np.concatenate((update_times, [move_time]))
+        # Interpolate the [old, new] position array with those update times
+        new_positions = np.interp(
+            update_times, [0, move_time], [old_position, new_position]
+        )
+        for update_time, new_position in zip(update_times, new_positions, strict=True):
+            # Calculate how long to wait to get there
+            relative_time = time.monotonic() - start
+            await asyncio.sleep(update_time - relative_time)
+            # Update the readback position
+            self._user_readback_set(new_position)
 
     @WatchableAsyncStatus.wrap
     async def set(self, value: float):
@@ -75,22 +74,25 @@ class SimMotor(StandardReadable, Movable, Stoppable):
             self.velocity.get_value(),
         )
         # If zero velocity, do instant move
-        move_time = abs(new_position - old_position) / velocity if velocity else 0
-        self._move_status = AsyncStatus(
-            self._move(old_position, new_position, move_time)
-        )
-        # If stop is called then this will raise a CancelledError, ignore it
-        with contextlib.suppress(asyncio.CancelledError):
-            async for current_position in observe_value(
-                self.user_readback, done_status=self._move_status
-            ):
-                yield WatcherUpdate(
-                    current=current_position,
-                    initial=old_position,
-                    target=new_position,
-                    name=self.name,
-                    unit=units,
-                )
+        if velocity == 0:
+            self._user_readback_set(new_position)
+        else:
+            move_time = abs(new_position - old_position) / velocity
+            self._move_status = AsyncStatus(
+                self._move(old_position, new_position, move_time)
+            )
+            # If stop is called then this will raise a CancelledError, ignore it
+            with contextlib.suppress(asyncio.CancelledError):
+                async for current_position in observe_value(
+                    self.user_readback, done_status=self._move_status
+                ):
+                    yield WatcherUpdate(
+                        current=current_position,
+                        initial=old_position,
+                        target=new_position,
+                        name=self.name,
+                        unit=units,
+                    )
         if not self._set_success:
             raise RuntimeError("Motor was stopped")
 

ophyd_async/tango/core/_signal.py

@@ -28,6 +28,8 @@ from tango.asyncio import DeviceProxy as AsyncDeviceProxy
 
 from ._tango_transport import TangoSignalBackend, get_python_type
 
+logger = logging.getLogger("ophyd_async")
+
 
 def make_backend(
     datatype: type[SignalDatatypeT] | None,
@@ -205,7 +207,7 @@ async def infer_signal_type(
         if config.in_type == CmdArgType.DevVoid:
             return SignalX
         elif config.in_type != config.out_type:
-            logging.debug("Commands with different in and out dtypes are not supported")
+            logger.debug("Commands with different in and out dtypes are not supported")
             return None
         else:
             return SignalRW

ophyd_async/tango/core/_tango_transport.py

@@ -189,7 +189,7 @@ class AttributeProxy(TangoProxy):
                 raise TimeoutError(f"{self._name} attr put failed: Timeout") from te
             except DevFailed as de:
                 raise RuntimeError(
-                    f"{self._name} device" f" failure: {de.args[0].desc}"
+                    f"{self._name} device failure: {de.args[0].desc}"
                 ) from de
 
         else:
@@ -210,11 +210,11 @@ class AttributeProxy(TangoProxy):
                             await asyncio.sleep(A_BIT)
                             if to and (time.time() - start_time > to):
                                 raise TimeoutError(
-                                    f"{self._name} attr put failed:" f" Timeout"
+                                    f"{self._name} attr put failed: Timeout"
                                 ) from exc
                         else:
                             raise RuntimeError(
-                                f"{self._name} device failure:" f" {exc.args[0].desc}"
+                                f"{self._name} device failure: {exc.args[0].desc}"
                             ) from exc
 
             return AsyncStatus(wait_for_reply(rid, timeout))
@@ -422,7 +422,7 @@ class CommandProxy(TangoProxy):
                 raise TimeoutError(f"{self._name} command failed: Timeout") from te
             except DevFailed as de:
                 raise RuntimeError(
-                    f"{self._name} device" f" failure: {de.args[0].desc}"
+                    f"{self._name} device failure: {de.args[0].desc}"
                 ) from de
 
         else:
@@ -446,8 +446,7 @@ class CommandProxy(TangoProxy):
                                 ) from de_exc
                         else:
                             raise RuntimeError(
-                                f"{self._name} device failure:"
-                                f" {de_exc.args[0].desc}"
+                                f"{self._name} device failure: {de_exc.args[0].desc}"
                             ) from de_exc
 
             return AsyncStatus(wait_for_reply(rid, timeout))
@@ -733,22 +732,21 @@ class TangoSignalBackend(SignalBackend[SignalDatatypeT]):
                 " for which polling is disabled."
             )
 
+        if callback and self.proxies[self.read_trl].has_subscription():  # type: ignore
+            msg = "Cannot set a callback when one is already set"
+            raise RuntimeError(msg)
+
+        if self.proxies[self.read_trl].has_subscription():  # type: ignore
+            self.proxies[self.read_trl].unsubscribe_callback()  # type: ignore
+
         if callback:
             try:
-                assert not self.proxies[self.read_trl].has_subscription()  # type: ignore
                 self.proxies[self.read_trl].subscribe_callback(callback)  # type: ignore
-            except AssertionError as ae:
-                raise RuntimeError(
-                    "Cannot set a callback when one" " is already set"
-                ) from ae
             except RuntimeError as exc:
                 raise RuntimeError(
-                    f"Cannot set callback" f" for {self.read_trl}. {exc}"
+                    f"Cannot set callback for {self.read_trl}. {exc}"
                 ) from exc
 
-        else:
-            self.proxies[self.read_trl].unsubscribe_callback()  # type: ignore
-
     def set_polling(
         self,
         allow_polling: bool = True,

ophyd_async/tango/{demo → sim}/_mover.py

@@ -43,8 +43,11 @@ class TangoMover(TangoReadable, Movable, Stoppable):
         (old_position, velocity) = await asyncio.gather(
             self.position.get_value(), self.velocity.get_value()
         )
-        if timeout is CALCULATE_TIMEOUT:
-            assert velocity > 0, "Motor has zero velocity"
+        # TODO: check whether Tango does work with negative velocity
+        if timeout is CALCULATE_TIMEOUT and velocity == 0:
+            msg = "Motor has zero velocity"
+            raise ValueError(msg)
+        else:
             timeout = abs(value - old_position) / velocity + DEFAULT_TIMEOUT
 
         if not (isinstance(timeout, float) or timeout is None):

ophyd_async/testing/__init__.py

@@ -0,0 +1,52 @@
+from . import __pytest_assert_rewrite  # noqa: F401
+from ._assert import (
+    ApproxTable,
+    MonitorQueue,
+    approx_value,
+    assert_configuration,
+    assert_describe_signal,
+    assert_emitted,
+    assert_reading,
+    assert_value,
+)
+from ._mock_signal_utils import (
+    callback_on_mock_put,
+    get_mock,
+    get_mock_put,
+    mock_puts_blocked,
+    reset_mock_put_calls,
+    set_mock_put_proceeds,
+    set_mock_value,
+    set_mock_values,
+)
+from ._one_of_everything import (
+    ExampleEnum,
+    ExampleTable,
+    OneOfEverythingDevice,
+    ParentOfEverythingDevice,
+)
+from ._wait_for_pending import wait_for_pending_wakeups
+
+__all__ = [
+    "approx_value",
+    "assert_configuration",
+    "assert_describe_signal",
+    "assert_emitted",
+    "assert_reading",
+    "assert_value",
+    "callback_on_mock_put",
+    "get_mock",
+    "get_mock_put",
+    "mock_puts_blocked",
+    "reset_mock_put_calls",
+    "set_mock_put_proceeds",
+    "set_mock_value",
+    "set_mock_values",
+    "wait_for_pending_wakeups",
+    "ExampleEnum",
+    "ExampleTable",
+    "OneOfEverythingDevice",
+    "ParentOfEverythingDevice",
+    "MonitorQueue",
+    "ApproxTable",
+]

ophyd_async/testing/__pytest_assert_rewrite.py

@@ -0,0 +1,4 @@
+import pytest
+
+# So that bare asserts give a nice pytest traceback
+pytest.register_assert_rewrite("ophyd_async.testing._assert")