Add support for additional data

Author: josemmo

src/compas_cadwork/elements/element.py

@@ -85,6 +85,72 @@ def setdefault(self, key: UserAttributeId, default: str) -> str:
         return self[key]
 
 
+class _ElementAdditionalData:
+    """Dictionary-like accessor for element additional data.
+
+    NOTE: Additional data is hidden from users and only accessible via the Cadwork API.
+    """
+
+    _id: Final[ElementId]
+
+    def __init__(self, element_id: ElementId) -> None:
+        self._id = element_id
+
+    def __contains__(self, key: str) -> bool:
+        raw_value = ac.get_additional_data(self._id, key)
+        return raw_value != ""
+
+    def __getitem__(self, key: str) -> str:
+        raw_value = ac.get_additional_data(self._id, key)
+        if raw_value == "":
+            raise KeyError(key)
+        return raw_value
+
+    def __setitem__(self, key: str, value: str) -> None:
+        ac.set_additional_data([self._id], key, value)
+
+    def __delitem__(self, key: str) -> None:
+        if key not in self:
+            raise KeyError(key)
+        ac.delete_additional_data([self._id], key)
+
+    def get(self, key: str, default: str | None = None) -> str | None:
+        """Get additional data.
+
+        Parameters
+        ----------
+        key : str
+            Additional data ID.
+        default : str | None, optional
+            Value to return if additional data is not set.
+
+        Returns
+        -------
+        str | None
+            Additional data value, or ``default`` if additional data is not set.
+        """
+        return self[key] if key in self else default
+
+    def setdefault(self, key: str, default: str) -> str:
+        """Set additional data to ``default`` if not set, then return its value.
+
+        Parameters
+        ----------
+        key : str
+            Additional data ID.
+        default : str
+            Value to set if additional data is not set.
+
+        Returns
+        -------
+        str
+            Existing additional data value, or ``default`` if data was not set.
+        """
+        if key not in self:
+            self[key] = default
+        return self[key]
+
+
 class Element:
     """Generic Cadwork element."""
 
@@ -189,6 +255,11 @@ def attributes(self) -> _ElementUserAttributes:
         """User attributes."""
         return _ElementUserAttributes(self.id)
 
+    @cached_property
+    def data(self) -> _ElementAdditionalData:
+        """Additional data."""
+        return _ElementAdditionalData(self.id)
+
     def delete(self) -> None:
         """Delete element.
 

tests/compas_cadwork/elements/test_element.py

@@ -235,6 +235,78 @@ def test_deletes_attributes(cadwork) -> None:
     cadwork.ac.set_user_attribute.assert_called_once_with([123], 700, "")
 
 
+def test_contains_data(cadwork) -> None:
+    element = Element(123)
+
+    # Without value
+    cadwork.ac.get_additional_data.return_value = ""
+    assert "first" not in element.data
+    cadwork.ac.get_additional_data.assert_called_once_with(123, "first")
+
+    # With value
+    cadwork.ac.get_additional_data.return_value = "Test Value"
+    assert "second" in element.data
+    cadwork.ac.get_additional_data.assert_called_with(123, "second")
+
+
+def test_gets_data(cadwork) -> None:
+    element = Element(123)
+
+    # Without value
+    cadwork.ac.get_additional_data.return_value = ""
+    with pytest.raises(KeyError):
+        _ = element.data["third"]
+    cadwork.ac.get_additional_data.assert_called_once_with(123, "third")
+    assert element.data.get("third", None) is None
+    assert element.data.get("third", "Default") == "Default"
+
+    # With value
+    cadwork.ac.get_additional_data.return_value = "Test Value"
+    assert element.data["fourth"] == "Test Value"
+    cadwork.ac.get_additional_data.assert_called_with(123, "fourth")
+    assert element.data.get("fourth", None) == "Test Value"
+    assert element.data.get("fourth", "Default") == "Test Value"
+
+
+def test_sets_data(cadwork) -> None:
+    element = Element(123)
+
+    # Base case
+    element.data["fifth"] = "New Value"
+    cadwork.ac.set_additional_data.assert_called_once_with([123], "fifth", "New Value")
+
+    # Without value
+    cadwork.ac.get_additional_data.side_effect = ["", "Default Value"]
+    assert element.data.setdefault("sixth", "Default Value") == "Default Value"
+    cadwork.ac.get_additional_data.assert_called_with(123, "sixth")
+    cadwork.ac.set_additional_data.assert_called_with([123], "sixth", "Default Value")
+
+    # With value
+    cadwork.ac.set_additional_data.reset_mock()
+    cadwork.ac.get_additional_data.reset_mock(side_effect=True)
+    cadwork.ac.get_additional_data.return_value = "Existing Value"
+    assert element.data.setdefault("seventh", "Default Value") == "Existing Value"
+    cadwork.ac.get_additional_data.assert_called_with(123, "seventh")
+    cadwork.ac.set_additional_data.assert_not_called()
+
+
+def test_deletes_data(cadwork) -> None:
+    element = Element(123)
+
+    # Without value
+    cadwork.ac.get_additional_data.return_value = ""
+    with pytest.raises(KeyError):
+        del element.data["first"]
+    cadwork.ac.get_additional_data.assert_called_once_with(123, "first")
+
+    # With value
+    cadwork.ac.get_additional_data.return_value = "Test Value"
+    del element.data["second"]
+    cadwork.ac.get_additional_data.assert_called_with(123, "second")
+    cadwork.ac.delete_additional_data.assert_called_once_with([123], "second")
+    cadwork.ac.set_additional_data.assert_not_called()
+
+
 def test_deletes_element(cadwork) -> None:
     element = Element(123)
     element.delete()