Add many additional tests

Author: jwlodek

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.gitignore

@@ -2,3 +2,7 @@ venv/
 *.egg*
 *.pyc
 _version.py
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+.htmlcov/

.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+exclude: ^tests/outputs/
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0

pixi.lock

@@ -14,6 +14,7 @@ classifiers = [
 description = "CLI utility for auto-creating phoebus engineering screens from EPICS db templates"
 dependencies = [
     "phoebusgen",
+    "rectangle-packer",
     "epicsdbtools@git+https://github.com/jwlodek/epicsdbtools",
 ]
 dynamic = ["version"]
@@ -117,3 +118,30 @@ exclude = [
 
 [tool.importlinter]
 root_package = "epicsdb2bob"
+
+[tool.pixi.workspace]
+channels = ["conda-forge"]
+platforms = ["linux-64"]
+
+[tool.pixi.pypi-dependencies]
+epicsdb2bob = { path = ".", editable = true }
+
+[tool.pixi.environments]
+default = { solve-group = "default" }
+dev = { features = ["dev"], solve-group = "default" }
+
+[tool.pixi.tasks]
+test = "pytest"
+test-w-cov = "pytest --cov --cov-report=html"
+lint = "pre-commit run --all-files"
+
+[tool.pixi.dependencies]
+pytest = ">=9.0.1,<10"
+pre-commit = ">=4.4.0,<5"
+ruff = ">=0.14.6,<0.15"
+tox = ">=4.32.0,<5"
+pytest-cov = ">=7.0.0,<8"
+phoebusgen = ">=3.1.0,<4"
+rectangle-packer = ">=2.0.4,<3"
+python = ">=3.12.12,<3.13"
+import-linter = ">=2.7,<3"

pyproject.toml

@@ -10,7 +10,11 @@
 from .bobfile_gen import generate_bobfile_for_db, generate_bobfile_for_substitution
 from .config import EPICSDB2BOBConfig
 from .palettes import BUILTIN_PALETTES
-from .parser import find_epics_dbs_and_templates, find_epics_subs
+from .utils import (
+    find_bobfiles_in_search_path,
+    find_epics_dbs_and_templates,
+    find_epics_subs,
+)
 
 __all__ = ["main"]
 
@@ -158,21 +162,14 @@ def main() -> None:
             epicsdbtools_logger.setLevel(logging.DEBUG)
         logger.debug("Loaded configuration from .epicsdb2bob.yml")
     else:
+        args.palette = BUILTIN_PALETTES[args.palette]
         config = EPICSDB2BOBConfig()
         logger.debug("No configuration file found, using defaults.")
         for key, value in vars(args).items():
             if value is not None:
                 setattr(config, key, value)
 
-    written_bobfiles: dict[str, Path] = {}
-
-    for bobfile_dir in config.bobfile_search_path:
-        for dirpath, _, filenames in os.walk(bobfile_dir):
-            for filename in filenames:
-                if filename.endswith((".bob", ".opi")):
-                    full_path = Path(os.path.join(dirpath, filename))
-                    logger.info(f"Found additional bob/opi file: {full_path}")
-                    written_bobfiles[filename] = full_path
+    written_bobfiles = find_bobfiles_in_search_path(config.bobfile_search_path)
 
     macros = (
         {macro.split("=")[0]: macro.split("=")[1] for macro in args.macros}

src/epicsdb2bob/__main__.py

@@ -35,6 +35,7 @@
     TitleBarFormat,
 )
 from .palettes import BLACK, WHITE
+from .utils import pack_close_to_square
 
 logger = logging.getLogger("epicsdb2bob")
 
@@ -151,26 +152,31 @@ def add_widget_for_record(
 
 
 def add_title_bar(
-    name: str, config: EPICSDB2BOBConfig, title_bar_width: int
+    name: str,
+    config: EPICSDB2BOBConfig,
+    title_bar_width: int,
+    top_level_titlebar: bool = False,
 ) -> Label | None:
-    if config.title_bar_format == TitleBarFormat.NONE:
+    title_bar_format = (
+        config.title_bar_format if not top_level_titlebar else TitleBarFormat.FULL
+    )
+
+    if title_bar_format == TitleBarFormat.NONE:
         return None
 
     title_bar = Label(
-        short_uuid(),
+        "TitleBar",
         name,
-        config.widget_offset
-        if config.title_bar_format == TitleBarFormat.MINIMAL
-        else 0,
+        config.widget_offset if title_bar_format == TitleBarFormat.MINIMAL else 0,
         0,
         title_bar_width,
-        config.title_bar_heights[config.title_bar_format],
+        config.title_bar_heights[title_bar_format],
     )
     title_bar.foreground_color(*WHITE)
-    if config.title_bar_format == TitleBarFormat.FULL:
+    if title_bar_format == TitleBarFormat.FULL:
         title_bar.font_size(config.font_size * 2)
         title_bar.horizontal_alignment_center()
-    elif config.title_bar_format == TitleBarFormat.MINIMAL:
+    elif title_bar_format == TitleBarFormat.MINIMAL:
         title_bar.auto_size()
         title_bar.font_size(config.font_size + 2)
         title_bar.border_width(2)
@@ -328,7 +334,11 @@ def generate_bobfile_for_db(
     else:
         screen_height = current_y_pos + config.widget_offset
 
-    title_bar = add_title_bar(name, config, screen_width - config.widget_offset)
+    title_bar = add_title_bar(
+        name.replace("_", " ").replace("-", " "),
+        config,
+        screen_width - config.widget_offset,
+    )
     if title_bar:
         widget_counters[Label] = widget_counters.get(Label, 0) + 1
         title_bar.name(f"Label_{widget_counters[Label]}")
@@ -340,7 +350,7 @@ def generate_bobfile_for_db(
             screen_height - int(config.title_bar_heights[config.title_bar_format] / 2)
         )
 
-    screen.background_color(*config.background_color)
+    screen.background_color(*config.palette.screen_bg)
 
     screen.height(screen_height)
     screen.width(screen_width)
@@ -372,22 +382,17 @@ def generate_bobfile_for_substitution(
     """
     Generate a BOB file for a substitution.
     """
+    substitution_name.replace("_", " ").replace("-", " ").title()
     screen = Screen(substitution_name)
     screen.background_color(*config.background_color)
 
-    screen_width = 0
-    max_col_width = 0
-    hit_max_y_pos = False
-
-    current_x_pos = config.widget_offset
-    current_y_pos = (
-        config.widget_offset + config.title_bar_heights[config.title_bar_format]
-    )
     launcher_buttons: dict[str, ActionButton] = {}
 
     logger.info(f"Generating screen for substitution: {substitution_name}")
     logger.debug(f"Found bobfiles: {found_bobfiles}")
 
+    embed_rects: dict[Widget, tuple[int, int]] = {}
+
     for template in substitution:
         template_instances = substitution[template]
         logger.info(f"Processing template: {template}")
@@ -402,33 +407,20 @@ def generate_bobfile_for_substitution(
                 )
                 embed_height = embed_raw_height + config.widget_offset
                 embed_width = embed_raw_width + config.widget_offset
-                if (
-                    current_y_pos + embed_height
-                    > config.max_screen_height
-                    + config.title_bar_heights[TitleBarFormat.FULL]
-                ):
-                    current_y_pos = (
-                        config.widget_offset
-                        + config.title_bar_heights[TitleBarFormat.FULL]
-                    )
-                    current_x_pos += max_col_width + config.widget_offset
-                    max_col_width = 0
 
                 embedded_display = EmbeddedDisplay(
                     short_uuid(),
                     template_to_bob(template),
-                    current_x_pos,
-                    current_y_pos,
+                    0,
+                    0,
                     embed_width,
                     embed_height,
                 )
-                current_y_pos += embed_height + config.widget_offset
 
-                if embed_width > max_col_width:
-                    max_col_width = embed_width
+                embed_rects[embedded_display] = (embed_width, embed_height)
+
                 for macro in instance:
                     embedded_display.macro(macro, instance[macro])
-                screen.add_widget(embedded_display)
 
             elif template in launcher_buttons:
                 launcher_buttons[template].action_open_display(
@@ -439,49 +431,59 @@ def generate_bobfile_for_substitution(
                 )
             else:
                 logger.info(f"Creating launcher button for template: {template}")
+
                 launcher_buttons[template] = ActionButton(
                     short_uuid(),
                     os.path.splitext(template)[0],
                     "",
-                    current_x_pos,
-                    current_y_pos,
+                    0,
+                    0,
                     config.default_widget_width,
                     config.default_widget_height,
                 )
+
                 launcher_buttons[template].action_open_display(
                     template_to_bob(template),
                     "tab",
                     f"{os.path.splitext(template)[0]} {i + 1}",
                     instance,
                 )
-                screen.add_widget(launcher_buttons[template])
-                current_y_pos += config.default_widget_height + config.widget_offset
-
-                if config.default_widget_width > max_col_width:
-                    max_col_width = config.default_widget_width
-
-                if (
-                    current_y_pos
-                    > config.max_screen_height
-                    + config.title_bar_heights[TitleBarFormat.FULL]
-                ):
-                    hit_max_y_pos = True
-                    current_y_pos = (
-                        config.widget_offset
-                        + config.title_bar_heights[TitleBarFormat.FULL]
-                    )
-                    current_x_pos += max_col_width + config.widget_offset
-                    max_col_width = 0
+                embed_rects[launcher_buttons[template]] = (
+                    config.default_widget_width + config.widget_offset,
+                    config.default_widget_height + config.widget_offset,
+                )
 
-    screen_height = current_y_pos + config.widget_offset
-    if hit_max_y_pos:
-        screen_height = config.max_screen_height + config.widget_offset
-    screen_width = current_x_pos + max_col_width + config.widget_offset
+    packed_x_y_embeds = pack_close_to_square(
+        list(embed_rects.values()),
+        config.max_screen_height,
+        padding=config.widget_offset,
+    )
+
+    embed_stop_positions = [
+        (pos[0] + size[0], pos[1] + size[1])
+        for pos, size in zip(packed_x_y_embeds, embed_rects.values(), strict=False)
+    ]
+    screen_width = max([pos[0] for pos in embed_stop_positions], default=0)
+    screen_height = max([pos[1] for pos in embed_stop_positions], default=0)
+    screen_height = screen_height + 5 * config.widget_offset
+
+    for i, (xy_position, embed) in enumerate(
+        zip(packed_x_y_embeds, embed_rects.keys(), strict=False)
+    ):
+        embed.x(xy_position[0])
+        embed.y(
+            xy_position[1]
+            + config.title_bar_heights[config.title_bar_format]
+            + 3 * config.widget_offset
+        )
+        embed.name(f"{embed.__class__.__name__}_{i + 1}")
+        screen.add_widget(embed)
 
     title_bar = add_title_bar(
         substitution_name,
         config,
         screen_width - config.widget_offset,
+        top_level_titlebar=True,
     )
     if title_bar:
         screen.add_widget(title_bar)

src/epicsdb2bob/bobfile_gen.py

@@ -3,6 +3,7 @@
 from collections import OrderedDict
 from pathlib import Path
 
+import rpack
 from epicsdbtools import (
     Database,
     LoadIncludesStrategy,
@@ -93,3 +94,59 @@ def find_epics_subs(search_path: Path) -> dict[str, dict[str, list[dict[str, str
                     )
 
     return epics_subs
+
+
+def find_bobfiles_in_search_path(bobfile_search_path: list[Path]) -> dict[str, Path]:
+    written_bobfiles: dict[str, Path] = {}
+
+    for bobfile_dir in bobfile_search_path:
+        for dirpath, _, filenames in os.walk(bobfile_dir):
+            for filename in filenames:
+                if filename.endswith((".bob", ".opi")):
+                    full_path = Path(os.path.join(dirpath, filename))
+                    logger.info(f"Found additional bob/opi file: {full_path}")
+                    written_bobfiles[filename] = full_path
+    return written_bobfiles
+
+
+def pack_close_to_square(
+    rectangle_sizes: list[tuple[int, int]], max_height: int, padding: int
+) -> list[tuple[int, int]]:
+    """Pack rectangles into as close to a square as possible.
+
+    Args:
+        rectangle_sizes (list[tuple[int, int]]): List of (width, height) for each rect
+        max_height (int): Maximum allowed height for the packed rectangles.
+
+    Returns:
+        tuple[int, int]: (total_width, total_height) of the packed rectangles.
+    """
+
+    # Add padding to each rectangle size
+    padded_rectangle_sizes = [
+        (width + padding, height + padding) for width, height in rectangle_sizes
+    ]
+
+    height = 100
+    width = 100
+    increment = 100
+
+    iteration = 0
+    while True:
+        try:
+            if height < width and height + increment <= max_height:
+                height += increment
+            else:
+                width += increment
+            packed_x_y_positions = rpack.pack(padded_rectangle_sizes, width, height)
+            break
+        except rpack.PackingImpossibleError as err:
+            iteration += 1
+            if iteration > 1000:
+                raise RuntimeError("Unable to pack rects within max height.") from err
+            else:
+                logger.warning(
+                    f"Packing impossible at dims {width}x{height}, increasing size."
+                )
+
+    return packed_x_y_positions

src/epicsdb2bob/parser.py renamed to src/epicsdb2bob/utils.py

@@ -0,0 +1,13 @@
+file db_with_readbacks.db
+{
+pattern {}
+{}
+}
+
+file simple_db.db
+{
+pattern {}
+{}
+{}
+{}
+}