also added epics name options to the gui

Author: evvaaaa

src/fastcs/backends/epics/backend.py

@@ -11,19 +11,22 @@ def __init__(
         self,
         controller: Controller,
         pv_prefix: str = "MY-DEVICE-PREFIX",
-        options: EpicsIOCOptions | None = None,
+        ioc_options: EpicsIOCOptions | None = None,
     ):
         super().__init__(controller)
 
         self._pv_prefix = pv_prefix
-        options = options or EpicsIOCOptions()
-        self._ioc = EpicsIOC(pv_prefix, self._mapping, options=options)
+        self.ioc_options = ioc_options or EpicsIOCOptions()
+        self._ioc = EpicsIOC(pv_prefix, self._mapping, options=ioc_options)
 
-    def create_docs(self, options: EpicsDocsOptions | None = None) -> None:
-        EpicsDocs(self._mapping).create_docs(options)
+    def create_docs(self, docs_options: EpicsDocsOptions | None = None) -> None:
+        EpicsDocs(self._mapping).create_docs(docs_options)
 
-    def create_gui(self, options: EpicsGUIOptions | None = None) -> None:
-        EpicsGUI(self._mapping, self._pv_prefix).create_gui(options)
+    def create_gui(self, gui_options: EpicsGUIOptions | None = None) -> None:
+        assert self.ioc_options.name_options is not None
+        EpicsGUI(
+            self._mapping, self._pv_prefix, self.ioc_options.name_options
+        ).create_gui(gui_options)
 
     def _run(self):
         self._ioc.run(self._dispatcher, self._context)

src/fastcs/backends/epics/gui.py

@@ -27,6 +27,7 @@
 from pydantic import ValidationError
 
 from fastcs.attributes import Attribute, AttrR, AttrRW, AttrW
+from fastcs.backends.epics.util import EpicsNameOptions, _convert_attr_name_to_pv_name
 from fastcs.cs_methods import Command
 from fastcs.datatypes import Bool, Float, Int, String
 from fastcs.exceptions import FastCSException
@@ -39,21 +40,41 @@ class EpicsGUIFormat(Enum):
     edl = ".edl"
 
 
-@dataclass
+@dataclass(frozen=True)
 class EpicsGUIOptions:
     output_path: Path = Path.cwd() / "output.bob"
     file_format: EpicsGUIFormat = EpicsGUIFormat.bob
     title: str = "Simple Device"
 
 
 class EpicsGUI:
-    def __init__(self, mapping: Mapping, pv_prefix: str) -> None:
+    def __init__(
+        self,
+        mapping: Mapping,
+        pv_prefix: str,
+        epics_name_options: EpicsNameOptions | None = None,
+    ) -> None:
         self._mapping = mapping
         self._pv_prefix = pv_prefix
+        self.epics_name_options = epics_name_options or EpicsNameOptions()
 
     def _get_pv(self, attr_path: list[str], name: str):
-        attr_prefix = ":".join([self._pv_prefix] + attr_path)
-        return f"{attr_prefix}:{name.title().replace('_', '')}"
+        return self.epics_name_options.pv_separator.join(
+            [
+                self._pv_prefix,
+            ]
+            + [
+                _convert_attr_name_to_pv_name(
+                    attr_name, self.epics_name_options.pv_naming_convention
+                )
+                for attr_name in attr_path
+            ]
+            + [
+                _convert_attr_name_to_pv_name(
+                    name, self.epics_name_options.pv_naming_convention
+                ),
+            ],
+        )
 
     @staticmethod
     def _get_read_widget(attribute: AttrR) -> ReadWidgetUnion:

src/fastcs/backends/epics/ioc.py

@@ -1,6 +1,5 @@
 from collections.abc import Callable
 from dataclasses import dataclass
-from enum import Enum
 from types import MethodType
 from typing import Any, Literal
 
@@ -11,6 +10,8 @@
 from fastcs.attributes import AttrR, AttrRW, AttrW
 from fastcs.backends.epics.util import (
     MBB_STATE_FIELDS,
+    EpicsNameOptions,
+    PvNamingConvention,
     attr_is_enum,
     enum_index_to_value,
     enum_value_to_index,
@@ -23,20 +24,10 @@
 EPICS_MAX_NAME_LENGTH = 60
 
 
-class PvNamingConvention(Enum):
-    NO_CONVERSION = "NO_CONVERSION"
-    PASCAL = "PASCAL"
-    CAPITALIZED = "CAPITALIZED"
-
-
-DEFAULT_PV_SEPARATOR = ":"
-
-
-@dataclass
+@dataclass(frozen=True)
 class EpicsIOCOptions:
     terminal: bool = True
-    pv_naming_convention: PvNamingConvention = PvNamingConvention.PASCAL
-    pv_separator: str = DEFAULT_PV_SEPARATOR
+    name_options: EpicsNameOptions = EpicsNameOptions()
 
 
 def _convert_attr_name_to_pv_name(
@@ -53,8 +44,10 @@ class EpicsIOC:
     def __init__(
         self, pv_prefix: str, mapping: Mapping, options: EpicsIOCOptions | None = None
     ):
-        self.options = options or EpicsIOCOptions()
-        _add_pvi_info(f"{pv_prefix}{self.options.pv_separator}PVI")
+        self._options = options or EpicsIOCOptions()
+        self._name_options = self._options.name_options
+
+        _add_pvi_info(f"{pv_prefix}{self._name_options.pv_separator}PVI")
         self._add_sub_controller_pvi_info(pv_prefix, mapping.controller)
 
         self._create_and_link_attribute_pvs(pv_prefix, mapping)
@@ -68,7 +61,7 @@ def run(
         builder.LoadDatabase()
         softioc.iocInit(dispatcher)
 
-        if self.options.terminal:
+        if self._options.terminal:
             softioc.interactive_ioc(context)
 
     def _add_sub_controller_pvi_info(self, pv_prefix: str, parent: BaseController):
@@ -79,14 +72,16 @@ def _add_sub_controller_pvi_info(self, pv_prefix: str, parent: BaseController):
             parent: Controller to add PVI refs for
 
         """
-        parent_pvi = self.options.pv_separator.join([pv_prefix] + parent.path + ["PVI"])
+        parent_pvi = self._name_options.pv_separator.join(
+            [pv_prefix] + parent.path + ["PVI"]
+        )
 
         for child in parent.get_sub_controllers().values():
-            child_pvi = self.options.pv_separator.join(
+            child_pvi = self._name_options.pv_separator.join(
                 [pv_prefix]
                 + [
                     _convert_attr_name_to_pv_name(
-                        path, self.options.pv_naming_convention
+                        path, self._name_options.pv_naming_convention
                     )
                     for path in child.path
                 ]
@@ -101,18 +96,20 @@ def _add_sub_controller_pvi_info(self, pv_prefix: str, parent: BaseController):
     def _create_and_link_attribute_pvs(self, pv_prefix: str, mapping: Mapping) -> None:
         for single_mapping in mapping.get_controller_mappings():
             formatted_path = [
-                _convert_attr_name_to_pv_name(p, self.options.pv_naming_convention)
+                _convert_attr_name_to_pv_name(
+                    p, self._name_options.pv_naming_convention
+                )
                 for p in single_mapping.controller.path
             ]
             for attr_name, attribute in single_mapping.attributes.items():
                 pv_name = _convert_attr_name_to_pv_name(
-                    attr_name, self.options.pv_naming_convention
+                    attr_name, self._name_options.pv_naming_convention
                 )
-                _pv_prefix = self.options.pv_separator.join(
+                _pv_prefix = self._name_options.pv_separator.join(
                     [pv_prefix] + formatted_path
                 )
                 full_pv_name_length = len(
-                    f"{_pv_prefix}{self.options.pv_separator}{pv_name}"
+                    f"{_pv_prefix}{self._name_options.pv_separator}{pv_name}"
                 )
 
                 if full_pv_name_length > EPICS_MAX_NAME_LENGTH:
@@ -163,7 +160,7 @@ async def async_record_set(value: T):
                 record.set(value)
 
         record = _get_input_record(
-            f"{pv_prefix}{self.options.pv_separator}{pv_name}", attribute
+            f"{pv_prefix}{self._name_options.pv_separator}{pv_name}", attribute
         )
         self._add_attr_pvi_info(record, pv_prefix, attr_name, "r")
 
@@ -172,18 +169,20 @@ async def async_record_set(value: T):
     def _create_and_link_command_pvs(self, pv_prefix: str, mapping: Mapping) -> None:
         for single_mapping in mapping.get_controller_mappings():
             formatted_path = [
-                _convert_attr_name_to_pv_name(p, self.options.pv_naming_convention)
+                _convert_attr_name_to_pv_name(
+                    p, self._name_options.pv_naming_convention
+                )
                 for p in single_mapping.controller.path
             ]
             for attr_name, method in single_mapping.command_methods.items():
                 pv_name = _convert_attr_name_to_pv_name(
-                    attr_name, self.options.pv_naming_convention
+                    attr_name, self._name_options.pv_naming_convention
                 )
-                _pv_prefix = self.options.pv_separator.join(
+                _pv_prefix = self._name_options.pv_separator.join(
                     [pv_prefix] + formatted_path
                 )
                 if (
-                    len(f"{_pv_prefix}{self.options.pv_separator}{pv_name}")
+                    len(f"{_pv_prefix}{self._name_options.pv_separator}{pv_name}")
                     > EPICS_MAX_NAME_LENGTH
                 ):
                     print(
@@ -221,7 +220,7 @@ async def async_write_display(value: T):
                 record.set(value, process=False)
 
         record = _get_output_record(
-            f"{pv_prefix}{self.options.pv_separator}{pv_name}",
+            f"{pv_prefix}{self._name_options.pv_separator}{pv_name}",
             attribute,
             on_update=on_update,
         )
@@ -237,7 +236,7 @@ async def wrapped_method(_: Any):
             await method()
 
         record = builder.aOut(
-            f"{pv_prefix}{self.options.pv_separator}{pv_name}",
+            f"{pv_prefix}{self._name_options.pv_separator}{pv_name}",
             initial_value=0,
             always_update=True,
             on_update=wrapped_method,
@@ -264,7 +263,7 @@ def _add_attr_pvi_info(
         record.add_info(
             "Q:group",
             {
-                f"{prefix}{self.options.pv_separator}PVI": {
+                f"{prefix}{self._name_options.pv_separator}PVI": {
                     f"value.{name}.{access_mode}": {
                         "+channel": "NAME",
                         "+type": "plain",

src/fastcs/backends/epics/util.py

@@ -1,3 +1,6 @@
+from dataclasses import dataclass
+from enum import Enum
+
 from fastcs.attributes import Attribute
 from fastcs.datatypes import String, T
 
@@ -25,6 +28,31 @@
 MBB_MAX_CHOICES = len(_MBB_FIELD_PREFIXES)
 
 
+class PvNamingConvention(Enum):
+    NO_CONVERSION = "NO_CONVERSION"
+    PASCAL = "PASCAL"
+    CAPITALIZED = "CAPITALIZED"
+
+
+DEFAULT_PV_SEPARATOR = ":"
+
+
+@dataclass(frozen=True)
+class EpicsNameOptions:
+    pv_naming_convention: PvNamingConvention = PvNamingConvention.PASCAL
+    pv_separator: str = DEFAULT_PV_SEPARATOR
+
+
+def _convert_attr_name_to_pv_name(
+    attr_name: str, naming_convention: PvNamingConvention
+) -> str:
+    if naming_convention == PvNamingConvention.PASCAL:
+        return attr_name.title().replace("_", "")
+    elif naming_convention == PvNamingConvention.CAPITALIZED:
+        return attr_name.upper().replace("_", "-")
+    return attr_name
+
+
 def attr_is_enum(attribute: Attribute) -> bool:
     """Check if the `Attribute` has a `String` datatype and has `allowed_values` set.
 
@@ -36,9 +64,9 @@ def attr_is_enum(attribute: Attribute) -> bool:
 
     """
     match attribute:
-        case Attribute(
-            datatype=String(), allowed_values=allowed_values
-        ) if allowed_values is not None and len(allowed_values) <= MBB_MAX_CHOICES:
+        case Attribute(datatype=String(), allowed_values=allowed_values) if (
+            allowed_values is not None and len(allowed_values) <= MBB_MAX_CHOICES
+        ):
             return True
         case _:
             return False