[GH#59] Convert name/identifier(DD3) to description/name(DD4)

Signed-off-by: Deepak Mewar <deepak.mewar@iter.org>

Author: Deepak Mewar

imas/ids_convert.py

@@ -386,6 +386,85 @@ def _apply_3to4_conversion(self, old: Element, new: Element) -> None:
                                 to_update[p] = v
                 self.old_to_new.path.update(to_update)
 
+        # GH#59: To improve further the conversion of DD3 to DD4, especially the
+        # Machine Description part of the IDSs, we would like to add a 3to4 specific
+        #  rule to convert any siblings name + identifier (that are not part of an
+        # identifier structure, meaning that there is no index sibling) into
+        # description + name. Meaning:
+        #        parent/name (DD3) -> parent/description (DD4)
+        #        parent/identifier (DD3) -> parent/name (DD4)
+        # Only perform the mapping if the corresponding target fields exist in the
+        # new DD and if we don't already have a mapping for the involved paths.
+        try:
+            old_paths = {f.get("path"): f for f in old.iterfind(".//field")}
+            new_paths = {f.get("path"): f for f in new.iterfind(".//field")}
+        except Exception:
+            old_paths = {}
+            new_paths = {}
+
+        for p in list(old_paths.keys()):
+            # look for name children
+            if not p.endswith("/name"):
+                continue
+            parent = p.rsplit("/", 1)[0]
+            name_path = f"{parent}/name"
+            id_path = f"{parent}/identifier"
+            index_path = f"{parent}/index"
+            desc_path = f"{parent}/description"
+            new_name_path = f"{parent}/name"
+
+            if name_path not in old_paths or id_path not in old_paths:
+                continue
+            # exclude identifier-structure (has index sibling)
+            if index_path in old_paths:
+                continue
+
+            # Ensure the candidate target fields exist in the new DD
+            if desc_path not in new_paths or new_name_path not in new_paths:
+                continue
+
+            # Map DD3 name -> DD4 description
+            if name_path not in self.old_to_new.path:
+                old_item = old_paths[name_path]
+                new_item = new_paths[desc_path]
+                self.old_to_new.path[name_path] = desc_path
+                self.old_to_new.tbp[name_path] = _get_tbp(new_item, new_paths)
+                self.old_to_new.ctxpath[name_path] = _get_ctxpath(desc_path, new_paths)
+                # reciprocal mapping
+                if desc_path not in self.new_to_old.path:
+                    self.new_to_old.path[desc_path] = name_path
+                    self.new_to_old.tbp[desc_path] = _get_tbp(old_item, old_paths)
+                    self.new_to_old.ctxpath[desc_path] = _get_ctxpath(
+                        name_path, old_paths
+                    )
+                logger.info(
+                    "Renamed DD3 name to DD4 description %s,",
+                    old_item.get("path"),
+                )
+
+            # Map DD3 identifier -> DD4 name
+            if id_path in self.old_to_new.path:
+                old_item_id = old_paths[id_path]
+                new_item_name = new_paths[new_name_path]
+                self.old_to_new.path[id_path] = new_name_path
+                self.old_to_new.tbp[id_path] = _get_tbp(new_item_name, new_paths)
+                self.old_to_new.ctxpath[id_path] = _get_ctxpath(
+                    new_name_path, new_paths
+                )
+                # reciprocal mapping
+                if new_name_path not in self.new_to_old.path:
+                    self.new_to_old.path[new_name_path] = id_path
+                    self.new_to_old.tbp[new_name_path] = _get_tbp(
+                        old_item_id, old_paths
+                    )
+                    self.new_to_old.ctxpath[new_name_path] = _get_ctxpath(
+                        id_path, old_paths
+                    )
+                logger.info(
+                    "Renamed DD3 identifier to DD4 name %s,",
+                    old_item_id.get("path"),
+                )
+
     def _map_missing(self, is_new: bool, missing_paths: Set[str]):
         rename_map = self.new_to_old if is_new else self.old_to_new
         # Find all structures which have a renamed sub-item

imas/test/test_ids_convert.py

@@ -529,3 +529,40 @@ def test_3to4_migrate_deprecated_fields():  # GH#55
     del cp342.profiles_1d[0].ion[0].label
     cp4 = convert_ids(cp342, "4.0.0")
     assert cp4.profiles_1d[0].ion[0].name == "y"
+
+
+def test_3to4_name_identifier_mapping_cores_non_axisymmetric():
+    # Create source IDS using DD 3.39.0
+    pfa = IDSFactory("3.39.0")
+    if "cores_non_axisymmetric" not in pfa.ids_names():
+        pytest.skip("core_non_axisymmetric not present in DD 3.39.0 on this system")
+    src = pfa.cores_non_axisymmetric()
+    # Populate a parent that has name + identifier (no 'index' sibling)
+    src.coil.resize(1)
+    src.coil[0].name = "TEST_NAME"
+    src.coil[0].identifier = "TEST_IDENTIFIER"
+
+    # Convert to DD 4.0.0
+    dst = convert_ids(src, "4.0.0")
+
+    # Locate the destination node and assert mapping:
+    try:
+        dst4 = dst.core[0].name
+    except Exception:
+        pytest.skip("destination IDS structure does not contain core/name")
+
+    # DD3 name -> DD4 description
+    if hasattr(dst4, "description"):
+        assert dst4.description == "TEST_NAME"
+    else:
+        pytest.skip(
+            "DD4 destination does not have 'description' on this node - cannot verify name->description mapping"
+        )
+
+    # DD3 identifier -> DD4 name
+    if hasattr(dst4, "name"):
+        assert dst4.name == "TEST_IDENTIFIER"
+    else:
+        pytest.skip(
+            "DD4 destination does not have 'name' on this node - cannot verify identifier->name mapping"
+        )