techui-builder 0.6.0a2__py3-none-any.whl

techui_builder/__init__.py

@@ -0,0 +1,16 @@
+"""Top level API.
+
+.. data:: __version__
+    :type: str
+
+    Version number as calculated by poetry-dynamic-versioning
+"""
+
+from techui_builder.builder import Builder
+
+from ._version import __version__
+
+__all__ = [
+    "__version__",
+    "Builder",
+]

techui_builder/__main__.py

@@ -0,0 +1,180 @@
+"""Interface for ``python -m techui_builder``."""
+
+import logging
+from pathlib import Path
+from typing import Annotated
+
+import typer
+from rich.logging import RichHandler
+
+from techui_builder import __version__
+from techui_builder.autofill import Autofiller
+from techui_builder.builder import Builder
+from techui_builder.schema_generator import schema_generator
+
+app = typer.Typer(
+    pretty_exceptions_show_locals=False,
+    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
+""",
+)
+
+default_bobfile = "index.bob"
+
+
+def version_callback(value: bool):
+    if value:
+        print(f"techui-builder version: {__version__}")
+        raise typer.Exit()
+
+
+def schema_callback(value: bool):
+    if value:
+        schema_generator()
+        raise typer.Exit()
+
+
+def log_level(level: str):
+    logging.basicConfig(
+        level=level,
+        format="%(message)s",
+        handlers=[RichHandler(omit_repeated_times=False, markup=True)],
+    )
+
+
+# This is the default behaviour when no command provided
+@app.callback(invoke_without_command=True)
+def main(
+    filename: Annotated[Path, typer.Argument(help="The path to techui.yaml")],
+    bobfile: Annotated[
+        Path | None,
+        typer.Argument(help="Override for template bob file location."),
+    ] = None,
+    version: Annotated[
+        bool | None, typer.Option("--version", callback=version_callback)
+    ] = None,
+    loglevel: Annotated[
+        str,
+        typer.Option(
+            "--log-level",
+            help="Set log level to INFO, DEBUG, WARNING, ERROR or CRITICAL",
+            case_sensitive=False,
+            callback=log_level,
+        ),
+    ] = "INFO",
+    schema: Annotated[
+        bool | None,
+        typer.Option(
+            "--schema",
+            help="Generate schema for validating techui and ibek-mapping yaml files",
+            callback=schema_callback,
+        ),
+    ] = None,
+) -> None:
+    """Default function called from cmd line tool."""
+
+    logger_ = logging.getLogger(__name__)
+
+    bob_file = bobfile
+
+    gui = Builder(techui=filename)
+
+    # Get the relative path to the techui file from working dir
+    abs_path = filename.absolute()
+    logger_.debug(f"techui.yaml absolute path: {abs_path}")
+
+    # Get the current working dir
+    cwd = Path.cwd()
+    logger_.debug(f"Working directory: {cwd}")
+
+    # Get the relative path of ixx-services to techui.yaml
+    ixx_services_dir = next(
+        (
+            ixx_services.relative_to(cwd, walk_up=True)
+            for parent in abs_path.parents
+            for ixx_services in parent.glob(f"{gui.conf.beamline.short_dom}-services")
+        ),
+        None,
+    )
+    if ixx_services_dir is None:
+        logging.critical("ixx-services not found. Is you file structure correct?")
+        exit()
+    logger_.debug(f"ixx-services relative path: {ixx_services_dir}")
+
+    # Get the synoptic dir relative to the parent dir
+    synoptic_dir = ixx_services_dir.joinpath("synoptic")
+    logger_.debug(f"synoptic relative path: {synoptic_dir}")
+
+    if bob_file is None:
+        # Search default relative dir to techui filename
+        # There will only ever be one file, but if not return None
+        bob_file = next(
+            synoptic_dir.glob("index.bob"),
+            None,
+        )
+        if bob_file is None:
+            logging.critical(
+                f"Source bob file '{default_bobfile}' not found in \
+{synoptic_dir}. Does it exist?"
+            )
+            exit()
+    elif not bob_file.exists():
+        logging.critical(f"Source bob file '{bob_file}' not found. Does it exist?")
+        exit()
+
+    logger_.debug(f"bob file: {bob_file}")
+
+    # # Overwrite after initialised to make sure this is picked up
+    gui._services_dir = ixx_services_dir.joinpath("services")  # noqa: SLF001
+    gui._write_directory = synoptic_dir  # noqa: SLF001
+
+    logger_.debug(
+        f"""
+
+Builder created for {gui.conf.beamline.short_dom}.
+Services directory: {gui._services_dir}
+Write directory: {gui._write_directory}
+""",  # noqa: SLF001
+    )
+
+    gui.setup()
+    gui.create_screens()
+    gui.write_devsta_pvs()
+
+    logger_.info(f"Screens generated for {gui.conf.beamline.short_dom}.")
+
+    autofiller = Autofiller(bob_file)
+    autofiller.read_bob()
+    autofiller.autofill_bob(gui)
+
+    dest_bob = gui._write_directory.joinpath("index.bob")  # noqa: SLF001
+
+    autofiller.write_bob(dest_bob)
+
+    logger_.info(f"Screens autofilled for {gui.conf.beamline.short_dom}.")
+
+    gui.write_json_map(synoptic=dest_bob, dest=gui._write_directory)  # noqa: SLF001
+    logger_.info(
+        f"Json map generated for {gui.conf.beamline.short_dom} (from index.bob)"
+    )
+
+
+if __name__ == "__main__":
+    app()

techui_builder/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.6.0a2'
+__version_tuple__ = version_tuple = (0, 6, 0, 'a2')
+
+__commit_id__ = commit_id = None

techui_builder/autofill.py

@@ -0,0 +1,102 @@
+import logging
+import os
+from collections import defaultdict
+from dataclasses import dataclass, field
+from pathlib import Path
+
+from lxml import objectify
+from lxml.objectify import ObjectifiedElement
+
+from techui_builder.builder import Builder, _get_action_group
+from techui_builder.models import Component
+from techui_builder.utils import read_bob
+
+logger_ = logging.getLogger(__name__)
+
+
+@dataclass
+class Autofiller:
+    path: Path
+    macros: list[str] = field(default_factory=lambda: ["prefix", "desc", "file"])
+    widgets: dict[str, ObjectifiedElement] = field(
+        default_factory=defaultdict, init=False, repr=False
+    )
+
+    def read_bob(self) -> None:
+        self.tree, self.widgets = read_bob(self.path)
+
+    def autofill_bob(self, gui: "Builder"):
+        # Get names from component list
+
+        for symbol_name, child in self.widgets.items():
+            # If the name exists in the component list
+            if symbol_name in gui.conf.components.keys():
+                # Get first copy of component (should only be one)
+                comp = next(
+                    (comp for comp in gui.conf.components if comp == symbol_name),
+                )
+
+                self.replace_content(
+                    widget=child,
+                    component_name=comp,
+                    component=gui.conf.components[comp],
+                )
+
+                # Add option to allow left mouse click to run action
+                child["run_actions_on_mouse_click"] = "true"
+
+    def write_bob(self, filename: Path):
+        # Check if data/ dir exists and if not, make it
+        data_dir = filename.parent
+        if not data_dir.exists():
+            os.mkdir(data_dir)
+
+        # Remove any unnecessary xmlns:py and py:pytype metadata from tags
+        objectify.deannotate(self.tree, cleanup_namespaces=True)
+
+        self.tree.write(
+            filename,
+            pretty_print=True,
+            encoding="utf-8",
+            xml_declaration=True,
+        )
+        logger_.debug(f"Screen filled for {filename}")
+
+    def replace_content(
+        self,
+        widget: ObjectifiedElement,
+        component_name: str,
+        component: Component,
+    ):
+        for macro in self.macros:
+            # Get current component attribute
+            component_attr = getattr(component, macro)
+
+            # Fix to make sure widget is reverted back to widget that was passed in
+            current_widget = widget
+            match macro:
+                case "prefix":
+                    tag_name = "pv_name"
+                    component_attr += ":DEVSTA"
+                case "desc":
+                    tag_name = "description"
+                    current_widget = _get_action_group(widget)
+                    if component_attr is None:
+                        component_attr = component_name
+                case "file":
+                    tag_name = "file"
+                    current_widget = _get_action_group(widget)
+                    if component_attr is None:
+                        component_attr = f"{component_name}.bob"
+                case _:
+                    raise ValueError("The provided macro type is not supported.")
+
+            if current_widget is None:
+                logger_.debug(
+                    f"Skipping replace_content for {component_name} as no action\
+ group found"
+                )
+                continue
+
+            # Set component's tag text to the corresponding widget tag
+            current_widget[tag_name] = component_attr