service response serialzier update

Author: VaghinakDev

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

@@ -29,9 +29,9 @@ def version():
 
     @staticmethod
     def init(
-            token: str,
-            logging_level: str = "INFO",
-            logging_path: str = constances.LOG_FILE_LOCATION,
+        token: str,
+        logging_level: str = "INFO",
+        logging_path: str = constances.LOG_FILE_LOCATION,
     ):
         """
         To initialize CLI (and SDK) with team token
@@ -53,7 +53,7 @@ def init(
         if Path(constances.CONFIG_INI_FILE_LOCATION).exists():
             operation = "updated"
             if not input(
-                    f"File {constances.CONFIG_INI_FILE_LOCATION} exists. Do you want to overwrite? [y/n] : "
+                f"File {constances.CONFIG_INI_FILE_LOCATION} exists. Do you want to overwrite? [y/n] : "
             ).lower() in ("y", "yes"):
                 return
         else:
@@ -84,14 +84,14 @@ def create_folder(self, project: str, name: str):
         sys.exit(0)
 
     def upload_images(
-            self,
-            project: str,
-            folder: str,
-            extensions: str = constances.DEFAULT_IMAGE_EXTENSIONS,
-            set_annotation_status: str = constances.AnnotationStatus.NOT_STARTED.name,
-            exclude_file_patterns=constances.DEFAULT_FILE_EXCLUDE_PATTERNS,
-            recursive_subfolders=False,
-            image_quality_in_editor=None,
+        self,
+        project: str,
+        folder: str,
+        extensions: str = constances.DEFAULT_IMAGE_EXTENSIONS,
+        set_annotation_status: str = constances.AnnotationStatus.NOT_STARTED.name,
+        exclude_file_patterns=constances.DEFAULT_FILE_EXCLUDE_PATTERNS,
+        recursive_subfolders=False,
+        image_quality_in_editor=None,
     ):
         """
         To upload images from folder to project use:
@@ -115,12 +115,12 @@ def upload_images(
         sys.exit(0)
 
     def export_project(
-            self,
-            project,
-            folder,
-            include_fuse=False,
-            disable_extract_zip_contents=False,
-            annotation_statuses=None,
+        self,
+        project,
+        folder,
+        include_fuse=False,
+        disable_extract_zip_contents=False,
+        annotation_statuses=None,
     ):
         project_name, folder_name = split_project_path(project)
         folders = None
@@ -146,7 +146,7 @@ def export_project(
         sys.exit(0)
 
     def upload_annotations(
-            self, project, folder, dataset_name=None, task=None, format=None
+        self, project, folder, dataset_name=None, task=None, format=None
     ):
         """
         To upload annotations from folder to project use
@@ -196,10 +196,10 @@ def _upload_annotations(self, project, folder, format, dataset_name, task):
         sys.exit(0)
 
     def attach_image_urls(
-            self,
-            project: str,
-            attachments: str,
-            annotation_status: Optional[Any] = "NotStarted",
+        self,
+        project: str,
+        attachments: str,
+        annotation_status: Optional[Any] = "NotStarted",
     ):
         """
         To attach image URLs to project use:
@@ -213,10 +213,10 @@ def attach_image_urls(
         sys.exit(0)
 
     def attach_video_urls(
-            self,
-            project: str,
-            attachments: str,
-            annotation_status: Optional[Any] = "NotStarted",
+        self,
+        project: str,
+        attachments: str,
+        annotation_status: Optional[Any] = "NotStarted",
     ):
         SAClient().attach_items(
             project=project,
@@ -227,7 +227,7 @@ def attach_video_urls(
 
     @staticmethod
     def attach_document_urls(
-            project: str, attachments: str, annotation_status: Optional[Any] = "NotStarted"
+        project: str, attachments: str, annotation_status: Optional[Any] = "NotStarted"
     ):
         SAClient().attach_items(
             project=project,
@@ -237,15 +237,15 @@ def attach_document_urls(
         sys.exit(0)
 
     def upload_videos(
-            self,
-            project,
-            folder,
-            target_fps=None,
-            recursive=False,
-            extensions=constances.DEFAULT_VIDEO_EXTENSIONS,
-            set_annotation_status=constances.AnnotationStatus.NOT_STARTED.name,
-            start_time=0.0,
-            end_time=None,
+        self,
+        project,
+        folder,
+        target_fps=None,
+        recursive=False,
+        extensions=constances.DEFAULT_VIDEO_EXTENSIONS,
+        set_annotation_status=constances.AnnotationStatus.NOT_STARTED.name,
+        start_time=0.0,
+        end_time=None,
     ):
         """
         To upload videos from folder to project use

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

@@ -30,6 +30,8 @@ class Config:
 
 
 class DocumentEntity(BaseItemEntity):
+    approval_status: Optional[ApprovalStatus] = Field(None)
+
     class Config:
         extra = Extra.ignore
 

src/superannotate/lib/core/service_types.py

@@ -5,6 +5,7 @@
 from typing import Union
 
 from lib.core import entities
+from lib.core.exceptions import AppException
 from pydantic import BaseModel
 from pydantic import Extra
 from pydantic import Field
@@ -90,13 +91,23 @@ class ServiceResponse(BaseModel):
     status: Optional[int]
     reason: Optional[str]
     content: Optional[Union[bytes, str]] = None
-    data: Optional[Any] = None
+    res_data: Optional[Any] = None  # response data
+    res_error: Optional[str] = None
     count: Optional[int] = 0
-    _error: Optional[str] = None
 
     class Config:
         extra = Extra.allow
 
+    @property
+    def data(self):
+        if self.error:
+            raise AppException(self.error)
+        return self.res_data
+
+    @data.setter
+    def data(self, value):
+        self.res_data = value
+
     @property
     def status_code(self):
         return self.status
@@ -109,114 +120,115 @@ def ok(self):
 
     @property
     def error(self):
-        if self._error:
-            return self._error
-        return self.data
+        if self.res_error:
+            return self.res_error
+        if not self.ok:
+            return self.res_data
 
     def set_error(self, value: Union[dict, str]):
         if isinstance(value, dict) and "error" in value:
-            self._error = value["error"]
-        self._error = value
+            self.res_error = value["error"]
+        self.res_error = value
 
     def __str__(self):
         return f"Status: {self.status_code}, Error {self.error}"
 
 
 class ImageResponse(ServiceResponse):
-    data: entities.ImageEntity = None
+    res_data: entities.ImageEntity = None
 
 
 class VideoResponse(ServiceResponse):
-    data: entities.VideoEntity = None
+    res_data: entities.VideoEntity = None
 
 
 class DocumentResponse(ServiceResponse):
-    data: entities.DocumentEntity = None
+    res_data: entities.DocumentEntity = None
 
 
 class TiledResponse(ServiceResponse):
-    data: entities.TiledEntity = None
+    res_data: entities.TiledEntity = None
 
 
 class ClassificationResponse(ServiceResponse):
-    data: entities.ClassificationEntity = None
+    res_data: entities.ClassificationEntity = None
 
 
 class PointCloudResponse(ServiceResponse):
-    data: entities.PointCloudEntity = None
+    res_data: entities.PointCloudEntity = None
 
 
 class TeamResponse(ServiceResponse):
-    data: entities.TeamEntity = None
+    res_data: entities.TeamEntity = None
 
 
 class UserResponse(ServiceResponse):
-    data: entities.UserEntity = None
+    res_data: entities.UserEntity = None
 
 
 class ModelListResponse(ServiceResponse):
-    data: List[entities.AnnotationClassEntity] = None
+    res_data: List[entities.AnnotationClassEntity] = None
 
 
 class _IntegrationResponse(ServiceResponse):
     integrations: List[entities.IntegrationEntity] = []
 
 
 class IntegrationListResponse(ServiceResponse):
-    data: _IntegrationResponse
+    res_data: _IntegrationResponse
 
 
 class AnnotationClassListResponse(ServiceResponse):
-    data: List[entities.AnnotationClassEntity] = None
+    res_data: List[entities.AnnotationClassEntity] = None
 
 
 class SubsetListResponse(ServiceResponse):
-    data: List[entities.SubSetEntity] = None
+    res_data: List[entities.SubSetEntity] = None
 
 
 class SubsetResponse(ServiceResponse):
-    data: entities.SubSetEntity = None
+    res_data: entities.SubSetEntity = None
 
 
 class DownloadMLModelAuthDataResponse(ServiceResponse):
-    data: DownloadMLModelAuthData = None
+    res_data: DownloadMLModelAuthData = None
 
 
 class UploadAnnotationsResponse(ServiceResponse):
-    data: Optional[UploadAnnotations] = None
+    res_data: Optional[UploadAnnotations] = None
 
 
 class UploadAnnotationAuthDataResponse(ServiceResponse):
-    data: UploadAnnotationAuthData = None
+    res_data: UploadAnnotationAuthData = None
 
 
 class UploadCustomFieldValuesResponse(ServiceResponse):
-    data: UploadCustomFieldValues = None
+    res_data: UploadCustomFieldValues = None
 
 
 class UserLimitsResponse(ServiceResponse):
-    data: UserLimits = None
+    res_data: UserLimits = None
 
 
 class ItemListResponse(ServiceResponse):
-    data: List[entities.BaseItemEntity] = None
+    res_data: List[entities.BaseItemEntity] = None
 
 
 class FolderResponse(ServiceResponse):
-    data: entities.FolderEntity = None
+    res_data: entities.FolderEntity = None
 
 
 class FolderListResponse(ServiceResponse):
-    data: List[entities.FolderEntity] = None
+    res_data: List[entities.FolderEntity] = None
 
 
 class ProjectResponse(ServiceResponse):
-    data: entities.ProjectEntity = None
+    res_data: entities.ProjectEntity = None
 
 
 class ProjectListResponse(ServiceResponse):
-    data: List[entities.ProjectEntity] = None
+    res_data: List[entities.ProjectEntity] = None
 
 
 class SettingsListResponse(ServiceResponse):
-    data: List[entities.SettingEntity] = None
+    res_data: List[entities.SettingEntity] = None