Merge pull request #1264 from compas-dev/private-data-api

Make serialisation infrastructure private

Author: tomvanmele

CHANGELOG.md

@@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Merged `compas.datastructures.Network` into `compas.datastructures.Graph`.
 * Merged `compas.datastructures.Halfface` into `compas.datastructures.VolMesh`.
 * Fixed `RhinoBrep` doesn't get capped after trimming.
+* Changed `compas.data.Data.data` to `compas.data.Data.__data__`.
+* Changed `compas.data.Data.dtype` to `compas.data.Data.__dtype__`.
+* Changed `compas.data.Data.from_data` to `compas.data.Data.__from_data__`.
 
 ### Removed
 
@@ -32,6 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Removed `attributes` from `compas.datastructures.Mesh.data`.
 * Removed `attributes` from `compas.datastructures.Tree.data`.
 * Removed `attributes` from `compas.datastructures.VolMesh.data`.
+* Removed `compas.data.Data.to_data`.
 * Removed `compas.rpc.XFunc`.
 
 ## [2.0.0-beta.2] 2024-01-12

src/compas/colors/color.py

@@ -40,6 +40,8 @@ class Color(Data):
         Transparency setting.
         If ``alpha = 0.0``, the color is fully transparent.
         If ``alpha = 1.0``, the color is fully opaque.
+    name : str, optional
+        The name of the color.
 
     Attributes
     ----------
@@ -152,8 +154,12 @@ class Color(Data):
         "required": ["red", "green", "blue", "alpha"],
     }
 
-    def __init__(self, red, green, blue, alpha=1.0, **kwargs):
-        super(Color, self).__init__(**kwargs)
+    @property
+    def __data__(self):
+        return {"red": self.r, "green": self.g, "blue": self.b, "alpha": self.a}
+
+    def __init__(self, red, green, blue, alpha=1.0, name=None):
+        super(Color, self).__init__(name=name)
         self._r = 1.0
         self._g = 1.0
         self._b = 1.0
@@ -184,14 +190,6 @@ def __iter__(self):
     def __eq__(self, other):
         return all(a == b for a, b in zip(self, other))
 
-    # --------------------------------------------------------------------------
-    # Data
-    # --------------------------------------------------------------------------
-
-    @property
-    def data(self):
-        return {"red": self.r, "green": self.g, "blue": self.b, "alpha": self.a}
-
     # --------------------------------------------------------------------------
     # Properties
     # --------------------------------------------------------------------------

src/compas/colors/colordict.py

@@ -13,6 +13,8 @@ class ColorDict(Data):
     ----------
     default : :class:`compas.colors.Color`
         The default color to use if the requested key is not in the dictionary.
+    name : str, optional
+        The name of the color dictionary.
 
     Attributes
     ----------
@@ -21,8 +23,12 @@ class ColorDict(Data):
 
     """
 
-    def __init__(self, default, **kwargs):
-        super(ColorDict, self).__init__(**kwargs)
+    @property
+    def __data__(self):
+        return {"default": self.default.__data__, "dict": self._dict}
+
+    def __init__(self, default, name=None):
+        super(ColorDict, self).__init__(name=name)
         self._default = None
         self.default = default
         self._dict = {}
@@ -57,10 +63,6 @@ def __len__(self):
     def __contains__(self, key):
         return key in self._dict
 
-    @property
-    def data(self):
-        return {"default": self.default.data, "dict": self._dict}
-
     def items(self):
         return self._dict.items()
 

src/compas/data/data.py

@@ -72,6 +72,14 @@ def __init__(self, name=None):
         if name:
             self.name = name
 
+    @property
+    def __dtype__(self):
+        return "{}/{}".format(".".join(self.__class__.__module__.split(".")[:2]), self.__class__.__name__)
+
+    @property
+    def __data__(self):
+        raise NotImplementedError
+
     def __jsondump__(self, minimal=False):
         """Return the required information for serialization with the COMPAS JSON serializer.
 
@@ -86,8 +94,8 @@ def __jsondump__(self, minimal=False):
 
         """
         state = {
-            "dtype": self.dtype,
-            "data": self.data,
+            "dtype": self.__dtype__,
+            "data": self.__data__,
         }
         if minimal:
             return state
@@ -114,7 +122,7 @@ def __jsonload__(cls, data, guid=None, name=None):
         object
 
         """
-        obj = cls.from_data(data)
+        obj = cls.__from_data__(data)
         if guid is not None:
             obj._guid = UUID(guid)
         if name is not None:
@@ -133,13 +141,22 @@ def __setstate__(self, state):
         if "name" in state:
             self.name = state["name"]
 
-    @property
-    def dtype(self):
-        return "{}/{}".format(".".join(self.__class__.__module__.split(".")[:2]), self.__class__.__name__)
+    @classmethod
+    def __from_data__(cls, data):  # type: (dict) -> Data
+        """Construct an object of this type from the provided data.
 
-    @property
-    def data(self):
-        raise NotImplementedError
+        Parameters
+        ----------
+        data : dict
+            The data dictionary.
+
+        Returns
+        -------
+        :class:`compas.data.Data`
+            An instance of this object type if the data contained in the dict has the correct schema.
+
+        """
+        return cls(**data)
 
     def ToString(self):
         """Converts the instance to a string.
@@ -169,34 +186,6 @@ def name(self):
     def name(self, name):
         self._name = name
 
-    @classmethod
-    def from_data(cls, data):  # type: (dict) -> Data
-        """Construct an object of this type from the provided data.
-
-        Parameters
-        ----------
-        data : dict
-            The data dictionary.
-
-        Returns
-        -------
-        :class:`compas.data.Data`
-            An instance of this object type if the data contained in the dict has the correct schema.
-
-        """
-        return cls(**data)
-
-    def to_data(self):
-        """Convert an object to its native data representation.
-
-        Returns
-        -------
-        dict
-            The data representation of the object as described by the schema.
-
-        """
-        return self.data
-
     @classmethod
     def from_json(cls, filepath):  # type: (...) -> Data
         """Construct an object of this type from a JSON file.
@@ -295,7 +284,7 @@ def copy(self, cls=None):  # type: (...) -> D
         """
         if not cls:
             cls = type(self)
-        obj = cls.from_data(deepcopy(self.data))
+        obj = cls.__from_data__(deepcopy(self.__data__))
         obj.name = self.name
         return obj  # type: ignore
 
@@ -335,7 +324,7 @@ def sha256(self, as_string=False):
     def validate_data(cls, data):
         """Validate the data against the object's data schema.
 
-        The data is the raw data that can be used to construct an object of this type with the classmethod ``from_data``.
+        The data is the raw data that can be used to construct an object of this type with the classmethod ``__from_data__``.
 
         Parameters
         ----------

src/compas/data/encoders.py

@@ -72,7 +72,7 @@ class DataEncoder(json.JSONEncoder):
     * iterables to lists; and
     * :class:`compas.data.Data` objects,
       such as geometric primitives and shapes, data structures, robots, ...,
-      to a dict with the following structure: ``{'dtype': o.dtype, 'value': o.data}``
+      to a dict with the following structure: ``{'dtype': o.__dtype__, 'data': o.__data__}``
 
     See Also
     --------
@@ -167,9 +167,9 @@ class DataDecoder(json.JSONDecoder):
 
     The reconstruction is possible if
 
-    * the serialized data has the following structure: ``{"dtype": "...", 'value': {...}}``;
+    * the serialized data has the following structure: ``{"dtype": "...", 'data': {...}}``;
     * a class can be imported into the current scope from the info in ``o["dtype"]``; and
-    * the imported class has a method ``from_data``.
+    * the imported class has a method ``__from_data__``.
 
     See Also
     --------
@@ -233,7 +233,7 @@ def object_hook(self, o):
         guid = o.get("guid")
         name = o.get("name")
 
-        # Kick-off from_data from a rebuilt Python dictionary instead of the C# data type
+        # Kick-off __from_data__ from a rebuilt Python dictionary instead of the C# data type
         if IDictionary and isinstance(o, IDictionary[str, object]):
             data = {key: data[key] for key in data.Keys}
 

src/compas/datastructures/assembly/assembly.py

@@ -14,6 +14,8 @@ class Assembly(Datastructure):
     ----------
     name : str, optional
         The name of the assembly.
+    **kwargs : dict, optional
+        Additional keyword arguments, which are stored in the attributes dict.
 
     Attributes
     ----------
@@ -32,36 +34,35 @@ class Assembly(Datastructure):
         "type": "object",
         "properties": {
             "graph": Graph.DATASCHEMA,
+            "attributes": {"type": "object"},
         },
-        "required": ["graph"],
+        "required": ["graph", "attributes"],
     }
 
-    def __init__(self, name=None):
-        super(Assembly, self).__init__(name=name)
-        self.graph = Graph()
-        self._parts = {}
-
-    def __str__(self):
-        tpl = "<Assembly with {} parts and {} connections>"
-        return tpl.format(self.graph.number_of_nodes(), self.graph.number_of_edges())
-
-    # ==========================================================================
-    # Data
-    # ==========================================================================
-
     @property
-    def data(self):
+    def __data__(self):
         return {
-            "graph": self.graph.data,
+            "graph": self.graph.__data__,
+            "attributes": self.attributes,
         }
 
     @classmethod
-    def from_data(cls, data):
+    def __from_data__(cls, data):
         assembly = cls()
-        assembly.graph = Graph.from_data(data["graph"])
+        assembly.attributes.update(data["attributes"] or {})
+        assembly.graph = Graph.__from_data__(data["graph"])
         assembly._parts = {part.guid: part.key for part in assembly.parts()}  # type: ignore
         return assembly
 
+    def __init__(self, name=None, **kwargs):
+        super(Assembly, self).__init__(kwargs, name=name)
+        self.graph = Graph()
+        self._parts = {}
+
+    def __str__(self):
+        tpl = "<Assembly with {} parts and {} connections>"
+        return tpl.format(self.graph.number_of_nodes(), self.graph.number_of_edges())
+
     # ==========================================================================
     # Constructors
     # ==========================================================================

src/compas/datastructures/assembly/part.py

@@ -65,11 +65,11 @@ def __init__(self, *args, **kwargs):
         self._geometry = None
 
     @property
-    def data(self):
+    def __data__(self):
         return {"geometry": self._geometry}
 
     @classmethod
-    def from_data(cls, data):
+    def __from_data__(cls, data):
         feature = cls()
         feature._geometry = data["geometry"]  # this will work but is not consistent with validation
         return feature
@@ -163,32 +163,32 @@ class Part(Datastructure):
         "required": ["key", "frame"],
     }
 
-    def __init__(self, name=None, frame=None, **kwargs):
-        super(Part, self).__init__()
-        self.attributes = {"name": name or "Part"}
-        self.attributes.update(kwargs)
-        self.key = None
-        self.frame = frame or Frame.worldXY()
-        self.features = []
-
     @property
-    def data(self):
+    def __data__(self):
         return {
             "attributes": self.attributes,
             "key": self.key,
-            "frame": self.frame.data,
+            "frame": self.frame.__data__,
             "features": self.features,
         }
 
     @classmethod
-    def from_data(cls, data):
+    def __from_data__(cls, data):
         part = cls()
         part.attributes.update(data["attributes"] or {})
         part.key = data["key"]
-        part.frame = Frame.from_data(data["frame"])
+        part.frame = Frame.__from_data__(data["frame"])
         part.features = data["features"] or []
         return part
 
+    def __init__(self, name=None, frame=None, **kwargs):
+        super(Part, self).__init__()
+        self.attributes = {"name": name or "Part"}
+        self.attributes.update(kwargs)
+        self.key = None
+        self.frame = frame or Frame.worldXY()
+        self.features = []
+
     def get_geometry(self, with_features=False):
         """
         Returns a transformed copy of the part's geometry.