Merge pull request #50 from bci-oss/add-human-readable-representation

Add human-readable object representation

Author: atextor

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/base/base.py

@@ -34,3 +34,7 @@ def parent_elements(self, elements: list["Base"]) -> None:
     @abstractmethod
     def append_parent_element(self, element: "Base") -> None:
         """Add parent element."""
+
+    def __repr__(self):
+        """Object representation."""
+        return f"{self.__class__.__name__}({self.name})"

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/base/data_types/data_type.py

@@ -30,3 +30,6 @@ def is_scalar(self) -> bool:
     def is_complex(self) -> bool:
         """Is complex flag."""
         return not self.is_scalar
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self.urn})"

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/base/data_types/scalar.py

@@ -25,3 +25,6 @@ class Scalar(DataType, ABC):
     def is_scalar(self) -> bool:
         """Is scalar flag."""
         return True
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self.urn})"

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/base_impl.py

@@ -14,12 +14,16 @@
 from typing import Dict, List, Optional
 
 from esmf_aspect_meta_model_python.base.base import Base
+from esmf_aspect_meta_model_python.base.is_described import IsDescribed
 from esmf_aspect_meta_model_python.loader.meta_model_base_attributes import MetaModelBaseAttributes
 
 
 class BaseImpl(Base, metaclass=abc.ABCMeta):
     """Base Implemented class."""
 
+    SCALAR_ATTR_NAMES = ["meta_model_version", "urn", "preferred_names", "descriptions"]
+    LIST_ATTR_NAMES = ["see"]
+
     def __init__(self, meta_model_base_attributes: MetaModelBaseAttributes):
         self._meta_model_version = meta_model_base_attributes.meta_model_version
         self._urn = meta_model_base_attributes.urn
@@ -75,3 +79,67 @@ def urn(self) -> Optional[str]:
     def name(self) -> str:
         """Name."""
         return self._name
+
+    def _get_base_message(self):
+        """Get base string message."""
+        message = self.__class__.__name__
+        message = message.replace("Default", "")
+        message = f"({message}){self.name}"
+
+        return message
+
+    @staticmethod
+    def _prepare_attr_message(name, value):
+        """Prepare a message with scalar attribute value."""
+        message = f"{name}: "
+        if isinstance(value, dict):
+            for k, v in value.items():
+                message += f"\n\t\t{k.upper()}: {v}"
+        else:
+            if isinstance(value, BaseImpl):
+                message += repr(value)
+            else:
+                value_str = str(value)
+                message += value_str.replace("\t", "\t\t")
+
+        return message
+
+    def _get_scalar_attr_info(self):
+        """Get info about all scalar attributes."""
+        message = ""
+        for attr_name in self.SCALAR_ATTR_NAMES:
+            attr_value = getattr(self, attr_name, None)
+            if attr_value:
+                message += f"\n\t{self._prepare_attr_message(attr_name, attr_value)}"
+
+        return message
+
+    @staticmethod
+    def _prepare_list_attr_message(name, value):
+        """Prepare a message for the list data type attribute value."""
+        message = f"{name}:"
+        for elem in value:
+            if isinstance(elem, IsDescribed):
+                message += f"\n\t\t{elem.name}"
+            else:
+                message += f"\n\t\t{elem}"
+
+        return message
+
+    def _get_list_attr_info(self):
+        """Get info about all list data type attributes."""
+        message = ""
+        for attr_name in self.LIST_ATTR_NAMES:
+            attr_value = getattr(self, attr_name, [])
+            if attr_value:
+                message += f"\n\t{self._prepare_list_attr_message(attr_name, attr_value)}"
+
+        return message
+
+    def __str__(self):
+        """String representation."""
+        message = self._get_base_message()
+        message += self._get_scalar_attr_info()
+        message += self._get_list_attr_info()
+
+        return message

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/characteristics/collection/default_collection.py

@@ -21,6 +21,8 @@
 class DefaultCollection(DefaultCharacteristic, Collection):
     """Default Collection class."""
 
+    SCALAR_ATTR_NAMES = DefaultCharacteristic.SCALAR_ATTR_NAMES + ["element_characteristic"]
+
     def __init__(
         self,
         meta_model_base_attributes: MetaModelBaseAttributes,

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/characteristics/default_characteristic.py

@@ -19,6 +19,8 @@
 class DefaultCharacteristic(BaseImpl, Characteristic):
     """Default Characteristic class."""
 
+    SCALAR_ATTR_NAMES = BaseImpl.SCALAR_ATTR_NAMES + ["data_type"]
+
     def __init__(self, meta_model_base_attributes: MetaModelBaseAttributes, data_type: DataType):
         super().__init__(meta_model_base_attributes)
         self._data_type = data_type

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/characteristics/default_enumeration.py

@@ -20,6 +20,8 @@
 class DefaultEnumeration(DefaultCharacteristic, Enumeration):
     """Default Enumeration class."""
 
+    LIST_ATTR_NAMES = DefaultCharacteristic.LIST_ATTR_NAMES + ["values"]
+
     def __init__(
         self,
         meta_model_base_attributes: MetaModelBaseAttributes,

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/characteristics/default_state.py

@@ -20,6 +20,8 @@
 class DefaultState(DefaultEnumeration, State):
     """Default State class."""
 
+    SCALAR_ATTR_NAMES = DefaultEnumeration.SCALAR_ATTR_NAMES + ["default_value"]
+
     def __init__(
         self,
         meta_model_base_attributes: MetaModelBaseAttributes,

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/characteristics/default_structured_value.py

@@ -20,6 +20,9 @@
 class DefaultStructuredValue(DefaultCharacteristic, StructuredValue):
     """Default Structured Value class"""
 
+    SCALAR_ATTR_NAMES = DefaultCharacteristic.SCALAR_ATTR_NAMES + ["deconstruction_rule"]
+    LIST_ATTR_NAMES = DefaultCharacteristic.LIST_ATTR_NAMES + ["elements"]
+
     def __init__(
         self,
         meta_model_base_attributes: MetaModelBaseAttributes,

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/impl/characteristics/default_trait.py

@@ -21,6 +21,9 @@
 class DefaultTrait(DefaultCharacteristic, Trait):
     """Default Trait class."""
 
+    SCALAR_ATTR_NAMES = DefaultCharacteristic.SCALAR_ATTR_NAMES + ["base_characteristic"]
+    LIST_ATTR_NAMES = DefaultCharacteristic.LIST_ATTR_NAMES + ["constraints"]
+
     def __init__(
         self,
         meta_model_base_attributes: MetaModelBaseAttributes,