Merge pull request #857 from superannotateai/FRIDAY-5185

feat(sdk): accept project/folder IDs across SDK methods

Author: VaghinakDev

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

@@ -71,7 +71,6 @@
 from lib.infrastructure.annotation_adapter import BaseMultimodalAnnotationAdapter
 from lib.infrastructure.annotation_adapter import MultimodalSmallAnnotationAdapter
 from lib.infrastructure.annotation_adapter import MultimodalLargeAnnotationAdapter
-from lib.infrastructure.utils import extract_project_folder
 from lib.infrastructure.validators import wrap_error
 from lib.app.serializers import WMProjectSerializer
 from lib.core.entities.work_managament import WMUserTypeEnum
@@ -322,7 +321,7 @@ def get_project_by_id(self, project_id: int):
         :return: project metadata
         :rtype: dict
         """
-        response = self.controller.get_project_by_id(project_id=project_id)
+        response = self.controller.get_project(project_id=project_id)
 
         return ProjectSerializer(response.data).serialize()
 
@@ -372,7 +371,7 @@ def get_item_by_id(
         :return: item metadata
         :rtype: dict
         """
-        project_response = self.controller.get_project_by_id(project_id=project_id)
+        project_response = self.controller.get_project(project_id=project_id)
         project_response.raise_for_status()
 
         if (
@@ -714,10 +713,7 @@ def list_users(
 
         """
         if project is not None:
-            if isinstance(project, int):
-                project = self.controller.get_project_by_id(project).data
-            else:
-                project = self.controller.get_project(project)
+            project = self.controller.get_project(project)
         response = BaseSerializer.serialize_iterable(
             self.controller.work_management.list_users(
                 project=project, include=include, **filters
@@ -958,11 +954,7 @@ def set_contributors_categories(
         if not categories:
             AppException("Categories should be a list of strings or '*'.")
 
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         self.controller.check_multimodal_project_categorization(project)
 
         self.controller.work_management.set_remove_contributor_categories(
@@ -1008,11 +1000,7 @@ def remove_contributors_categories(
         if not categories:
             AppException("Categories should be a list of strings or '*'.")
 
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         self.controller.check_multimodal_project_categorization(project)
 
         self.controller.work_management.set_remove_contributor_categories(
@@ -1064,11 +1052,7 @@ def retrieve_context(
                 raise e
             return False, None
 
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         if project.type != ProjectType.MULTIMODAL:
             raise AppException(
                 "This function is only supported for Multimodal projects."
@@ -1429,11 +1413,7 @@ def create_categories(
         if not categories:
             raise AppException("Categories should be a list of strings.")
 
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         self.controller.check_multimodal_project_categorization(project)
 
         response = (
@@ -1483,11 +1463,7 @@ def list_categories(self, project: NotEmptyStr | int):
             ]
 
         """
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         self.controller.check_multimodal_project_categorization(project)
 
         response = (
@@ -1529,11 +1505,7 @@ def remove_categories(
         if not categories:
             AppException("Categories should be a list of strings or '*'.")
 
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         self.controller.check_multimodal_project_categorization(project)
 
         query = EmptyQuery()
@@ -1589,16 +1561,14 @@ def create_folder(self, project: NotEmptyStr | int, folder_name: NotEmptyStr):
         if res.errors:
             raise AppException(res.errors)
 
-    def delete_project(self, project: NotEmptyStr | dict):
+    def delete_project(self, project: NotEmptyStr | int):
         """Deletes the project
 
-        :param project: project name
+        :param project: project name or ID
         :type project: str
         """
-        name = project
-        if isinstance(project, dict):
-            name = project["name"]
-        self.controller.projects.delete(name=name)
+        project = self.controller.get_project(project)
+        self.controller.projects.delete(name=project.name)
 
     def rename_project(self, project: NotEmptyStr | int, new_name: NotEmptyStr):
         """Renames the project
@@ -1868,11 +1838,7 @@ def list_folders(
                 }
             ]
         """
-        project_entity = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project_entity = self.controller.get_project(project)
 
         valid_fields = FolderFilters.__annotations__
         chain = QueryBuilderChain(
@@ -2410,11 +2376,7 @@ def set_project_custom_field(
                 value=1738671238.759,
             )
         """
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         self.controller.work_management.set_custom_field_value(
             entity_id=project.id,
             field_name=custom_field_name,
@@ -2868,9 +2830,9 @@ def prepare_export(
 
             client.download_export("Project Name", export, "path_to_download")
         """
-        project, folder = self.controller.get_project_folder(project)
+        project = self.controller.get_project(project)
         if folder_names is None:
-            folders = [folder.name] if folder else []
+            folders = []
         else:
             folders = folder_names
         integration_name = kwargs.get("integration_name")
@@ -2933,11 +2895,7 @@ def delete_exports(
                 exports="*"
             )
         """
-        project_entity = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project_entity = self.controller.get_project(project)
         response = self.controller.delete_exports(
             project=project_entity, exports=exports
         )
@@ -3268,7 +3226,7 @@ def delete_annotation_class(
                 raise AppException(wrap_error(e))
         else:
             annotation_class = AnnotationClassEntity(**annotation_class)
-        project = self.controller.projects.get_by_name(project).data
+        project = self.controller.get_project(project)
 
         self.controller.annotation_classes.delete(
             project=project, annotation_class=annotation_class
@@ -3641,15 +3599,17 @@ def upload_annotations_from_folder_to_project(
         :rtype: tuple of list of strs
         """
 
-        project_name, folder_name = extract_project_folder(project)
+        project, folder = self.controller.get_project_folder(project)
         if keep_status is not None:
             warnings.warn(
                 DeprecationWarning(
                     "The “keep_status” parameter is deprecated. "
                     "Please use the “set_annotation_statuses” function instead."
                 )
             )
-        project_folder_name = project_name + (f"/{folder_name}" if folder_name else "")
+        project_folder_name = project.name + (
+            f"/{folder.name}" if not folder.is_root else ""
+        )
 
         if recursive_subfolders:
             logger.info(
@@ -3668,7 +3628,6 @@ def upload_annotations_from_folder_to_project(
         logger.info(
             f"Uploading {len(annotation_paths)} annotations from {folder_path} to the project {project_folder_name}."
         )
-        project, folder = self.controller.get_project_folder(project)
         response = self.controller.annotations.upload_from_folder(
             project=project,
             folder=folder,
@@ -3715,7 +3674,6 @@ def upload_image_annotations(
 
         """
 
-        _, folder_name = extract_project_folder(project)
         if keep_status is not None:
             warnings.warn(
                 DeprecationWarning(
@@ -3732,9 +3690,6 @@ def upload_image_annotations(
                 logger.info("Uploading annotations from %s.", annotation_json)
             with open(annotation_json, "rb") as f:
                 annotation_json = json.load(f)
-        folder = self.controller.get_folder(project, folder_name)
-        if not folder:
-            raise AppException("Folder not found.")
 
         items = self.controller.items.list_items(project, folder, name=image_name)
         image = next(iter(items), None)
@@ -4161,7 +4116,9 @@ def upload_priority_scores(
         """
         scores = TypeAdapter(list[PriorityScoreEntity]).validate_python(scores)
         project, folder = self.controller.get_project_folder(project)
-        project_folder_name = project.name + "" if folder.is_root else f"/{folder.name}"
+        project_folder_name = project.name + (
+            "" if folder.is_root else f"/{folder.name}"
+        )
         response = self.controller.projects.upload_priority_scores(
             project, folder, scores, project_folder_name
         )
@@ -4693,11 +4650,7 @@ def list_items(
                 assignee__user_id="qa@example.com"
             )
         """
-        project = (
-            self.controller.get_project_by_id(project).data
-            if isinstance(project, int)
-            else self.controller.get_project(project)
-        )
+        project = self.controller.get_project(project)
         if (
             include
             and "categories" in include
@@ -5294,10 +5247,7 @@ def download_annotations(
 
 
         """
-        project_name, folder_name = extract_project_folder(project)
-        project, folder = self.controller.get_project_folder(
-            (project_name, folder_name)
-        )
+        project, folder = self.controller.get_project_folder(project)
         response = self.controller.annotations.download(
             project=project,
             folder=folder,
@@ -5823,7 +5773,7 @@ def item_context(
             project = self.controller.get_project(path[0])
             folder = self.controller.get_folder(project, path[1])
         elif len(path) == 2 and all([isinstance(i, int) for i in path]):
-            project = self.controller.get_project_by_id(path[0]).data
+            project = self.controller.get_project(path[0]).data
             folder = self.controller.get_folder_by_id(path[1], project.id).data
         else:
             raise AppException("Invalid path provided.")