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,18 +1,19 @@
 import asyncio
+from abc import ABC, abstractmethod
 from collections import defaultdict
 from collections.abc import Callable
 from concurrent.futures import Future
 from types import MethodType
 
-from softioc.asyncio_dispatcher import AsyncioDispatcher
+from fastcs.util import AsyncioDispatcher
 
 from .attributes import AttrR, AttrW, Sender, Updater
 from .controller import Controller
 from .exceptions import FastCSException
 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,8 @@
-from .asyncio_backend import AsyncioBackend
-from .epics.backend import EpicsBackend
-from .tango.backend import TangoBackend
+from .epics.options import EpicsDocsOptions as EpicsDocsOptions
+from .epics.options import EpicsGUIOptions as EpicsGUIOptions
+from .epics.options import EpicsIOCOptions as EpicsIOCOptions
+from .epics.options import EpicsOptions as EpicsOptions
+from .tango.options import TangoDSROptions as TangoDSROptions
+from .tango.options import TangoOptions as TangoOptions
 
-__all__ = ["EpicsBackend", "AsyncioBackend", "TangoBackend"]
+__all__ = ["EpicsOptions", "TangoOptions"]

src/fastcs/backends/epics/backend.py

@@ -1,23 +1,37 @@
+from typing import cast
+
+from softioc.asyncio_dispatcher import AsyncioDispatcher
+
 from fastcs.backend import Backend
 from fastcs.controller import Controller
 
-from .docs import EpicsDocs, EpicsDocsOptions
-from .gui import EpicsGUI, EpicsGUIOptions
-from .ioc import EpicsIOC, EpicsIOCOptions
+from .docs import EpicsDocs
+from .gui import EpicsGUI
+from .ioc import EpicsIOC
+from .options import EpicsOptions
 
 
 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(
+            cast(AsyncioDispatcher, self._dispatcher), self._context, self.options.ioc
+        )

src/fastcs/backends/epics/docs.py

@@ -1,13 +1,6 @@
-from dataclasses import dataclass
-from pathlib import Path
-
 from fastcs.mapping import Mapping
 
-
-@dataclass
-class EpicsDocsOptions:
-    path: Path = Path.cwd()
-    depth: int | None = None
+from .options import EpicsDocsOptions
 
 
 class EpicsDocs:

src/fastcs/backends/epics/gui.py

@@ -1,7 +1,3 @@
-from dataclasses import dataclass
-from enum import Enum
-from pathlib import Path
-
 from pvi._format.dls import DLSFormatter
 from pvi.device import (
     LED,
@@ -33,17 +29,7 @@
 from fastcs.mapping import Mapping, SingleMapping, _get_single_mapping
 from fastcs.util import snake_to_pascal
 
-
-class EpicsGUIFormat(Enum):
-    bob = ".bob"
-    edl = ".edl"
-
-
-@dataclass
-class EpicsGUIOptions:
-    output_path: Path = Path.cwd() / "output.bob"
-    file_format: EpicsGUIFormat = EpicsGUIFormat.bob
-    title: str = "Simple Device"
+from .options import EpicsGUIFormat, EpicsGUIOptions
 
 
 class EpicsGUI:

src/fastcs/backends/epics/ioc.py

@@ -1,5 +1,4 @@
 from collections.abc import Callable
-from dataclasses import dataclass
 from types import MethodType
 from typing import Any, Literal
 
@@ -19,12 +18,9 @@
 from fastcs.exceptions import FastCSException
 from fastcs.mapping import Mapping
 
-EPICS_MAX_NAME_LENGTH = 60
-
+from .options import EpicsIOCOptions
 
-@dataclass
-class EpicsIOCOptions:
-    terminal: bool = True
+EPICS_MAX_NAME_LENGTH = 60
 
 
 class EpicsIOC:

src/fastcs/backends/epics/options.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from pathlib import Path
+
+
+@dataclass
+class EpicsDocsOptions:
+    path: Path = Path.cwd()
+    depth: int | None = None
+
+
+class EpicsGUIFormat(Enum):
+    bob = ".bob"
+    edl = ".edl"
+
+
+@dataclass
+class EpicsGUIOptions:
+    output_path: Path = Path.cwd() / "output.bob"
+    file_format: EpicsGUIFormat = EpicsGUIFormat.bob
+    title: str = "Simple Device"
+
+
+@dataclass
+class EpicsIOCOptions:
+    terminal: bool = True
+    pv_prefix: str = "MY-DEVICE-PREFIX"
+
+
+@dataclass
+class EpicsOptions:
+    docs: EpicsDocsOptions = field(default_factory=EpicsDocsOptions)
+    gui: EpicsGUIOptions = field(default_factory=EpicsGUIOptions)
+    ioc: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)

src/fastcs/backends/tango/backend.py

@@ -2,13 +2,25 @@
 from fastcs.controller import Controller
 
 from .dsr import TangoDSR
+from .options import TangoOptions
 
 
 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/backends/tango/dsr.py

@@ -1,5 +1,4 @@
 from collections.abc import Awaitable, Callable
-from dataclasses import dataclass
 from types import MethodType
 from typing import Any
 
@@ -12,13 +11,7 @@
 from fastcs.datatypes import Float
 from fastcs.mapping import Mapping
 
-
-@dataclass
-class TangoDSROptions:
-    dev_name: str = "MY/DEVICE/NAME"
-    dev_class: str = "FAST_CS_DEVICE"
-    dsr_instance: str = "MY_SERVER_INSTANCE"
-    debug: bool = False
+from .options import TangoDSROptions
 
 
 def _wrap_updater_fget(