Merge pull request #597 from superannotateai/1838_deprecated_functions

removed create_project_from_metadata get_project_image_count

Author: VaghinakDev

docs/source/api_reference/api_project.rst

@@ -5,15 +5,13 @@ Projects
 .. _ref_search_projects:
 .. automethod:: superannotate.SAClient.create_project
 .. automethod:: superannotate.SAClient.search_projects
-.. automethod:: superannotate.SAClient.create_project_from_metadata
 .. automethod:: superannotate.SAClient.clone_project
 .. automethod:: superannotate.SAClient.rename_project
 .. automethod:: superannotate.SAClient.delete_project
 .. _ref_get_project_metadata:
 .. automethod:: superannotate.SAClient.get_project_by_id
 .. automethod:: superannotate.SAClient.set_project_status
 .. automethod:: superannotate.SAClient.get_project_metadata
-.. automethod:: superannotate.SAClient.get_project_image_count
 .. automethod:: superannotate.SAClient.upload_images_to_project
 .. automethod:: superannotate.SAClient.attach_items_from_integrated_storage
 .. automethod:: superannotate.SAClient.upload_image_to_project

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

@@ -5,7 +5,6 @@
 import logging
 import os
 import sys
-import warnings
 from pathlib import Path
 from typing import Callable
 from typing import Dict
@@ -47,7 +46,6 @@
 from lib.app.serializers import TeamSerializer
 from lib.core import LIMITED_FUNCTIONS
 from lib.core import entities
-from lib.core import enums
 from lib.core.conditions import CONDITION_EQ as EQ
 from lib.core.conditions import Condition
 from lib.core.conditions import EmptyCondition
@@ -385,45 +383,6 @@ def create_project(
                 project.workflows = self.controller.projects.list_workflow(project).data
         return ProjectSerializer(project).serialize()
 
-    def create_project_from_metadata(self, project_metadata: Project):
-        """Create a new project in the team using project metadata object dict.
-
-        | Mandatory keys: “name”, “description” and “type” (Vector or Pixel)
-        | Non-mandatory keys: “workflow”, “settings” and “annotation_classes”
-
-        :param project_metadata: project metadata
-        :type project_metadata: dict
-
-        :return: dict object metadata the new project
-        :rtype: dict
-        """
-        deprecation_msg = '"create_project_from_metadata" is deprecated and replaced by "create_project"'
-        warnings.warn(deprecation_msg, DeprecationWarning)
-        logger.warning(deprecation_msg)
-
-        project_metadata = project_metadata.dict()
-        if project_metadata["type"] not in enums.ProjectType.titles():
-            raise AppException(
-                "Please provide a valid project type: Vector, Pixel, Document, or Video."
-            )
-
-        response = self.controller.projects.create(
-            entities.ProjectEntity(
-                name=project_metadata["name"],
-                description=project_metadata.get("description"),
-                type=constants.ProjectType.get_value(project_metadata["type"]),
-                settings=parse_obj_as(
-                    List[SettingEntity], project_metadata.get("settings", [])
-                ),
-                classes=project_metadata.get("classes", []),
-                workflows=project_metadata.get("workflows", []),
-                instructions_link=project_metadata.get("instructions_link"),
-            ),
-        )
-        if response.errors:
-            raise AppException(response.errors)
-        return ProjectSerializer(response.data).serialize()
-
     def clone_project(
         self,
         project_name: Union[NotEmptyStr, dict],
@@ -1112,39 +1071,6 @@ def upload_images_from_folder_to_project(
             return use_case.data
         raise AppException(use_case.response.errors)
 
-    def get_project_image_count(
-        self,
-        project: Union[NotEmptyStr, dict],
-        with_all_subfolders: Optional[StrictBool] = False,
-    ):
-        """Returns number of images in the project.
-
-        :param project: project name or folder path (e.g., "project1/folder1")
-        :type project: str
-        :param with_all_subfolders: enables recursive folder counting
-        :type with_all_subfolders: bool
-
-        :return: number of images in the project
-        :rtype: int
-        """
-        deprecation_msg = (
-            "“get_project_image_count” is deprecated and replaced"
-            " by “item_count” value will be included in project metadata."
-        )
-
-        warnings.warn(deprecation_msg, DeprecationWarning)
-        logger.warning(deprecation_msg)
-        project_name, folder_name = extract_project_folder(project)
-
-        response = self.controller.get_project_image_count(
-            project_name=project_name,
-            folder_name=folder_name,
-            with_all_subfolders=with_all_subfolders,
-        )
-        if response.errors:
-            raise AppException(response.errors)
-        return response.data
-
     def download_image_annotations(
         self,
         project: Union[NotEmptyStr, dict],

src/superannotate/lib/core/usecases/projects.py

@@ -7,7 +7,6 @@
 from lib.core.conditions import Condition
 from lib.core.conditions import CONDITION_EQ as EQ
 from lib.core.entities import ContributorEntity
-from lib.core.entities import FolderEntity
 from lib.core.entities import ProjectEntity
 from lib.core.entities import SettingEntity
 from lib.core.entities import TeamEntity
@@ -508,48 +507,6 @@ def execute(self):
         return self._response
 
 
-class GetProjectImageCountUseCase(BaseUseCase):
-    def __init__(
-        self,
-        service_provider: BaseServiceProvider,
-        project: ProjectEntity,
-        folder: FolderEntity,
-        with_all_sub_folders: bool = False,
-    ):
-        super().__init__()
-        self._service_provider = service_provider
-        self._project = project
-        self._folder = folder
-        self._with_all_sub_folders = with_all_sub_folders
-
-    def validate_user_input(self):
-        if not self._folder.name == "root" and self._with_all_sub_folders:
-            raise AppValidationException("The folder does not contain any sub-folders.")
-
-    def validate_project_type(self):
-        if self._project.type in constances.LIMITED_FUNCTIONS:
-            raise AppValidationException(
-                constances.LIMITED_FUNCTIONS[self._project.type]
-            )
-
-    def execute(self):
-        if self.is_valid():
-            data = self._service_provider.get_project_images_count(self._project).data
-            count = 0
-            if self._folder.name == "root":
-                count += data["images"]["count"]
-                if self._with_all_sub_folders:
-                    for i in data["folders"]["data"]:
-                        count += i["imagesCount"]
-            else:
-                for i in data["folders"]["data"]:
-                    if i["id"] == self._folder.id:
-                        count = i["imagesCount"]
-
-            self._response.data = count
-        return self._response
-
-
 class SetWorkflowUseCase(BaseUseCase):
     def __init__(
         self,

src/superannotate/lib/infrastructure/controller.py

@@ -1073,22 +1073,6 @@ def get_exports(self, project_name: str, return_metadata: bool):
         )
         return use_case.execute()
 
-    def get_project_image_count(
-        self, project_name: str, folder_name: str, with_all_subfolders: bool
-    ):
-
-        project = self.get_project(project_name)
-        folder = self.get_folder(project=project, name=folder_name)
-
-        use_case = usecases.GetProjectImageCountUseCase(
-            service_provider=self.service_provider,
-            project=project,
-            folder=folder,
-            with_all_sub_folders=with_all_subfolders,
-        )
-
-        return use_case.execute()
-
     def download_image(
         self,
         project_name: str,

tests/integration/folders/test_folders.py

@@ -174,27 +174,18 @@ def test_project_folder_image_count(self):
         sa.upload_images_from_folder_to_project(
             self.PROJECT_NAME, self.folder_path, annotation_status="InProgress"
         )
-        num_images = sa.get_project_image_count(self.PROJECT_NAME)
-        self.assertEqual(num_images, 4)
 
         sa.create_folder(self.PROJECT_NAME, self.TEST_FOLDER_NAME_1)
         sa.upload_images_from_folder_to_project(
             self.PROJECT_NAME + f"/{self.TEST_FOLDER_NAME_1}",
             self.folder_path,
             annotation_status="InProgress",
         )
-        num_images = sa.get_project_image_count(self.PROJECT_NAME)
-        self.assertEqual(num_images, 4)
+        num_images = sa.search_items(self.PROJECT_NAME)
+        assert len(num_images) == 4
 
-        num_images = sa.get_project_image_count(
-            self.PROJECT_NAME + f"/{self.TEST_FOLDER_NAME_1}"
-        )
-        self.assertEqual(num_images, 4)
-
-        num_images = sa.get_project_image_count(
-            self.PROJECT_NAME, with_all_subfolders=True
-        )
-        self.assertEqual(num_images, 8)
+        num_images = sa.search_items(f"{self.PROJECT_NAME}/{self.TEST_FOLDER_NAME_1}")
+        assert len(num_images) == 4
 
     def test_delete_items(self):
         sa.create_folder(self.PROJECT_NAME, self.TEST_FOLDER_NAME_1)
@@ -204,26 +195,20 @@ def test_delete_items(self):
             self.folder_path,
             annotation_status="InProgress",
         )
-        num_images = sa.get_project_image_count(
-            self.PROJECT_NAME, with_all_subfolders=True
-        )
-        self.assertEqual(num_images, 4)
+        num_images = sa.search_items(self.PROJECT_NAME)
+        assert len(num_images) == 4
 
         sa.delete_items(
             f"{self.PROJECT_NAME}/{self.TEST_FOLDER_NAME_1}",
             [self.EXAMPLE_IMAGE_2, self.EXAMPLE_IMAGE_3],
         )
-        num_images = sa.get_project_image_count(
-            self.PROJECT_NAME, with_all_subfolders=True
-        )
-        self.assertEqual(num_images, 2)
+        num_images = sa.search_items(self.PROJECT_NAME)
+        assert len(num_images) == 2
 
         sa.delete_items(self.PROJECT_NAME, None)
-        time.sleep(2)
-        num_images = sa.get_project_image_count(
-            self.PROJECT_NAME, with_all_subfolders=False
-        )
-        self.assertEqual(num_images, 0)
+
+        num_images = sa.search_items(self.PROJECT_NAME)
+        assert len(num_images) == 0
 
     @pytest.mark.flaky(reruns=2)
     def test_project_completed_count(self):