diff --git a/src/blueapi/core/bluesky_types.py b/src/blueapi/core/bluesky_types.py index 674c28e2a..9a20e5452 100644 --- a/src/blueapi/core/bluesky_types.py +++ b/src/blueapi/core/bluesky_types.py @@ -1,6 +1,6 @@ import inspect from collections.abc import Callable, Generator, Mapping -from dataclasses import dataclass +from dataclasses import dataclass, field from typing import ( Any, Protocol, @@ -133,6 +133,12 @@ def watch(self, __func: Callable) -> None: ... +@dataclass +class DeviceTree: + name: str + children: list["DeviceTree"] = field(default_factory=list) + + @dataclass class BlueapiDevice: """Wrapper around Device held in the context. @@ -140,6 +146,7 @@ class BlueapiDevice: At the moment this just holds the Device but will later hold child device trees""" device: Device + tree: DeviceTree def find_component(self, addr: list[str]) -> Device | None: dev = self.device diff --git a/src/blueapi/core/context.py b/src/blueapi/core/context.py index af3fcc631..a44885f38 100644 --- a/src/blueapi/core/context.py +++ b/src/blueapi/core/context.py @@ -50,6 +50,7 @@ AsyncDevice, BlueapiDevice, Device, + DeviceTree, Plan, PlanGenerator, is_bluesky_compatible_device, @@ -196,7 +197,7 @@ def find_device(self, addr: str | list[str]) -> Device | None: def with_config(self, config: EnvironmentConfig) -> None: if config.metadata is not None: - self.run_engine.md |= config.metadata.model_dump() + self.run_engine.md.update(config.metadata.model_dump()) package_map = metadata.packages_distributions() packages = {src.module.split(".")[0] for src in config.sources} @@ -358,23 +359,28 @@ def register_device(self, device: Device, name: str | None = None) -> None: else: raise KeyError(f"Must supply a name for this device: {device}") - if self._add_device(name, device): - self._register_children(device) + if blueapi_device := self._add_device(name, device): + self._register_children(blueapi_device) - def _register_children(self, device: Device) -> None: + def _register_children(self, parent: BlueapiDevice) -> None: """Register the children of an ophyd-async device under their own names.""" - if not isinstance(device, AsyncDevice): + if not isinstance(parent.device, AsyncDevice): return - for _, child in device.children(): - if child.name and self._add_device(child.name, child): - self._register_children(child) + subtrees = [] + for _, child in parent.device.children(): + if child.name and (blueapi_device := self._add_device(child.name, child)): + self._register_children(blueapi_device) + subtrees.append(blueapi_device.tree) + parent.tree.children = subtrees - def _add_device(self, name: str, device: Device) -> bool: + def _add_device(self, name: str, device: Device) -> BlueapiDevice | None: """Add a device unless a different one is already registered as name.""" - existing = self.devices.setdefault(name, BlueapiDevice(device)) + existing = self.devices.setdefault( + name, BlueapiDevice(device, DeviceTree(name)) + ) if existing.device is not device: # Expected for e.g. a motor's user_readback, which has the motor's name. # The caller skips its children too, as their names start with this one @@ -389,8 +395,8 @@ def _add_device(self, name: str, device: Device) -> bool: device, name, ) - return False - return True + return None + return existing def unregister_all_devices(self): """Unregister all devices from the context.""" diff --git a/tests/unit_tests/core/test_context.py b/tests/unit_tests/core/test_context.py index 883d7ac7e..d2127dba1 100644 --- a/tests/unit_tests/core/test_context.py +++ b/tests/unit_tests/core/test_context.py @@ -50,7 +50,7 @@ TiledConfig, ) from blueapi.core import BlueskyContext, is_bluesky_compatible_device -from blueapi.core.bluesky_types import BlueapiDevice +from blueapi.core.bluesky_types import BlueapiDevice, DeviceTree from blueapi.core.context import generic_bounds, qualified_name from blueapi.core.protocols import DeviceConnectResult, DeviceManager from blueapi.utils.invalid_config_error import InvalidConfigError @@ -901,7 +901,7 @@ def test_single_device_manager(empty_context: BlueskyContext): sdm = StaticDeviceManager(devices={"foo": foo}) empty_context.with_device_manager(sdm) - assert empty_context.devices == {"foo": BlueapiDevice(foo)} + assert empty_context.devices == {"foo": BlueapiDevice(foo, DeviceTree("foo"))} def test_device_manager_build_error(empty_context: BlueskyContext): @@ -971,7 +971,7 @@ def test_device_manager_environment_source(empty_context: BlueskyContext): with patch("blueapi.core.context.import_module") as imp_mod: imp_mod.side_effect = lambda mod: dev_mod if mod == "foo.bar" else None empty_context.with_config(env) - assert empty_context.devices == {"foo": BlueapiDevice(foo)} + assert empty_context.devices == {"foo": BlueapiDevice(foo, DeviceTree("foo"))} def test_non_device_manager_errors(empty_context: BlueskyContext):