Seperated dataclasses in datatypes from guibuilder

Rebasing phoebus class redesign with changes made to testing and
dependencies.

Author: adedamola-sode

.pdm-python

@@ -0,0 +1 @@
+/workspaces/guibuilder/.venv/bin/python

.python-version

@@ -0,0 +1 @@
+3.12

src/phoebus_guibuilder/__init__.py

@@ -8,4 +8,7 @@
 
 from ._version import __version__
 
-__all__ = ["__version__"]
+from phoebus_guibuilder.datatypes import Beamline, Component, Entry
+from phoebus_guibuilder.guibuilder import Guibuilder
+
+__all__ = ["__version__", "Beamline", "Component", "Entry", "Guibuilder"]

src/phoebus_guibuilder/__main__.py

@@ -2,8 +2,10 @@
 
 from argparse import ArgumentParser
 from collections.abc import Sequence
+from fileinput import filename
 
-from . import __version__, guibuilder
+from . import __version__
+from .guibuilder import Guibuilder
 
 __all__ = ["main"]
 
@@ -20,7 +22,8 @@ def main(args: Sequence[str] | None = None) -> None:
     )
     _args = parser.parse_args(args)
 
-    guibuilder.main(_args.filename)
+    gb = Guibuilder(_args.filename)
+    gb.extract_from_create_gui()
 
 
 if __name__ == "__main__":

src/phoebus_guibuilder/datatypes.py

@@ -0,0 +1,67 @@
+import re
+from dataclasses import dataclass
+
+
+@dataclass
+class Beamline:
+    dom: str
+    desc: str
+
+
+@dataclass
+class Entry:
+    type: str
+    DESC: str | None
+    P: str
+    M: str | None
+    R: str | None
+
+
+@dataclass
+class Component:
+    name: str
+    desc: str
+    prefix: str
+    filename: str | None = None
+
+    def __post_init__(self):
+        self._extract_p_and_r()
+
+    def __repr__(self) -> str:
+        return f"Component(name={self.name}, desc={self.desc}, \
+            prefix={self.P}, suffix={self.R}, filename={self.filename})"
+
+    def _extract_p_and_r(self):
+        pattern = re.compile(
+            r"""
+            ^           # start of string
+            (?=         # lookahead to ensure the following pattern matches
+                [A-Za-z0-9-]{14,16} # match 14 to 16 alphanumeric characters or hyphens
+                [:A-Za-z0-9]* # match zero or more colons or alphanumeric characters
+                [.A-Za-z0-9]  # match a dot or alphanumeric character
+            )
+            (?!.*--)    # negative lookahead to ensure no double hyphens
+            (?!.*:\..)  # negative lookahead to ensure no colon followed by a dot
+            (           # start of capture group 1
+                (?:[A-Za-z0-9]{2,5}-){3} # match 2 to 5 alphanumeric characters followed
+                                    # by a hyphen, repeated 3 times
+                [\d]*   # match zero or more digits
+                [^:]?   # match zero or one non-colon character
+            )
+            (?::([a-zA-Z0-9:]*))? # match zero or one colon followed by zero or more
+                                # alphanumeric characters or colons (capture group 2)
+            (?:\.([a-zA-Z0-9]+))? # match zero or one dot followed by one or more
+                                # alphanumeric characters (capture group 3)
+            $           # end of string
+        """,
+            re.VERBOSE,
+        )
+
+        match = re.match(pattern, self.prefix)
+        if match:
+            self.P: str = match.group(1)
+            self.R: str = match.group(2)
+            # TODO: Is this needed?
+            self.attribute: str | None = match.group(3)
+        else:
+            raise AttributeError(f"No valid PV prefix found for {self.name}.")

src/phoebus_guibuilder/guibuilder.py

@@ -1,171 +1,129 @@
 import os
-import pprint
 import re
-from dataclasses import dataclass
+import sys
 
 import yaml
 
-pp = pprint.PrettyPrinter()
-
-
-@dataclass
-class Beamline:
-    dom: str
-    desc: str
-
-
-@dataclass
-class Entry:
-    type: str
-    DESC: str | None
-    P: str
-    M: str | None
-    R: str | None
-
-
-@dataclass
-class Component:
-    name: str
-    desc: str
-    prefix: str
-    filename: str | None = None
-
-    def __post_init__(self):
-        self._extract_p_and_r()
-
-    def __repr__(self) -> str:
-        return f"Component(name={self.name}, desc={self.desc}, prefix={self.P}, \
-suffix={self.R}, filename={self.filename})"
-
-    def _extract_p_and_r(self):
-        pattern = re.compile(
-            r"""
-            ^           # start of string
-            (?=         # lookahead to ensure the following pattern matches
-                [A-Za-z0-9-]{14,16} # match 14 to 16 alphanumeric characters or hyphens
-                [:A-Za-z0-9]* # match zero or more colons or alphanumeric characters
-                [.A-Za-z0-9]  # match a dot or alphanumeric character
-            )
-            (?!.*--)    # negative lookahead to ensure no double hyphens
-            (?!.*:\..)  # negative lookahead to ensure no colon followed by a dot
-            (           # start of capture group 1
-                (?:[A-Za-z0-9]{2,5}-){3} # match 2 to 5 alphanumeric characters followed
-                                    # by a hyphen, repeated 3 times
-                [\d]*   # match zero or more digits
-                [^:]?   # match zero or one non-colon character
-            )
-            (?::([a-zA-Z0-9:]*))? # match zero or one colon followed by zero or more
-                                # alphanumeric characters or colons (capture group 2)
-            (?:\.([a-zA-Z0-9]+))? # match zero or one dot followed by one or more
-                                # alphanumeric characters (capture group 3)
-            $           # end of string
-        """,
-            re.VERBOSE,
-        )
-
-        match = re.match(pattern, self.prefix)
-        if match:
-            self.P: str = match.group(1)
-            self.R: str = match.group(2)
-            # TODO: Is this needed?
-            self.attribute: str | None = match.group(3)
-        else:
-            raise AttributeError(f"No valid PV prefix found for {self.name}.")
-
-
-def main(filename: str):
-    components: list[Component] = []  # TODO Manage global lists better
-
-    with open(filename) as f:
-        conf = yaml.safe_load(f)
-
-        bl: dict[str, str] = conf["beamline"]
-        comps: dict[str, dict[str, str]] = conf["components"]
-
-        beamline = Beamline(**bl)
-
-        for key, comp in comps.items():
-            components.append(Component(key, **comp))
-
-    print("BEAMLINE:")
-    pp.pprint(beamline)
-
-    print("")
-    print("COMPONENTS")
-    pp.pprint(components)
-
-
-#####################################################
-# TODO Functionality should be in phoebusguibuilder class
-# class Phoebusguibuilder(beamline: Beamline, components: list[Component]):
-
-
-def find_services_folders(beamline: Beamline, components: list[Component]):
-    services_directory = (
-        beamline.dom + "-services/services"
-    )  # TODO: rm hardcoding, map to services.
-    path = f"/dls/science/users/uns32131/{services_directory}"
-    files = os.listdir(path)
-
-    # Attempting to match the prefix to the files in the services directory
-    pattern = "^(.*)-(.*)-(.*)"
-
-    for component in components:
-        domain: re.Match[str] | None = re.match(pattern, component.P)
-        assert domain is not None, "Empty Prefix Field"
-
-        for file in files:
-            match = re.match(pattern, file)
-            if match:
-                if match.group(1) == domain.group(1).lower():
-                    if os.path.exists(f"{path}/{file}/config/ioc.yaml"):
-                        valid_entities = extract_valid_entities(
-                            ioc_yaml=f"{path}/{file}/config/ioc.yaml",
-                            component=component,
+from phoebus_guibuilder.datatypes import Beamline, Component, Entry
+
+
+class Guibuilder:
+    """
+    This class provides the functionality to process the required
+    create_gui.yaml file into screens mapped from ioc.yaml and
+    gui_map.yaml files.
+
+    """
+
+    def __init__(self, create_gui: str):
+        self.components: list[Component]
+
+        self.beamline: Beamline
+
+        self.valid_entities: list[Entry] = []
+
+        self.create_gui: str = create_gui
+
+    def extract_from_create_gui(
+        self,
+    ):
+        """
+        Extracts from the create_gui.yaml file to generate
+        the required Beamline and components structures.
+        """
+
+        with open(self.create_gui) as f:
+            conf = yaml.safe_load(f)
+
+            bl: dict[str, str] = conf["beamline"]
+            comps: dict[str, dict[str, str]] = conf["components"]
+
+            self.beamline = Beamline(**bl)
+
+            for key, comp in comps.items():
+                self.components.append(Component(key, **comp))
+
+    def find_services_folders(
+        self,
+    ):
+        """
+        Finds the related folders in the services directory
+        and extracts the related entites with the matching prefixes
+        """
+
+        services_directory = (
+            self.beamline.dom + "-services/services"
+        )  # TODO: rm hardcoding, map to services.
+        path = f"{services_directory}"
+        files = os.listdir(path)
+
+        # Attempting to match the prefix to the files in the services directory
+        pattern = "^(.*)-(.*)-(.*)"
+
+        for component in self.components:
+            domain: re.Match[str] | None = re.match(pattern, component.P)
+            assert domain is not None, "Empty Prefix Field"
+
+            for file in files:
+                match = re.match(pattern, file)
+                if match:
+                    if match.group(1) == domain.group(1).lower():
+                        if os.path.exists(f"{path}/{file}/config/ioc.yaml"):
+                            self.extract_valid_entities(
+                                ioc_yaml=f"{path}/{file}/config/ioc.yaml",
+                                component=component,
+                            )
+                        else:
+                            print(f"No ioc.yaml file for service: {file}")
+
+    def extract_valid_entities(self, ioc_yaml: str, component: Component):
+        """
+        Extracts the entities in ioc.yaml matching the defined prefix
+        """
+
+        entities: list[dict[str, str]] = []
+        component_match = f"{component.P}:{component.R}"
+
+        with open(ioc_yaml) as ioc:
+            conf = yaml.safe_load(ioc)
+            entities = conf["entities"]
+            for entity in entities:
+                if (
+                    "P" in entity.keys() and entity["P"] == component_match
+                ):  # the suffix could be M, could be R
+                    self.valid_entities.append(
+                        Entry(
+                            type=entity["type"],
+                            DESC=None,
+                            P=entity["P"],
+                            M=None,
+                            R=None,
                         )
-                        return valid_entities
-                    else:
-                        print(f"No ioc.yaml file for service: {file}")
-
-
-def extract_valid_entities(ioc_yaml: str, component: Component) -> list[Entry]:
-    print(type(ioc_yaml))
-    entities: list[dict[str, str]] = []
-    valid_entities: list[Entry] = []
-    component_match = f"{component.P}:{component.R}"
-    with open(ioc_yaml) as ioc:
-        conf = yaml.safe_load(ioc)
-        entities = conf["entities"]
-        for entity in entities:
-            if (
-                "P" in entity.keys() and entity["P"] == component_match
-            ):  # the suffix could be M, could be R
-                valid_entities.append(
-                    Entry(type=entity["type"], DESC=None, P=entity["P"], M=None, R=None)
-                )
-
-    return valid_entities
-
-
-def gui_map(entrys: list[Entry]):
-    gui_map = "/dls/science/users/uns32131/BLGui/BLGuiApp/opi/bob/gui_map.yaml"
-
-    with open(gui_map) as map:
-        conf = yaml.safe_load(map)
-
-        for entry in entrys:
-            print(entry.type)
-            if conf[entry.type]:
-                print(
-                    conf[entry.type]["file"]
-                )  # Find correct .bob file, and injet macros
-                # TODO:  create a copy of the file, and replace the required macros
-                # TODO:  return the file to guibuilder
-
-            else:
-                print("No BOB available")
-
-
-# find_services_folders()
-# print(valid_entities)
-# gui_map(valid_entities)
+                    )
+
+    def gui_map(self, entrys: list[Entry]):
+        """
+        Maps the valid entities from the ioc.yaml file
+        to the required screen in gui_map.yaml
+        """
+
+        gui_map = "/BLGui/BLGuiApp/opi/bob/gui_map.yaml"
+
+        with open(gui_map) as map:
+            conf = yaml.safe_load(map)
+
+            for entry in entrys:
+                print(entry.type)
+                if conf[entry.type]:
+                    print(
+                        conf[entry.type]["file"]
+                    )  # Find correct .bob file, and injet macros
+                    # TODO:  create a copy of the file, and replace the required macros
+                    # TODO:  return the file to guibuilder
+
+                else:
+                    print("No BOB available")
+
+
+if __name__ == "__main__":
+    Guibuilder(sys.argv[1])