Raise exception if attr name is a bluesky protocol

src/ophyd_async/core/_device.py

@@ -70,6 +70,39 @@ async def connect_real(self, device: Device, timeout: float, force_reconnect: bo
         await wait_for_connection(**coros)
 
 
+DEVICE_RESERVED_ATTRS = {
+    "add_callback",
+    "exception",
+    "done",
+    "success",
+    "name",
+    "collect_asset_docs",
+    "get_index",
+    "read_configuration",
+    "describe_configuration",
+    "trigger",
+    "prepare",
+    "read",
+    "describe",
+    "describe_collect",
+    "collect",
+    "collect_pages",
+    "set",
+    "locate",
+    "kickoff",
+    "complete",
+    "stage",
+    "unstage",
+    "pause",
+    "resume",
+    "stop",
+    "subscribe",
+    "clear_sub",
+    "check_value",
+    "hints",
+}
+
+
 class Device(HasName):
     """Common base class for all Ophyd Async Devices.
 
@@ -152,6 +185,11 @@ def __setattr__(self, name: str, value: Any) -> None:
         # ...hence not doing an isinstance check for attributes we
         # know not to be Devices
         elif name not in _not_device_attrs and isinstance(value, Device):
+            if name in DEVICE_RESERVED_ATTRS:
+                raise NameError(
+                    f"`{name}` is used in one of the bluesky protocols. "
+                    f"Please use `{name}_` instead."
+                )
             value.parent = self
             self._child_devices[name] = value
             # And if the name is set, then set the name of all children,

tests/core/test_device.py

@@ -16,6 +16,7 @@
     soft_signal_rw,
     wait_for_connection,
 )
+from ophyd_async.core._device import DEVICE_RESERVED_ATTRS  # noqa: PLC2701
 from ophyd_async.epics import motor
 from ophyd_async.plan_stubs import ensure_connected
 
@@ -67,6 +68,19 @@ def get_source(self) -> str:
         return self.signal_ref().source
 
 
+@pytest.mark.parametrize("attr_name", DEVICE_RESERVED_ATTRS)
+def test_attr_in_bluesky_protocols(attr_name):
+    class DeviceWithProtocolName(Device):
+        def __init__(self, name: str = "") -> None:
+            super().__init__(name)
+            # use setattr so we can inject the name dynamically
+            setattr(self, attr_name, soft_signal_rw(int, name="foo"))
+
+    expected_msg = f"Please use `{attr_name}_` instead"
+    with pytest.raises(NameError, match=expected_msg):
+        DeviceWithProtocolName("bar")
+
+
 async def test_device_connect_missing_connector() -> None:
     # Create an instance of Device without calling __init__
     device = object.__new__(Device)