upload_image_annotations rename

Author: hovnatan

.pylintrc

@@ -1,3 +1,6 @@
+[BASIC]
+good-names=df,f,e
+
 [MASTER]
 load-plugins=pylint_pytest
 

docs/source/superannotate.sdk.rst

@@ -77,7 +77,7 @@ ______
 .. autofunction:: superannotate.get_image_preannotations
 .. autofunction:: superannotate.download_image_annotations
 .. autofunction:: superannotate.download_image_preannotations
-.. autofunction:: superannotate.upload_annotations_from_json_to_image
+.. autofunction:: superannotate.upload_image_annotations
 .. autofunction:: superannotate.copy_image
 .. autofunction:: superannotate.move_image
 .. autofunction:: superannotate.pin_image

docs/source/tutorial.sdk.rst

@@ -367,7 +367,7 @@ and upload back to the platform with:
 
 .. code-block:: python
 
-   sa.upload_annotations_from_json_to_image(project, image, "<path_to_json>")
+   sa.upload_image_annotations(project, image, "<path_to_json>")
 
 Last two steps can be combined into one:
 

superannotate/__init__.py

@@ -45,7 +45,7 @@
     create_fuse_image, delete_image, download_image, download_image_annotations,
     download_image_preannotations, get_image_annotations, get_image_bytes,
     get_image_metadata, get_image_preannotations, search_images,
-    set_image_annotation_status, upload_annotations_from_json_to_image
+    set_image_annotation_status, upload_image_annotations
 )
 from .db.project_images import (
     assign_images, copy_image, move_image, pin_image, upload_image_to_project

superannotate/db/images.py

@@ -17,8 +17,8 @@
 )
 from ..api import API
 from ..common import (
-    annotation_status_str_to_int, deprecated_alias, hex_to_rgb,
-    image_path_to_annotation_paths, project_type_int_to_str
+    annotation_status_str_to_int, hex_to_rgb, image_path_to_annotation_paths,
+    project_type_int_to_str
 )
 from ..exceptions import SABaseException
 from .annotation_classes import (
@@ -201,9 +201,7 @@ def add_annotation_comment_to_image(
         comment_author,
         resolved=resolved
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_bbox_to_image(
@@ -239,9 +237,7 @@ def add_annotation_bbox_to_image(
         annotation_class_attributes,
         error,
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_polygon_to_image(
@@ -275,9 +271,7 @@ def add_annotation_polygon_to_image(
         annotations, polygon, annotation_class_name,
         annotation_class_attributes, error
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_polyline_to_image(
@@ -310,9 +304,7 @@ def add_annotation_polyline_to_image(
         annotations, polyline, annotation_class_name,
         annotation_class_attributes, error
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_point_to_image(
@@ -345,9 +337,7 @@ def add_annotation_point_to_image(
         annotations, point, annotation_class_name, annotation_class_attributes,
         error
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_ellipse_to_image(
@@ -380,9 +370,7 @@ def add_annotation_ellipse_to_image(
         annotations, ellipse, annotation_class_name,
         annotation_class_attributes, error
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_template_to_image(
@@ -422,9 +410,7 @@ def add_annotation_template_to_image(
         annotations, template_points, template_connections,
         annotation_class_name, annotation_class_attributes, error
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def add_annotation_cuboid_to_image(
@@ -460,9 +446,7 @@ def add_annotation_cuboid_to_image(
         annotations, cuboid, annotation_class_name, annotation_class_attributes,
         error
     )
-    upload_annotations_from_json_to_image(
-        project, image_name, annotations, verbose=False
-    )
+    upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
 def download_image(
@@ -628,9 +612,7 @@ def get_image_preannotations(project, image_name):
         raise SABaseException(response.status_code, response.text)
     res = response.json()
 
-    annotation_classes = search_annotation_classes(
-        project
-    )
+    annotation_classes = search_annotation_classes(project)
     annotation_classes_dict = get_annotation_classes_id_to_name(
         annotation_classes
     )
@@ -724,9 +706,7 @@ def get_image_annotations(project, image_name, project_type=None):
         raise SABaseException(response.status_code, response.text)
     res = response.json()
 
-    annotation_classes = search_annotation_classes(
-        project
-    )
+    annotation_classes = search_annotation_classes(project)
     annotation_classes_dict = get_annotation_classes_id_to_name(
         annotation_classes
     )
@@ -853,8 +833,7 @@ def download_image_preannotations(project, image_name, local_dir_path):
     return tuple(return_filepaths)
 
 
-@deprecated_alias(mask_path="mask")
-def upload_annotations_from_json_to_image(
+def upload_image_annotations(
     project, image_name, annotation_json, mask=None, verbose=True
 ):
     """Upload annotations from JSON (also mask for pixel annotations)
@@ -886,9 +865,7 @@ def upload_annotations_from_json_to_image(
             "Uploading annotations for image %s in project %s.", image_name,
             project["name"]
         )
-    annotation_classes = search_annotation_classes(
-        project
-    )
+    annotation_classes = search_annotation_classes(project)
     annotation_classes_dict = get_annotation_classes_name_to_id(
         annotation_classes
     )

superannotate/db/project_images.py

@@ -12,13 +12,13 @@
 from .images import (
     delete_image, get_image_annotations, get_image_bytes, get_image_metadata,
     search_images, set_image_annotation_status,
-    upload_annotations_from_json_to_image
+    upload_image_annotations
 )
+from .project_api import get_project_metadata_bare
 from .projects import (
     __create_image, _get_project_image_quality_in_editor,
-    get_image_array_to_upload
+    get_image_array_to_upload, upload_image_array_to_s3
 )
-from .project_api import get_project_metadata_bare
 
 logger = logging.getLogger("superannotate-python-sdk")
 _api = API.get_instance()
@@ -100,15 +100,10 @@ def upload_image_to_project(
     )
     s3_resource = s3_session.resource('s3')
     bucket = s3_resource.Bucket(res["bucket"])
-    orig_image, lores_image, huge_image, thumbnail_image = get_image_array_to_upload(
-        img, image_quality_in_editor
-    )
+    images = get_image_array_to_upload(img, image_quality_in_editor)
     key = prefix + f'{img_name}'
     try:
-        bucket.put_object(Body=orig_image, Key=key)
-        bucket.put_object(Body=lores_image, Key=key + '___lores.jpg')
-        bucket.put_object(Body=huge_image, Key=key + '___huge.jpg')
-        bucket.put_object(Body=thumbnail_image, Key=key + '___thumb.jpg')
+        upload_image_array_to_s3(bucket, *images, key)
     except Exception as e:
         raise SABaseException(0, "Couldn't upload to data server. " + e)
 
@@ -180,13 +175,13 @@ def copy_image(
         annotations = get_image_annotations(source_project, image_name)
         if annotations["annotation_json"] is not None:
             if "annotation_mask" in annotations:
-                upload_annotations_from_json_to_image(
+                upload_image_annotations(
                     destination_project, new_name,
                     annotations["annotation_json"],
                     annotations["annotation_mask"]
                 )
             else:
-                upload_annotations_from_json_to_image(
+                upload_image_annotations(
                     destination_project, new_name,
                     annotations["annotation_json"]
                 )

superannotate/db/projects.py

@@ -1,3 +1,4 @@
+import cgi
 import copy
 import io
 import json
@@ -8,17 +9,16 @@
 import tempfile
 import threading
 import time
-from pathlib import Path
-import requests
-import cgi
 from os.path import basename
+from pathlib import Path
 from urllib.parse import urlparse
 
 import boto3
 import cv2
 import ffmpeg
-from google.cloud import storage
+import requests
 from azure.storage.blob import BlobServiceClient
+from google.cloud import storage
 from PIL import Image, ImageOps
 from tqdm import tqdm
 
@@ -539,6 +539,15 @@ def upload_images_from_folder_to_project(
     )
 
 
+def upload_image_array_to_s3(
+    bucket, orig_image, lores_image, huge_image, thumbnail_image, key
+):
+    bucket.put_object(Body=orig_image, Key=key)
+    bucket.put_object(Body=lores_image, Key=key + '___lores.jpg')
+    bucket.put_object(Body=huge_image, Key=key + '___huge.jpg')
+    bucket.put_object(Body=thumbnail_image, Key=key + '___thumb.jpg')
+
+
 def get_image_array_to_upload(byte_io_orig, image_quality_in_editor):
     Image.MAX_IMAGE_PIXELS = None
     im = Image.open(byte_io_orig)
@@ -638,13 +647,8 @@ def __upload_images_to_aws_thread(
             couldnt_upload[thread_id].append(path)
             continue
         try:
-            orig_image, lores_image, huge_image, thumbnail_image = get_image_array_to_upload(
-                file, image_quality_in_editor
-            )
-            bucket.put_object(Body=orig_image, Key=key)
-            bucket.put_object(Body=lores_image, Key=key + '___lores.jpg')
-            bucket.put_object(Body=huge_image, Key=key + '___huge.jpg')
-            bucket.put_object(Body=thumbnail_image, Key=key + '___thumb.jpg')
+            images = get_image_array_to_upload(file, image_quality_in_editor)
+            upload_image_array_to_s3(bucket, *images, key)
         except Exception as e:
             logger.warning("Unable to upload to data server %s.", e)
             couldnt_upload[thread_id].append(path)

tests/test_basic_images.py

@@ -51,7 +51,7 @@ def test_basic_images(project_type, name, description, from_folder, tmpdir):
 
     assert (Path(tmpdir) / image_name).is_file()
 
-    sa.upload_annotations_from_json_to_image(
+    sa.upload_image_annotations(
         project, image_name,
         sa.image_path_to_annotation_paths(
             from_folder / image_name, project_type

tests/test_fuse_gen.py

@@ -102,7 +102,7 @@ def test_fuse_image_create_pixel(tmpdir):
     sa.create_annotation_classes_from_classes_json(
         project, "./tests/sample_project_pixel/classes/classes.json"
     )
-    sa.upload_annotations_from_json_to_image(
+    sa.upload_image_annotations(
         PROJECT_NAME_PIXEL, "example_image_1.jpg",
         "./tests/sample_project_pixel/example_image_1.jpg___pixel.json",
         "./tests/sample_project_pixel/example_image_1.jpg___save.png"

tests/test_image_copy_move.py

@@ -28,7 +28,7 @@ def test_image_copy_mult(tmpdir):
     sa.create_annotation_classes_from_classes_json(
         project, "./tests/sample_project_vector/classes/classes.json"
     )
-    sa.upload_annotations_from_json_to_image(
+    sa.upload_image_annotations(
         project, "example_image_1.jpg",
         "./tests/sample_project_vector/example_image_1.jpg___objects.json"
     )