renaming mro to inheritance

Author: Licini

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-* Added `mro` field to `__jsondump__` of `compas.datastructures.Datastructure` to allow for deserialization to closest available superclass of custom datastructures.
+* Added `inheritance` field to `__jsondump__` of `compas.datastructures.Datastructure` to allow for deserialization to closest available superclass of custom datastructures.
 
 ### Changed
 

src/compas/data/data.py

@@ -76,7 +76,7 @@ def __dtype__(self):
         return "{}/{}".format(".".join(self.__class__.__module__.split(".")[:2]), self.__class__.__name__)
 
     @classmethod
-    def __cls_dtype__(cls):
+    def __clstype__(cls):
         return "{}/{}".format(".".join(cls.__module__.split(".")[:2]), cls.__name__)
 
     @property

src/compas/data/encoders.py

@@ -40,16 +40,16 @@
     numpy_support = False
 
 
-def cls_from_dtype(dtype, mro=None):  # type: (...) -> Type[Data]
+def cls_from_dtype(dtype, inheritance=None):  # type: (...) -> Type[Data]
     """Get the class object corresponding to a COMPAS data type specification.
 
     Parameters
     ----------
     dtype : str
         The data type of the COMPAS object in the following format:
         '{}/{}'.format(o.__class__.__module__, o.__class__.__name__).
-    mro : list[str], optional
-        The MRO of the class, all superclasses of the class that can be used if given dtype is not found.
+    inheritance : list[str], optional
+        The inheritance chain of this class, a list of superclasses that can be used if given dtype is not found.
 
     Returns
     -------
@@ -66,12 +66,12 @@ def cls_from_dtype(dtype, mro=None):  # type: (...) -> Type[Data]
 
     """
 
-    if mro is None:
-        full_mro = [dtype]
+    if inheritance is None:
+        full_inheritance = [dtype]
     else:
-        full_mro = [dtype] + mro
+        full_inheritance = [dtype] + inheritance
 
-    for dtype in full_mro:
+    for dtype in full_inheritance:
         mod_name, attr_name = dtype.split("/")
         try:
             module = __import__(mod_name, fromlist=[attr_name])
@@ -81,7 +81,7 @@ def cls_from_dtype(dtype, mro=None):  # type: (...) -> Type[Data]
         except AttributeError:
             continue
 
-    raise ValueError("No class found in MRO: {}".format(mro))
+    raise ValueError("No class found in inheritance chain: {}".format(full_inheritance))
 
 
 class DataEncoder(json.JSONEncoder):
@@ -236,7 +236,7 @@ def object_hook(self, o):
             return o
 
         try:
-            cls = cls_from_dtype(o["dtype"], o.get("mro", None))
+            cls = cls_from_dtype(o["dtype"], o.get("inheritance", None))
 
         except ValueError:
             raise DecoderError(

src/compas/datastructures/datastructure.py

@@ -21,15 +21,25 @@ def __init__(self, attributes=None, name=None):
         self._aabb = None
         self._obb = None
 
-    def __get_mro__(self):
-        mro = []
+    @property
+    def __inheritance__(self):
+        """Get the inheritance chain of the datastructure.
+        Until one level above the Datastructure class (eg. Mesh, Graph, ...).
+
+        Returns
+        -------
+        list[str]
+            The inheritance chain of the datastructure.
+
+        """
+        inheritance = []
         for cls in self.__class__.__mro__:
             if cls == self.__class__:
                 continue
             if cls == Datastructure:
                 break
-            mro.append(cls.__cls_dtype__())
-        return mro
+            inheritance.append(cls.__clstype__())
+        return inheritance
 
     def __jsondump__(self, minimal=False):
         """Return the required information for serialization with the COMPAS JSON serializer.
@@ -47,7 +57,7 @@ def __jsondump__(self, minimal=False):
         state = {
             "dtype": self.__dtype__,
             "data": self.__data__,
-            "mro": self.__get_mro__(),
+            "inheritance": self.__inheritance__,
         }
         if minimal:
             return state

tests/compas/datastructures/test_datastructure.py

@@ -115,16 +115,16 @@ def test_mro_fallback(level2):
         return
 
     assert level2.__jsondump__()["dtype"] == "test_datastructure/Level2"
-    # Level2 should serialize Level1 into the mro
-    assert level2.__jsondump__()["mro"] == ["test_datastructure/Level1"]
+    # Level2 should serialize Level1 into the inheritance
+    assert level2.__jsondump__()["inheritance"] == ["test_datastructure/Level1"]
 
     dumped = json_dumps(level2)
     loaded = json_loads(dumped)
 
     # The loaded object should be deserialized as the closes available class: Level1
     assert loaded.__class__ == Level1
     assert loaded.__jsondump__()["dtype"] == "test_datastructure/Level1"
-    assert loaded.__jsondump__()["mro"] == []
+    assert loaded.__jsondump__()["inheritance"] == []
 
     # level1 attributes should still be available
     assert loaded.level1_attr == "level1"
@@ -139,16 +139,16 @@ def test_mro_fallback_multi_level(level3):
         return
 
     assert level3.__jsondump__()["dtype"] == "test_datastructure/Level3"
-    # Level3 should serialize Level2 and Level1 into the mro
-    assert level3.__jsondump__()["mro"] == ["test_datastructure/Level2", "test_datastructure/Level1"]
+    # Level3 should serialize Level2 and Level1 into the inheritance
+    assert level3.__jsondump__()["inheritance"] == ["test_datastructure/Level2", "test_datastructure/Level1"]
 
     dumped = json_dumps(level3)
     loaded = json_loads(dumped)
 
     # The loaded object should be deserialized as the closes available class: Level1
     assert loaded.__class__ == Level1
     assert loaded.__jsondump__()["dtype"] == "test_datastructure/Level1"
-    assert loaded.__jsondump__()["mro"] == []
+    assert loaded.__jsondump__()["inheritance"] == []
 
     # level1 attributes should still be available
     assert loaded.level1_attr == "level1"
@@ -161,13 +161,13 @@ def test_mro_fallback_multi_level(level3):
 def test_custom_mesh(custom_mesh):
     # This test should pass both Python and IronPython
     assert custom_mesh.__jsondump__()["dtype"].endswith("CustomMesh")
-    assert custom_mesh.__jsondump__()["mro"] == ["compas.datastructures/Mesh"]
+    assert custom_mesh.__jsondump__()["inheritance"] == ["compas.datastructures/Mesh"]
     assert custom_mesh.__jsondump__()["data"]["custom_mesh_attr"] == "custom_mesh"
 
     dumped = json_dumps(custom_mesh)
     loaded = json_loads(dumped)
 
     assert loaded.__class__ == Mesh
     assert loaded.__jsondump__()["dtype"] == "compas.datastructures/Mesh"
-    assert loaded.__jsondump__()["mro"] == []
+    assert loaded.__jsondump__()["inheritance"] == []
     assert not hasattr(loaded, "custom_mesh_attr")