Merge pull request #560 from Labelbox/develop

[3.20.1]

Author: jtsodapop

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# Version 3.20.1 (2022-05-02)
+## Updated
+* Ontology Classification `scope` field is only set for top level classifications
+
 # Version 3.20.0 (2022-04-27)
 ## Added
 * Batches in a project can be retrieved with `project.batches()`

Dockerfile

@@ -7,7 +7,8 @@ RUN apt install -y libsm6 \
                 ffmpeg \
                 libfontconfig1 \
                 libxrender1 \
-                libgl1-mesa-glx
+                libgl1-mesa-glx \
+                libgeos-dev
 
 WORKDIR /usr/src/labelbox
 COPY requirements.txt /usr/src/labelbox

labelbox/__init__.py

@@ -1,5 +1,5 @@
 name = "labelbox"
-__version__ = "3.20.0"
+__version__ = "3.20.1"
 
 import sys
 import warnings

labelbox/schema/ontology.py

@@ -69,7 +69,7 @@ def asdict(self) -> Dict[str, Any]:
             "featureSchemaId": self.feature_schema_id,
             "label": self.label,
             "value": self.value,
-            "options": [o.asdict() for o in self.options]
+            "options": [o.asdict(is_subclass=True) for o in self.options]
         }
 
     def add_option(self, option: 'Classification') -> None:
@@ -159,29 +159,25 @@ def from_dict(cls, dictionary: Dict[str, Any]) -> Dict[str, Any]:
                    feature_schema_id=dictionary.get("featureSchemaId", None),
                    scope=cls.Scope(dictionary.get("scope", cls.Scope.GLOBAL)))
 
-    def asdict(self) -> Dict[str, Any]:
+    def asdict(self, is_subclass: bool = False) -> Dict[str, Any]:
         if self.class_type in self._REQUIRES_OPTIONS \
                 and len(self.options) < 1:
             raise InconsistentOntologyException(
                 f"Classification '{self.instructions}' requires options.")
-        return {
-            "type":
-                self.class_type.value,
-            "instructions":
-                self.instructions,
-            "name":
-                self.name,
-            "required":
-                self.required,
+        classification = {
+            "type": self.class_type.value,
+            "instructions": self.instructions,
+            "name": self.name,
+            "required": self.required,
             "options": [o.asdict() for o in self.options],
-            "schemaNodeId":
-                self.schema_id,
-            "featureSchemaId":
-                self.feature_schema_id,
-            "scope":
-                self.scope.value
-                if self.scope is not None else self.Scope.GLOBAL.value
+            "schemaNodeId": self.schema_id,
+            "featureSchemaId": self.feature_schema_id
         }
+        if is_subclass:
+            return classification
+        classification[
+            "scope"] = self.scope.value if self.scope is not None else self.Scope.GLOBAL.value
+        return classification
 
     def add_option(self, option: Option) -> None:
         if option.value in (o.value for o in self.options):
@@ -258,7 +254,9 @@ def asdict(self) -> Dict[str, Any]:
             "name": self.name,
             "required": self.required,
             "color": self.color,
-            "classifications": [c.asdict() for c in self.classifications],
+            "classifications": [
+                c.asdict(is_subclass=True) for c in self.classifications
+            ],
             "schemaNodeId": self.schema_id,
             "featureSchemaId": self.feature_schema_id
         }

tests/unit/test_unit_ontology.py

@@ -46,8 +46,6 @@
                 "nested classification",
             "type":
                 "radio",
-            "scope":
-                "global",
             "options": [{
                 "schemaNodeId":
                     None,
@@ -64,7 +62,6 @@
                     "instructions": "nested nested text",
                     "name": "nested nested text",
                     "type": "text",
-                    "scope": "global",
                     "options": []
                 }]
             }, {
@@ -81,7 +78,6 @@
             "instructions": "nested text",
             "name": "nested text",
             "type": "text",
-            "scope": "global",
             "options": []
         }]
     }, {
@@ -250,6 +246,5 @@ def test_option_add_option() -> None:
 
 
 def test_ontology_asdict() -> None:
-    print(OntologyBuilder.from_dict(_SAMPLE_ONTOLOGY))
     assert OntologyBuilder.from_dict(
         _SAMPLE_ONTOLOGY).asdict() == _SAMPLE_ONTOLOGY