Merge pull request #126 from superannotateai/SAS-3046

Sas 3046

Author: VaghinakDev

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/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,
@@ -109,10 +109,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):

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")

superannotate/db/projects.py

@@ -761,51 +761,18 @@ def attach_image_urls_to_project(
         project, attachments, annotation_status="NotStarted"
 ):
     """Link images on external storage to SuperAnnotate.
-
+    
     :param project: project name or project folder path
     :type project: str or dict
     :param attachments: path to csv file on attachments metadata
     :type attachments: Pathlike (str or Path)
     :param annotation_status: value to set the annotation statuses of the linked images: NotStarted InProgress QualityCheck Returned Completed Skipped
     :type annotation_status: str
 
-    :return: list of linked image names, list of failed image names, list of duplicate image names
-    :rtype: tuple
+    :return: attached images, failed images, skipped images
+    :rtype: (list, list, list)
     """
-    project, folder = get_project_and_folder_metadata(project)
-    folder_name = project["name"] + (f'/{folder["name"]}' if folder else "")
-    upload_state = common.upload_state_int_to_str(project.get("upload_state"))
-    if upload_state == "Basic":
-        raise SABaseException(
-            0,
-            "You cannot attach URLs in this type of project. Please attach it in an external storage project"
-        )
-    annotation_status = common.annotation_status_str_to_int(annotation_status)
-    team_id, project_id = project["team_id"], project["id"]
-    image_data = pd.read_csv(attachments, dtype=str)
-    image_data = image_data[~image_data["url"].isnull()]
-    for ind, _ in image_data[image_data["name"].isnull()].iterrows():
-        name_try = str(uuid.uuid4())
-        image_data.at[ind, "name"] = name_try
-    image_data = pd.DataFrame(image_data, columns=["name", "url"])
-    img_names_urls = image_data.values.tolist()
-
-    if folder:
-        folder_id = folder["id"]
-    else:
-        folder_id = get_project_root_folder_id(project)
-
-    list_of_uploaded, list_of_not_uploaded, duplicate_images = _attach_urls(
-        img_names_urls=img_names_urls,
-        team_id=team_id,
-        folder_id=folder_id,
-        project_id=project_id,
-        annotation_status=annotation_status,
-        project=project,
-        folder_name=folder_name
-    )
-
-    return (list_of_uploaded, list_of_not_uploaded, duplicate_images)
+    return attach_file_urls_to_project(project, attachments, annotation_status)
 
 
 @Trackable
@@ -1993,3 +1960,79 @@ def clone_project(
         metadata["description"] = project_description
 
     return create_project_from_metadata(metadata)
+
+
+
+@Trackable
+def attach_video_urls_to_project(project, attachments, annotation_status="NotStarted"):
+    """Link videos on external storage to SuperAnnotate.
+
+    :param project: project name or project folder path
+    :type project: str or dict
+
+    :param attachments: path to csv file on attachments metadata
+    :type attachments: Path-like (str or Path)
+
+    :param annotation_status: value to set the annotation statuses of the linked videos: NotStarted InProgress QualityCheck Returned Completed Skipped
+    :type annotation_status: str
+
+    :return: attached videos, failed videos, skipped videos
+    :rtype: (list, list, list)
+    """
+    return attach_file_urls_to_project(project, attachments, annotation_status)
+
+
+def attach_file_urls_to_project(project, attachments, annotation_status):
+    """Link files on external storage to SuperAnnotate.
+
+    :param project: project name or project folder path
+    :type project: str or dict
+
+    :param attachments: path to csv file on attachments metadata
+    :type attachments: Path-like (str or Path)
+
+    :param annotation_status: value to set the annotation statuses of the linked files: NotStarted InProgress QualityCheck Returned Completed Skipped
+    :type annotation_status: str
+
+    :return: attached files, failed files, skipped files
+    :rtype: (list, list, list)
+    """
+    project, folder = get_project_and_folder_metadata(project)
+    folder_name = project["name"] + (f'/{folder["name"]}' if folder else "")
+    upload_state = common.upload_state_int_to_str(project.get("upload_state"))
+    if upload_state == "Basic":
+        raise SABaseException(
+            0,
+            "You cannot attach URLs in this type of project. Please attach it in an external storage project"
+        )
+    annotation_status = common.annotation_status_str_to_int(annotation_status)
+    team_id, project_id = project["team_id"], project["id"]
+    df = pd.read_csv(attachments, dtype=str)
+    df = df[~df["url"].isnull()]
+
+    if "name" in df.columns:
+        df.loc[df["name"].isnull(), "name"] = [
+            str(uuid.uuid4()) for _ in range(df["name"].isnull().sum())
+        ]
+    else:
+        df["name"] = [str(uuid.uuid4()) for _ in range(len(df.index))]
+
+    df = pd.DataFrame(df, columns=["name", "url"])
+    df_names_urls = df.values.tolist()
+
+    if folder:
+        folder_id = folder["id"]
+    else:
+        folder_id = get_project_root_folder_id(project)
+
+    list_of_uploaded, list_of_not_uploaded, list_of_duplicated = _attach_urls(
+        file_urls=df_names_urls,
+        team_id=team_id,
+        folder_id=folder_id,
+        project_id=project_id,
+        annotation_status=annotation_status,
+        project=project,
+        folder_name=folder_name
+    )
+
+    return list_of_uploaded, list_of_not_uploaded, list_of_duplicated