update to project upsert instructions to no longer remove old ontology. added test cases

Author: jtsodapop

labelbox/schema/project.py

@@ -151,8 +151,9 @@ def labels(self, datasets=None, order_by=None):
             id_param, id_param, where, order_by_str,
             query.results_query_part(Label))
 
-        return PaginatedCollection(self.client, query_str, {id_param: self.uid},
-                                   ["project", "labels"], Label)
+        return PaginatedCollection(self.client, query_str,
+                                   {id_param: self.uid}, ["project", "labels"],
+                                   Label)
 
     def export_queued_data_rows(self, timeout_seconds=120):
         """ Returns all data rows that are currently enqueued for this project.
@@ -346,7 +347,7 @@ def upsert_instructions(self, instructions_file: str):
 
         lfo = list(self.labeling_frontend_options())[-1]
         instructions_url = self.client.upload_file(instructions_file)
-        customization_options = json.loads(lfo.customization_options)
+        customization_options = self.ontology().normalized
         customization_options['projectInstructions'] = instructions_url
         option_id = lfo.uid
 
@@ -393,11 +394,13 @@ def create_labeler_performance(client, result):
             # python isoformat doesn't accept Z as utc timezone
             result["lastActivityTime"] = datetime.fromisoformat(
                 result["lastActivityTime"].replace('Z', '+00:00'))
-            return LabelerPerformance(
-                **
-                {utils.snake_case(key): value for key, value in result.items()})
+            return LabelerPerformance(**{
+                utils.snake_case(key): value
+                for key, value in result.items()
+            })
 
-        return PaginatedCollection(self.client, query_str, {id_param: self.uid},
+        return PaginatedCollection(self.client, query_str,
+                                   {id_param: self.uid},
                                    ["project", "labelerPerformance"],
                                    create_labeler_performance)
 
@@ -409,7 +412,7 @@ def review_metrics(self, net_score):
         Returns:
             int, aggregation count of reviews for given `net_score`.
         """
-        if net_score not in (None,) + tuple(Entity.Review.NetScore):
+        if net_score not in (None, ) + tuple(Entity.Review.NetScore):
             raise InvalidQueryError(
                 "Review metrics net score must be either None "
                 "or one of Review.NetScore values")
@@ -422,41 +425,6 @@ def review_metrics(self, net_score):
         res = self.client.execute(query_str, {id_param: self.uid})
         return res["project"]["reviewMetrics"]["labelAggregate"]["count"]
 
-    def setup_editor(self, ontology):
-        """
-        Sets up the project using the Pictor editor.
-
-        Args:
-            ontology (Ontology): The ontology to attach to the project
-        """
-        labeling_frontend = next(
-            self.client.get_labeling_frontends(
-                where=Entity.LabelingFrontend.name == "Editor"))
-        self.labeling_frontend.connect(labeling_frontend)
-
-        LFO = Entity.LabelingFrontendOptions
-        self.client._create(
-            LFO, {
-                LFO.project:
-                    self,
-                LFO.labeling_frontend:
-                    labeling_frontend,
-                LFO.customization_options:
-                    json.dumps({
-                        "tools": [],
-                        "classifications": []
-                    })
-            })
-
-        query_str = """mutation ConnectOntologyPyApi($projectId: ID!, $ontologyId: ID!){
-            project(where: {id: $projectId}) {connectOntology(ontologyId: $ontologyId) {id}}}"""
-        self.client.execute(query_str, {
-            'ontologyId': ontology.uid,
-            'projectId': self.uid
-        })
-        timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
-        self.update(setup_complete=timestamp)
-
     def setup(self, labeling_frontend, labeling_frontend_options):
         """ Finalizes the Project setup.
 
@@ -516,7 +484,7 @@ def _post_batch(self, method, data_row_ids: List[str]):
                   }
                 }
               }
-            }
+            }         
         """ % (method, method)
 
         res = self.client.execute(query, {
@@ -552,7 +520,7 @@ def _update_queue_mode(self, mode: QueueMode) -> QueueMode:
                     tagSetStatus
                 }
             }
-        }
+        }       
         """ % "setTagSetStatusPyApi"
 
         self.client.execute(query_str, {
@@ -568,7 +536,7 @@ def queue_mode(self):
               project(where: {id: $projectId}) {
                  tagSetStatus
             }
-        }
+        }       
         """ % "GetTagSetStatusPyApi"
 
         status = self.client.execute(
@@ -666,8 +634,8 @@ def unset_labeling_parameter_overrides(self, data_rows):
         query_str = """mutation UnsetLabelingParameterOverridesPyApi($%s: ID!){
             project(where: { id: $%s}) {
             unsetLabelingParameterOverrides(data: [%s]) { success }}}""" % (
-            id_param, id_param, ",\n".join(
-                "{dataRowId: \"%s\"}" % row.uid for row in data_rows))
+            id_param, id_param, ",\n".join("{dataRowId: \"%s\"}" % row.uid
+                                           for row in data_rows))
         res = self.client.execute(query_str, {id_param: self.uid})
         return res["project"]["unsetLabelingParameterOverrides"]["success"]
 

tests/data/assets/loremipsum.pdf

@@ -103,6 +103,19 @@ def test_attach_instructions(client, project):
     assert "instructions_file must end with one of" in str(exc_info.value)
 
 
+def test_same_ontology_after_instructions(
+        client, configured_project_with_complex_ontology):
+    project, _ = configured_project_with_complex_ontology
+    initial_ontology = project.ontology().normalized
+    project.upsert_instructions('tests/data/assets/loremipsum.pdf')
+    updated_ontology = project.ontology().normalized
+
+    instructions = updated_ontology.pop('projectInstructions')
+
+    assert initial_ontology == updated_ontology
+    assert instructions is not None
+
+
 def test_queued_data_row_export(configured_project):
     result = configured_project.export_queued_data_rows()
     assert len(result) == 1