Merge pull request #388 from Labelbox/ms/html-instructions

msokoloff1 · web-flow · commit 4c53c9c80611 · 2022-01-10T20:59:29.000-05:00
add back html instructions
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Fix
 * Make `TypedArray` class compatible with `numpy` versions `>= 1.22.0`
 * `project.upsert_review_queue` quotas can now be in the inclusive range [0,1]
+* Restore support for upserting html instructions to a project
 
 # Version 3.11.0 (2021-12-15)
 
diff --git a/labelbox/schema/project.py b/labelbox/schema/project.py
@@ -317,12 +317,12 @@ def upsert_instructions(self, instructions_file: str):
 
         Args:
             instructions_file (str): Path to a local file.
-                * Must be a pdf file
+                * Must be a pdf or html file
 
         Raises:
             ValueError:
                 * project must be setup
-                * instructions file must have a ".pdf" extension
+                * instructions file must have a ".pdf" or ".html" extension
         """
 
         if self.setup_complete is None:
@@ -338,10 +338,11 @@ def upsert_instructions(self, instructions_file: str):
                 f"This function has only been tested to work with the Editor front end. Found %s",
                 frontend.name)
 
-        supported_instruction_formats = (".pdf")
+        supported_instruction_formats = (".pdf", ".html")
         if not instructions_file.endswith(supported_instruction_formats):
             raise ValueError(
-                f"instructions_file must be a pdf. Found {instructions_file}")
+                f"instructions_file must be a pdf or html file. Found {instructions_file}"
+            )
 
         lfo = list(self.labeling_frontend_options())[-1]
         instructions_url = self.client.upload_file(instructions_file)
diff --git a/tests/integration/test_project.py b/tests/integration/test_project.py
@@ -1,6 +1,7 @@
 import json
 
 import pytest
+import requests
 
 from labelbox import Project, LabelingFrontend
 from labelbox.exceptions import InvalidQueryError
@@ -97,7 +98,22 @@ def test_attach_instructions(client, project):
 
     with pytest.raises(ValueError) as exc_info:
         project.upsert_instructions('/tmp/file.invalid_file_extension')
-    assert "instructions_file must be a pdf. Found" in str(exc_info.value)
+    assert "instructions_file must be a pdf or html file. Found" in str(
+        exc_info.value)
+
+
+def test_html_instructions(configured_project):
+    html_file_path = '/tmp/instructions.html'
+    sample_html_str = "<html></html>"
+
+    with open(html_file_path, 'w') as file:
+        file.write(sample_html_str)
+
+    configured_project.upsert_instructions(html_file_path)
+    updated_ontology = configured_project.ontology().normalized
+
+    instructions = updated_ontology.pop('projectInstructions')
+    assert requests.get(instructions).text == sample_html_str
 
 
 def test_same_ontology_after_instructions(
