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

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, ".", ""]
 
 
 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)

tests/json/test_load_from_json.py

@@ -12,6 +12,7 @@
     TransformDependencyMissing,
 )
 from nexus_constructor.json.load_from_json import JSONReader
+from nexus_constructor.json.load_from_json_utils import DEPENDS_ON_IGNORE
 from nexus_constructor.model.component import Component
 from nexus_constructor.model.module import Dataset
 from nexus_constructor.model.value_type import ValueTypes
@@ -120,132 +121,43 @@ def json_dict_with_component():
                   ],
                   "children":[
                     {
-                      "type":"group",
                       "name":"transformations",
-                      "children":[
-
-                      ]
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              "name":"sample",
-              "type":"group",
-              "attributes":[
-                {
-                  "name":"NX_class",
-                  "type":"string",
-                  "values":"NXsample"
-                }
-              ],
-              "children":[
-                {
-                  "type":"group",
-                  "name":"transformations",
-                  "children":[
-
-                  ]
-                }
-              ]
-            }
-          ]
-        }
-      ]
-    }
-    """
-    return json.loads(json_string)
-
-
-@pytest.fixture(scope="function")
-def json_dict_with_component_and_transform():
-    json_string = """
-    {
-      "children":[
-        {
-          "name":"entry",
-          "type":"group",
-          "attributes":[
-            {
-              "name":"NX_class",
-              "type":"String",
-              "values":"NXentry"
-            }
-          ],
-          "children":[
-            {
-              "name":"instrument",
-              "type":"group",
-              "attributes":[
-                {
-                  "name":"NX_class",
-                  "type":"String",
-                  "values":"NXinstrument"
-                }
-              ],
-              "children":[
-                {
-                  "name":"test_component",
-                  "type":"group",
-                  "attributes":[
-                    {
-                      "name":"NX_class",
-                      "type":"String",
-                      "values":"NXaperture"
-                    }
-                  ],
-                  "children":[
-                    {
-                      "module":"dataset",
-                      "attributes":[],
-                      "config":{
-                        "name":"depends_on",
-                        "type":"string",
-                        "values": "/entry/instrument/test_component/transformations/location"
-                      }
-                    },
-                    {
                       "type":"group",
-                      "name":"transformations",
                       "children":[
                         {
-                          "module":"dataset",
-                          "config":{
-                            "type":"double",
-                            "values":1.0,
-                            "name":"location"
+                          "module": "dataset",
+                          "config": {
+                              "name": "slit0",
+                              "values": 10.0,
+                              "type": "float"
                           },
-                          "attributes":[
+                          "attributes": [
                             {
-                              "name":"units",
-                              "values":"m"
+                                "name": "vector",
+                                "dtype": "float",
+                                "values": [
+                                    0.0,
+                                    0.0,
+                                    1.0
+                                ]
                             },
                             {
-                              "name":"transformation_type",
-                              "values":"translation"
+                                "name": "depends_on",
+                                "dtype": "string",
+                                "values": "."
                             },
                             {
-                              "name":"vector",
-                              "values":[
-                                0.0,
-                                0.0,
-                                0.0
-                              ],
-                              "type":"double"
+                                "name": "transformation_type",
+                                "dtype": "string",
+                                "values": "translation"
                             },
                             {
-                              "name":"depends_on",
-                              "values":"."
+                                "name": "units",
+                                "dtype": "string",
+                                "values": "metre"
                             }
                           ]
                         }
-                      ],
-                      "attributes":[
-                        {
-                          "name":"NX_class",
-                          "values":"NXtransformations"
-                        }
                       ]
                     }
                   ]
@@ -258,9 +170,16 @@ def json_dict_with_component_and_transform():
               "attributes":[
                 {
                   "name":"NX_class",
-                  "type":"String",
+                  "type":"string",
                   "values":"NXsample"
                 }
+              ],
+              "children":[
+                {
+                  "type":"group",
+                  "name":"transformations",
+                  "children":[]
+                }
               ]
             }
           ]
@@ -422,6 +341,57 @@ def test_GIVEN_json_with_component_depending_on_non_existent_transform_WHEN_load
     assert contains_warning_of_type(json_reader.warnings, TransformDependencyMissing)
 
 
+@pytest.mark.parametrize(
+    "depends_on_path",
+    [
+        "/entry/instrument/componentname/transformations/slit0",
+        "transformations/slit0",
+        "slit0",
+        ".",
+        "",
+        None
+    ],
+)
+def test_GIVEN_json_with_component_depending_on_relative_transform_WHEN_loaded_THEN_model_updated(
+    json_dict_with_component, json_reader, depends_on_path
+):
+    # Add depends_on dataset which points to a transformation in the JSON
+    depends_on_dataset_str = f"""
+    {{
+      "module":"dataset",
+      "attributes":[],
+      "config":{{
+        "type":"string",
+        "values": "{depends_on_path}",
+        "name":"depends_on"
+      }}
+    }}
+    """
+    depends_on_dataset = json.loads(depends_on_dataset_str)
+    if depends_on_path is not None:
+        transform_name = depends_on_path.split("/")[-1]
+    else:
+        transform_name = 'None'
+
+    json_dict_with_component["children"][0]["children"][0]["children"][0][
+        "children"
+    ].append(depends_on_dataset)
+    json_reader._load_from_json_dict(json_dict_with_component)
+    if depends_on_path in DEPENDS_ON_IGNORE:
+        try:
+            json_reader._components_depends_on["componentname"][1].component_name
+        except AttributeError:
+            assert True
+    else:
+        assert (
+            json_reader._components_depends_on["componentname"][1].component_name
+            == "componentname"
+        )
+        assert (
+            json_reader._components_depends_on["componentname"][1].transform_name == transform_name
+        )
+
+
 def test_when_experiment_id_in_json_then_it_is_added_to_entry(json_reader):
     json_string = """
    {

tests/json/test_transformation_reader.py

@@ -128,6 +128,7 @@ def attributes_list(transformation_json):
 def transformation_reader(transformation_json):
     parent_component = Mock(spec=Component)
     parent_component.name = PARENT_COMPONENT_NAME
+    parent_component.absolute_path = "/entry/" + parent_component.name
     entry = [transformation_json]
     transforms_with_dependencies: Dict[
         TransformId, Tuple[Transformation, TransformId]