Merge branch 'main' into 2.1.x

Author: atextor

.gitignore

@@ -69,3 +69,4 @@ dmypy.json
 
 # SAMM
 core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/samm/
+/core/esmf-aspect-meta-model-python/samm-cli/

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/base/README.md

@@ -12,7 +12,7 @@ HasUrn
         ├── StructureElement <──┘                  │
         │   ├── Aspect                             │
         │   └── ComplexType <──────────────────────┘
-        │       ├── AbstractEntity                 
+        │       ├── AbstractEntity
         │       └── Entity
         ├── Characteristic
         │   ├── Code
@@ -41,7 +41,7 @@ HasUrn
         ├── Event
         ├── Operation
         ├── Property
-        ├── QuantityKind           
+        ├── QuantityKind
         └── Unit
 
 BoundDefiniton

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/aspect_loader.py

@@ -11,7 +11,7 @@
 
 from os.path import exists, join
 from pathlib import Path
-from typing import Optional, Union
+from typing import Dict, Optional, Union
 
 import rdflib  # type: ignore
 
@@ -44,7 +44,7 @@ def load_aspect_model(self, file_path: Union[str, Path]) -> Aspect:
         :param file_path: path to the turtle file. Can be either a string or a Path object
         :return: instance of the aspect
         """
-        return self.load_aspect_model_from_multiple_files([file_path])
+        return self._load_aspect_model_from_multiple_files([file_path])
 
     @staticmethod
     def _get_additional_files_from_dir(file_path: str) -> list[str]:
@@ -100,34 +100,6 @@ def _get_dirs_for_advanced_loading(self, aspect_graph: rdflib.Graph, file_path:
 
         return paths_for_advanced_loading
 
-    def _get_list_of_additional_files(self, aspect_graph: rdflib.Graph, file_path: str) -> list[str]:
-        """Get a list of additional files for parsing in graph.
-
-        :param aspect_graph: rdflib.Graph
-        :param base_path: base path of the main graph file
-        :return: list of full path to the additional files
-        """
-        additional_files = []
-
-        for file_path in self._get_dirs_for_advanced_loading(aspect_graph, file_path):
-            additional_files += self._get_additional_files_from_dir(file_path)
-
-        return list(set(additional_files))
-
-    def _extend_graph_with_prefix_files(self, aspect_graph: rdflib.Graph, file_path: str) -> None:
-        """Extend graph with models from prefix namespaces.
-
-        :param aspect_graph: rdflib.Graph
-        :param file_path: str path of the base graph file
-        """
-        additional_files = self._get_list_of_additional_files(aspect_graph, file_path)
-
-        if file_path in additional_files:
-            additional_files.remove(file_path)
-
-        for file_path in additional_files:
-            aspect_graph.parse(file_path, format="turtle")
-
     @staticmethod
     def _prepare_file_paths(file_paths: list[Union[str, Path]]):
         """Check and prepare file paths."""
@@ -141,22 +113,55 @@ def _prepare_file_paths(file_paths: list[Union[str, Path]]):
 
         return prepared_file_paths
 
+    def get_dependency_folders(self, file_path):
+        """Get dependency folders from file description."""
+        graph = rdflib.Graph()
+        graph.parse(file_path, format="turtle")
+
+        dependency_folders = self._get_dirs_for_advanced_loading(graph, file_path)
+
+        return dependency_folders
+
+    def _get_dependency_files(self, file_dependencies, folder_dependencies, file_path):
+        """Get dependency files with folder dependencies."""
+        file_dependencies[file_path] = self.get_dependency_folders(file_path)
+        for folder in file_dependencies[file_path]:
+            if folder not in folder_dependencies:
+                folder_dependencies[folder] = self._get_additional_files_from_dir(folder)
+
+        files = set()
+        for tmp in folder_dependencies.values():
+            files.update(tmp)
+
+        for file_path in files:
+            if file_path not in file_dependencies:
+                self._get_dependency_files(file_dependencies, folder_dependencies, file_path)
+
+        return file_dependencies
+
+    def _get_all_dependencies(self, file_paths: list[Union[str, Path]]):
+        """Get all dependency files."""
+        file_dependencies: Dict[str, list[str]] = {}
+        folder_dependencies: Dict[str, list[str]] = {}
+        for file_path in file_paths:
+            file_dependencies.update(self._get_dependency_files(file_dependencies, folder_dependencies, file_path))
+
+        return file_dependencies
+
     def _get_graph(self, file_paths: list[Union[str, Path]]) -> rdflib.Graph:
         """Get RDF graph object.
 
         :param file_paths: list of absolute paths to the turtle files.
         :return: parsed rdflib Graph.
         """
-
         aspect_graph = rdflib.Graph()
-
-        for file_path in self._prepare_file_paths(file_paths):
+        file_paths = self._prepare_file_paths(file_paths)
+        for file_path in self._get_all_dependencies(file_paths):
             aspect_graph.parse(file_path, format="turtle")
-            self._extend_graph_with_prefix_files(aspect_graph, file_path)
 
         return aspect_graph
 
-    def load_aspect_model_from_multiple_files(
+    def _load_aspect_model_from_multiple_files(
         self,
         file_paths: list[Union[str, Path]],
         aspect_urn: rdflib.URIRef | str = "",
@@ -184,8 +189,9 @@ def load_aspect_model_from_multiple_files(
 
         AspectMetaModelResolver.resolve_meta_model(aspect_graph, meta_model_version)
         model_element_factory = ModelElementFactory(meta_model_version, aspect_graph, self._cache)
+        aspect_element = model_element_factory.create_element(aspect_urn)  # type: ignore
 
-        return model_element_factory.create_element(aspect_urn)  # type: ignore
+        return aspect_element
 
     @staticmethod
     def __extract_samm_version(aspect_graph: rdflib.Graph) -> str:
@@ -265,7 +271,6 @@ def __determine_access_path(self, base_element: Base, path: list[list[str]]) ->
 
         for index, parent in enumerate(base_element.parent_elements):
             if isinstance(parent, Property):
-                path_segment = ""
                 if hasattr(parent, "payload_name") and parent.payload_name is not None:  # type: ignore
                     path_segment = parent.payload_name  # type: ignore
                 else:

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/characteristic_instantiator.py

@@ -13,15 +13,16 @@
 
 from esmf_aspect_meta_model_python.base.characteristics.characteristic import Characteristic
 from esmf_aspect_meta_model_python.impl.characteristics.default_characteristic import DefaultCharacteristic
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
 from esmf_aspect_meta_model_python.loader.instantiator_base import InstantiatorBase
 
 
 class CharacteristicInstantiator(InstantiatorBase[Characteristic]):
     def _create_instance(self, element_node: Node) -> Characteristic:
-        meta_model_base_attributes = self._get_base_attributes(element_node)
         data_type = self._get_data_type(element_node)
+        if not data_type:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
 
-        if data_type is None:
-            raise TypeError("Data type can't be None.")
+        meta_model_base_attributes = self._get_base_attributes(element_node)
 
         return DefaultCharacteristic(meta_model_base_attributes, data_type)

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/code_instantiator.py

@@ -13,15 +13,16 @@
 
 from esmf_aspect_meta_model_python.base.characteristics.code import Code
 from esmf_aspect_meta_model_python.impl.characteristics.default_code import DefaultCode
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
 from esmf_aspect_meta_model_python.loader.instantiator_base import InstantiatorBase
 
 
 class CodeInstantiator(InstantiatorBase[Code]):
     def _create_instance(self, element_node: Node) -> Code:
-        meta_model_base_attributes = self._get_base_attributes(element_node)
         data_type = self._get_data_type(element_node)
+        if not data_type:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
 
-        if data_type is None:
-            raise TypeError("Data type can't be None.")
+        meta_model_base_attributes = self._get_base_attributes(element_node)
 
         return DefaultCode(meta_model_base_attributes, data_type)

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/collection_instantiator.py

@@ -13,17 +13,18 @@
 
 from esmf_aspect_meta_model_python.base.characteristics.collection.collection import Collection
 from esmf_aspect_meta_model_python.impl.characteristics.collection.default_collection import DefaultCollection
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
 from esmf_aspect_meta_model_python.loader.instantiator_base import InstantiatorBase
 from esmf_aspect_meta_model_python.vocabulary.SAMMC import SAMMC
 
 
 class CollectionInstantiator(InstantiatorBase[Collection]):
     def _create_instance(self, element_node: Node) -> Collection:
-        meta_model_base_attributes = self._get_base_attributes(element_node)
-        element_characteristic = self._get_child(element_node, self._sammc.get_urn(SAMMC.element_characteristic))
         data_type = self._get_data_type(element_node)
+        if not data_type:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
 
-        if data_type is None:
-            raise TypeError("Data type can't be None.")
+        meta_model_base_attributes = self._get_base_attributes(element_node)
+        element_characteristic = self._get_child(element_node, self._sammc.get_urn(SAMMC.element_characteristic))
 
         return DefaultCollection(meta_model_base_attributes, data_type, element_characteristic)

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/constants.py

@@ -0,0 +1,13 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+
+DATA_TYPE_ERROR_MSG = "Could not find a data type. Please validate the model to get more detailed information."

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/duration_instantiator.py

@@ -13,17 +13,18 @@
 
 from esmf_aspect_meta_model_python.base.characteristics.quantifiable.duration import Duration
 from esmf_aspect_meta_model_python.impl.characteristics.quantifiable.default_duration import DefaultDuration
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
 from esmf_aspect_meta_model_python.loader.instantiator_base import InstantiatorBase
 from esmf_aspect_meta_model_python.vocabulary.SAMMC import SAMMC
 
 
 class DurationInstantiator(InstantiatorBase[Duration]):
     def _create_instance(self, element_node: Node) -> Duration:
-        meta_model_base_attributes = self._get_base_attributes(element_node)
         data_type = self._get_data_type(element_node)
-        unit = self._get_child(element_node, self._sammc.get_urn(SAMMC.unit))
+        if not data_type:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
 
-        if data_type is None:
-            raise TypeError("Data type can't be None.")
+        meta_model_base_attributes = self._get_base_attributes(element_node)
+        unit = self._get_child(element_node, self._sammc.get_urn(SAMMC.unit))
 
         return DefaultDuration(meta_model_base_attributes, data_type, unit)

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/enumeration_instantiator.py

@@ -17,6 +17,7 @@
 
 from esmf_aspect_meta_model_python.base.characteristics.enumeration import Enumeration
 from esmf_aspect_meta_model_python.impl.characteristics.default_enumeration import DefaultEnumeration
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
 from esmf_aspect_meta_model_python.loader.instantiator_base import InstantiatorBase
 from esmf_aspect_meta_model_python.loader.rdf_helper import RdfHelper
 from esmf_aspect_meta_model_python.vocabulary.SAMM import SAMM
@@ -25,20 +26,18 @@
 
 class EnumerationInstantiator(InstantiatorBase[Enumeration]):
     def _create_instance(self, element_node: Node) -> Enumeration:
-        meta_model_base_attributes = self._get_base_attributes(element_node)
-
         data_type = self._get_data_type(element_node)
+        if data_type is None:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
 
+        meta_model_base_attributes = self._get_base_attributes(element_node)
         value_collection_node = self._aspect_graph.value(
             subject=element_node,
             predicate=self._sammc.get_urn(SAMMC.values),
         )
         value_nodes = RdfHelper.get_rdf_list_values(value_collection_node, self._aspect_graph)
         values = [self.__to_enum_node_value(value_node) for value_node in value_nodes]
 
-        if data_type is None:
-            raise TypeError("Data type can't be None.")
-
         return DefaultEnumeration(meta_model_base_attributes, data_type, values)
 
     def __to_enum_node_value(self, value_node: Node) -> typing.Dict:

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/list_instantiator.py

@@ -13,17 +13,18 @@
 
 from esmf_aspect_meta_model_python.base.characteristics.collection.list import List
 from esmf_aspect_meta_model_python.impl.characteristics.collection.default_list import DefaultList
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
 from esmf_aspect_meta_model_python.loader.instantiator_base import InstantiatorBase
 from esmf_aspect_meta_model_python.vocabulary.SAMMC import SAMMC
 
 
 class ListInstantiator(InstantiatorBase[List]):
     def _create_instance(self, element_node: Node) -> List:
-        meta_model_base_attributes = self._get_base_attributes(element_node)
-        element_characteristic = self._get_child(element_node, self._sammc.get_urn(SAMMC.element_characteristic))
         data_type = self._get_data_type(element_node)
+        if not data_type:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
 
-        if data_type is None:
-            raise TypeError("Data type can't be None.")
+        meta_model_base_attributes = self._get_base_attributes(element_node)
+        element_characteristic = self._get_child(element_node, self._sammc.get_urn(SAMMC.element_characteristic))
 
         return DefaultList(meta_model_base_attributes, data_type, element_characteristic)