Merge pull request #958 from Labelbox/PTDT-1106

[PTDT-1106] Implemented delete_feature_schema_from_ontology client method

Author: Tim-Kerr

labelbox/client.py

@@ -44,6 +44,11 @@
 _LABELBOX_API_KEY = "LABELBOX_API_KEY"
 
 
+class DeleteFeatureFromOntologyResult:
+    archived: bool
+    deleted: bool
+
+
 class Client:
     """ A Labelbox client.
 
@@ -931,7 +936,6 @@ def delete_unused_ontology(self, ontology_id: str) -> None:
         Example:
             >>> client.delete_unused_ontology("cleabc1my012ioqvu5anyaabc")
         """
-
         endpoint = self.rest_endpoint + "/ontologies/" + urllib.parse.quote(
             ontology_id)
         response = requests.delete(
@@ -1597,3 +1601,48 @@ def get_model_slice(self, slice_id) -> ModelSlice:
         """
         res = self.execute(query_str, {"id": slice_id})
         return Entity.ModelSlice(self, res["getSavedQuery"])
+
+    def delete_feature_schema_from_ontology(
+            self, ontology_id: str,
+            feature_schema_id: str) -> DeleteFeatureFromOntologyResult:
+        """
+        Deletes or archives a feature schema from an ontology.
+        If the feature schema is a root level node with associated labels, it will be archived.
+        If the feature schema is a nested node in the ontology and does not have associated labels, it will be deleted.
+        If the feature schema is a nested node in the ontology and has associated labels, it will not be deleted.
+
+        Args:
+            ontology_id (str): The ID of the ontology.
+            feature_schema_id (str): The ID of the feature schema.
+
+        Returns:
+            DeleteFeatureFromOntologyResult: The result of the feature schema removal.
+
+        Example:
+            >>> client.remove_feature_schema_from_ontology(<ontology_id>, <feature_schema_id>)
+        """
+        ontology_endpoint = self.rest_endpoint + "/ontologies/" + urllib.parse.quote(
+            ontology_id) + "/feature-schemas/" + urllib.parse.quote(
+                feature_schema_id)
+        response = requests.delete(
+            ontology_endpoint,
+            headers=self.headers,
+        )
+
+        if response.status_code == requests.codes.ok:
+            response_json = response.json()
+            if response_json['archived'] == True:
+                logger.info(
+                    'Feature schema was archived from the ontology because it had associated labels.'
+                )
+            elif response_json['deleted'] == True:
+                logger.info(
+                    'Feature schema was successfully removed from the ontology')
+            result = DeleteFeatureFromOntologyResult()
+            result.archived = bool(response_json['archived'])
+            result.deleted = bool(response_json['deleted'])
+            return result
+        else:
+            raise labelbox.exceptions.LabelboxError(
+                "Failed to remove feature schema from ontology, message: " +
+                str(response.json()['message']))

tests/integration/conftest.py

@@ -11,7 +11,7 @@
 
 from labelbox import Client
 from labelbox import LabelingFrontend
-from labelbox import OntologyBuilder, Tool, Option, Classification
+from labelbox import OntologyBuilder, Tool, Option, Classification, MediaType
 from labelbox.orm import query
 from labelbox.pagination import PaginatedCollection
 from labelbox.schema.annotation_import import LabelImport
@@ -525,3 +525,25 @@ def func(project):
             time.sleep(2)
 
     return func
+
+
+@pytest.fixture
+def ontology(client):
+    ontology_builder = OntologyBuilder(
+        tools=[
+            Tool(tool=Tool.Type.BBOX, name="Box 1", color="#ff0000"),
+            Tool(tool=Tool.Type.BBOX, name="Box 2", color="#ff0000")
+        ],
+        classifications=[
+            Classification(name="Root Class",
+                           class_type=Classification.Type.RADIO,
+                           options=[
+                               Option(value="1", label="Option 1"),
+                               Option(value="2", label="Option 2")
+                           ])
+        ])
+    ontology = client.create_ontology('Integration Test Ontology',
+                                      ontology_builder.asdict(),
+                                      MediaType.Image)
+    yield ontology
+    client.delete_unused_ontology(ontology.uid)

tests/integration/test_ontology.py

@@ -6,6 +6,17 @@
 import time
 
 
+def test_delete_tool_feature_from_ontology(client, ontology):
+    feature_schema_to_delete = ontology.normalized['tools'][0]
+    assert len(ontology.normalized['tools']) == 2
+    result = client.delete_feature_schema_from_ontology(
+        ontology.uid, feature_schema_to_delete['featureSchemaId'])
+    assert result.deleted == True
+    assert result.archived == False
+    updatedOntology = client.get_ontology(ontology.uid)
+    assert len(updatedOntology.normalized['tools']) == 1
+
+
 @pytest.mark.skip(reason="normalized ontology contains Relationship, "
                   "which is not finalized yet. introduce this back when"
                   "Relationship feature is complete and we introduce"