Merge pull request #476 from superannotateai/1089_getting_custom_values

added custom fields

Author: VaghinakDev

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

@@ -2318,23 +2318,59 @@ def get_item_metadata(
         self,
         project: NotEmptyStr,
         item_name: NotEmptyStr,
+        include_custom_metadata: bool = False,
     ):
         """Returns item metadata
 
         :param project: project name or folder path (e.g., “project1/folder1”)
         :type project: str
 
-        :param item_name: item name
+        :param item_name: item name.
         :type item_name: str
 
+        :param include_custom_metadata: include custom metadata that has been attached to an asset.
+        :type include_custom_metadata: bool
+
         :return: metadata of item
         :rtype: dict
+
+        Request Example:
+        ::
+            client.get_item_metadata(
+               project="Medical Annotations",
+               item_name = "image_1.png",
+               include_custom_metadata=True
+            )
+
+
+        Response Example:
+        ::
+            {
+               "name": "image_1.jpeg",
+               "path": "Medical Annotations/Study",
+               "url": "https://sa-public-files.s3.../image_1.png",
+               "annotation_status": "NotStarted",
+               "annotator_email": None,
+               "qa_email": None,
+               "entropy_value": None,
+               "createdAt": "2022-02-15T20:46:44.000Z",
+               "updatedAt": "2022-02-15T20:46:44.000Z",
+               "custom_metadata": {
+                   "study_date": "2021-12-31",
+                   "patient_id": "62078f8a756ddb2ca9fc9660",
+                   "patient_sex": "female",
+                   "medical_specialist": "robertboxer@ms.com",
+               }
+            }
         """
         project_name, folder_name = extract_project_folder(project)
-        response = self.controller.get_item(project_name, folder_name, item_name)
+        response = self.controller.get_item(
+            project_name, folder_name, item_name, include_custom_metadata
+        )
+        exclude = {"custom_metadata"} if not include_custom_metadata else {}
         if response.errors:
             raise AppException(response.errors)
-        return BaseSerializer(response.data).serialize()
+        return BaseSerializer(response.data).serialize(exclude=exclude)
 
     def search_items(
         self,
@@ -2344,6 +2380,7 @@ def search_items(
         annotator_email: Optional[NotEmptyStr] = None,
         qa_email: Optional[NotEmptyStr] = None,
         recursive: bool = False,
+        include_custom_metadata: bool = False,
     ):
         """Search items by filtering criteria.
 
@@ -2365,8 +2402,6 @@ def search_items(
                                 ♦ “Completed” \n
                                 ♦ “Skippe
         :type annotation_status: str
-        :type annotation_status: str
-
 
         :param annotator_email: returns those items’ names that are assigned to the specified annotator.
          If None, all items are returned. Strict equal.
@@ -2380,8 +2415,41 @@ def search_items(
          If False search only in the project’s root or given directory.
         :type recursive: bool
 
-        :return: items' metadata
+        :param include_custom_metadata: include custom metadata that has been attached to an asset.
+        :type include_custom_metadata: bool
+
+        :return: metadata of item
         :rtype: list of dicts
+
+        Request Example:
+        ::
+            client.search_items(
+               project="Medical Annotations",
+               name_contains="image_1",
+               include_custom_metadata=True
+            )
+
+        Response Example:
+        ::
+            [
+               {
+                   "name": "image_1.jpeg",
+                   "path": "Medical Annotations/Study",
+                   "url": "https://sa-public-files.s3.../image_1.png",
+                   "annotation_status": "NotStarted",
+                   "annotator_email": None,
+                   "qa_email": None,
+                   "entropy_value": None,
+                   "createdAt": "2022-02-15T20:46:44.000Z",
+                   "updatedAt": "2022-02-15T20:46:44.000Z",
+                   "custom_metadata": {
+                       "study_date": "2021-12-31",
+                       "patient_id": "62078f8a756ddb2ca9fc9660",
+                       "patient_sex": "female",
+                       "medical_specialist": "robertboxer@ms.com",
+                   }
+               }
+            ]
         """
         project_name, folder_name = extract_project_folder(project)
         response = self.controller.list_items(
@@ -2392,10 +2460,12 @@ def search_items(
             annotator_email=annotator_email,
             qa_email=qa_email,
             recursive=recursive,
+            include_custom_metadata=include_custom_metadata,
         )
+        exclude = {"custom_metadata"} if not include_custom_metadata else {}
         if response.errors:
             raise AppException(response.errors)
-        return BaseSerializer.serialize_iterable(response.data)
+        return BaseSerializer.serialize_iterable(response.data, exclude=exclude)
 
     def attach_items(
         self,

src/superannotate/lib/app/serializers.py

@@ -73,11 +73,14 @@ def serialize_iterable(
         fields: Union[List[str], Set[str]] = None,
         by_alias: bool = False,
         flat: bool = False,
+        exclude: Set = None,
     ) -> List[Any]:
         serialized_data = []
         for i in data:
             serialized_data.append(
-                cls._fill_enum_values(cls._serialize(i, fields, by_alias, flat))
+                cls._fill_enum_values(
+                    cls._serialize(i, fields, by_alias, flat, exclude=exclude)
+                )
             )
         return serialized_data
 

src/superannotate/lib/core/__init__.py

@@ -12,10 +12,8 @@
 from superannotate.lib.core.enums import UploadState
 from superannotate.lib.core.enums import UserRole
 
-
 CONFIG = Config()
 
-
 CONFIG_PATH = "~/.superannotate/config.json"
 CONFIG_FILE_LOCATION = expanduser(CONFIG_PATH)
 LOG_FILE_LOCATION = expanduser("~/.superannotate/sa.log")
@@ -49,7 +47,6 @@
 
 AVAILABLE_SEGMENTATION_MODELS = ["autonomous", "generic"]
 
-
 VECTOR_ANNOTATION_POSTFIX = "___objects.json"
 PIXEL_ANNOTATION_POSTFIX = "___pixel.json"
 ANNOTATION_MASK_POSTFIX = "___save.png"
@@ -86,6 +83,9 @@
     ProjectType.DOCUMENT.value: DEPRECATED_DOCUMENT_PROJECTS_MESSAGE,
 }
 
+METADATA_DEPRICATED_FOR_PIXEL = (
+    "custom_metadata field is not supported for project type Pixel."
+)
 DEPRICATED_DOCUMENT_VIDEO_MESSAGE = "The function does not support projects containing videos / documents attached with URLs"
 
 UPLOAD_FOLDER_LIMIT_ERROR_MESSAGE = "The number of items you want to upload exceeds the limit of 50 000 items per folder."
@@ -96,7 +96,6 @@
 ATTACH_PROJECT_LIMIT_ERROR_MESSAGE = "The number of items you want to attach exceeds the limit of 500 000 items per project."
 ATTACH_USER_LIMIT_ERROR_MESSAGE = "The number of items you want to attach  exceeds the limit of your subscription plan."
 
-
 COPY_FOLDER_LIMIT_ERROR_MESSAGE = (
     "The number of items you want to copy exceeds the limit of 50 000 items per folder."
 )
@@ -105,7 +104,6 @@
     "The number of items you want to copy exceeds the limit of your subscription plan."
 )
 
-
 MOVE_FOLDER_LIMIT_ERROR_MESSAGE = (
     "The number of items you want to move exceeds the limit of 50 000 items per folder."
 )

src/superannotate/lib/core/service_types.py

@@ -1,4 +1,5 @@
 from typing import Any
+from typing import Callable
 from typing import Dict
 from typing import List
 from typing import Optional
@@ -79,30 +80,55 @@ class ServiceResponse(BaseModel):
     reason: str
     content: Union[bytes, str]
     data: Any
+    count: Optional[int] = 0
+    _error: str
 
-    def __init__(self, response, content_type=None):
+    class Config:
+        extra = Extra.allow
+
+    def __init__(self, response, content_type=None, dispatcher: Callable = None):
         data = {
             "status": response.status_code,
             "reason": response.reason,
             "content": response.content,
         }
+        try:
+            response_json = response.json()
+        except Exception:
+            response_json = dict()
+        if not response.ok:
+            data["_error"] = response_json.get("error", "Unknown Error")
+            data["data"] = response_json
+            super().__init__(**data)
+            return
+        if dispatcher:
+            _data = response_json
+            response_json = dispatcher(_data)
+            data.update(_data)
         try:
             if content_type and content_type is not self.__class__:
-                data["data"] = parse_obj_as(content_type, response.json())
+                data["data"] = parse_obj_as(content_type, response_json)
             else:
-                data["data"] = response.json()
-        except Exception as e:
+                data["data"] = response_json
+        except Exception:
             data["data"] = {}
+
         super().__init__(**data)
 
+    @property
+    def status_code(self):
+        return self.status
+
     @property
     def ok(self):
         return 199 < self.status < 300
 
     @property
     def error(self):
+        if self._error:
+            return self._error
         default_message = self.reason if self.reason else "Unknown Error"
-        if isinstance(self.data, dict):
+        if isinstance(self.data, dict) and "error" in self.data:
             return self.data.get("error", default_message)
         else:
             return getattr(self.data, "error", default_message)

src/superannotate/lib/core/serviceproviders.py

@@ -95,6 +95,9 @@ def create_folder(self, project_id: int, team_id: int, folder_name: str):
     def update_folder(self, project_id: int, team_id: int, folder_data: dict):
         raise NotImplementedError
 
+    def list_items(self, query_params: str) -> ServiceResponse:
+        raise NotImplementedError
+
     def get_download_token(
         self,
         project_id: int,