Proposal API

Author: marcelldls

src/fastcs/__init__.py

@@ -7,5 +7,6 @@
 """
 
 from ._version import __version__
+from .main import FastCS as FastCS
 
 __all__ = ["__version__"]

src/fastcs/backend.py

@@ -1,4 +1,5 @@
 import asyncio
+from abc import ABC, abstractmethod
 from collections import defaultdict
 from collections.abc import Callable
 from concurrent.futures import Future
@@ -12,7 +13,7 @@
 from .mapping import Mapping, SingleMapping
 
 
-class Backend:
+class Backend(ABC):
     def __init__(
         self, controller: Controller, loop: asyncio.AbstractEventLoop | None = None
     ):
@@ -47,6 +48,12 @@ def run(self):
 
         self._run()
 
+    def create_docs(self) -> None:
+        self._create_docs()
+
+    def create_gui(self) -> None:
+        self._create_gui()
+
     def _run_initial_tasks(self):
         for task in self._initial_tasks:
             future = asyncio.run_coroutine_threadsafe(task(), self._loop)
@@ -58,8 +65,17 @@ def _start_scan_tasks(self):
         for task in scan_tasks:
             asyncio.run_coroutine_threadsafe(task(), self._loop)
 
-    def _run(self):
-        raise NotImplementedError("Specific Backend must implement _run")
+    @abstractmethod
+    def _run(self) -> None:
+        pass
+
+    @abstractmethod
+    def _create_docs(self) -> None:
+        pass
+
+    @abstractmethod
+    def _create_gui(self) -> None:
+        pass
 
 
 def _link_single_controller_put_tasks(single_mapping: SingleMapping) -> None:

src/fastcs/backends/__init__.py

@@ -1,5 +1,11 @@
 from .asyncio_backend import AsyncioBackend
 from .epics.backend import EpicsBackend
+from .epics.backend import EpicsOptions as EpicsOptions
+from .epics.docs import EpicsDocsOptions as EpicsDocsOptions
+from .epics.gui import EpicsGUIOptions as EpicsGUIOptions
+from .epics.ioc import EpicsIOCOptions as EpicsIOCOptions
 from .tango.backend import TangoBackend
+from .tango.backend import TangoDSROptions as TangoDSROptions
+from .tango.backend import TangoOptions as TangoOptions
 
 __all__ = ["EpicsBackend", "AsyncioBackend", "TangoBackend"]

src/fastcs/backends/epics/backend.py

@@ -1,3 +1,5 @@
+from dataclasses import dataclass, field
+
 from fastcs.backend import Backend
 from fastcs.controller import Controller
 
@@ -6,18 +8,32 @@
 from .ioc import EpicsIOC, EpicsIOCOptions
 
 
+@dataclass
+class EpicsOptions:
+    docs: EpicsDocsOptions = field(default_factory=EpicsDocsOptions)
+    gui: EpicsGUIOptions = field(default_factory=EpicsGUIOptions)
+    ioc: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
+
+
 class EpicsBackend(Backend):
-    def __init__(self, controller: Controller, pv_prefix: str = "MY-DEVICE-PREFIX"):
+    def __init__(
+        self, controller: Controller, options: EpicsOptions | None = None
+    ) -> None:
         super().__init__(controller)
 
-        self._pv_prefix = pv_prefix
-        self._ioc = EpicsIOC(pv_prefix, self._mapping)
+        if options is None:
+            self.options = EpicsOptions()
+        else:
+            self.options = options
+
+        self._pv_prefix = self.options.ioc.pv_prefix
+        self._ioc = EpicsIOC(self.options.ioc.pv_prefix, self._mapping)
 
-    def create_docs(self, options: EpicsDocsOptions | None = None) -> None:
-        EpicsDocs(self._mapping).create_docs(options)
+    def _create_docs(self) -> None:
+        EpicsDocs(self._mapping).create_docs(self.options.docs)
 
-    def create_gui(self, options: EpicsGUIOptions | None = None) -> None:
-        EpicsGUI(self._mapping, self._pv_prefix).create_gui(options)
+    def _create_gui(self) -> None:
+        EpicsGUI(self._mapping, self._pv_prefix).create_gui(self.options.gui)
 
-    def _run(self, options: EpicsIOCOptions | None = None):
-        self._ioc.run(self._dispatcher, self._context, options)
+    def _run(self):
+        self._ioc.run(self._dispatcher, self._context, self.options.ioc)

src/fastcs/backends/epics/ioc.py

@@ -25,6 +25,7 @@
 @dataclass
 class EpicsIOCOptions:
     terminal: bool = True
+    pv_prefix: str = "MY-DEVICE-PREFIX"
 
 
 class EpicsIOC:

src/fastcs/backends/tango/backend.py

@@ -1,14 +1,32 @@
+from dataclasses import dataclass, field
+
 from fastcs.backend import Backend
 from fastcs.controller import Controller
 
-from .dsr import TangoDSR
+from .dsr import TangoDSR, TangoDSROptions
+
+
+@dataclass
+class TangoOptions:
+    dsr: TangoDSROptions = field(default_factory=TangoDSROptions)
 
 
 class TangoBackend(Backend):
-    def __init__(self, controller: Controller):
+    def __init__(self, controller: Controller, options: TangoOptions | None = None):
         super().__init__(controller)
 
+        if options is None:
+            self.options = TangoOptions()
+        else:
+            self.options = options
+
         self._dsr = TangoDSR(self._mapping)
 
-    def _run(self):
-        self._dsr.run()
+    def _create_docs(self) -> None:
+        raise NotImplementedError
+
+    def _create_gui(self) -> None:
+        raise NotImplementedError
+
+    def _run(self) -> None:
+        self._dsr.run(self.options.dsr)

src/fastcs/connections/__init__.py

@@ -1,3 +1,7 @@
 from .ip_connection import IPConnection
+from .ip_connection import IPConnectionSettings as IPConnectionSettings
+from .ip_connection import StreamConnection as StreamConnection
+from .serial_connection import SerialConnection as SerialConnection
+from .serial_connection import SerialConnectionSettings as SerialConnectionSettings
 
 __all__ = ["IPConnection"]

src/fastcs/main.py

@@ -0,0 +1,22 @@
+from .backends.epics.backend import EpicsBackend, EpicsOptions
+from .backends.tango.backend import TangoBackend, TangoOptions
+from .controller import Controller
+
+
+class FastCS:
+    def __init__(self, controller: Controller, options: EpicsOptions | TangoOptions):
+        self.backend: EpicsBackend | TangoBackend
+        match options:
+            case EpicsOptions():
+                self.backend = EpicsBackend(controller, options)
+            case TangoOptions():
+                self.backend = TangoBackend(controller, options)
+
+    def create_docs(self) -> None:
+        self.backend.create_docs()
+
+    def create_gui(self) -> None:
+        self.backend.create_gui()
+
+    def run(self) -> None:
+        self.backend.run()