Merge pull request #1036 from ess-dmsc/ECDC-3518-only-partial-depends-on-support

ECDC-3518-only-partial-depends-on-support

Author: ggoneiESS

nexus_constructor/json/json_warnings.py

@@ -29,6 +29,11 @@ class TransformDependencyMissing:
     message: str = attr.ib()
 
 
+@attr.s
+class RelativeDependsonWrong:
+    message = attr.ib(type=str)
+
+
 @attr.s
 class NameFieldMissing:
     message: str = attr.ib()
@@ -44,6 +49,7 @@ class NXClassAttributeMissing:
     InvalidShape,
     InvalidTransformation,
     TransformDependencyMissing,
+    RelativeDependsonWrong,
     NameFieldMissing,
     NXClassAttributeMissing,
 ]

nexus_constructor/json/load_from_json.py

@@ -23,6 +23,7 @@
     NameFieldMissing,
     NXClassAttributeMissing,
     TransformDependencyMissing,
+    RelativeDependsonWrong,
 )
 from nexus_constructor.json.load_from_json_utils import (
     DEPENDS_ON_IGNORE,
@@ -113,8 +114,19 @@ def _set_components_depends_on(self):
             except KeyError:
                 self.warnings.append(
                     TransformDependencyMissing(
-                        f"Component {component_name} depends on {depends_on_id.transform_name} in component "
-                        f"{depends_on_id.component_name}, but that transform was not successfully loaded from the JSON"
+                        f"Component {component_name} depends on "
+                        + (
+                            depends_on_id.transform_name
+                            if depends_on_id is not None
+                            else "Unknown"
+                        )
+                        + " in component "
+                        + (
+                            depends_on_id.component_name
+                            if depends_on_id is not None
+                            else "Unknown"
+                        )
+                        + ", but that transform was not successfully loaded from the JSON"
                     )
                 )
 
@@ -138,9 +150,19 @@ def _set_transforms_depends_on(self):
             except KeyError:
                 self.warnings.append(
                     TransformDependencyMissing(
-                        f"Transformation {transform_id.transform_name} in component {transform_id.component_name} "
-                        f"depends on {depends_on_id.transform_name} in component {depends_on_id.component_name}, "
-                        f"but that transform was not successfully loaded from the JSON"
+                        f"Transformation {transform_id.transform_name} in component {transform_id.component_name} depends on "
+                        + (
+                            depends_on_id.transform_name
+                            if depends_on_id is not None
+                            else "Unknown"
+                        )
+                        + " in component "
+                        + (
+                            depends_on_id.component_name
+                            if depends_on_id is not None
+                            else "Unknown"
+                        )
+                        + ", but that transform was not successfully loaded from the JSON"
                     )
                 )
 
@@ -387,11 +409,20 @@ def _add_transform_and_shape_to_component(self, component, children_dict):
         )
         transformation_reader.add_transformations_to_component()
         self.warnings += transformation_reader.warnings
-        depends_on_path = _find_depends_on_path(children_dict, component.name)
-        if depends_on_path not in DEPENDS_ON_IGNORE:
-            depends_on_id = TransformId(
-                *get_component_and_transform_name(depends_on_path)
-            )
+        depends_on = _find_depends_on_path(children_dict, component.name)
+        if depends_on not in DEPENDS_ON_IGNORE:
+            if depends_on[0] != "/":
+                #   we are always in the NXtransformations group but the path could be anything
+                if len(depends_on.split("/")) <= 2:
+                    depends_on = "/transformations/" + depends_on.split("/")[-1]
+                else:
+                    self.warnings.append(
+                        RelativeDependsonWrong(
+                            f"depends_on in component {component.name} is relative, but we only support relative paths of length 1 or 2"
+                        )
+                    )
+                depends_on = component.absolute_path + depends_on
+            depends_on_id = TransformId(*get_component_and_transform_name(depends_on))
             self._components_depends_on[component.name] = (component, depends_on_id)
         else:
             self._components_depends_on[component.name] = (component, None)

nexus_constructor/json/load_from_json_utils.py

@@ -9,7 +9,7 @@
     NodeType,
 )
 
-DEPENDS_ON_IGNORE = [None, "."]
+DEPENDS_ON_IGNORE = [None, 'None', ".", ""]
 
 
 def _find_shape_information(children: List[Dict]) -> Union[Dict, None]:

nexus_constructor/json/transformation_reader.py

@@ -306,6 +306,15 @@ def _create_transformations(self, json_transformations: list):
             depends_on = _find_attribute_from_list_or_dict(
                 CommonAttrs.DEPENDS_ON, attributes
             )
+            if depends_on not in DEPENDS_ON_IGNORE:
+                # relative paths warnings were sent to user when JSON was read in
+                if depends_on[0] != "/":
+                    depends_on = (
+                        self.parent_component.absolute_path
+                        + "/transformations/"
+                        + depends_on
+                    )
+
             if module == DATASET:
                 values = self._get_transformation_attribute(
                     CommonKeys.VALUES, config, name
@@ -319,15 +328,14 @@ def _create_transformations(self, json_transformations: list):
                 angle_or_magnitude = 0.0
             else:
                 continue
-            temp_depends_on = None
 
             transform = self.parent_component._create_and_add_transform(
                 name=name,
                 transformation_type=transformation_type,
                 angle_or_magnitude=angle_or_magnitude,
                 units=units,
                 vector=QVector3D(*vector),
-                depends_on=temp_depends_on,
+                depends_on=None,
                 values=values,
             )
             offset = self._find_attribute_in_list(CommonAttrs.OFFSET, name, attributes)

nx-class-documentation/html/index.html

@@ -109,7 +109,7 @@ <h1>User Manual and Reference Documentation<a class="headerlink" href="#user-man
 </div>
 <hr class="docutils" />
 <p class="rubric">Publishing Information</p>
-<p>This manual built Sep 15, 2023.</p>
+<p>This manual built Sep 18, 2023.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
 <p>This document is available in these formats online:</p>