Merge pull request #1403 from compas-dev/fix-data-name

Fix bug in data copy name

Author: tomvanmele

CHANGELOG.md

@@ -10,16 +10,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * Added instructions for creating new data types to the dev guide.
+* Added `compact=False`, `minimal=False` to `compas.data.Data.to_json()` to `compas.data.Data.to_jsonstring()`.
+* Added `copy_guid=False` to `compas.data.Data.copy()`. If true, the copy has the same guid as the original.
 
 ### Changed
 
-* Fixed `RuntimeError` when using `compas_rhino.unload_modules` in CPython`. 
+* Fixed `RuntimeError` when using `compas_rhino.unload_modules` in CPython`.
 * Fixed bug in `Box.scaled` causing a `TypeError` due to incorrect parameter forwarding.
 * Changed argument names of `Box.scale()` to `x`, `y`, `z`, instead of `factor` and made `y` and `z` optional to keep positional arguments backwards compatible.
 * Fixed import errors in `compas_rhino.conduits` for Rhino 8.
 * Fixed doctest failures.
 * Fixed bug in serialization when `compas.datastructures.attributes.AttributeView` is used.
 * Fixed bug in the serialisation of empty scenes.
+* Fixed bug in serialisation process due to `name` attribute appearing in json representation after copy even if not present before copy.
 
 ### Removed
 

src/compas/data/data.py

@@ -210,19 +210,22 @@ def from_json(cls, filepath):  # type: (...) -> Data
             raise TypeError("The data in the file is not a {}.".format(cls))
         return data
 
-    def to_json(self, filepath, pretty=False):
+    def to_json(self, filepath, pretty=False, compact=False, minimal=False):
         """Convert an object to its native data representation and save it to a JSON file.
 
         Parameters
         ----------
         filepath : str
             The path to the JSON file.
         pretty : bool, optional
-            If True, the JSON file will be pretty printed.
-            Defaults to False.
+            If True, format the output with newlines and indentation.
+        compact : bool, optional
+            If True, format the output without any whitespace.
+        minimal : bool, optional
+            If True, exclude the GUID from the JSON output.
 
         """
-        compas.json_dump(self, filepath, pretty=pretty)
+        compas.json_dump(self, filepath, pretty=pretty, compact=compact, minimal=minimal)
 
     @classmethod
     def from_jsonstring(cls, string):  # type: (...) -> Data
@@ -249,31 +252,36 @@ def from_jsonstring(cls, string):  # type: (...) -> Data
             raise TypeError("The data in the string is not a {}.".format(cls))
         return data
 
-    def to_jsonstring(self, pretty=False):
+    def to_jsonstring(self, pretty=False, compact=False, minimal=False):
         """Convert an object to its native data representation and save it to a JSON string.
 
         Parameters
         ----------
         pretty : bool, optional
-            If True, the JSON string will be pretty printed.
-            Defaults to False.
+            If True, format the output with newlines and indentation.
+        compact : bool, optional
+            If True, format the output without any whitespace.
+        minimal : bool, optional
+            If True, exclude the GUID from the JSON output.
 
         Returns
         -------
         str
             The JSON string.
 
         """
-        return compas.json_dumps(self, pretty=pretty)
+        return compas.json_dumps(self, pretty=pretty, compact=compact, minimal=minimal)
 
-    def copy(self, cls=None):  # type: (...) -> D
+    def copy(self, cls=None, copy_guid=False):  # type: (...) -> D
         """Make an independent copy of the data object.
 
         Parameters
         ----------
         cls : Type[:class:`compas.data.Data`], optional
             The type of data object to return.
             Defaults to the type of the current data object.
+        copy_guid : bool, optional
+            If True, the copy will have the same guid as the original.
 
         Returns
         -------
@@ -284,7 +292,10 @@ def copy(self, cls=None):  # type: (...) -> D
         if not cls:
             cls = type(self)
         obj = cls.__from_data__(deepcopy(self.__data__))
-        obj.name = self.name
+        if self._name is not None:
+            obj._name = self.name
+        if copy_guid:
+            obj._guid = self.guid
         return obj  # type: ignore
 
     def sha256(self, as_string=False):

tests/compas/data/test_copy.py

@@ -0,0 +1,63 @@
+from compas.data import Data
+
+
+class TestData(Data):
+    @property
+    def __data__(self):
+        return {}
+
+
+def test_copy_noname():
+    data = TestData()
+
+    assert data._name is None
+    assert data.name == "TestData"
+
+    assert data.copy()._name is None
+    assert data.copy().name == "TestData"
+
+    assert data.name == data.copy().name
+    assert data.__dtype__ == data.copy().__dtype__
+
+    assert data.guid != data.copy().guid
+    assert data.guid == data.copy(copy_guid=True).guid
+
+    assert data.__jsondump__() != data.copy().__jsondump__()
+    assert data.__jsondump__() == data.copy(copy_guid=True).__jsondump__()
+
+    assert data.to_jsonstring() != data.copy().to_jsonstring()
+    assert data.to_jsonstring() == data.copy(copy_guid=True).to_jsonstring()
+
+    assert data.__jsondump__(minimal=True) == data.copy().__jsondump__(minimal=True)
+    assert data.__jsondump__(minimal=True) == data.copy(copy_guid=False).__jsondump__(minimal=True)
+
+    assert data.to_jsonstring(minimal=True) == data.copy().to_jsonstring(minimal=True)
+    assert data.to_jsonstring(minimal=True) == data.copy(copy_guid=False).to_jsonstring(minimal=True)
+
+
+def test_copy():
+    data = TestData(name="test")
+
+    assert data._name == "test"
+    assert data.name == "test"
+
+    assert data.copy()._name == "test"
+    assert data.copy().name == "test"
+
+    assert data.name == data.copy().name
+    assert data.__dtype__ == data.copy().__dtype__
+
+    assert data.guid != data.copy().guid
+    assert data.guid == data.copy(copy_guid=True).guid
+
+    assert data.__jsondump__() != data.copy().__jsondump__()
+    assert data.__jsondump__() == data.copy(copy_guid=True).__jsondump__()
+
+    assert data.to_jsonstring() != data.copy().to_jsonstring()
+    assert data.to_jsonstring() == data.copy(copy_guid=True).to_jsonstring()
+
+    assert data.__jsondump__(minimal=True) == data.copy().__jsondump__(minimal=True)
+    assert data.__jsondump__(minimal=True) == data.copy(copy_guid=False).__jsondump__(minimal=True)
+
+    assert data.to_jsonstring(minimal=True) == data.copy().to_jsonstring(minimal=True)
+    assert data.to_jsonstring(minimal=True) == data.copy(copy_guid=False).to_jsonstring(minimal=True)