Added dynamic behaviour to schemas

Author: Vaghinak Basentsyan

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

@@ -3656,7 +3656,7 @@ def validate_annotations(
         """
     with open(annotations_json) as file:
         annotation_data = json.loads(file.read())
-        response = controller.validate_annotations(project_type, annotation_data)
+        response = controller.validate_annotations(project_type, annotation_data, allow_extra=False)
         if response.errors:
             raise AppException(response.errors)
         is_valid, _ = response.data

src/superannotate/lib/core/entities/utils.py

@@ -27,7 +27,9 @@ def enum_error_handling(self) -> str:
 
 
 class BaseModel(PyDanticBaseModel):
+
     class Config:
+        # extra = "forbid"
         use_enum_values = True
         error_msg_templates = {
             "type_error.integer": "integer type expected",

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

@@ -3154,12 +3154,17 @@ def execute(self):
 
 class ValidateAnnotationUseCase(BaseUseCase):
     def __init__(
-        self, project_type: str, annotation: dict, validators: BaseAnnotationValidator
+            self,
+            project_type: str,
+            annotation: dict,
+            validators: BaseAnnotationValidator,
+            allow_extra: bool = True
     ):
         super().__init__()
         self._project_type = project_type
         self._annotation = annotation
         self._validators = validators
+        self._allow_extra = allow_extra
 
     def execute(self) -> Response:
         validator = None
@@ -3172,7 +3177,7 @@ def execute(self) -> Response:
         elif self._project_type.lower() == constances.ProjectType.DOCUMENT.name.lower():
             validator = self._validators.get_document_validator()
         if validator:
-            validator = validator(self._annotation)
+            validator = validator(self._annotation, allow_extra=self._allow_extra)
             if validator.is_valid():
                 self._response.data = True, validator.data
             else:

src/superannotate/lib/core/validators.py

@@ -1,24 +1,29 @@
+import copy
 from abc import ABCMeta
 from abc import abstractmethod
 from typing import Any
 from typing import Type
 
 from pydantic import BaseModel
+from pydantic import Extra
 
 
 class BaseValidator(metaclass=ABCMeta):
     MODEL: BaseModel()
 
-    def __init__(self, data: Any):
+    def __init__(self, data: Any, allow_extra: bool = True):
         self.data = data
         self._validation_output = None
+        self._extra = Extra.ignore if allow_extra else Extra.forbid
 
     @classmethod
-    def validate(cls, data: Any):
+    def validate(cls, data: Any, extra=True):
         return cls.MODEL(**data)
 
     def _validate(self):
-        self.data = self.validate(self.data).dict(by_alias=True, exclude_none=True)
+        model = copy.deepcopy(self.MODEL)
+        model.Config.extra = self._extra
+        self.data = model(**self.data).dict(by_alias=True, exclude_none=True)
 
     @abstractmethod
     def is_valid(self) -> bool:

src/superannotate/lib/infrastructure/controller.py

@@ -1642,8 +1642,10 @@ def delete_annotations(
         )
         return use_case.execute()
 
-    def validate_annotations(self, project_type: str, annotation: dict):
+    def validate_annotations(self, project_type: str, annotation: dict, allow_extra: bool = False):
         use_case = usecases.ValidateAnnotationUseCase(
-            project_type, annotation, validators=self.annotation_validators
+            project_type, annotation,
+            validators=self.annotation_validators,
+            allow_extra=allow_extra
         )
         return use_case.execute()

tests/unit/test_validators.py

@@ -16,11 +16,11 @@
     "width": 1024,
     "height": 683,
     "status": "Completed",
-    "pinned": false,
-    "isPredicted": null,
-    "projectId": null,
-    "annotatorEmail": null,
-    "qaEmail": null
+    "pinned": False,
+    "isPredicted": None,
+    "projectId": None,
+    "annotatorEmail": None,
+    "qaEmail": None
   },
   "instances": [
     {
@@ -35,8 +35,8 @@
       },
       "groupId": 0,
       "pointLabels": {},
-      "locked": false,
-      "visible": false,
+      "locked": False,
+      "visible": False,
       "attributes": [
         {
           "id": 117845,
@@ -46,12 +46,12 @@
         }
       ],
       "trackingId": "aaa97f80c9e54a5f2dc2e920fc92e5033d9af45b",
-      "error": null,
-      "createdAt": null,
-      "createdBy": null,
-      "creationType": null,
-      "updatedAt": null,
-      "updatedBy": null,
+      "error": None,
+      "createdAt": None,
+      "createdBy": None,
+      "creationType": None,
+      "updatedAt": None,
+      "updatedBy": None,
       "className": "Personal vehicle"
     }
   ]
@@ -112,11 +112,11 @@ class TestTypeHandling(TestCase):
         "width": 1024,
         "height": 683,
         "status": "Completed",
-        "pinned": false,
-        "isPredicted": null,
-        "projectId": null,
-        "annotatorEmail": null,
-        "qaEmail": null
+        "pinned": False,
+        "isPredicted": None,
+        "projectId": None,
+        "annotatorEmail": None,
+        "qaEmail": None
         },
         "instances": [
         {
@@ -131,8 +131,8 @@ class TestTypeHandling(TestCase):
           },
           "groupId": 0,
           "pointLabels": {},
-          "locked": false,
-          "visible": false,
+          "locked": False,
+          "visible": False,
           "attributes": [
             {
               "id": 117845,
@@ -142,12 +142,12 @@ class TestTypeHandling(TestCase):
             }
           ],
           "trackingId": "aaa97f80c9e54a5f2dc2e920fc92e5033d9af45b",
-          "error": null,
-          "createdAt": null,
-          "createdBy": null,
-          "creationType": null,
-          "updatedAt": null,
-          "updatedBy": null,
+          "error": None,
+          "createdAt": None,
+          "createdBy": None,
+          "creationType": None,
+          "updatedAt": None,
+          "updatedBy": None,
           "className": "Personal vehicle"
         }
         ]
@@ -171,4 +171,4 @@ def test_validate_annotation_with_wrong_bbox(self):
                     "instances[0]invalidtype,validtypesisbbox,"
                     "template,cuboid,polygon,point,polyline,ellipse,rbbox",
                     out.getvalue().strip().replace(" ", "")
-                )
+                )