Merge pull request #173 from ISISComputingGroup/redefine_refl_param_optional

allow redefine to be optional for refl param

Author: rerpha

doc/plan_stubs/redefining.md

@@ -31,7 +31,7 @@ def my_plan():
 ## `redefine_refl_parameter`
 
 The {py:obj}`ibex_bluesky_core.plan_stubs.redefine_refl_parameter` plan stub can be used to redefine the current
-position of a {py:obj}`ibex_bluesky_core.devices.reflectometry.ReflParameter` to a new value.
+position of a {py:obj}`ibex_bluesky_core.devices.reflectometry.ReflParameter` to a new value. Note that some reflectometry parameters ie. `Theta` cannot be redefined, so these must be constructed with `has_redefine=False`. This plan stub will handle this case and raise an error if a user tries to redefine it. 
 
 This plan stub has an identical API to that of the {py:obj}`ibex_bluesky_core.plan_stubs.redefine_motor` plan stub
 described above, but operates on a reflectometry parameter rather than a motor.

src/ibex_bluesky_core/devices/reflectometry/__init__.py

@@ -3,6 +3,7 @@
 import asyncio
 import logging
 
+from bluesky.protocols import NamedMovable
 from ophyd_async.core import (
     AsyncStatus,
     SignalR,
@@ -18,16 +19,19 @@
 logger = logging.getLogger(__name__)
 
 
-class ReflParameter(StandardReadable):
+class ReflParameter(StandardReadable, NamedMovable[float]):
     """Utility device for a reflectometry server parameter."""
 
-    def __init__(self, prefix: str, name: str, changing_timeout_s: float) -> None:
+    def __init__(
+        self, prefix: str, name: str, changing_timeout_s: float, *, has_redefine: bool = True
+    ) -> None:
         """Reflectometry server parameter.
 
         Args:
             prefix: the PV prefix.
             name: the name of the parameter.
             changing_timeout_s: seconds to wait for the CHANGING signal to go to False after a set.
+            has_redefine: whether this parameter can be redefined.
 
         """
         with self.add_children_as_readables(StandardReadableFormat.HINTED_SIGNAL):
@@ -36,7 +40,10 @@ def __init__(self, prefix: str, name: str, changing_timeout_s: float) -> None:
         self.changing: SignalR[bool] = epics_signal_r(
             bool, f"{prefix}REFL_01:PARAM:{name}:CHANGING"
         )
-        self.redefine = ReflParameterRedefine(prefix=f"{prefix}REFL_01:PARAM:{name}:", name="")
+        if has_redefine:
+            self.redefine = ReflParameterRedefine(prefix=f"{prefix}REFL_01:PARAM:{name}:", name="")
+        else:
+            self.redefine = None
         self.changing_timeout = changing_timeout_s
         super().__init__(name=name)
         self.readback.set_name(name)

src/ibex_bluesky_core/plan_stubs/__init__.py

@@ -120,6 +120,8 @@ def redefine_refl_parameter(
         position: The position to set.
 
     """
+    if parameter.redefine is None:
+        raise ValueError(f"Parameter {parameter.name} cannot be redefined.")
     logger.info("Redefining refl parameter %s to %s", parameter.name, position)
     yield from bps.mv(parameter.redefine, position)
 

tests/test_plan_stubs.py

@@ -155,7 +155,20 @@ async def test_redefine_refl_parameter(RE):
 
     RE(redefine_refl_parameter(param, 42.0))
 
-    get_mock_put(param.redefine.define_pos_sp).assert_called_once_with(42.0, wait=True)
+    get_mock_put(param.redefine.define_pos_sp).assert_called_once_with(42.0, wait=True)  # pyright: ignore [reportOptionalMemberAccess]
+
+
+async def test_raises_when_attempting_to_redefine_refl_parameter_with_no_redefine(RE):
+    param = ReflParameter(
+        prefix="", name="some_refl_parameter_no_redefine", changing_timeout_s=1, has_redefine=False
+    )
+    await param.connect(mock=True)
+    with pytest.raises(
+        ValueError,
+        match=r"Parameter some_refl_parameter_no_redefine"
+        r" cannot be redefined.",
+    ):
+        RE(redefine_refl_parameter(param, 42.0))
 
 
 def test_get_user_input(RE):