Merge pull request #474 from superannotateai/1191_default_attributes

Added default_value handeling

Author: VaghinakDev

src/superannotate/lib/core/reporter.py

@@ -96,7 +96,7 @@ def log_warning(self, value: str):
         self.warning_messages.append(value)
 
     def log_error(self, value: str):
-        self.logger.warning(value)
+        self.logger.error(value)
 
     def log_debug(self, value: str):
         if self._log_debug:

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

@@ -120,7 +120,7 @@ def __init__(
     def execute(self) -> Response:
         uploaded_items, failed_items = [], []
         self.reporter.log_info(
-            " Validating metadata against the schema of the custom fields. "
+            "Validating metadata against the schema of the custom fields. "
             "Valid metadata will be attached to the specified item."
         )
         with self.reporter.spinner:
@@ -138,11 +138,13 @@ def execute(self) -> Response:
 
         if failed_items:
             self.reporter.log_error(
-                f"""The metadata dicts of {len(failed_items)} items are invalid because they don't match
-                 the schema of the custom fields defined for the "{self._project.name}" project."""
+                f"The metadata dicts of {len(failed_items)} items are invalid because they don't match"
+                f'the schema of the custom fields defined for the "{self._project.name}" project.'
             )
         self._response.data = {
-            "succeeded": list({list(item)[0] for item in self._items} ^ set(failed_items)),
+            "succeeded": list(
+                {list(item)[0] for item in self._items} ^ set(failed_items)
+            ),
             "failed": failed_items,
         }
         return self._response

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

@@ -1953,7 +1953,7 @@ def validate_uniqueness(self):
                 if annotation_class.name == self._annotation_class.name
             ]
         ):
-            raise AppValidationException("Annotation class already exits.")
+            raise AppValidationException("Annotation class already exists.")
 
     def validate_project_type(self):
         if (
@@ -1964,6 +1964,15 @@ def validate_project_type(self):
                 f"Predefined tagging functionality is not supported for projects of type {ProjectType.get_name(self._project.type)}."
             )
 
+    def validate_default_value(self):
+        if self._project.type == ProjectType.PIXEL.value and any(
+            getattr(attr_group, "default_value", None)
+            for attr_group in getattr(self._annotation_class, "attribute_groups", [])
+        ):
+            raise AppException(
+                'The "default_value" key is not supported for project type Pixel.'
+            )
+
     def execute(self):
         if self.is_valid():
             logger.info(
@@ -2079,6 +2088,17 @@ def validate_project_type(self):
                 f"Predefined tagging functionality is not supported for projects of type {ProjectType.get_name(self._project.type)}."
             )
 
+    def validate_default_value(self):
+        if self._project.type == ProjectType.PIXEL.value:
+            for annotation_class in self._annotation_classes:
+                if any(
+                    getattr(attr_group, "default_value", None)
+                    for attr_group in getattr(annotation_class, "attribute_groups", [])
+                ):
+                    raise AppException(
+                        'The "default_value" key is not supported for project type Pixel.'
+                    )
+
     def execute(self):
         if self.is_valid():
             existing_annotation_classes = self._annotation_classes_repo.get_all()

tests/integration/base.py

@@ -1,7 +1,7 @@
 from unittest import TestCase
 
 from src.superannotate import SAClient
-from tests import DATA_SET_PATH
+
 
 sa = SAClient()
 

tests/integration/classes/test_create_annotation_class.py

@@ -1,11 +1,12 @@
 import os
-from os.path import dirname
 import tempfile
 
+from src.superannotate import AppException
 from src.superannotate import SAClient
-sa = SAClient()
-from tests.integration.base import BaseTestCase
 from tests import DATA_SET_PATH
+from tests.integration.base import BaseTestCase
+
+sa = SAClient()
 
 
 class TestCreateAnnotationClass(BaseTestCase):
@@ -33,6 +34,46 @@ def test_hex_color_adding(self):
         classes = sa.search_annotation_classes(self.PROJECT_NAME, "test_add")
         assert classes[0]["color"] == "#0000FF"
 
+    def test_create_annotation_class_with_default_attribute(self):
+        sa.create_annotation_class(
+            self.PROJECT_NAME,
+            "test_add",
+            "#FF0000",
+            class_type="tag",
+            attribute_groups=[
+                {
+                    "name": "test",
+                    "attributes": [{"name": "Car"}, {"name": "Track"}, {"name": "Bus"}],
+                    "default_value": "Bus"
+                }
+            ]
+        )
+        classes = sa.search_annotation_classes(self.PROJECT_NAME)
+        assert classes[0]['attribute_groups'][0]["default_value"] == "Bus"
+
+    def test_create_annotation_classes_with_default_attribute(self):
+        sa.create_annotation_classes_from_classes_json(
+            self.PROJECT_NAME,
+            classes_json=[
+                {
+                    "name": "Personal vehicle",
+                    "color": "#ecb65f",
+                    "count": 25,
+                    "createdAt": "2020-10-12T11:35:20.000Z",
+                    "updatedAt": "2020-10-12T11:48:19.000Z",
+                    "attribute_groups": [
+                        {
+                            "name": "test",
+                            "attributes": [{"name": "Car"}, {"name": "Track"}, {"name": "Bus"}],
+                            "default_value": "Bus"
+                        }
+                    ]
+                }
+            ]
+        )
+        classes = sa.search_annotation_classes(self.PROJECT_NAME)
+        assert classes[0]['attribute_groups'][0]["default_value"] == "Bus"
+
 
 class TestCreateAnnotationClassNonVectorWithError(BaseTestCase):
     PROJECT_NAME = "TestCreateAnnotationClassNonVectorWithError"
@@ -95,3 +136,50 @@ def test_create_annotation_class(self):
                 msg = str(e)
             self.assertEqual(msg, "Predefined tagging functionality is not supported for projects of type Video.")
 
+
+class TestCreateAnnotationClassPixel(BaseTestCase):
+    PROJECT_NAME = "TestCreateAnnotationClassPixel"
+    PROJECT_TYPE = "Pixel"
+    PROJECT_DESCRIPTION = "Example "
+    TEST_LARGE_CLASSES_JSON = "large_classes_json.json"
+
+    @property
+    def large_json_path(self):
+        return os.path.join(DATA_SET_PATH, self.TEST_LARGE_CLASSES_JSON)
+
+    def test_create_annotation_class_with_default_attribute(self):
+        with self.assertRaisesRegexp(AppException, 'The "default_value" key is not supported for project type Pixel.'):
+            sa.create_annotation_class(
+                self.PROJECT_NAME,
+                "test_add",
+                "#FF0000",
+                attribute_groups=[
+                    {
+                        "name": "test",
+                        "attributes": [{"name": "Car"}, {"name": "Track"}, {"name": "Bus"}],
+                        "default_value": "Bus"
+                    }
+                ]
+            )
+
+    def test_create_annotation_classes_with_default_attribute(self):
+        with self.assertRaisesRegexp(AppException, 'The "default_value" key is not supported for project type Pixel.'):
+            sa.create_annotation_classes_from_classes_json(
+                self.PROJECT_NAME,
+                classes_json=[
+                    {
+                        "name": "Personal vehicle",
+                        "color": "#ecb65f",
+                        "count": 25,
+                        "createdAt": "2020-10-12T11:35:20.000Z",
+                        "updatedAt": "2020-10-12T11:48:19.000Z",
+                        "attribute_groups": [
+                            {
+                                "name": "test",
+                                "attributes": [{"name": "Car"}, {"name": "Track"}, {"name": "Bus"}],
+                                "default_value": "Bus"
+                            }
+                        ]
+                    }
+                ]
+            )

tests/integration/projects/test_create_project_from_metadata.py

@@ -0,0 +1,47 @@
+from unittest import TestCase
+
+from src.superannotate import SAClient
+
+sa = SAClient()
+
+
+class CreateProjectFromMetadata(TestCase):
+    PROJECT_1 = "pr_1"
+    PROJECT_2 = "pr_2"
+
+    def setUp(self) -> None:
+        self.tearDown()
+
+    def tearDown(self) -> None:
+        for project_name in self.PROJECT_1, self.PROJECT_2:
+            try:
+                sa.delete_project(project_name)
+            except Exception:
+                pass
+
+    def test_create_project_with_default_attribute(self):
+        sa.create_project(self.PROJECT_1, project_type="Vector", project_description="Desc")
+        sa.create_annotation_classes_from_classes_json(
+            self.PROJECT_1,
+            classes_json=[
+                {
+                    "name": "Personal vehicle",
+                    "color": "#ecb65f",
+                    "count": 25,
+                    "createdAt": "2020-10-12T11:35:20.000Z",
+                    "updatedAt": "2020-10-12T11:48:19.000Z",
+                    "attribute_groups": [
+                        {
+                            "name": "test",
+                            "attributes": [{"name": "Car"}, {"name": "Track"}, {"name": "Bus"}],
+                            "default_value": "Bus"
+                        }
+                    ]
+                }
+            ]
+        )
+        pr_1_metadata = sa.get_project_metadata(self.PROJECT_1, include_annotation_classes=True)
+        pr_1_metadata["name"] = self.PROJECT_2
+        sa.create_project_from_metadata(pr_1_metadata)
+        pr_2_metadata = sa.get_project_metadata(self.PROJECT_2, include_annotation_classes=True)
+        assert pr_2_metadata["classes"][0]["attribute_groups"][0]["default_value"] == "Bus"