techui-builder 0.6.8a2__tar.gz → 0.7__tar.gz

techui_builder-0.7/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "example/t01-services/synoptic/techui-support"]
+	path = example/t01-services/synoptic/techui-support
+	url = https://github.com/DiamondLightSource/techui-support.git

{techui_builder-0.6.8a2/src/techui_builder.egg-info → techui_builder-0.7}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: techui-builder
-Version: 0.6.8a2
+Version: 0.7
 Summary: A package for building Phoebus GUIs
-Author-email: Oliver Copping <oliver.copping@diamond.ac.uk>, Adedamola Sode <adedamola.sode@diamond.ac.uk>, Niamh Dougan <niamh.dougan@diamond.ac.uk>
+Author-email: Oliver Copping <oliver.copping@diamond.ac.uk>, Adedamola Sode <adedamola.sode@diamond.ac.uk>, Niamh Dougan <niamh.dougan@diamond.ac.uk>, Thomas Kane <thomas.kane@diamond.ac.uk>
 Project-URL: GitHub, https://github.com/DiamondLightSource/techui-builder
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3.12
@@ -75,7 +75,7 @@ The process to use this module goes as follows (WIP):
     > `extras` is optional, but allows any embedded screen to be added to make a summary screen e.g. combining all imgs, pirgs and ionps associated with a vacuum space.
 1. Run this command to locally generate a schema, which can be used for validation testing
 
-    ```$ techui-builder --schema```
+    ```$ techui-builder schema```
 
     Add the following at the top of the `techui.yaml` to validate it against a schema
     
@@ -85,10 +85,22 @@ The process to use this module goes as follows (WIP):
 
 ## Generating the Synoptic
 
-`$ techui-builder /path/to/synoptic/techui.yaml`
+`$ techui-builder build /path/to/synoptic/techui.yaml`
 
 This populates `index.bob` and individual component screens inside `ixx-services/synoptic`.
 
+## Generating the JsonMap
+
+`$ techui-builder generate-jsonmap /path/to/synoptic/index.bob`
+
+This populates `JsonMap.json` with the tree of component screens inside `ixx-services/synoptic/index.bob`.
+
+## Generating the Status PV database file
+
+`$ techui-builder status /path/to/synoptic/techui.yaml`
+
+This populates `config/status.db` with the status PVs of components inside `ixx-services/synoptic/techui.yaml`.
+
 ## Viewing the Synoptic
 
 In a terminal outside of the container:

{techui_builder-0.6.8a2 → techui_builder-0.7}/README.md

@@ -53,7 +53,7 @@ The process to use this module goes as follows (WIP):
     > `extras` is optional, but allows any embedded screen to be added to make a summary screen e.g. combining all imgs, pirgs and ionps associated with a vacuum space.
 1. Run this command to locally generate a schema, which can be used for validation testing
 
-    ```$ techui-builder --schema```
+    ```$ techui-builder schema```
 
     Add the following at the top of the `techui.yaml` to validate it against a schema
     
@@ -63,10 +63,22 @@ The process to use this module goes as follows (WIP):
 
 ## Generating the Synoptic
 
-`$ techui-builder /path/to/synoptic/techui.yaml`
+`$ techui-builder build /path/to/synoptic/techui.yaml`
 
 This populates `index.bob` and individual component screens inside `ixx-services/synoptic`.
 
+## Generating the JsonMap
+
+`$ techui-builder generate-jsonmap /path/to/synoptic/index.bob`
+
+This populates `JsonMap.json` with the tree of component screens inside `ixx-services/synoptic/index.bob`.
+
+## Generating the Status PV database file
+
+`$ techui-builder status /path/to/synoptic/techui.yaml`
+
+This populates `config/status.db` with the status PVs of components inside `ixx-services/synoptic/techui.yaml`.
+
 ## Viewing the Synoptic
 
 In a terminal outside of the container:

techui_builder-0.7/example/t01-services/services/bl01t-ea-ioc-01/config/fastcs.yaml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=schema.json
+controllers:
+  - name: BL01T-EA-TEST-01
+    type: fastcs.TemperatureController
+    ip_settings:
+      ip: "localhost"
+      port: 25565
+    num_ramp_controllers: 4
+
+transport:
+  - graphql:
+      host: localhost
+      port: 8083
+      log_level: info
+  - epicsca: {}
+    gui:
+      title: Temperature Controller Demo
+      output_dir: .

{techui_builder-0.6.8a2 → techui_builder-0.7}/example/t01-services/synoptic/techui.yaml

@@ -9,6 +9,8 @@ components:
   fshtr:
     label: Fast Shutter
     prefix: BL01T-EA-FSHTR-01
+    status:
+      - BL01T-EA-FSHTR-01:FSHTR1.STAT
 
   d1:
     label: Diode 1

{techui_builder-0.6.8a2 → techui_builder-0.7}/pyproject.toml

@@ -3,6 +3,8 @@ requires = ["setuptools>=64", "setuptools_scm[toml]>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
+scripts = { techui-builder = "techui_builder.__main__:app" }
+
 name = "techui-builder"
 dynamic = ["version"]
 description = "A package for building Phoebus GUIs"
@@ -16,6 +18,7 @@ authors = [
     { name = "Oliver Copping", email = "oliver.copping@diamond.ac.uk" },
     { name = "Adedamola Sode", email = "adedamola.sode@diamond.ac.uk" },
     { name = "Niamh Dougan", email = "niamh.dougan@diamond.ac.uk" },
+    { name = "Thomas Kane", email = "thomas.kane@diamond.ac.uk" },
 ]
 license-files = ["LICENSE"]
 readme = "README.md"
@@ -30,8 +33,6 @@ dependencies = [
     "softioc>=4.7.0",
     "epicsdbbuilder>=1.5",
 ]
-scripts = { techui-builder = "techui_builder.__main__:app" }
-
 [dependency-groups]
 dev = [
     "copier",

techui_builder-0.7/src/techui_builder/__main__.py

@@ -0,0 +1,69 @@
+"""Interface for ``python -m techui_builder``."""
+
+import logging
+
+import typer
+
+from techui_builder._version import __version__
+from techui_builder.generate_jsonmap import app as generate_jsonmap_app
+from techui_builder.main_app import app as main_app
+from techui_builder.schema_generator import app as schema_app
+from techui_builder.status import app as status_app
+
+logger_ = logging.getLogger(__name__)
+
+app = typer.Typer(
+    pretty_exceptions_show_locals=False,
+    context_settings={"allow_interspersed_args": True},
+    help="""
+    A script for building Phoebus GUIs.
+
+    This is the required file structure:\n
+\n
+    ixx-services\n
+    |-- services\n
+    |   |-- blxxi-ea-device-01\n
+    |   |   `-- config\n
+    |   |       `-- ioc.yaml\n
+    |   |-- ...\n
+    |   `-- blxxi-va-device-01\n
+    |       `-- config\n
+    |           `-- ioc.yaml\n
+    `-- synoptic\n
+    .   |-- techui-support/\n
+    |   |   `-- ...\n
+    .   |-- techui.yaml\n
+    .   `-- index.bob\n
+""",
+    no_args_is_help=True,
+)
+
+
+def version_callback(value: bool):
+    if value:
+        print(f"techui-builder version: {__version__}")
+        raise typer.Exit()
+
+
+@app.callback()
+def _(
+    version: bool = typer.Option(
+        False,
+        "--version",
+        callback=version_callback,
+        is_eager=True,
+        help="Show version of techui-builder and exit",
+    ),
+):
+    """Boilerplate callback function to allow for --version CLI option"""
+    pass
+
+
+app.add_typer(main_app)
+app.add_typer(schema_app, name="schema")
+app.add_typer(generate_jsonmap_app, name="generate-jsonmap")
+app.add_typer(status_app, name="status")
+
+
+if __name__ == "__main__":
+    app()

{techui_builder-0.6.8a2 → techui_builder-0.7}/src/techui_builder/_logger.py

@@ -16,3 +16,7 @@ class Logger:
             format="%(message)s",
             handlers=[self.handler],
         )
+
+
+def log_level(level: str):
+    Logger(level)

{techui_builder-0.6.8a2 → techui_builder-0.7}/src/techui_builder/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.6.8a2'
-__version_tuple__ = version_tuple = (0, 6, 8, 'a2')
+__version__ = version = '0.7'
+__version_tuple__ = version_tuple = (0, 7)
 
-__commit_id__ = commit_id = 'gd10e2d23d'
+__commit_id__ = commit_id = 'ga46847b35'

{techui_builder-0.6.8a2 → techui_builder-0.7}/src/techui_builder/autofill.py

@@ -8,7 +8,7 @@ from lxml import objectify
 from lxml.etree import Element, SubElement, tostring
 from lxml.objectify import ObjectifiedElement, fromstring
 
-from techui_builder.builder import _get_action_group
+from techui_builder.generate_jsonmap import _get_action_group
 from techui_builder.models import Component
 from techui_builder.utils import read_bob
 

techui_builder-0.7/src/techui_builder/builder.py

@@ -0,0 +1,238 @@
+import logging
+import os
+import re
+from collections import defaultdict
+from dataclasses import dataclass, field
+from pathlib import Path
+
+import yaml
+from jinja2 import Template
+
+from techui_builder.generate import Generator
+from techui_builder.models import Entity, SupportEntity, TechUi, TechUiSupport
+from techui_builder.validator import Validator
+
+logger_ = logging.getLogger(__name__)
+
+
+@dataclass
+class Builder:
+    """
+    This class provides the functionality to process the required
+    techui.yaml file into screens mapped from ioc.yaml and
+    *-mapping.yaml files.
+
+    By default it looks for a `techui.yaml` file in the same dir
+    of the script Guibuilder is called in. Optionally a custom path
+    can be declared.
+
+    """
+
+    techui: Path = field(default=Path("techui.yaml"))
+
+    entities: defaultdict[str, list[Entity]] = field(
+        default_factory=lambda: defaultdict(list), init=False
+    )
+    _services_dir: Path = field(init=False, repr=False)
+    _write_directory: Path = field(init=False, repr=False)
+
+    def __post_init__(self):
+        # Populate beamline and components
+        self.conf = TechUi.model_validate(
+            yaml.safe_load(self.techui.read_text(encoding="utf-8"))
+        )
+
+    def setup(self):
+        """
+        Run intial setup, e.g. extracting entries
+        from service ioc.yaml or fastcs.yaml.
+        """
+        # This needs to be before _read_map()
+        self.support_path = self._write_directory.joinpath("techui-support")
+
+        self._read_map()
+
+        self._extract_services()
+
+        self.clean_files()
+
+        self.generator = Generator(
+            self._write_directory,
+            self.conf.beamline.url,
+            self.support_path,
+            self.techui_support,
+        )
+
+    def _read_map(self):
+        """Read the techui-support.yaml file from techui-support."""
+        support_yaml = self.support_path.joinpath("techui-support.yaml").absolute()
+        logger_.debug(f"techui-support.yaml location: {support_yaml}")
+
+        self.techui_support = TechUiSupport.model_validate(
+            yaml.safe_load(support_yaml.read_text(encoding="utf-8"))
+        )
+
+    def clean_files(self):
+        exclude = {"index.bob"}
+        bobs = [
+            bob
+            for bob in self._write_directory.glob("*.bob")
+            if bob.name not in exclude
+        ]
+
+        self.validator = Validator(bobs)
+        self.validator.check_bobs()
+
+        # Get bobs that are only present in the bobs list (i.e. generated)
+        self.generated_bobs = list(set(bobs) ^ set(self.validator.validate.values()))
+
+        logger_.info("Preserving edited screens for validation.")
+        logger_.debug(f"Screens to validate: {list(self.validator.validate.keys())}")
+
+        logger_.info("Cleaning synoptic/ of generated screens.")
+
+        try:
+            # Find the JsonMap file
+            json_map_file = next(self._write_directory.glob("JsonMap.json"))
+            # If it exists, we want to remove it too
+            generated_files = [*self.generated_bobs, json_map_file]
+        except StopIteration:
+            generated_files = self.generated_bobs
+
+        # Remove any generated files that exist
+        for file_ in generated_files:
+            logger_.debug(f"Removing generated file: {file_.name}")
+            os.remove(file_)
+
+    def _extract_services(self):
+        """
+        Finds the services folders in the services directory
+        and extracts all entites
+        """
+
+        # Loop over every dir in services, ignoring anything that isn't a service
+        for service in self._services_dir.glob(f"{self.conf.beamline.domain}-*-*-*"):
+            service_name = service.name
+            # If service doesn't exist, file open will fail throwing exception
+            try:
+                service_yaml_dir = service.joinpath("config")
+                service_yaml = next(service_yaml_dir.glob("*.yaml"), None)
+                if service_yaml is None:
+                    raise OSError()
+
+                self._extract_entities(
+                    service_name=service_name,
+                    service_yaml=service_yaml,
+                )
+
+            except OSError:
+                logger_.error(
+                    "No ioc.yaml or fastcs.yaml found for service: "
+                    f"[bold]{service_name}[/bold]. Does it exist?"
+                )
+
+    def _extract_entities(self, service_name: str, service_yaml: Path):
+        """
+        Extracts the entries in ioc.yaml matching the defined prefix
+        """
+
+        with open(service_yaml) as ioc:
+            ioc_conf: dict[str, list[dict[str, str]]] = yaml.safe_load(ioc)
+
+            for key in ioc_conf.keys():
+                _regex = re.compile(r"^(?:(entities)|(controllers))$")
+                match = _regex.match(key)
+                if match:
+                    entity_key = match.group()
+
+                    for entity in ioc_conf[entity_key]:
+                        if entity["type"] in self.techui_support.support_modules:
+                            support_mapping: SupportEntity = (
+                                self.techui_support.support_modules[entity["type"]]
+                            )
+                            support_macros = support_mapping.macros
+
+                            macros = {
+                                k: v for k, v in entity.items() if k in support_macros
+                            }
+
+                            prefix_template = Template(support_mapping.prefix)
+                            prefix: str = prefix_template.render(macros)
+
+                            # Create Entity and append to entity list
+                            new_entity = Entity(
+                                service_name=service_name,
+                                type=entity["type"],
+                                desc=entity.get("desc", None),
+                                prefix=prefix,
+                                macros=macros,
+                            )
+
+                            pv_root = prefix.split(":", maxsplit=1)[0]
+                            self.entities[pv_root].append(new_entity)
+                    break
+
+    def _generate_screen(self, screen_name: str):
+        self.generator.build_screen(screen_name)
+        self.generator.write_screen(screen_name, self._write_directory)
+
+    def _validate_screen(self, screen_name: str):
+        # Get the generated widgets to validate against
+        widgets = self.generator.widgets
+        widget_group = self.generator.group
+        assert widget_group is not None
+        widget_group_name = widget_group.get_element_value("name")
+        self.validator.validate_bob(screen_name, widget_group_name, widgets)
+
+    def create_screens(self):
+        """Create the screens for each component in techui.yaml"""
+        if len(self.entities) == 0:
+            logger_.critical(
+                "No ioc entities found. This [italic]normally[/italic]"
+                " suggests an issue with finding ixx-services."
+            )
+            exit()
+
+        # Loop over every component defined in techui.yaml and locate
+        # any extras defined
+        for component_name, component in self.conf.components.items():
+            screen_entities: list[Entity] = []
+
+            # ONLY IF there is a matching component and entity, generate a screen
+            if component.prefix in self.entities.keys():
+                # Populate child labels for any entities
+                # with the same prefix as the component
+                for entity in self.entities[component.prefix]:
+                    entity.child_labels = component.child_labels
+
+                screen_entities.extend(self.entities[component.prefix])
+
+                if component.extras is not None:
+                    # If component has any extras, add them to the entries to generate
+                    for extra_p in component.extras:
+                        if extra_p not in self.entities.keys():
+                            logger_.error(
+                                f"Extra prefix {extra_p} for {component_name} does not"
+                                " exist."
+                            )
+                            continue
+                        screen_entities.extend(self.entities[extra_p])
+
+                # This is used by both generate and validate,
+                # so called beforehand for tidyness
+                self.generator.build_widgets(component_name, screen_entities)
+                self.generator.build_groups(component_name, self.conf.components)
+
+                screens_to_validate = list(self.validator.validate.keys())
+
+                if component_name in screens_to_validate:
+                    self._validate_screen(component_name)
+                else:
+                    self._generate_screen(component_name)
+
+            else:
+                logger_.warning(
+                    f"{self.techui.name}: The prefix [bold]{component.prefix}[/bold] "
+                    f"set in the component [bold]{component_name}[/bold] does not match"
+                    " any P field in the ioc.yaml files in services"
+                )