Added attch/copy/move items

Author: VaghinakDev

docs/source/superannotate.sdk.rst

@@ -74,6 +74,9 @@ ______
 
 .. autofunction:: superannotate.query
 .. autofunction:: superannotate.search_items
+.. autofunction:: superannotate.attach_items
+.. autofunction:: superannotate.copy_items
+.. autofunction:: superannotate.move_items
 .. autofunction:: superannotate.get_item_metadata
 
 ----------

src/superannotate/__init__.py

@@ -35,6 +35,7 @@
 from superannotate.lib.app.interface.sdk_interface import consensus
 from superannotate.lib.app.interface.sdk_interface import copy_image
 from superannotate.lib.app.interface.sdk_interface import copy_images
+from superannotate.lib.app.interface.sdk_interface import copy_items
 from superannotate.lib.app.interface.sdk_interface import create_annotation_class
 from superannotate.lib.app.interface.sdk_interface import (
     create_annotation_classes_from_classes_json,
@@ -72,6 +73,7 @@
 from superannotate.lib.app.interface.sdk_interface import init
 from superannotate.lib.app.interface.sdk_interface import invite_contributors_to_team
 from superannotate.lib.app.interface.sdk_interface import move_images
+from superannotate.lib.app.interface.sdk_interface import move_items
 from superannotate.lib.app.interface.sdk_interface import pin_image
 from superannotate.lib.app.interface.sdk_interface import prepare_export
 from superannotate.lib.app.interface.sdk_interface import query
@@ -177,6 +179,8 @@
     "search_items",
     "query",
     "attach_items",
+    "copy_items",
+    "move_items",
     # Image Section
     "copy_images",
     "move_images",

src/superannotate/lib/app/interface/sdk_interface.py

@@ -12,12 +12,6 @@
 from typing import Union
 
 import boto3
-from pydantic import StrictBool
-from pydantic import conlist
-from pydantic import parse_obj_as
-from pydantic.error_wrappers import ValidationError
-from tqdm import tqdm
-
 import lib.core as constances
 from lib.app.annotation_helpers import add_annotation_bbox_to_json
 from lib.app.annotation_helpers import add_annotation_comment_to_json
@@ -56,7 +50,12 @@
 from lib.core.types import PriorityScore
 from lib.core.types import Project
 from lib.infrastructure.controller import Controller
+from pydantic import conlist
+from pydantic import parse_obj_as
+from pydantic import StrictBool
+from pydantic.error_wrappers import ValidationError
 from superannotate.logger import get_default_logger
+from tqdm import tqdm
 
 logger = get_default_logger()
 
@@ -594,15 +593,20 @@ def copy_images(
     :return: list of skipped image names
     :rtype: list of strs
     """
-
+    warning_msg = (
+        "We're deprecating the copy_images function. Please use copy_items instead. Learn more. \n"
+        "https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html#superannotate.copy_items"
+    )
+    logger.warning(warning_msg)
+    warnings.warn(warning_msg, DeprecationWarning)
     project_name, source_folder_name = extract_project_folder(source_project)
 
     to_project_name, destination_folder_name = extract_project_folder(
         destination_project
     )
     if project_name != to_project_name:
         raise AppException(
-            "Source and destination projects should be the same for copy_images"
+            "Source and destination projects should be the same"
         )
     if not image_names:
         images = (
@@ -658,6 +662,12 @@ def move_images(
     :return: list of skipped image names
     :rtype: list of strs
     """
+    warning_msg = (
+        "We're deprecating the move_images function. Please use move_items instead. Learn more."
+        "https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html#superannotate.move_items"
+    )
+    logger.warning(warning_msg)
+    warnings.warn(warning_msg, DeprecationWarning)
     project_name, source_folder_name = extract_project_folder(source_project)
 
     project = Controller.get_default().get_project_metadata(project_name).data
@@ -1817,6 +1827,12 @@ def attach_image_urls_to_project(
     :return: list of linked image names, list of failed image names, list of duplicate image names
     :rtype: tuple
     """
+    warning_msg = (
+        "We're deprecating the attach_image_urls_to_project function. Please use attach_items instead. Learn more."
+        "https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html#superannotate.attach_items"
+    )
+    logger.warning(warning_msg)
+    warnings.warn(warning_msg, DeprecationWarning)
     project_name, folder_name = extract_project_folder(project)
     project = Controller.get_default().get_project_metadata(project_name).data
     project_folder_name = project_name + (f"/{folder_name}" if folder_name else "")
@@ -1884,6 +1900,12 @@ def attach_video_urls_to_project(
     :return: attached videos, failed videos, skipped videos
     :rtype: (list, list, list)
     """
+    warning_msg = (
+        "We're deprecating the attach_video_urls_to_project function. Please use attach_items instead. Learn more."
+        "https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html#superannotate.attach_items"
+    )
+    logger.warning(warning_msg)
+    warnings.warn(warning_msg, DeprecationWarning)
     project_name, folder_name = extract_project_folder(project)
     project = Controller.get_default().get_project_metadata(project_name).data
     project_folder_name = project_name + (f"/{folder_name}" if folder_name else "")
@@ -2744,6 +2766,12 @@ def attach_document_urls_to_project(
     :return: list of attached documents, list of not attached documents, list of skipped documents
     :rtype: tuple
     """
+    warning_msg = (
+        "We're deprecating the attach_document_urls_to_project function. Please use attach_items instead. Learn more."
+        "https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html#superannotate.attach_items"
+    )
+    logger.warning(warning_msg)
+    warnings.warn(warning_msg, DeprecationWarning)
     project_name, folder_name = extract_project_folder(project)
     project = Controller.get_default().get_project_metadata(project_name).data
     project_folder_name = project_name + (f"/{folder_name}" if folder_name else "")
@@ -3102,66 +3130,121 @@ def search_items(
 @validate_arguments
 def attach_items(
         project: Union[NotEmptyStr, dict],
-        attachments,
-        annotation_status="NotStarted"
+        attachments: AttachmentArg,
+        annotation_status: Optional[AnnotationStatuses] = "NotStarted"
 ):
-    """Link items from external storage to SuperAnnotate using URLs.
+    attachments = attachments.data
+    project_name, folder_name = extract_project_folder(project)
+    if attachments and isinstance(attachments[0], AttachmentDict):
+        unique_attachments = set(attachments)
+        duplicate_attachments = [item for item, count in collections.Counter(attachments).items() if count > 1]
+    else:
+        unique_attachments, duplicate_attachments = get_name_url_duplicated_from_csv(attachments)
+    if duplicate_attachments:
+        logger.info("Dropping duplicates.")
+    unique_attachments = parse_obj_as(List[AttachmentEntity], unique_attachments)
+    uploaded, fails, duplicated = [], [], []
+    if unique_attachments:
+        logger.info(f"Attaching  {len(unique_attachments)} file(s) to project {project}.")
+        response = Controller.get_default().attach_items(
+            project_name=project_name,
+            folder_name=folder_name,
+            attachments=unique_attachments,
+            annotation_status=annotation_status,
+        )
+        if response.errors:
+            raise AppException(response.errors)
+        uploaded, duplicated = response.data
+        uploaded = [i["name"] for i in uploaded]
+        fails = [
+            attachment.name
+            for attachment in unique_attachments
+            if attachment.name not in uploaded and attachment.name not in duplicated
+        ]
+    return uploaded, fails, duplicated
 
-    :param project: project name or folder path (e.g., “project1/folder1”)
-    :type project: str
 
-    :param attachments: path to CSV file or list of dicts containing attachments URLs.
-    :type attachments: path-like (str or Path) or list of dicts
+@Trackable
+@validate_arguments
+def copy_items(
+        source: Union[NotEmptyStr, dict],
+        destination: Union[NotEmptyStr, dict],
+        items: Optional[List[NotEmptyStr]] = None,
+        include_annotations: Optional[StrictBool] = True,
+):
+    """Copy images in bulk between folders in a project
 
-    :param annotation_status: value to set the annotation statuses of the
-                            linked items:
-                                “NotStarted”
-                                “InProgress”
-                                “QualityCheck”
-                                “Returned”
-                                “Completed”
-                                “Skipped”
-    :type annotation_status: str
+    :param source: project name or folder path to select items from (e.g., “project1/folder1”).
+    :type source: str
 
-    :return: list of attached item names, list of not attached item names, list of duplicate item names
-     that are already in SuperAnnotate.
-    :rtype: tuple
+    :param destination: project name (root) or folder path to place copied items.
+    :type destination: str
+
+    :param items: names of items to copy. If None, all items from the source directory will be copied.
+    :type itmes: list of str
+
+    :param include_annotations: enables annotations copy
+    :type include_annotations: bool
+
+    :return: list of skipped item names
+    :rtype: list of strs
     """
-    project_name, folder_name = extract_project_folder(project)
 
-    images_to_upload, duplicate_images = get_paths_and_duplicated_from_csv(attachments)
+    project_name, source_folder = extract_project_folder(source)
 
-    attachments_data
+    to_project_name, destination_folder = extract_project_folder(destination)
+    if project_name != to_project_name:
+        raise AppException(
+            "Source and destination projects should be the same for copy_images"
+        )
 
-    use_case = Controller.get_default().attach_items(
+    response = Controller.get_default().copy_items(
         project_name=project_name,
-        folder_name=folder_name,
-        files=ImageSerializer.deserialize(images_to_upload),  # noqa: E203
-        annotation_status=annotation_status,
+        from_folder=source_folder,
+        to_folder=destination_folder,
+        items=items,
+        include_annotations=include_annotations,
     )
-    if len(duplicate_images):
-        logger.warning(
-            constances.ALREADY_EXISTING_FILES_WARNING.format(len(duplicate_images))
-        )
+    if response.errors:
+        raise AppException(response.errors)
 
-    if use_case.is_valid():
-        logger.info(
-            constances.ATTACHING_FILES_MESSAGE.format(
-                len(images_to_upload), project
-            )
+    return response.data
+
+
+@Trackable
+@validate_arguments
+def move_items(
+        source: Union[NotEmptyStr, dict],
+        destination: Union[NotEmptyStr, dict],
+        items: Optional[List[NotEmptyStr]] = None,
+):
+    """Copy images in bulk between folders in a project
+
+    :param source: project name or folder path to pick items from (e.g., “project1/folder1”).
+    :type source: str
+
+    :param destination: project name (root) or folder path to move items to.
+    :type destination: str
+
+    :param items: names of items to move. If None, all items from the source directory will be moved.
+    :type items: list of str
+
+    :return: list of skipped item names
+    :rtype: list of strs
+    """
+
+    project_name, source_folder = extract_project_folder(source)
+    to_project_name, destination_folder = extract_project_folder(destination)
+    if project_name != to_project_name:
+        raise AppException(
+            "Source and destination projects should be the same"
         )
-        with tqdm(
-                total=use_case.attachments_count, desc="Attaching urls"
-        ) as progress_bar:
-            for attached in use_case.execute():
-                progress_bar.update(attached)
-        uploaded, duplications = use_case.data
-        uploaded = [i["name"] for i in uploaded]
-        duplications.extend(duplicate_images)
-        failed_images = [
-            image["name"]
-            for image in images_to_upload
-            if image["name"] not in uploaded + duplications
-        ]
-        return uploaded, failed_images, duplications
-    raise AppException(use_case.response.errors)
+    response = Controller.get_default().move_items(
+        project_name=project_name,
+        from_folder=source_folder,
+        to_folder=destination_folder,
+        items=items,
+    )
+    if response.errors:
+        raise AppException(response.errors)
+    return response.data

src/superannotate/lib/app/interface/types.py

@@ -113,6 +113,10 @@ class AttachmentArg(BaseModel):
     def __getitem__(self, index):
         return self.__root__[index]
 
+    @property
+    def data(self):
+        return self.__root__
+
     @root_validator(pre=True)
     def validate_root(cls, values):
         try:

src/superannotate/lib/app/mixp/utils/parsers.py

@@ -1029,3 +1029,47 @@ def search_items(**kwargs):
             "recursive": bool(recursive),
         },
     }
+
+
+def move_items(**kwargs):
+    project = kwargs["project"]
+    project_name, _ = extract_project_folder(project)
+    project = Controller.get_default().get_project_metadata(project_name).data["project"]
+    items = kwargs["items"]
+    return {
+        "event_name": "move_items",
+        "properties": {
+            "project_type": ProjectType.get_name(project.project_type),
+            "items_count": len(items) if items else None
+        },
+    }
+
+
+def copy_items(**kwargs):
+    project = kwargs["project"]
+    project_name, _ = extract_project_folder(project)
+    project = Controller.get_default().get_project_metadata(project_name).data["project"]
+    items = kwargs["items"]
+    return {
+        "event_name": "copy_items",
+        "properties": {
+            "project_type": ProjectType.get_name(project.project_type),
+            "items_count": len(items) if items else None,
+            "include_annotations": kwargs["include_annotations"]
+        },
+    }
+
+
+def attach_items(**kwargs):
+    project = kwargs["project"]
+    project_name, _ = extract_project_folder(project)
+    project = Controller.get_default().get_project_metadata(project_name).data["project"]
+    attachments = kwargs["attachments"]
+    return {
+        "event_name": "copy_items",
+        "properties": {
+            "project_type": ProjectType.get_name(project.project_type),
+            "attachments": "scv" if isinstance(attachments, (str, Path)) else "dict",
+            "annotation_status": kwargs["annotation_status"]
+        },
+    }

src/superannotate/lib/core/exceptions.py

@@ -7,12 +7,18 @@ class AppException(Exception):
     def __init__(self, message):
         super().__init__(message)
 
-        self.message = message
+        self.message = str(message)
 
     def __str__(self):
         return self.message
 
 
+class BackendError(AppException):
+    """
+    Backend Error
+    """
+
+
 class AppValidationException(AppException):
     """
     App validation exception