Merge branch 'main' into scene

Author: Licini

AUTHORS.md

@@ -41,3 +41,4 @@
 - Adam Anouar <<aanouar@student.ethz.ch>> [@AdamAnouar](https://github.com/AdamAnouar)
 - Joseph Kenny <<kenny@arch.ethz.ch>> [@jckenny59](https://github.com/jckenny59)
 - Panayiotis Papacharalambous <<papacharalambous@arch.ethz.ch>> [@papachap](https://github.com/papachap)
+- Oliver Bucklin <<obucklin@arch.ethz.ch>> [@obucklin](https://github.com/obucklin)

CHANGELOG.md

@@ -9,15 +9,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `inheritance` field to `__jsondump__` of `compas.datastructures.Datastructure` to allow for deserialization to closest available superclass of custom datastructures.
+
+### Changed
+
+### Removed
+
+
+## [2.11.0] 2025-04-22
+
+### Added
+
 * Added `Group` to `compas.scene`.
 * Added `compas.geometry.Brep.cap_planar_holes`.
 * Added `compas_rhino.geometry.RhinoBrep.cap_planar_holes`.
+* Added `compas.geometry.angle_vectors_projected`.
+* Added `compas.geometry.Brep.from_curves`.
+* Added `compas_rhino.geometry.RhinoBrep.from_curves`.
 
 ### Changed
 
 * Changed `SceneObject.frame` to read-only result of `Frame.from_transformation(SceneObject.worldtransformation)`, representing the local coordinate system of the scene object in world coordinates.
 * Changed `SceneObject.worldtransformation` to the multiplication of all transformations from the scene object to the root of the scene tree, there will no longer be an additional transformation in relation to the object's frame.
 * Fixed call to `astar_shortest_path` in `Graph.shortest_path`.
+* Fixed a bug when printing an empty `Tree`.
+* Fixed a bug in `Group` for IronPython where the decoding declaration was missing.
+* Fixed a bug where a `Group` without name could not be added to the scene.
 
 ### Removed
 

docs/userguide/advanced.serialisation.rst

@@ -149,6 +149,50 @@ which will help with IntelliSense and code completion.
     boxes: List[Box] = session['boxes']
 
 
+Inheritance
+===========
+
+When working with custom classes that inherit from COMPAS datastructures, COMPAS will encode the inheritance chain in the serialized data. This allows the object to be reconstructed using the closest available superclass if the custom class is not available in the environment where the data is loaded.
+For example, a user can create a custom mesh class and serialize it to JSON:
+
+.. code-block:: python
+
+    from compas.datastructures import Mesh
+    from compas import json_dump
+
+    class CustomMesh(Mesh):
+        def __init__(self, *args, **kwargs):
+            super(CustomMesh, self).__init__(*args, **kwargs)
+            self.custom_mesh_attr = "custom_mesh"
+
+        @property
+        def __data__(self):
+            data = super(CustomMesh, self).__data__
+            data["custom_mesh_attr"] = self.custom_mesh_attr
+            return data
+
+        @classmethod
+        def __from_data__(cls, data):
+            obj = super(CustomMesh, cls).__from_data__(data)
+            obj.custom_mesh_attr = data.get("custom_mesh_attr", "")
+            return obj
+
+    # Create and serialize a custom mesh
+    custom_mesh = CustomMesh(name="test")
+    json_dump(custom_mesh, 'custom_mesh.json')
+
+If another user loads "custom_mesh.json" in an environment where the CustomMesh class is not available, COMPAS will reconstruct the object as an instance of its closest available superclass, which in this case is the regular Mesh class:
+
+.. code-block:: python
+
+    from compas.datastructures import Mesh
+    from compas import json_load
+
+    mesh = json_load('custom_mesh.json')
+    assert isinstance(mesh, Mesh) # This will be True
+
+
+
 Validation
 ==========
 

pyproject.toml

@@ -84,7 +84,7 @@ doctest_optionflags = [
 # ============================================================================
 
 [tool.bumpversion]
-current_version = "2.10.0"
+current_version = "2.11.0"
 message = "Bump version to {new_version}"
 commit = true
 tag = true

src/compas/__init__.py

@@ -20,7 +20,7 @@
 __copyright__ = "Copyright 2014-2022 - ETH Zurich, Copyright 2023 - COMPAS Association"
 __license__ = "MIT License"
 __email__ = "tom.v.mele@gmail.com"
-__version__ = "2.10.0"
+__version__ = "2.11.0"
 
 
 HERE = compas._os.realpath(os.path.dirname(__file__))

src/compas/data/data.py

@@ -75,6 +75,10 @@ def __init__(self, name=None):
     def __dtype__(self):
         return "{}/{}".format(".".join(self.__class__.__module__.split(".")[:2]), self.__class__.__name__)
 
+    @classmethod
+    def __clstype__(cls):
+        return "{}/{}".format(".".join(cls.__module__.split(".")[:2]), cls.__name__)
+
     @property
     def __data__(self):
         raise NotImplementedError

src/compas/data/encoders.py

@@ -40,14 +40,16 @@
     numpy_support = False
 
 
-def cls_from_dtype(dtype):  # 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__).
+    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
     -------
@@ -63,9 +65,23 @@ def cls_from_dtype(dtype):  # type: (...) -> Type[Data]
         If the module doesn't contain the specified data type.
 
     """
-    mod_name, attr_name = dtype.split("/")
-    module = __import__(mod_name, fromlist=[attr_name])
-    return getattr(module, attr_name)
+
+    if inheritance is None:
+        full_inheritance = [dtype]
+    else:
+        full_inheritance = [dtype] + inheritance
+
+    for dtype in full_inheritance:
+        mod_name, attr_name = dtype.split("/")
+        try:
+            module = __import__(mod_name, fromlist=[attr_name])
+            return getattr(module, attr_name)
+        except ImportError:
+            continue
+        except AttributeError:
+            continue
+
+    raise ValueError("No class found in inheritance chain: {}".format(full_inheritance))
 
 
 class DataEncoder(json.JSONEncoder):
@@ -220,7 +236,7 @@ def object_hook(self, o):
             return o
 
         try:
-            cls = cls_from_dtype(o["dtype"])
+            cls = cls_from_dtype(o["dtype"], o.get("inheritance", None))
 
         except ValueError:
             raise DecoderError(

src/compas/datastructures/datastructure.py

@@ -21,6 +21,51 @@ def __init__(self, attributes=None, name=None):
         self._aabb = None
         self._obb = None
 
+    @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
+            inheritance.append(cls.__clstype__())
+        return inheritance
+
+    def __jsondump__(self, minimal=False):
+        """Return the required information for serialization with the COMPAS JSON serializer.
+
+        Parameters
+        ----------
+        minimal : bool, optional
+            If True, exclude the GUID from the dump dict.
+
+        Returns
+        -------
+        dict
+
+        """
+        state = {
+            "dtype": self.__dtype__,
+            "data": self.__data__,
+            "inheritance": self.__inheritance__,
+        }
+        if minimal:
+            return state
+        if self._name is not None:
+            state["name"] = self._name
+        state["guid"] = str(self.guid)
+        return state
+
     @property
     def aabb(self):
         if self._aabb is None:

src/compas/datastructures/tree/tree.py

@@ -474,7 +474,8 @@ def traverse(node, hierarchy, prefix="", last=True, depth=0, node_repr=None):
             for i, child in enumerate(node.children):
                 traverse(child, hierarchy, prefix, i == len(node.children) - 1, depth + 1, node_repr)
 
-        traverse(self.root, hierarchy, node_repr=node_repr)
+        if self.root:
+            traverse(self.root, hierarchy, node_repr=node_repr)
 
         return "\n".join(hierarchy)
 

src/compas/geometry/__init__.py

@@ -99,6 +99,7 @@
     angle_points_xy,
     angle_vectors,
     angle_vectors_signed,
+    angle_vectors_projected,
     angle_vectors_xy,
     angles_points,
     angles_points_xy,
@@ -488,6 +489,7 @@
     "angle_points_xy",
     "angle_vectors",
     "angle_vectors_signed",
+    "angle_vectors_projected",
     "angle_vectors_xy",
     "angles_points",
     "angles_points_xy",