Resolving merge conflicts

Author: burkeds

src/ophyd_async/core/__init__.py

@@ -49,6 +49,7 @@
     soft_signal_r_and_setter,
     soft_signal_rw,
     wait_for_value,
+    walk_config_signals,
     walk_rw_signals,
 )
 from ._signal_backend import (
@@ -131,6 +132,7 @@
     "set_and_wait_for_value",
     "set_and_wait_for_other_value",
     "walk_rw_signals",
+    "walk_config_signals",
     # Readable
     "StandardReadable",
     "StandardReadableFormat",

src/ophyd_async/core/_signal.py

@@ -2,11 +2,13 @@
 
 import asyncio
 import functools
+import inspect
 import time
 from collections.abc import AsyncGenerator, Awaitable, Callable
 from typing import Any, Generic, cast
 
 from bluesky.protocols import (
+    Configurable,
     Locatable,
     Location,
     Movable,
@@ -678,6 +680,36 @@ def walk_rw_signals(device: Device, path_prefix: str = "") -> dict[str, SignalRW
     return signals
 
 
+async def walk_config_signals(
+    device: Device, path_prefix: str = ""
+) -> dict[str, SignalRW[Any]]:
+    """Retrieve all configuration signals from a device.
+
+    Stores retrieved signals with their dotted attribute paths in a dictionary. Used as
+    part of saving and loading a device.
+
+    :param device: Device to retrieve configuration signals from.
+    :param path_prefix: For internal use, leave blank when calling the method.
+    :return:
+        A dictionary matching the string attribute path of a SignalRW with the
+        signal itself.
+    """
+    signals: dict[str, SignalRW[Any]] = {}
+    config_names: list[str] = []
+    if isinstance(device, Configurable):
+        configuration = device.read_configuration()
+        if inspect.isawaitable(configuration):
+            configuration = await configuration
+        config_names = list(configuration.keys())
+    for attr_name, attr in device.children():
+        dot_path = f"{path_prefix}{attr_name}"
+        if isinstance(attr, SignalRW) and attr.name in config_names:
+            signals[dot_path] = attr
+        signals.update(await walk_config_signals(attr, path_prefix=dot_path + "."))
+
+    return signals
+
+
 class Ignore:
     """Annotation to ignore a signal when connecting a device."""
 

src/ophyd_async/plan_stubs/__init__.py

@@ -13,6 +13,7 @@
     apply_settings_if_different,
     get_current_settings,
     retrieve_settings,
+    store_config_settings,
     store_settings,
 )
 
@@ -29,4 +30,5 @@
     "get_current_settings",
     "retrieve_settings",
     "store_settings",
+    "store_config_settings",
 ]

src/ophyd_async/plan_stubs/_settings.py

@@ -13,6 +13,7 @@
     Settings,
     SettingsProvider,
     SignalRW,
+    walk_config_signals,
     walk_rw_signals,
 )
 from ophyd_async.core._table import Table
@@ -55,6 +56,21 @@ def store_settings(
     yield from wait_for_awaitable(provider.store(name, named_values))
 
 
+@plan
+def store_config_settings(
+    provider: SettingsProvider, name: str, device: Device
+) -> MsgGenerator[None]:
+    """Walk a Device for SignalRWs and store their values.
+
+    :param provider: The provider to store the settings with.
+    :param name: The name to store the settings under.
+    :param device: The Device to walk for SignalRWs.
+    """
+    signals = yield from wait_for_awaitable(walk_config_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

tests/plan_stubs/test_settings.py

@@ -11,9 +11,15 @@
     apply_settings_if_different,
     get_current_settings,
     retrieve_settings,
+    store_config_settings,
     store_settings,
 )
-from ophyd_async.testing import ExampleTable, ParentOfEverythingDevice, get_mock
+from ophyd_async.testing import (
+    ExampleTable,
+    OneOfEverythingDevice,
+    ParentOfEverythingDevice,
+    get_mock,
+)
 
 TEST_DATA = Path(__file__).absolute().parent.parent / "test_data"
 
@@ -47,6 +53,25 @@ def my_plan():
     RE(my_plan())
 
 
+async def test_store_config_settings(
+    RE, parent_device: OneOfEverythingDevice, tmp_path
+):
+    provider = YamlSettingsProvider(tmp_path)
+
+    def my_plan():
+        yield from store_config_settings(provider, "test_file", parent_device)
+        with open(tmp_path / "test_file.yaml") as actual_file:
+            actual_data = yaml.safe_load(actual_file)
+        with open(TEST_DATA / "test_yaml_save.yaml") as expected_file:
+            expected_data = yaml.safe_load(expected_file)
+        # Remove the keys that shouldn't be expected
+        expected_data.pop("_sig_rw", None)
+        expected_data.pop("sig_rw", None)
+        assert actual_data == expected_data
+
+    RE(my_plan())
+
+
 async def test_retrieve_and_apply_settings(RE, parent_device: ParentOfEverythingDevice):
     provider = YamlSettingsProvider(TEST_DATA)
     expected_values = await parent_device.get_signal_values()