Merge pull request #148 from superannotateai/develop

Video attach urls

Author: dshabin

docs/source/superannotate.sdk.rst

@@ -46,6 +46,7 @@ ________
 .. autofunction:: superannotate.upload_images_from_folder_to_project
 .. autofunction:: superannotate.upload_video_to_project
 .. autofunction:: superannotate.upload_videos_from_folder_to_project
+.. autofunction:: superannotate.attach_video_urls_to_project
 .. _ref_upload_annotations_from_folder_to_project:
 .. autofunction:: superannotate.upload_annotations_from_folder_to_project
 .. autofunction:: superannotate.upload_preannotations_from_folder_to_project

superannotate/__init__.py

@@ -75,7 +75,8 @@ def consensus(*args, **kwargs):
     upload_images_from_public_urls_to_project,
     upload_images_from_s3_bucket_to_project, upload_images_to_project,
     attach_image_urls_to_project, upload_preannotations_from_folder_to_project,
-    upload_video_to_project, upload_videos_from_folder_to_project
+    upload_video_to_project, upload_videos_from_folder_to_project,
+    attach_video_urls_to_project
 )
 from .db.search_projects import search_projects
 from .db.teams import (

superannotate/__main__.py

@@ -48,37 +48,35 @@ def ask_token():
 
 
 def main():
-    available_commands = "Available commands to superannotate CLI are: init version create-project create-folder upload-images upload-videos upload-preannotations upload-annotations export-project"
+    available_commands = {
+        "create-project": create_project,
+        "create-folder": create_folder,
+        "upload-images": image_upload,
+        "attach-image-urls": attach_video_urls,
+        "upload-videos": video_upload,
+        "upload-preannotations": preannotations_upload,
+        "upload-annotations": preannotations_upload,
+        "init": lambda *args, **kwargs: ask_token(),
+        "export-project": export_project,
+        "attach-video-urls": attach_video_urls,
+        "version": lambda *args, **kwargs: print(f"SuperAnnotate Python SDK version {sa.__version__}")
+    }
     if len(sys.argv) == 1:
-        raise SABaseException(
-            0, "No command given to superannotate CLI. " + available_commands
+        print(
+            "No command given to superannotate CLI. Available commands to superannotate CLI are:"
+            + ", ".join(available_commands.keys())
         )
+
     command = sys.argv[1]
     further_args = sys.argv[2:]
-
-    if command == "create-project":
-        create_project(command, further_args)
-    elif command == "create-folder":
-        create_folder(command, further_args)
-    elif command == "upload-images":
-        image_upload(command, further_args)
-    elif command == "attach-image-urls":
-        attach_image_urls(command, further_args)
-    elif command == "upload-videos":
-        video_upload(command, further_args)
-    elif command in ["upload-preannotations", "upload-annotations"]:
-        preannotations_upload(command, further_args)
-    elif command == "init":
-        ask_token()
-    elif command == "export-project":
-        export_project(command, further_args)
-    elif command == "version":
-        print(f"SuperAnnotate Python SDK version {sa.__version__}")
-    else:
-        raise SABaseException(
-            0, "Wrong command " + command + " to superannotate CLI. " +
-            available_commands
-        )
+    try:
+        available_commands[command](command, further_args)
+    except KeyError:
+        sys.stdout.write("Wrong command " + command + " to superannotate CLI. " + ", ".join(available_commands.keys()))
+    except SABaseException as e:
+        sys.stdout.write(e.message)
+    except BaseException as e:
+        sys.stdout.write(str(e))
 
 
 def _list_str(values):
@@ -364,5 +362,30 @@ def export_project(command_name, args):
     )
 
 
+def attach_video_urls(command_name, args):
+    parser = argparse.ArgumentParser(prog=_CLI_COMMAND + " " + command_name)
+    parser.add_argument(
+        '--project', required=True, help='Project name to upload'
+    )
+    parser.add_argument(
+        '--attachments',
+        required=True,
+        help='path to csv file on attachments metadata'
+    )
+    parser.add_argument(
+        '--annotation_status',
+        required=False,
+        default="NotStarted",
+        help=
+        'Set images\' annotation statuses after upload. Default is NotStarted'
+    )
+    args = parser.parse_args(args)
+    sa.attach_video_urls_to_project(
+        project=args.project,
+        attachments=args.attachments,
+        annotation_status=args.annotation_status
+    )
+
+
 if __name__ == "__main__":
     main()

superannotate/api.py

@@ -89,7 +89,6 @@ def init(self, config_location=None):
                 req_type='GET',
                 path=f'/team/{self.team_id}',
             )
-
             self.user_id = response.json().get('creator_id', None)
             self.team_name = response.json().get('name', None)
 

superannotate/common.py

@@ -19,7 +19,7 @@
 
 SPECIAL_CHARACTERS_IN_PROJECT_FOLDER_NAMES = set('/\\:*?"<>|')
 
-_PROJECT_TYPES = {"Vector": 1, "Pixel": 2}
+_PROJECT_TYPES = {"Vector": 1, "Pixel": 2, "Video": 3}
 
 _ANNOTATION_STATUSES = {
     "NotStarted": 1,
@@ -59,6 +59,46 @@
     "Semantic Segmentation for Pixel Projects": "semantic_segmentation_pixel"
 }
 
+VIDEO_DEPRICATED_FUNCTIONS = [
+    "upload_images_from_folder_to_project",
+    "get_image_metadata",
+    "search_images",
+    "upload_images_to_project",
+    "upload_annotations_from_folder_to_project",
+    "upload_image_annotations",
+    "download_image",
+    "download_image_annotations",
+    "get_image_annotations",
+    "set_image_annotation_status",
+    "aggregate_annotations_as_df",
+    "attach_image_urls_to_project",
+    "clone_project",
+    "copy_image",
+    "export_annotation",
+    "upload_image_to_project",
+    "upload_video_to_project",
+    "add_annotation_bbox_to_image",
+    "assign_images",
+    "delete_images",
+    "get_project_image_count",
+    "set_project_workflow",
+    "upload_preannotations_from_folder_to_project",
+    "upload_videos_from_folder_to_project",
+    "add_annotation_comment_to_image",
+    "add_annotation_point_to_image",
+    "benchmark",
+    "class_distribution",
+    "consensus",
+    "convert_project_type",
+    "copy_images",
+    "get_project_workflow",
+    "move_image",
+    "move_images",
+    "set_images_annotation_statuses",
+    "set_project_default_image_quality_in_editor",
+    "upload_images_from_google_cloud_to_project",
+]
+
 
 def prediction_segmentation_status_from_str_to_int(status):
     return _PREDICTION_SEGMENTATION_STATUSES[status]
@@ -109,10 +149,11 @@ def project_type_int_to_str(project_type):
     :return: 'Vector' or 'Pixel'
     :rtype: str
     """
+    if project_type not in _PROJECT_TYPES.values():
+        raise RuntimeError("NA Project type")
     for k, v in _PROJECT_TYPES.items():
         if v == project_type:
             return k
-    raise RuntimeError("NA Project type")
 
 
 def user_role_str_to_int(user_role):
@@ -323,7 +364,7 @@ def write_to_json(output_path, json_data):
 
 
 def tqdm_converter(
-    total_num, images_converted, images_not_converted, finish_event
+        total_num, images_converted, images_not_converted, finish_event
 ):
     with tqdm(total=total_num) as pbar:
         while True:

superannotate/consensus_benchmark/benchmark.py

@@ -10,6 +10,7 @@
 from ..db.exports import prepare_export, download_export
 from ..analytics.common import aggregate_annotations_as_df
 from ..mixp.decorators import Trackable
+from ..db.project_api import get_project_and_folder_metadata
 
 logger = logging.getLogger("superannotate-python-sdk")
 
@@ -44,6 +45,12 @@ def benchmark(
     :return: Pandas DateFrame with columns (creatorEmail, QA, imageName, instanceId, className, area, attribute, folderName, score)
     :rtype: pandas DataFrame
     """
+
+    if isinstance(project, dict):
+        get_project_and_folder_metadata(project['name'])
+    else:
+        get_project_and_folder_metadata(project)
+
     def aggregate_attributes(instance_df):
         def attribute_to_list(attribute_df):
             attribute_names = list(attribute_df["attributeName"])

superannotate/consensus_benchmark/consensus.py

@@ -2,6 +2,7 @@
 Main module for consensus computation
 """
 import logging
+from ..db.project_api import get_project_and_folder_metadata
 import tempfile
 import pandas as pd
 from pathlib import Path
@@ -45,6 +46,8 @@ def consensus(
     if annot_type not in supported_types:
         raise NotImplementedError
 
+    get_project_and_folder_metadata(project)
+
     if export_root is None:
         with tempfile.TemporaryDirectory() as export_dir:
             proj_export_meta = prepare_export(project)

superannotate/db/exports.py

@@ -127,12 +127,21 @@ def prepare_export(
     """
     if not isinstance(project, dict):
         project = get_project_metadata_bare(project)
+
     upload_state = upload_state_int_to_str(project.get("upload_state"))
-    if upload_state == "External" and include_fuse == True:
-        logger.info(
-            "Include fuse functionality is not supported for  projects containing images attached with URLs"
+
+    if upload_state == "External" and include_fuse:
+        logger.warning(
+            "Include fuse functionality is not supported for projects containing  items attached with URLs"
         )
         include_fuse = False
+    if project["type"] == "Video":
+        if only_pinned:
+            logger.warning(
+                "Pin functionality is not supported for projects containing videos attached with URLs"
+            )
+        only_pinned, include_fuse = False, False
+
     team_id, project_id = project["team_id"], project["id"]
     if annotation_statuses is None:
         annotation_statuses = [2, 3, 4, 5]
@@ -144,9 +153,9 @@ def prepare_export(
     current_time = datetime.now().strftime("%b %d %Y %H:%M")
     json_req = {
         "include": annotation_statuses,
-        "fuse": int(include_fuse),
-        "is_pinned": int(only_pinned),
         "coco": 0,
+        "is_pinned": int(only_pinned),
+        "fuse": int(include_fuse),
         "time": current_time
     }
     if folder_names is not None:

superannotate/db/project_api.py

@@ -1,4 +1,5 @@
 import logging
+import inspect
 
 from .. import common
 from ..api import API
@@ -41,6 +42,19 @@ def get_project_metadata_bare(project_name, include_complete_image_count=False):
         res = results[0]
         res["type"] = common.project_type_int_to_str(res["type"])
         res["user_role"] = common.user_role_int_to_str(res["user_role"])
+        current_frame = inspect.currentframe()
+        outer_function = inspect.getframeinfo(current_frame.f_back).function
+        outer_outer_function = inspect.getframeinfo(
+            current_frame.f_back.f_back
+        ).function
+        if res.get("type") and res["type"] == "Video" and (
+            outer_function in common.VIDEO_DEPRICATED_FUNCTIONS or
+            outer_outer_function in common.VIDEO_DEPRICATED_FUNCTIONS
+        ):
+            raise SABaseException(
+                0,
+                "The function does not support projects containing videos attached with URLs"
+            )
         return res
     else:
         raise SANonExistingProjectNameException(
@@ -131,6 +145,18 @@ def get_project_and_folder_metadata(project):
             raise SAIncorrectProjectArgument(project)
     else:
         raise SAIncorrectProjectArgument(project)
+    current_frame = inspect.currentframe()
+    outer_function = inspect.getframeinfo(current_frame.f_back).function
+    outer_outer_function = inspect.getframeinfo(
+        current_frame.f_back.f_back
+    ).function
+    if project.get("type") and project["type"] == "Video" \
+            and (outer_function in common.VIDEO_DEPRICATED_FUNCTIONS
+                 or outer_outer_function in common.VIDEO_DEPRICATED_FUNCTIONS):
+        raise SABaseException(
+            0,
+            "The function does not support projects containing videos attached with URLs"
+        )
     return project, folder
 
 

superannotate/db/project_images.py

@@ -22,7 +22,7 @@
 from .teams import get_team_metadata
 from ..mixp.decorators import Trackable
 from .utils import _unassign_images, _assign_images, _get_upload_auth_token, _get_boto_session_by_credentials, upload_image_array_to_s3, \
-    get_image_array_to_upload, __create_image, __copy_images, __move_images, get_project_folder_string
+    get_image_array_to_upload, __create_file, __copy_images, __move_images, get_project_folder_string
 
 logger = logging.getLogger("superannotate-python-sdk")
 _api = API.get_instance()
@@ -118,7 +118,7 @@ def upload_image_to_project(
     except Exception as e:
         raise SABaseException(0, "Couldn't upload to data server.") from e
 
-    __create_image(
+    __create_file(
         [img_name], [key],
         project,
         annotation_status,
@@ -640,8 +640,8 @@ def assign_folder(project, folder_name, users):
 
 @Trackable
 def unassign_folder(project, folder_name):
-    """Removes assignment of given folder for all assignees. 
-    With SDK, the user can be assigned to a role in the project 
+    """Removes assignment of given folder for all assignees.
+    With SDK, the user can be assigned to a role in the project
     with the share_project function.
 
     :param project: project name or folder path (e.g., "project1/folder1")