Merge branch 'troubleshooting_guide' of https://github.com/IsisComputingGroup/ibex_bluesky_core into troubleshooting_guide

Author: Tom-Willemsen

README.md

@@ -1,13 +1,12 @@
-[<img src="https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/test-against-main.yml/badge.svg">](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/test-against-main.yml)
-[<img src="https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/lint-and-test-nightly.yml/badge.svg">](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/lint-and-test-nightly.yml)
-
-
 ![ibex_bluesky_core](https://github.com/IsisComputingGroup/ibex_bluesky_core/blob/main/doc/logo.svg?sanitize=true&raw=true)
 
 Core bluesky plan stubs &amp; devices for use at ISIS.
 
-Documentation: https://isiscomputinggroup.github.io/ibex_bluesky_core/
-
-Source: https://github.com/ISISComputingGroup/ibex_bluesky_core
-
-PyPi: https://pypi.org/project/ibex-bluesky-core/
+| -                                                                                                                                      | -                                                                                                                                                                                                                                |
+|----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Documentation](https://isiscomputinggroup.github.io/ibex_bluesky_core/)                                                               | [![sphinx](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/documentation.yml/badge.svg)](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/documentation.yml)                  |
+| [CI (nightly)](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/lint-and-test-nightly.yml)                    | [<img src="https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/lint-and-test-nightly.yml/badge.svg">](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/lint-and-test-nightly.yml) |
+| [CI (`bluesky` & `ophyd-async` main)](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/test-against-main.yml) | [<img src="https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/test-against-main.yml/badge.svg">](https://github.com/ISISComputingGroup/ibex_bluesky_core/actions/workflows/test-against-main.yml)         |
+| [PyPI](https://pypi.org/project/ibex-bluesky-core/)                                                                                    | ![PyPI - Version](https://img.shields.io/pypi/v/ibex_bluesky_core)                                                                                                                                                               |
+| [Github](https://github.com/ISISComputingGroup/ibex_bluesky_core)                                                                      | ![GitHub Release](https://img.shields.io/github/v/release/IsisComputingGroup/ibex_bluesky_core)                                                                                                                                  |
+| [License](https://github.com/ISISComputingGroup/ibex_bluesky_core/blob/main/LICENSE)                                                   | ![GitHub License](https://img.shields.io/github/license/ISISComputingGroup/ibex_bluesky_core)                                                                                                                                    |

src/ibex_bluesky_core/devices/block.py

@@ -2,6 +2,7 @@
 
 import asyncio
 import logging
+import sys
 from collections.abc import Callable
 from dataclasses import dataclass
 from typing import Generic, TypeVar
@@ -57,6 +58,8 @@
 # looking at the global moving flag.
 GLOBAL_MOVING_FLAG_PRE_WAIT = 0.1
 
+aio_timeout_error = asyncio.exceptions.TimeoutError if sys.version_info < (3, 11) else TimeoutError
+
 
 @dataclass(kw_only=True, frozen=True)
 class BlockWriteConfig(Generic[T]):
@@ -101,13 +104,19 @@ def check(setpoint: T, actual: T) -> bool:
         move, and all movement needs to be complete before the set is considered complete. Defaults
         to False.
 
+    timeout_is_error:
+        Whether a write timeout is considered an error. Defaults to True. If False, a set will be
+        marked as complete without error even if the block has not given a completion callback or
+        satisfied set_success_func within settle_time_s.
+
     """
 
     use_completion_callback: bool = True
     set_success_func: Callable[[T, T], bool] | None = None
     set_timeout_s: float | None = None
     settle_time_s: float = 0.0
     use_global_moving_flag: bool = False
+    timeout_is_error: bool = True
 
 
 class RunControl(StandardReadable):
@@ -272,7 +281,19 @@ async def set_and_settle(setpoint: T) -> None:
             )
             await asyncio.sleep(self._write_config.settle_time_s)
 
-        await set_and_settle(value)
+        if self._write_config.timeout_is_error:
+            await set_and_settle(value)
+        else:
+            try:
+                await set_and_settle(value)
+            except aio_timeout_error as e:
+                logger.info(
+                    "block set %s value=%s failed with %s, but continuing anyway because "
+                    "continue_on_failed_write is set.",
+                    self.name,
+                    value,
+                    e,
+                )
         logger.info("block set complete %s value=%s", self.name, value)
 
 
@@ -362,6 +383,7 @@ def __init__(
         use_global_moving_flag:
             This is unnecessary for a single motor block, as a completion callback will always be
             used instead to detect when a single move has finished.
+
         """
         self.run_control = RunControl(f"{prefix}CS:SB:{block_name}:RC:")
 

tests/devices/test_block.py

@@ -1,6 +1,7 @@
 # pyright: reportMissingParameterType=false
 import asyncio
 import sys
+from contextlib import nullcontext
 from unittest.mock import ANY, MagicMock, call, patch
 
 import bluesky.plan_stubs as bps
@@ -73,7 +74,7 @@ def test_block_naming(rw_rbv_block):
 def test_mot_block_naming(mot_block):
     assert mot_block.name == "mot_block"
     assert mot_block.user_readback.name == "mot_block"
-    assert mot_block.user_setpoint.name == ("mot_block-user_setpoint")
+    assert mot_block.user_setpoint.name == "mot_block-user_setpoint"
 
 
 def test_block_signal_monitors_correct_pv(rw_rbv_block):
@@ -353,3 +354,19 @@ async def test_block_mot_set(mot_block):
     set_mock_value(mot_block.velocity, 10)
     await mot_block.set(20)
     get_mock_put(mot_block.user_setpoint).assert_called_once_with(20, wait=True)
+
+
+@pytest.mark.parametrize("timeout_is_error", [True, False])
+async def test_block_failing_write(timeout_is_error):
+    block = await _block_with_write_config(BlockWriteConfig(timeout_is_error=timeout_is_error))
+
+    get_mock_put(block.setpoint).side_effect = aio_timeout_error
+
+    with pytest.raises(aio_timeout_error) if timeout_is_error else nullcontext():
+        await block.set(1)
+
+
+async def test_block_failing_write_with_default_write_config(writable_block):
+    get_mock_put(writable_block.setpoint).side_effect = aio_timeout_error
+    with pytest.raises(aio_timeout_error):
+        await writable_block.set(1)