From 6477093d26c4f14d6e1126cd8e8d2efb4996f1a6 Mon Sep 17 00:00:00 2001
From: Giles Knap <giles.knap@diamond.ac.uk>
Date: Wed, 12 Jun 2024 13:29:18 +0000
Subject: [PATCH] first version of support yaml converter

---
 convert/ibek2to3.py | 120 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 120 insertions(+)

diff --git a/convert/ibek2to3.py b/convert/ibek2to3.py
index e69de29bb..d15e3ef5d 100644
--- a/convert/ibek2to3.py
+++ b/convert/ibek2to3.py
@@ -0,0 +1,120 @@
+"""
+Converts .ibek.support.yaml files from the v2.0 format to the v3.0 format.
+
+Changes:
+- args are now params
+- params are a dictionary of dictionaries instead of a list of dictionaries
+- params no longer have a name field as the key in the dictionary is the name
+- values is now post_defines and is also a dictionary of dictionaries
+- pre_values is now pre_defines and is also a dictionary of dictionaries
+- __utils__ is now _global
+- __utils__ functions have changed:
+    - get_var -> get
+    - set_var -> set
+    - counter -> incrementor
+      - behaviour has changed: the --increment and --stop flags are interpreted
+        on every invocation of the incrementor function (so non linear counters
+        are possible)
+      - counters current value is accessible via _global.get(counterName)
+
+Backward compatible changes:
+- object refs are literally the object - so you can modify a referenced object's
+  attributes (with appropriate care)
+- defines now may have optional type: which defaults to str and may be
+    - list (of Any), int, float, bool
+- each definition may have 'shared' field which is a list of Any
+- there is also a global 'shared' at the root level
+- shared are scratch areas in which to place anchors that can be referred to
+  by aliases
+"""
+
+from pathlib import Path
+
+import typer
+from ruamel.yaml import YAML, CommentedMap
+
+eg_file = Path(__file__).parent.parent / "tests/samples/support/ipac.ibek.support.yaml"
+
+
+def main(files: list[Path]):
+    """
+    Read a list of files in and process each one
+    """
+    for f in files or [eg_file]:
+        print(f"Processing {f} ...")
+        process_file(f)
+
+
+def process_file(file: Path):
+    """
+    process a single file by reading its yaml - transforming it and writing it back
+    """
+    yaml = YAML()
+    with open(file, "r") as f:
+        data = yaml.load(f)
+    data = convert(data)
+
+    with open(file, "w") as f:
+        yaml.dump(data, f)
+
+
+def convert(data: dict):
+    """
+    root data conversion function, replaces each definition in the data with
+    a processed version of that definition
+    """
+
+    # replace all definitions with converted versions
+    if "defs" in data:
+        data["defs"] = [convert_definition(definition) for definition in data["defs"]]
+    return data
+
+
+def convert_definition(data: dict):
+    """
+    convert a single definition's args list to a params dict
+    """
+
+    # rebuild the definition from scratch to enforce order
+    new_data = CommentedMap()
+
+    # copy the leading keys that are not being changed
+    copy_verbatim(data, new_data, ["name", "description", "shared"])
+
+    if "pre_defines" in data:
+        new_data["pre_defines"] = list_to_dict(data["pre_defines"])
+    if "args" in data:
+        new_data["params"] = list_to_dict(data["args"])
+    if "post_defines" in data:
+        new_data["post_defines"] = list_to_dict(data["post_defines"])
+
+    # copy the trailing keys that are not being changed
+    copy_verbatim(data, new_data, ["pre_init", "post_init", "databases", "pvi"])
+
+    return new_data
+
+
+def copy_verbatim(source: dict, dest: dict, keys: list[str]):
+    """
+    copy keys from data to a new dictionary
+    """
+    for key in keys:
+        if key in source:
+            dest[key] = source[key]
+
+
+def list_to_dict(args: list[dict]) -> dict[str, dict]:
+    """
+    convert a list of args to a dictionary, removing the name field as that
+    becomes the key in the dictionary
+    """
+    params = CommentedMap()
+    for arg in args:
+        name = arg["name"]
+        del arg["name"]
+        params[name] = arg
+    return params
+
+
+if __name__ == "__main__":
+    typer.run(main)