merged blocks and fields into a single recursive controller

Author: evvaaaa

src/fastcs_pandablocks/__init__.py

@@ -10,13 +10,12 @@
 from ._version import __version__
 from .gui import PandaGUIOptions
 from .panda.controller import PandaController
-from .types import EpicsName
 
 DEFAULT_POLL_PERIOD = 0.1
 
 
 def ioc(
-    epics_prefix: EpicsName,
+    epics_prefix: str,
     hostname: str,
     screens_directory: Path | None = None,
     clear_bobfiles: bool = False,
@@ -31,7 +30,7 @@ def ioc(
 
     controller = PandaController(hostname, poll_period)
     backend = EpicsBackend(
-        controller, pv_prefix=str(epics_prefix), ioc_options=epics_ioc_options
+        controller, pv_prefix=epics_prefix, ioc_options=epics_ioc_options
     )
 
     if clear_bobfiles and not screens_directory:

src/fastcs_pandablocks/__main__.py

@@ -7,7 +7,6 @@
 from fastcs.backends.epics.util import PvNamingConvention
 
 from fastcs_pandablocks import DEFAULT_POLL_PERIOD, ioc
-from fastcs_pandablocks.types import EpicsName
 
 from . import __version__
 
@@ -83,7 +82,7 @@ def main():
     logging.basicConfig(format="%(levelname)s:%(message)s", level=level)
 
     ioc(
-        EpicsName(prefix=parsed_args.prefix),
+        parsed_args.prefix,
         parsed_args.hostname,
         screens_directory=Path(parsed_args.screens_dir),
         clear_bobfiles=parsed_args.clear_bobfiles,

src/fastcs_pandablocks/panda/blocks.py

@@ -14,11 +14,11 @@
 )
 
 from fastcs_pandablocks.types import (
+    PandaName,
     RawBlocksType,
     RawFieldsType,
     RawInitialValuesType,
 )
-from fastcs_pandablocks.types.string_types import PandaName
 
 
 class RawPanda:

src/fastcs_pandablocks/panda/client_wrapper.py

@@ -1,49 +1,119 @@
 import asyncio
 
+from fastcs.attributes import Attribute, AttrR, AttrRW, AttrW
 from fastcs.controller import Controller
 from fastcs.wrappers import scan
 
-from fastcs_pandablocks.types import PandaName
+from fastcs_pandablocks.types import (
+    PandaName,
+    RawBlocksType,
+    RawFieldsType,
+    RawInitialValuesType,
+)
 
-from .blocks import Blocks
 from .client_wrapper import RawPanda
+from .fields import FieldController
+
+
+def _parse_introspected_data(
+    blocks: RawBlocksType,
+    field_infos: RawFieldsType,
+    labels: RawInitialValuesType,
+    initial_values: RawInitialValuesType,
+):
+    block_controllers: dict[PandaName, FieldController] = {}
+    for (block_name, block_info), field_info in zip(
+        blocks.items(), field_infos, strict=True
+    ):
+        numbered_block_names = (
+            [block_name]
+            if block_info.number in (None, 1)
+            else [
+                block_name + PandaName(block_number=number)
+                for number in range(1, block_info.number + 1)
+            ]
+        )
+        for numbered_block_name in numbered_block_names:
+            block_initial_values = {
+                key: value
+                for key, value in initial_values.items()
+                if key in numbered_block_name
+            }
+            label = labels.get(numbered_block_name, None)
+            block = FieldController(
+                numbered_block_name,
+                label=block_info.description or label,
+            )
+            block.make_sub_fields(field_info, block_initial_values)
+            block_controllers[numbered_block_name] = block
+
+    return block_controllers
 
 
 class PandaController(Controller):
     def __init__(self, hostname: str, poll_period: float) -> None:
+        # TODO https://github.com/DiamondLightSource/FastCS/issues/62
+        self.poll_period = poll_period
+
+        self._additional_attributes: dict[str, Attribute] = {}
         self._raw_panda = RawPanda(hostname)
-        self._blocks = Blocks()
-        self.is_connected = False
+        _blocks: dict[PandaName, FieldController] = {}
 
         super().__init__()
 
-    async def connect(self) -> None:
-        if self.is_connected:
-            return
+    @property
+    def additional_attributes(self):
+        return self._additional_attributes
 
+    async def connect(self) -> None:
         await self._raw_panda.connect()
         blocks, fields, labels, initial_values = await self._raw_panda.introspect()
-
-        self._blocks.parse_introspected_data(blocks, fields, labels, initial_values)
-        self.is_connected = True
+        self._blocks = _parse_introspected_data(blocks, fields, labels, initial_values)
 
     async def initialise(self) -> None:
         await self.connect()
+        for block_name, block in self._blocks.items():
+            if block.top_level_attribute is not None:
+                self._additional_attributes[block_name.attribute_name] = (
+                    block.top_level_attribute
+                )
+            if block.additional_attributes or block.sub_fields:
+                self.register_sub_controller(block_name.attribute_name, block)
+            await block.initialise()
+
+    def get_attribute(self, panda_name: PandaName) -> Attribute:
+        assert panda_name.block
+        block_controller = self._blocks[panda_name.up_to_block()]
+        if panda_name.field is None:
+            assert block_controller.top_level_attribute is not None
+            return block_controller.top_level_attribute
+
+        field_controller = block_controller.sub_fields[panda_name.up_to_field()]
+        if panda_name.sub_field is None:
+            assert field_controller.top_level_attribute is not None
+            return field_controller.top_level_attribute
 
-        for attr_name, controller in self._blocks.flattened_attribute_tree():
-            self.register_sub_controller(attr_name, controller)
-            controller.initialise()
+        sub_field_controller = field_controller.sub_fields[panda_name]
+        assert sub_field_controller.top_level_attribute is not None
+        return sub_field_controller.top_level_attribute
+
+    async def update_field_value(self, panda_name: PandaName, value: str):
+        attribute = self.get_attribute(panda_name)
+
+        if isinstance(attribute, AttrW):
+            await attribute.process(value)
+        elif isinstance(attribute, (AttrRW | AttrR)):
+            await attribute.set(value)
+        else:
+            raise RuntimeError(f"Couldn't find panda field for {panda_name}.")
 
-    # TODO https://github.com/DiamondLightSource/FastCS/issues/62
     @scan(0.1)
     async def update(self):
         await self._raw_panda.get_changes()
         assert self._raw_panda.changes
         await asyncio.gather(
             *[
-                self._blocks.update_field_value(
-                    PandaName.from_string(raw_panda_name), value
-                )
+                self.update_field_value(PandaName.from_string(raw_panda_name), value)
                 for raw_panda_name, value in self._raw_panda.changes.items()
             ]
         )