add get_unused_ontologies and get_unused_feature_schemas

Author: lgluszek

labelbox/client.py

@@ -1031,6 +1031,62 @@ def insert_feature_schema_into_ontology(self, feature_schema_id: str,
                 "Failed to insert the feature schema into the ontology, message: "
                 + str(response.json()['message']))
 
+    def get_unused_ontologies(self, after: str = None) -> List[str]:
+        """
+        Returns a list of unused ontology ids
+        Args:
+            after (str): The cursor to use for pagination
+        Returns:
+            A list of unused ontology ids
+        Example:
+            To get the first page of unused ontology ids (100 at a time)
+            >>> client.get_unused_ontologies()
+            To get the next page of unused ontology ids
+            >>> client.get_unused_ontologies("cleabc1my012ioqvu5anyaabc")
+        """
+
+        endpoint = self.rest_endpoint + "/ontologies/unused"
+        response = requests.get(
+            endpoint,
+            headers=self.headers,
+            json={"after": after},
+        )
+
+        if response.status_code == requests.codes.ok:
+            return response.json()
+        else:
+            raise labelbox.exceptions.LabelboxError(
+                "Failed to get unused ontologies, message: " +
+                str(response.json()['message']))
+
+    def get_unused_feature_schemas(self, after: str = None) -> List[str]:
+        """
+        Returns a list of unused feature schema ids
+        Args:
+            after (str): The cursor to use for pagination
+        Returns:
+            A list of unused feature schema ids
+        Example:
+            To get the first page of unused feature schema ids (100 at a time)
+            >>> client.get_unused_feature_schemas()
+            To get the next page of unused feature schema ids
+            >>> client.get_unused_feature_schemas("cleabc1my012ioqvu5anyaabc")
+        """
+
+        endpoint = self.rest_endpoint + "/feature-schemas/unused"
+        response = requests.get(
+            endpoint,
+            headers=self.headers,
+            json={"after": after},
+        )
+
+        if response.status_code == requests.codes.ok:
+            return response.json()
+        else:
+            raise labelbox.exceptions.LabelboxError(
+                "Failed to get unused feature schemas, message: " +
+                str(response.json()['message']))
+
     def create_ontology(self, name, normalized, media_type=None) -> Ontology:
         """
         Creates an ontology from normalized data

tests/integration/test_feature_schema.py

@@ -112,3 +112,18 @@ def test_updates_a_feature_schema(client):
         tool_to_update.asdict())
 
     assert updated_feature_schema.normalized['name'] == "new name"
+
+
+def test_does_not_include_used_feature_schema(client):
+    tool = client.upsert_feature_schema(point.asdict())
+    feature_schema_id = tool.normalized['featureSchemaId']
+    ontology = client.create_ontology_from_feature_schemas(
+        name='ontology name',
+        feature_schema_ids=[feature_schema_id],
+        media_type=MediaType.Image)
+    unused_feature_schemas = client.get_unused_feature_schemas()
+
+    assert feature_schema_id not in unused_feature_schemas
+
+    client.delete_unused_ontology(ontology.uid)
+    client.delete_unused_feature_schema(feature_schema_id)

tests/integration/test_ontology.py

@@ -108,6 +108,25 @@ def test_moves_already_added_feature_schema_in_ontology(client):
     client.delete_unused_ontology(ontology.uid)
 
 
+def test_does_not_include_used_ontologies(client):
+    tool = client.upsert_feature_schema(point.asdict())
+    feature_schema_id = tool.normalized['featureSchemaId']
+    ontology_with_project = client.create_ontology_from_feature_schemas(
+        name='ontology name',
+        feature_schema_ids=[feature_schema_id],
+        media_type=MediaType.Image)
+    project = client.create_project(name="test project",
+                                    media_type=MediaType.Image)
+    project.setup_editor(ontology_with_project)
+    unused_ontologies = client.get_unused_ontologies()
+
+    assert ontology_with_project.uid not in unused_ontologies
+
+    project.delete()
+    client.delete_unused_ontology(ontology_with_project.uid)
+    client.delete_unused_feature_schema(feature_schema_id)
+
+
 def _get_attr_stringify_json(obj, attr):
     value = getattr(obj, attr.name)
     if attr.field_type.name.lower() == "json":