instruction upload works and is tested

Author: Matt Sokoloff

labelbox/schema/project.py

@@ -175,37 +175,65 @@ def export_labels(self, timeout_seconds=60):
 
     def attach_instructions(self, instructions_file: str):
         """
-        - Upload a set of instructions for labeling
+        * Uploads instructions to the UI. Running more than once will replace the instructions
+            
+        Args:
+            instructions_file (str): Path to a local file.
+                * Must be either a pdf, text, or html file.
 
+        Raises ValueError:
+            * project must be setup 
+            * instructions file must be one of ".text", ".txt", ".pdf", ".html"
         """
+
         if self.setup_complete is None:
-            raise Exception("Cannot attach instructions to a project that has not been setup.")
+            raise ValueError(
+                "Cannot attach instructions to a project that has not been setup."
+            )
+
+        frontend = self.labeling_frontend()
+        frontendId = frontend.uid
+
+        if frontend.name != "Editor":
+            logger.warn(
+                f"This function has only been tested to work with the Editor front end. Found {frontend.name}"
+            )
+
+        supported_instruction_formats = (".text", ".txt", ".pdf", ".html")
+        if not instructions_file.endswith(supported_instruction_formats):
+            raise ValueError(
+                f"instructions_file must end with one of {supported_instruction_formats}. Found {instructions_file}"
+            )
 
-        assert self.setup_complete is not None #Change this to an actual exception...
-        #Assert that the editor type is the editor..
-        instructions_url = self.client.upload_file(instructions_file)
         lfo = list(self.labeling_frontend_options())[-1]
+        instructions_url = self.client.upload_file(instructions_file)
         customization_options = json.loads(lfo.customization_options)
         customization_options['projectInstructions'] = instructions_url
         option_id = lfo.uid
-        frontendId = self.labeling_frontend().uid
-        args = {"frontendId": frontendId,
-                "name": "Editor", #Probably only compatible with the regular editor..
+
+        self.client.execute(
+            """mutation UpdateFrontendWithExistingOptionsPyApi (
+                    $frontendId: ID!, 
+                    $optionsId: ID!, 
+                    $name: String!, 
+                    $description: String!, 
+                    $customizationOptions: String!
+                ) {
+                    updateLabelingFrontend(
+                        where: {id: $frontendId}, 
+                        data: {name: $name, description: $description}
+                    ) {id}
+                    updateLabelingFrontendOptions(
+                        where: {id: $optionsId}, 
+                        data: {customizationOptions: $customizationOptions}
+                    ) {id}
+                }""", {
+                "frontendId": frontendId,
+                "name": frontend.name,
                 "description": "Video, image, and text annotation",
                 "optionsId": option_id,
                 "customizationOptions": json.dumps(customization_options)
-        }
-        return self.client.execute("""
-            mutation UpdateFrontendWithExistingOptions($frontendId: ID!, $optionsId: ID!, $name: String!, $description: String!, $customizationOptions: String!) {
-                updateLabelingFrontend(where: {id: $frontendId}, data: {name: $name, description: $description}) {
-                    id
-                }
-                updateLabelingFrontendOptions(where: {id: $optionsId}, data: {customizationOptions: $customizationOptions}) {
-                    id
-                }
-            }
-            """, args)
-
+            })
 
     def labeler_performance(self):
         """ Returns the labeler performances for this Project.

tests/integration/test_project.py

@@ -1,8 +1,8 @@
 import pytest
+import json
 
-from labelbox import Project
+from labelbox import Project, LabelingFrontend
 from labelbox.exceptions import InvalidQueryError
-import json
 
 
 def test_project(client, rand_gen):
@@ -67,7 +67,23 @@ def test_extend_reservations(project):
         project.extend_reservations("InvalidQueueType")
 
 
+def test_attach_instructions(client, project):
+    with pytest.raises(ValueError):
+        project.attach_instructions('/tmp/instructions.txt')
+
+    editor = list(
+        client.get_labeling_frontends(
+            where=LabelingFrontend.name == "editor"))[0]
+    empty_ontology = {"tools": [], "classifications": []}
+    project.setup(editor, empty_ontology)
+
+    with open('/tmp/instructions.txt', 'w') as file:
+        file.write("some instructions...")
+
+    project.attach_instructions('/tmp/instructions.txt')
+    assert json.loads(
+        list(project.labeling_frontend_options())
+        [-1].customization_options).get('projectInstructions') is not None
 
-def test_attach_instructions(setup_project):
-    setup_project.attach_labeling_instructions("http://www.africau.edu/images/default/sample.pdf")
-    assert json.loads(list(setup_project.labeling_frontend_options())[-1].customization_options).get('projectInstructions') is not None
+    with pytest.raises(ValueError):
+        project.attach_instructions('/tmp/file.invalid_file_extension')