Merge pull request #586 from superannotateai/1821_implementation

added OCR groupe type validation in class creation

Author: VaghinakDev

docs/source/api_reference/api_folder.rst

@@ -8,4 +8,4 @@ Folders
 .. automethod:: superannotate.SAClient.get_folder_by_id
 .. automethod:: superannotate.SAClient.get_folder_metadata
 .. automethod:: superannotate.SAClient.create_folder
-.. automethod:: superannotate.SAClient.delete_folders
+.. automethod:: superannotate.SAClient.delete_folders

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

@@ -1,3 +1,4 @@
+import nest_asyncio
 from lib.core.usecases.annotations import *  # noqa: F403 F401
 from lib.core.usecases.classes import *  # noqa: F403 F401
 from lib.core.usecases.custom_fields import *  # noqa: F403 F401
@@ -8,5 +9,4 @@
 from lib.core.usecases.models import *  # noqa: F403 F401
 from lib.core.usecases.projects import *  # noqa: F403 F401
 
-import nest_asyncio
-nest_asyncio.apply()
+nest_asyncio.apply()

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

@@ -6,6 +6,7 @@
 from lib.core.conditions import CONDITION_EQ as EQ
 from lib.core.entities import AnnotationClassEntity
 from lib.core.entities import ProjectEntity
+from lib.core.entities.classes import GroupTypeEnum
 from lib.core.enums import ProjectType
 from lib.core.exceptions import AppException
 from lib.core.serviceproviders import BaseServiceProvider
@@ -66,6 +67,13 @@ def validate_project_type(self):
                 "Predefined tagging functionality is not supported for projects"
                 f" of type {ProjectType.get_name(self._project.type)}."
             )
+        if self._project.type != ProjectType.VECTOR:
+            for g in self._annotation_class.attribute_groups:
+                if g.group_type == GroupTypeEnum.OCR:
+                    raise AppException(
+                        f"OCR attribute group is not supported for project type "
+                        f"{ProjectType.get_name(self._project.type)}."
+                    )
 
     def validate_default_value(self):
         if self._project.type == ProjectType.PIXEL.value and any(
@@ -109,13 +117,19 @@ def __init__(
         self._annotation_classes = annotation_classes
 
     def validate_project_type(self):
-        if self._project.type == ProjectType.PIXEL and any(
-            [True for i in self._annotation_classes if i.type == "tag"]
-        ):
-            raise AppException(
-                f"Predefined tagging functionality is not supported"
-                f" for projects of type {ProjectType.get_name(self._project.type)}."
-            )
+        if self._project.type != ProjectType.VECTOR:
+            for c in self._annotation_classes:
+                if self._project.type == ProjectType.PIXEL and c.type == "tag":
+                    raise AppException(
+                        f"Predefined tagging functionality is not supported"
+                        f" for projects of type {ProjectType.get_name(self._project.type)}."
+                    )
+                for g in c.attribute_groups:
+                    if g.group_type == GroupTypeEnum.OCR:
+                        raise AppException(
+                            f"OCR attribute group is not supported for project type "
+                            f"{ProjectType.get_name(self._project.type)}."
+                        )
 
     def validate_default_value(self):
         if self._project.type == ProjectType.PIXEL.value:

tests/integration/classes/test_classes_serialization.py

@@ -78,6 +78,6 @@ def test_group_type_wrong_arg(self):
                 "'radio',",
                 "'checklist',",
                 "'numeric',",
-                "'text'",
+                "'text',",
                 "'ocr'",
             ] == wrap_error(e).split()

tests/integration/classes/test_create_annotation_class.py

@@ -245,6 +245,71 @@ def test_create_annotation_class(self):
                 "Predefined tagging functionality is not supported for projects of type Video.",
             )
 
+    def test_create_annotation_class_via_ocr_group_type(self):
+        with self.assertRaisesRegexp(
+            AppException,
+            f"OCR attribute group is not supported for project type {self.PROJECT_TYPE}.",
+        ):
+            attribute_groups = [
+                {
+                    "id": 21448,
+                    "class_id": 56820,
+                    "name": "Large",
+                    "group_type": "ocr",
+                    "is_multiselect": 0,
+                    "createdAt": "2020-09-29T10:39:39.000Z",
+                    "updatedAt": "2020-09-29T10:39:39.000Z",
+                    "attributes": [],
+                }
+            ]
+            sa.create_annotation_class(
+                self.PROJECT_NAME,
+                "test_add",
+                "#FF0000",
+                attribute_groups,
+                class_type="tag",
+            )
+
+    def test_create_annotation_class_via_json_and_ocr_group_type(self):
+        with tempfile.TemporaryDirectory() as tmpdir_name:
+            temp_path = f"{tmpdir_name}/new_classes.json"
+            with open(temp_path, "w") as new_classes:
+                new_classes.write(
+                    """
+                    [
+                       {
+                          "id":56820,
+                          "project_id":7617,
+                          "name":"Personal vehicle",
+                          "color":"#547497",
+                          "count":18,
+                          "createdAt":"2020-09-29T10:39:39.000Z",
+                          "updatedAt":"2020-09-29T10:48:18.000Z",
+                          "type": "tag",
+                          "attribute_groups":[
+                             {
+                                "id":21448,
+                                "class_id":56820,
+                                "name":"Large",
+                                "group_type": "ocr",
+                                "is_multiselect":0,
+                                "createdAt":"2020-09-29T10:39:39.000Z",
+                                "updatedAt":"2020-09-29T10:39:39.000Z",
+                                "attributes":[]
+                             }
+                          ]
+                       }
+                    ]
+                    """
+                )
+            with self.assertRaisesRegexp(
+                AppException,
+                f"OCR attribute group is not supported for project type {self.PROJECT_TYPE}.",
+            ):
+                sa.create_annotation_classes_from_classes_json(
+                    self.PROJECT_NAME, temp_path
+                )
+
 
 class TestCreateAnnotationClassPixel(BaseTestCase):
     PROJECT_NAME = "TestCreateAnnotationClassPixel"

tests/integration/folders/test_set_folder_status.py

@@ -34,9 +34,7 @@ def tearDownClass(cls) -> None:
 
     def test_set_folder_status(self):
         with self.assertLogs("sa", level="INFO") as cm:
-            for index, status in enumerate(
-                self.FOLDER_STATUSES
-            ):
+            for index, status in enumerate(self.FOLDER_STATUSES):
                 sa.set_folder_status(
                     project=self.PROJECT_NAME, folder=self.FOLDER_NAME, status=status
                 )

tests/integration/projects/test_set_project_status.py

@@ -30,9 +30,7 @@ def tearDownClass(cls) -> None:
 
     def test_set_project_status(self):
         with self.assertLogs("sa", level="INFO") as cm:
-            for index, status in enumerate(
-                self.PROJECT_STATUSES
-            ):
+            for index, status in enumerate(self.PROJECT_STATUSES):
                 sa.set_project_status(project=self.PROJECT_NAME, status=status)
                 project = sa.get_project_metadata(self.PROJECT_NAME)
                 assert (

tests/unit/test_async_functions.py

@@ -1,7 +1,7 @@
 import asyncio
+from unittest import TestCase
 
 from superannotate import SAClient
-from unittest import TestCase
 
 
 sa = SAClient()
@@ -54,6 +54,7 @@ def test_get_annotations_in_running_event_loop(self):
         async def _test():
             annotations = sa.get_annotations(self.PROJECT_NAME)
             assert len(annotations) == 4
+
         asyncio.run(_test())
 
     def test_create_task_get_annotations_in_running_event_loop(self):
@@ -62,25 +63,29 @@ async def _test():
             task2 = asyncio.create_task(self.nested())
             await task1
             await task2
+
         asyncio.run(_test())
 
     def test_gather_get_annotations_in_running_event_loop(self):
         async def gather_test():
             await asyncio.gather(self.nested(), self.nested())
+
         asyncio.run(gather_test())
 
     def test_gather_async_for(self):
         async def gather_test():
             async for _ in DummyIterator(delay=0.01, to=2):
                 annotations = sa.get_annotations(TestAsyncFunctions.PROJECT_NAME)
                 assert len(annotations) == 4
+
         asyncio.run(gather_test())
 
     def test_upload_annotations_in_running_event_loop(self):
         async def _test():
             sa.attach_items(self.PROJECT_NAME, self.ATTACH_PAYLOAD)
-            annotations = sa.upload_annotations(self.PROJECT_NAME, annotations=self.UPLOAD_PAYLOAD)
-            assert len(annotations['succeeded']) == 4
-        asyncio.run(_test())
-
+            annotations = sa.upload_annotations(
+                self.PROJECT_NAME, annotations=self.UPLOAD_PAYLOAD
+            )
+            assert len(annotations["succeeded"]) == 4
 
+        asyncio.run(_test())