Merge TransportAdapter and TransportOptions classes into Transport (#220)

hyperrealist · web-flow · commit 08010b7a4cf6 · 2025-09-29T15:47:53.000+01:00
diff --git a/src/fastcs/launch.py b/src/fastcs/launch.py
@@ -17,7 +17,7 @@
 from .backend import Backend
 from .controller import Controller
 from .exceptions import LaunchError
-from .transport.adapter import TransportAdapter
+from .transport import Transport
 from .transport.epics.ca.options import EpicsCAOptions
 from .transport.epics.pva.options import EpicsPVAOptions
 from .transport.graphql.options import GraphQLOptions
@@ -33,57 +33,15 @@
 class FastCS:
     """For launching a controller with given transport(s)."""
 
-    def __init__(
-        self,
-        controller: Controller,
-        transport_options: TransportOptions,
-    ):
+    def __init__(self, controller: Controller, transports: list[Transport]):
         self._loop = asyncio.get_event_loop()
         self._controller = controller
         self._backend = Backend(controller, self._loop)
-        transport: TransportAdapter
-        self._transports: list[TransportAdapter] = []
-        for option in transport_options:
-            match option:
-                case EpicsPVAOptions():
-                    from .transport.epics.pva.adapter import EpicsPVATransport
-
-                    transport = EpicsPVATransport(
-                        self._backend.controller_api,
-                        option,
-                    )
-                case EpicsCAOptions():
-                    from .transport.epics.ca.adapter import EpicsCATransport
-
-                    transport = EpicsCATransport(
-                        self._backend.controller_api,
-                        self._loop,
-                        option,
-                    )
-                case TangoOptions():
-                    from .transport.tango.adapter import TangoTransport
-
-                    transport = TangoTransport(
-                        self._backend.controller_api,
-                        self._loop,
-                        option,
-                    )
-                case RestOptions():
-                    from .transport.rest.adapter import RestTransport
-
-                    transport = RestTransport(
-                        self._backend.controller_api,
-                        option,
-                    )
-                case GraphQLOptions():
-                    from .transport.graphql.adapter import GraphQLTransport
-
-                    transport = GraphQLTransport(
-                        self._backend.controller_api,
-                        option,
-                    )
-
-            self._transports.append(transport)
+        self._transports = transports
+        for transport in self._transports:
+            transport.initialise(
+                controller_api=self._backend.controller_api, loop=self._loop
+            )
 
     def create_docs(self) -> None:
         for transport in self._transports:
diff --git a/src/fastcs/transport/__init__.py b/src/fastcs/transport/__init__.py
@@ -9,3 +9,4 @@
 from .rest.options import RestServerOptions as RestServerOptions
 from .tango.options import TangoDSROptions as TangoDSROptions
 from .tango.options import TangoOptions as TangoOptions
+from .transport import Transport as Transport
diff --git a/src/fastcs/transport/epics/ca/adapter.py b/src/fastcs/transport/epics/ca/adapter.py
@@ -4,28 +4,29 @@
 from softioc import softioc
 
 from fastcs.controller_api import ControllerAPI
-from fastcs.transport.adapter import TransportAdapter
+from fastcs.transport import Transport
 from fastcs.transport.epics.ca.ioc import EpicsCAIOC
 from fastcs.transport.epics.ca.options import EpicsCAOptions
 from fastcs.transport.epics.docs import EpicsDocs
 from fastcs.transport.epics.gui import EpicsGUI
 
 
-class EpicsCATransport(TransportAdapter):
+class EpicsCATransport(Transport):
     """Channel access transport."""
 
-    def __init__(
+    def __init__(self, options: EpicsCAOptions | None = None):
+        self._options = options or EpicsCAOptions()
+
+    def initialise(
         self,
         controller_api: ControllerAPI,
         loop: asyncio.AbstractEventLoop,
-        options: EpicsCAOptions | None = None,
     ) -> None:
         self._controller_api = controller_api
         self._loop = loop
-        self._options = options or EpicsCAOptions()
-        self._pv_prefix = self.options.ca_ioc.pv_prefix
+        self._pv_prefix = self._options.ca_ioc.pv_prefix
         self._ioc = EpicsCAIOC(
-            self.options.ca_ioc.pv_prefix,
+            self._options.ca_ioc.pv_prefix,
             controller_api,
             self._options.ca_ioc,
         )
@@ -35,10 +36,10 @@ def options(self) -> EpicsCAOptions:
         return self._options
 
     def create_docs(self) -> None:
-        EpicsDocs(self._controller_api).create_docs(self.options.docs)
+        EpicsDocs(self._controller_api).create_docs(self._options.docs)
 
     def create_gui(self) -> None:
-        EpicsGUI(self._controller_api, self._pv_prefix).create_gui(self.options.gui)
+        EpicsGUI(self._controller_api, self._pv_prefix).create_gui(self._options.gui)
 
     async def serve(self) -> None:
         print(f"Running FastCS IOC: {self._pv_prefix}")
diff --git a/src/fastcs/transport/epics/pva/adapter.py b/src/fastcs/transport/epics/pva/adapter.py
@@ -1,22 +1,26 @@
+import asyncio
+
 from fastcs.controller_api import ControllerAPI
-from fastcs.transport.adapter import TransportAdapter
+from fastcs.transport import Transport
 from fastcs.transport.epics.docs import EpicsDocs
 from fastcs.transport.epics.gui import PvaEpicsGUI
 from fastcs.transport.epics.pva.options import EpicsPVAOptions
 
 from .ioc import P4PIOC
 
 
-class EpicsPVATransport(TransportAdapter):
+class EpicsPVATransport(Transport):
     """PV access transport."""
 
-    def __init__(
+    def __init__(self, options: EpicsPVAOptions | None = None):
+        self._options = options or EpicsPVAOptions()
+
+    def initialise(
         self,
         controller_api: ControllerAPI,
-        options: EpicsPVAOptions | None = None,
+        loop: asyncio.AbstractEventLoop,
     ) -> None:
         self._controller_api = controller_api
-        self._options = options or EpicsPVAOptions()
         self._pv_prefix = self.options.pva_ioc.pv_prefix
         self._ioc = P4PIOC(self.options.pva_ioc.pv_prefix, controller_api)
 
diff --git a/src/fastcs/transport/graphql/adapter.py b/src/fastcs/transport/graphql/adapter.py
@@ -1,19 +1,23 @@
+import asyncio
+
 from fastcs.controller_api import ControllerAPI
-from fastcs.transport.adapter import TransportAdapter
+from fastcs.transport import Transport
 
 from .graphql import GraphQLServer
 from .options import GraphQLOptions
 
 
-class GraphQLTransport(TransportAdapter):
+class GraphQLTransport(Transport):
     """GraphQL transport."""
 
-    def __init__(
+    def __init__(self, options: GraphQLOptions | None = None):
+        self._options = options or GraphQLOptions()
+
+    def initialise(
         self,
         controller_api: ControllerAPI,
-        options: GraphQLOptions | None = None,
+        loop: asyncio.AbstractEventLoop,
     ):
-        self._options = options or GraphQLOptions()
         self._server = GraphQLServer(controller_api)
 
     @property
diff --git a/src/fastcs/transport/rest/adapter.py b/src/fastcs/transport/rest/adapter.py
@@ -1,19 +1,26 @@
+import asyncio
+
 from fastcs.controller_api import ControllerAPI
-from fastcs.transport.adapter import TransportAdapter
+from fastcs.transport import Transport
 
 from .options import RestOptions
 from .rest import RestServer
 
 
-class RestTransport(TransportAdapter):
+class RestTransport(Transport):
     """Rest Transport Adapter."""
 
     def __init__(
         self,
-        controller_api: ControllerAPI,
         options: RestOptions | None = None,
     ):
         self._options = options or RestOptions()
+
+    def initialise(
+        self,
+        controller_api: ControllerAPI,
+        loop: asyncio.AbstractEventLoop,
+    ):
         self._server = RestServer(controller_api)
 
     @property
diff --git a/src/fastcs/transport/tango/adapter.py b/src/fastcs/transport/tango/adapter.py
@@ -1,22 +1,25 @@
 import asyncio
 
 from fastcs.controller_api import ControllerAPI
-from fastcs.transport.adapter import TransportAdapter
+from fastcs.transport import Transport
 
 from .dsr import TangoDSR
 from .options import TangoOptions
 
 
-class TangoTransport(TransportAdapter):
+class TangoTransport(Transport):
     """Tango transport."""
 
-    def __init__(
+    def __init__(self, options: TangoOptions | None = None):
+        self._options = options or TangoOptions()
+
+    def initialise(
         self,
         controller_api: ControllerAPI,
         loop: asyncio.AbstractEventLoop,
-        options: TangoOptions | None = None,
     ):
-        self._options = options or TangoOptions()
+        if loop is None:
+            raise ValueError("TangoTransport expects a non-None loop")
         self._dsr = TangoDSR(controller_api, loop)
 
     @property
diff --git a/src/fastcs/transport/transport.py b/src/fastcs/transport/transport.py
@@ -1,9 +1,12 @@
+import asyncio
 from abc import ABC, abstractmethod
 from typing import Any
 
+from fastcs.controller_api import ControllerAPI
 
-class TransportAdapter(ABC):
-    """A base class for adapting a transport's implementation to
+
+class Transport(ABC):
+    """A base class for transport's implementation
     so it can be used in FastCS."""
 
     @property
@@ -26,3 +29,11 @@ def create_gui(self) -> None:
     @property
     def context(self) -> dict[str, Any]:
         return {}
+
+    @abstractmethod
+    def initialise(
+        self,
+        controller_api: ControllerAPI,
+        loop: asyncio.AbstractEventLoop,
+    ) -> None:
+        pass
diff --git a/tests/example_p4p_ioc.py b/tests/example_p4p_ioc.py
@@ -10,6 +10,7 @@
 from fastcs.transport.epics.options import (
     EpicsIOCOptions,
 )
+from fastcs.transport.epics.pva.adapter import EpicsPVATransport
 from fastcs.transport.epics.pva.options import EpicsPVAOptions
 from fastcs.wrappers import command, scan
 
@@ -82,7 +83,7 @@ def run(pv_prefix="P4P_TEST_DEVICE"):
     controller.register_sub_controller(
         "Child2", ChildController(description="another sub controller")
     )
-    fastcs = FastCS(controller, [p4p_options])
+    fastcs = FastCS(controller, [EpicsPVATransport(p4p_options)])
     fastcs.run()
 
 
diff --git a/tests/example_softioc.py b/tests/example_softioc.py
@@ -2,6 +2,7 @@
 from fastcs.controller import Controller, SubController
 from fastcs.datatypes import Int
 from fastcs.launch import FastCS
+from fastcs.transport.epics.ca.adapter import EpicsCATransport
 from fastcs.transport.epics.ca.options import EpicsCAOptions
 from fastcs.transport.epics.options import EpicsIOCOptions
 from fastcs.wrappers import command
@@ -24,7 +25,7 @@ def run(pv_prefix="SOFTIOC_TEST_DEVICE"):
     epics_options = EpicsCAOptions(ca_ioc=EpicsIOCOptions(pv_prefix=pv_prefix))
     controller = ParentController()
     controller.register_sub_controller("Child", ChildController())
-    fastcs = FastCS(controller, [epics_options])
+    fastcs = FastCS(controller, [EpicsCATransport(epics_options)])
     fastcs.run()
 
 
diff --git a/tests/test_launch.py b/tests/test_launch.py
@@ -151,7 +151,7 @@ def test_error_if_identical_context_in_transports(mocker: MockerFixture, data):
     mocker.patch("fastcs.launch.FastCS.create_gui")
     mocker.patch("fastcs.launch.FastCS.create_docs")
     mocker.patch(
-        "fastcs.transport.adapter.TransportAdapter.context",
+        "fastcs.transport.Transport.context",
         new_callable=mocker.PropertyMock,
         return_value={"controller": "test"},
     )
diff --git a/tests/transport/epics/ca/test_softioc.py b/tests/transport/epics/ca/test_softioc.py
@@ -564,7 +564,7 @@ def test_update_datatype(mocker: MockerFixture):
 
 
 def test_ca_context_contains_softioc_commands(mocker: MockerFixture):
-    transport = EpicsCATransport(mocker.MagicMock(), mocker.MagicMock())
+    transport = EpicsCATransport(mocker.MagicMock())
 
     softioc_commands = {
         command: getattr(softioc, command) for command in softioc.command_names
diff --git a/tests/transport/epics/pva/test_p4p.py b/tests/transport/epics/pva/test_p4p.py
@@ -18,6 +18,7 @@
 from fastcs.datatypes import Bool, Enum, Float, Int, String, Table, Waveform
 from fastcs.launch import FastCS
 from fastcs.transport.epics.options import EpicsIOCOptions
+from fastcs.transport.epics.pva.adapter import EpicsPVATransport
 from fastcs.transport.epics.pva.options import EpicsPVAOptions
 from fastcs.wrappers import command
 
@@ -227,7 +228,7 @@ async def test_numerical_alarms(p4p_subprocess: tuple[str, Queue]):
 
 def make_fastcs(pv_prefix: str, controller: Controller) -> FastCS:
     epics_options = EpicsPVAOptions(pva_ioc=EpicsIOCOptions(pv_prefix=pv_prefix))
-    return FastCS(controller, [epics_options])
+    return FastCS(controller, [EpicsPVATransport(epics_options)])
 
 
 def test_read_signal_set():
diff --git a/tests/transport/graphQL/test_graphql.py b/tests/transport/graphQL/test_graphql.py
@@ -1,3 +1,4 @@
+import asyncio
 import copy
 import json
 from typing import Any
@@ -66,7 +67,9 @@ def nest_response(path: list[str], value: Any) -> dict:
 
 
 def create_test_client(gql_controller_api: AssertableControllerAPI) -> TestClient:
-    return TestClient(GraphQLTransport(gql_controller_api)._server._app)
+    graphql_transport = GraphQLTransport()
+    graphql_transport.initialise(gql_controller_api, asyncio.AbstractEventLoop())
+    return TestClient(graphql_transport._server._app)
 
 
 class TestGraphQLServer:
diff --git a/tests/transport/rest/test_rest.py b/tests/transport/rest/test_rest.py
@@ -1,3 +1,4 @@
+import asyncio
 import enum
 
 import numpy as np
@@ -36,7 +37,9 @@ def rest_controller_api(class_mocker: MockerFixture):
 
 
 def create_test_client(rest_controller_api: ControllerAPI) -> TestClient:
-    return TestClient(RestTransport(rest_controller_api)._server._app)
+    rest_transport = RestTransport()
+    rest_transport.initialise(rest_controller_api, asyncio.AbstractEventLoop())
+    return TestClient(rest_transport._server._app)
 
 
 class TestRestServer:
diff --git a/tests/transport/tango/test_dsr.py b/tests/transport/tango/test_dsr.py
@@ -50,12 +50,14 @@ def tango_controller_api(class_mocker: MockerFixture) -> AssertableControllerAPI
 
 
 def create_test_context(tango_controller_api: AssertableControllerAPI):
-    device = TangoTransport(
+    tango_transport = TangoTransport()
+    tango_transport.initialise(
         tango_controller_api,
         # This is passed to enable instantiating the transport, but tests must avoid
         # using via patching of functions. It will raise NotImplementedError if used.
         asyncio.AbstractEventLoop(),
-    )._dsr._device
+    )
+    device = tango_transport._dsr._device
     # https://tango-controls.readthedocs.io/projects/pytango/en/v9.5.1/testing/test_context.html
     with DeviceTestContext(device, debug=0) as proxy:
         yield proxy

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`from fastcs.transport.epics.options import (`
`11`	`11`	`EpicsIOCOptions,`
`12`	`12`	`)`
	`13`	`+from fastcs.transport.epics.pva.adapter import EpicsPVATransport`
`13`	`14`	`from fastcs.transport.epics.pva.options import EpicsPVAOptions`
`14`	`15`	`from fastcs.wrappers import command, scan`
`15`	`16`
`@@ -82,7 +83,7 @@ def run(pv_prefix="P4P_TEST_DEVICE"):`
`82`	`83`	`controller.register_sub_controller(`
`83`	`84`	`"Child2", ChildController(description="another sub controller")`
`84`	`85`	`)`
`85`		`- fastcs = FastCS(controller, [p4p_options])`
	`86`	`+ fastcs = FastCS(controller, [EpicsPVATransport(p4p_options)])`
`86`	`87`	`fastcs.run()`
`87`	`88`
`88`	`89`