chore: Mark the classification as read only. Set at creation time (#1013)

Author: rad-cord

encord/objects/classification.py

@@ -55,7 +55,7 @@ class Classification(OntologyElement):
             in the ontology tree corresponding to this classification.
         attributes (List[Attribute]): List of `Attribute` instances that define
             the semantic meaning or properties associated with the classification.
-        level (OntologyClassificationLevel | None): The hierarchical level of
+        _level (OntologyClassificationLevel | None): The hierarchical level of
             this classification (for example: `GLOBAL`). Optional: defaults to None.
 
     Example:
@@ -72,7 +72,7 @@ class Classification(OntologyElement):
     uid: int
     feature_node_hash: str
     attributes: List[Attribute]
-    level: OntologyClassificationLevel | None = None
+    _level: OntologyClassificationLevel | None = None
 
     @property
     def title(self) -> str:
@@ -83,6 +83,15 @@ def title(self) -> str:
         """
         return self.attributes[0].name
 
+    @property
+    def level(self) -> OntologyClassificationLevel | None:
+        """Get the level of the classification.
+
+        Returns:
+            OntologyClassificationLevel | None: The level of the classification.
+        """
+        return self._level
+
     @property
     def children(self) -> Sequence[OntologyElement]:
         """Returns the attributes of the classification as children elements.
@@ -126,7 +135,7 @@ def from_dict(cls, d: dict) -> Classification:
             uid=int(d["id"]),
             feature_node_hash=d["featureNodeHash"],
             attributes=attributes_ret,
-            level=level,
+            _level=level,
         )
 
     def to_dict(self) -> Dict[str, Any]:

encord/objects/ontology_structure.py

@@ -16,7 +16,7 @@
 from uuid import uuid4
 
 from encord.exceptions import OntologyError
-from encord.objects.classification import Classification
+from encord.objects.classification import Classification, OntologyClassificationLevel
 from encord.objects.common import Shape
 from encord.objects.constants import AVAILABLE_COLORS
 from encord.objects.ontology_element import (
@@ -230,12 +230,14 @@ def add_classification(
         self,
         uid: Optional[int] = None,
         feature_node_hash: Optional[str] = None,
+        level: Optional[OntologyClassificationLevel] = None,
     ) -> Classification:
         """Adds a classification definition to the ontology.
 
         Args:
             uid: Integer identifier of the object. Normally auto-generated; omit this unless the aim is to create an exact clone of existing structure.
             feature_node_hash: Global identifier of the object. Normally auto-generated; omit this unless the aim is to create an exact clone of existing structure.
+            level: The level at which this classification applies. See :py:class:`encord.objects.classification.OntologyClassificationLevel` enum for possible values.
 
         Returns:
             Classification: The created classification node. Note that classification attribute should be further specified by calling its `add_attribute()` method.
@@ -258,7 +260,7 @@ def add_classification(
         if any([cls.feature_node_hash == feature_node_hash for cls in self.classifications]):
             raise ValueError(f"Duplicate feature_node_hash '{feature_node_hash}'")
 
-        cls = Classification(uid=uid, feature_node_hash=feature_node_hash, attributes=list())
+        cls = Classification(uid=uid, feature_node_hash=feature_node_hash, attributes=list(), _level=level)
         self.classifications.append(cls)
         return cls
 

tests/objects/classifications/test_global_classification.py

@@ -1,3 +1,4 @@
+import dataclasses
 from dataclasses import asdict
 from unittest.mock import Mock
 
@@ -20,6 +21,22 @@ def test_global_ontology_serde() -> None:
     assert Classification.from_dict(global_classification_dict) == GLOBAL_CLASSIFICATION
 
 
+def test_ontology_level_serde() -> None:
+    classification_without_level = dataclasses.replace(GLOBAL_CLASSIFICATION, _level=None)
+
+    classification_dict_without_level_key = GLOBAL_CLASSIFICATION.to_dict()
+    del classification_dict_without_level_key["level"]
+    assert Classification.from_dict(classification_dict_without_level_key) == classification_without_level
+
+    classification_dict_with_level_none = GLOBAL_CLASSIFICATION.to_dict()
+    classification_dict_with_level_none["level"] = None
+    assert Classification.from_dict(classification_dict_with_level_none) == classification_without_level
+
+    classification_dict_with_invalid_level = GLOBAL_CLASSIFICATION.to_dict()
+    classification_dict_with_invalid_level["level"] = "not-a-real-level"
+    assert Classification.from_dict(classification_dict_with_invalid_level) == classification_without_level
+
+
 def test_global_classification_image_group(all_types_ontology) -> None:
     label_row_metadata_dict = asdict(FAKE_LABEL_ROW_METADATA)
     label_row_metadata_dict["frames_per_second"] = None  # not a thing in image groups

tests/objects/data/all_types_ontology_structure.py

@@ -14,7 +14,7 @@
 GLOBAL_CLASSIFICATION = Classification(
     uid=4,
     feature_node_hash="3DuQbFx4",
-    level=OntologyClassificationLevel.GLOBAL,
+    _level=OntologyClassificationLevel.GLOBAL,
     attributes=[
         ChecklistAttribute(
             uid=[4, 1],