Removed Protocol from Handler classes. Renamed Sender to Setter.

Author: ajgdls

src/fastcs/attributes.py

@@ -3,7 +3,7 @@
 import asyncio
 from collections.abc import Callable
 from enum import Enum
-from typing import Any, Generic, Protocol, runtime_checkable
+from typing import Any, Generic
 
 import fastcs
 
@@ -18,34 +18,30 @@ class AttrMode(Enum):
     READ_WRITE = 3
 
 
-@runtime_checkable
-class Sender(Protocol):
-    """Protocol for setting the value of an ``Attribute``."""
-
+class _BaseHandler:
     async def initialise(self, controller: fastcs.controller.BaseController) -> None:
         pass
 
+
+class Setter(_BaseHandler):
+    """Protocol for setting the value of an ``Attribute``."""
+
     async def put(self, attr: AttrW[T], value: T) -> None:
         pass
 
 
-@runtime_checkable
-class Updater(Protocol):
+class Updater(_BaseHandler):
     """Protocol for updating the cached readback value of an ``Attribute``."""
 
     # If update period is None then the attribute will not be updated as a task.
     update_period: float | None = None
 
-    async def initialise(self, controller: fastcs.controller.BaseController) -> None:
-        pass
-
     async def update(self, attr: AttrR) -> None:
         pass
 
 
-@runtime_checkable
-class Handler(Sender, Updater, Protocol):
-    """Protocol encapsulating both ``Sender`` and ``Updater``."""
+class Handler(Setter, Updater):
+    """Protocol encapsulating both ``Setter`` and ``Updater``."""
 
     pass
 
@@ -179,7 +175,7 @@ def __init__(
         datatype: DataType[T],
         access_mode=AttrMode.WRITE,
         group: str | None = None,
-        handler: Sender | None = None,
+        handler: Setter | None = None,
         description: str | None = None,
     ) -> None:
         super().__init__(
@@ -193,9 +189,9 @@ def __init__(
         self._write_display_callbacks: list[AttrCallback[T]] | None = None
 
         if handler is not None:
-            self._sender = handler
+            self._setter = handler
         else:
-            self._sender = SimpleHandler()
+            self._setter = SimpleHandler()
 
     async def process(self, value: T) -> None:
         await self.process_without_display_update(value)
@@ -225,8 +221,8 @@ def add_write_display_callback(self, callback: AttrCallback[T]) -> None:
         self._write_display_callbacks.append(callback)
 
     @property
-    def sender(self) -> Sender:
-        return self._sender
+    def sender(self) -> Setter:
+        return self._setter
 
 
 class AttrRW(AttrR[T], AttrW[T]):

src/fastcs/backend.py

@@ -4,7 +4,7 @@
 
 from fastcs.cs_methods import Command, Put, Scan
 
-from .attributes import AttrR, AttrW, Sender, Updater
+from .attributes import AttrR, AttrW, Setter, Updater
 from .controller import BaseController, Controller
 from .controller_api import ControllerAPI
 from .exceptions import FastCSException
@@ -79,7 +79,7 @@ def _link_put_tasks(controller_api: ControllerAPI) -> None:
 def _link_attribute_sender_class(controller_api: ControllerAPI) -> None:
     for attr_name, attribute in controller_api.attributes.items():
         match attribute:
-            case AttrW(sender=Sender()):
+            case AttrW(sender=Setter()):
                 assert not attribute.has_process_callback(), (
                     f"Cannot assign both put method and Sender object to {attr_name}"
                 )

tests/assertable_controller.py

@@ -4,7 +4,7 @@
 
 from pytest_mock import MockerFixture, MockType
 
-from fastcs.attributes import AttrR, Handler, Sender, Updater
+from fastcs.attributes import AttrR, Handler, Setter, Updater
 from fastcs.backend import build_controller_api
 from fastcs.controller import Controller, SubController
 from fastcs.controller_api import ControllerAPI
@@ -22,15 +22,15 @@ async def update(self, attr):
         print(f"{self.controller} update {attr}")
 
 
-class TestSender(Sender):
+class TestSetter(Setter):
     async def initialise(self, controller) -> None:
         self.controller = controller
 
     async def put(self, attr, value):
         print(f"{self.controller}: {attr} = {value}")
 
 
-class TestHandler(Handler, TestUpdater, TestSender):
+class TestHandler(Handler, TestUpdater, TestSetter):
     pass
 
 

tests/conftest.py

@@ -23,7 +23,7 @@
 from tests.assertable_controller import (
     MyTestController,
     TestHandler,
-    TestSender,
+    TestSetter,
     TestUpdater,
 )
 from tests.example_p4p_ioc import run as _run_p4p_ioc
@@ -37,7 +37,7 @@ class BackendTestController(MyTestController):
     read_write_int: AttrRW = AttrRW(Int(), handler=TestHandler())
     read_write_float: AttrRW = AttrRW(Float())
     read_bool: AttrR = AttrR(Bool())
-    write_bool: AttrW = AttrW(Bool(), handler=TestSender())
+    write_bool: AttrW = AttrW(Bool(), handler=TestSetter())
     read_string: AttrRW = AttrRW(String())
 
 

tests/transport/epics/ca/test_softioc.py

@@ -8,7 +8,7 @@
     AssertableControllerAPI,
     MyTestController,
     TestHandler,
-    TestSender,
+    TestSetter,
     TestUpdater,
 )
 from tests.util import ColourEnum
@@ -187,7 +187,7 @@ class EpicsController(MyTestController):
     read_write_int = AttrRW(Int(), handler=TestHandler())
     read_write_float = AttrRW(Float())
     read_bool = AttrR(Bool())
-    write_bool = AttrW(Bool(), handler=TestSender())
+    write_bool = AttrW(Bool(), handler=TestSetter())
     read_string = AttrRW(String())
     enum = AttrRW(Enum(enum.IntEnum("Enum", {"RED": 0, "GREEN": 1, "BLUE": 2})))
     one_d_waveform = AttrRW(Waveform(np.int32, (10,)))

tests/transport/graphQL/test_graphQL.py

@@ -9,7 +9,7 @@
     AssertableControllerAPI,
     MyTestController,
     TestHandler,
-    TestSender,
+    TestSetter,
     TestUpdater,
 )
 
@@ -23,7 +23,7 @@ class GraphQLController(MyTestController):
     read_write_int = AttrRW(Int(), handler=TestHandler())
     read_write_float = AttrRW(Float())
     read_bool = AttrR(Bool())
-    write_bool = AttrW(Bool(), handler=TestSender())
+    write_bool = AttrW(Bool(), handler=TestSetter())
     read_string = AttrRW(String())
 
 

tests/transport/rest/test_rest.py

@@ -8,7 +8,7 @@
     AssertableControllerAPI,
     MyTestController,
     TestHandler,
-    TestSender,
+    TestSetter,
     TestUpdater,
 )
 
@@ -23,7 +23,7 @@ class RestController(MyTestController):
     read_write_int = AttrRW(Int(), handler=TestHandler())
     read_write_float = AttrRW(Float())
     read_bool = AttrR(Bool())
-    write_bool = AttrW(Bool(), handler=TestSender())
+    write_bool = AttrW(Bool(), handler=TestSetter())
     read_string = AttrRW(String())
     enum = AttrRW(Enum(enum.IntEnum("Enum", {"RED": 0, "GREEN": 1, "BLUE": 2})))
     one_d_waveform = AttrRW(Waveform(np.int32, (10,)))

tests/transport/tango/test_dsr.py

@@ -10,7 +10,7 @@
     AssertableControllerAPI,
     MyTestController,
     TestHandler,
-    TestSender,
+    TestSetter,
     TestUpdater,
 )
 
@@ -37,7 +37,7 @@ class TangoController(MyTestController):
     read_write_int = AttrRW(Int(), handler=TestHandler())
     read_write_float = AttrRW(Float())
     read_bool = AttrR(Bool())
-    write_bool = AttrW(Bool(), handler=TestSender())
+    write_bool = AttrW(Bool(), handler=TestSetter())
     read_string = AttrRW(String())
     enum = AttrRW(Enum(enum.IntEnum("Enum", {"RED": 0, "GREEN": 1, "BLUE": 2})))
     one_d_waveform = AttrRW(Waveform(np.int32, (10,)))