fix get_things_by_id

Author: VaghinakDev

docs/source/superannotate.sdk.rst

@@ -25,11 +25,13 @@ ________
 .. automethod:: superannotate.SAClient.delete_project
 .. automethod:: superannotate.SAClient.rename_project
 .. _ref_get_project_metadata:
+.. automethod:: superannotate.SAClient.get_project_by_id
 .. automethod:: superannotate.SAClient.get_project_metadata
 .. automethod:: superannotate.SAClient.get_project_image_count
 .. automethod:: superannotate.SAClient.search_folders
 .. automethod:: superannotate.SAClient.assign_folder
 .. automethod:: superannotate.SAClient.unassign_folder
+.. automethod:: superannotate.SAClient.get_folder_by_id
 .. automethod:: superannotate.SAClient.get_folder_metadata
 .. automethod:: superannotate.SAClient.create_folder
 .. automethod:: superannotate.SAClient.delete_folders
@@ -68,6 +70,7 @@ Items
 ______
 
 .. automethod:: superannotate.SAClient.query
+.. automethod:: superannotate.SAClient.get_item_by_id
 .. automethod:: superannotate.SAClient.search_items
 .. automethod:: superannotate.SAClient.download_annotations
 .. automethod:: superannotate.SAClient.attach_items

src/superannotate/lib/app/analytics/aggregators.py

@@ -9,13 +9,13 @@
 import lib.core as constances
 import pandas as pd
 from lib.app.exceptions import AppException
-from lib.core import ATTACHED_VIDEO_ANNOTATION_POSTFIX
 from lib.core import PIXEL_ANNOTATION_POSTFIX
 from lib.core import VECTOR_ANNOTATION_POSTFIX
 from superannotate.logger import get_default_logger
 
 logger = get_default_logger()
 
+
 @dataclass
 class ImageRowData:
     itemName: str = None
@@ -50,6 +50,7 @@ class ImageRowData:
     commentResolved: str = None
     tag: str = None
 
+
 @dataclass
 class VideoRawData:
     itemName: str = None
@@ -135,9 +136,9 @@ class DataAggregator:
         ),
         "tag": lambda annotation: None,
         "mask": lambda annotation: {"parts": annotation["parts"]},
-        "template": lambda annotation : None,
+        "template": lambda annotation: None,
         "rbbox": lambda annotation: annotation["points"],
-        "comment_inst": lambda annotation: annotation["points"]
+        "comment_inst": lambda annotation: annotation["points"],
     }
 
     def __init__(
@@ -204,18 +205,16 @@ def aggregate_annotations_as_df(self):
         self.check_classes_path()
         annotation_paths = self.get_annotation_paths()
 
-
         if self.project_type in (
             constances.ProjectType.VECTOR,
-            constances.ProjectType.PIXEL
+            constances.ProjectType.PIXEL,
         ):
             return self.aggregate_image_annotations_as_df(annotation_paths)
         elif self.project_type is constances.ProjectType.VIDEO:
             return self.aggregate_video_annotations_as_df(annotation_paths)
         elif self.project_type is constances.ProjectType.DOCUMENT:
             return self.aggregate_document_annotations_as_df(annotation_paths)
 
-
     def __add_attributes_to_raws(self, raws, attributes, element_raw):
         for attribute_id, attribute in enumerate(attributes):
             attribute_raw = copy.copy(element_raw)
@@ -388,10 +387,10 @@ def aggregate_image_annotations_as_df(self, annotations_paths: List[str]):
         for annotation_path in annotations_paths:
             row_data = ImageRowData()
             annotation_json = None
-            with open(annotation_path, 'r') as fp:
+            with open(annotation_path) as fp:
                 annotation_json = json.load(fp)
             parts = Path(annotation_path).name.split(self._annotation_suffix)
-            row_data = self.__fill_image_metadata(row_data, annotation_json['metadata'])
+            row_data = self.__fill_image_metadata(row_data, annotation_json["metadata"])
             annotation_instance_id = 0
 
             # include comments
@@ -408,7 +407,7 @@ def aggregate_image_annotations_as_df(self, annotations_paths: List[str]):
                 tag_row.rag = tag
                 rows.append(tag_row)
 
-            #Instances
+            # Instances
             for idx, annotation in enumerate(annotation_json["instances"]):
                 instance_row = copy.copy(row_data)
                 annotation_type = annotation.get("type", "mask")
@@ -462,7 +461,8 @@ def aggregate_image_annotations_as_df(self, annotations_paths: List[str]):
                             attribute_name
                             not in class_group_name_to_values[annotation_class_name][
                                 attribute_group
-                            ] and group_id not in freestyle_attributes
+                            ]
+                            and group_id not in freestyle_attributes
                         ):
                             logger.warning(
                                 f"Annotation class group value {attribute_name} not in classes json. Skipping."
@@ -473,7 +473,6 @@ def aggregate_image_annotations_as_df(self, annotations_paths: List[str]):
                             attribute_row.attributeGroupName = attribute_group
                             attribute_row.attributeName = attribute_name
 
-
                         rows.append(attribute_row)
                         num_added += 1
 
@@ -486,7 +485,7 @@ def aggregate_image_annotations_as_df(self, annotations_paths: List[str]):
 
     @staticmethod
     def __fill_image_metadata(raw_data, metadata):
-        raw_data.itemName = metadata.get('name')
+        raw_data.itemName = metadata.get("name")
         raw_data.itemHeight = metadata.get("height")
         raw_data.itemWidth = metadata.get("width")
         raw_data.itemStatus = metadata.get("status")

src/superannotate/lib/app/analytics/common.py

@@ -398,6 +398,7 @@ def instance_consensus(inst_1, inst_2):
 
     return score
 
+
 def calculate_tag_consensus(image_df):
     column_names = [
         "creatorEmail",
@@ -406,14 +407,14 @@ def calculate_tag_consensus(image_df):
         "className",
         "folderName",
         "attributeGroupName",
-        "attributeName"
+        "attributeName",
     ]
 
     image_data = {}
     for column_name in column_names:
         image_data[column_name] = []
 
-    image_df=image_df.reset_index()
+    image_df = image_df.reset_index()
     image_data["score"] = []
     for i, irow in image_df.iterrows():
         for c in column_names:
@@ -422,10 +423,15 @@ def calculate_tag_consensus(image_df):
         for j, jrow in image_df.iterrows():
             if i == j:
                 continue
-            if (irow["className"] == jrow["className"]) and irow["attributeGroupName"] == jrow["attributeGroupName"] and irow["attributeName"] == jrow["attributeName"]:
-                image_data["score"][i]+=1
+            if (
+                (irow["className"] == jrow["className"])
+                and irow["attributeGroupName"] == jrow["attributeGroupName"]
+                and irow["attributeName"] == jrow["attributeName"]
+            ):
+                image_data["score"][i] += 1
     return image_data
 
+
 def consensus(df, item_name, annot_type):
     """Helper function that computes consensus score for instances of a single image:
 
@@ -484,7 +490,7 @@ def consensus(df, item_name, annot_type):
             inst = Polygon(shapely_format)
         elif annot_type == "point":
             inst = Point(inst_data["x"], inst_data["y"])
-        if  annot_type != "tag" and inst.is_valid:
+        if annot_type != "tag" and inst.is_valid:
             projects_shaply_objs[row["folderName"]].append(
                 (inst, row["className"], row["creatorEmail"], row["attributes"])
             )

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

@@ -35,10 +35,10 @@
 from lib.app.interface.types import Setting
 from lib.app.serializers import BaseSerializer
 from lib.app.serializers import FolderSerializer
+from lib.app.serializers import ItemSerializer
 from lib.app.serializers import ProjectSerializer
 from lib.app.serializers import SettingsSerializer
 from lib.app.serializers import TeamSerializer
-from lib.app.serializers import ItemSerializer
 from lib.core import entities
 from lib.core import LIMITED_FUNCTIONS
 from lib.core.conditions import Condition
@@ -86,48 +86,59 @@ def __init__(
     ):
         super().__init__(token, config_path)
 
-    def get_folder_by_id(self, project_id: int, folder_id: int):
-        """Returns the folder
-        :param folder_id: the id of the folder
+    def get_project_by_id(self, project_id: int):
+        """Returns the project metadata
+
         :param project_id: the id of the project
-        :return: folder information
+        :type project_id: int
+
+        :return: project metadata
         :rtype: dict
         """
+        response = self.controller.get_project_by_id(project_id=project_id)
 
-        response = self.controller.get_folder_by_id(
-            folder_id=folder_id,
-            project_id=project_id
-        )
+        return ProjectSerializer(response.data).serialize()
 
-        return FolderSerializer(response).serialize(exclude={"completedCount", "is_root"})
+    def get_folder_by_id(self, project_id: int, folder_id: int):
+        """Returns the folder metadata
 
-    def get_project_by_id(self, project_id: int):
-        """Returns the project
         :param project_id: the id of the project
-        :return: folder information
+        :type project_id: int
+
+        :param folder_id: the id of the folder
+        :type folder_id: int
+
+        :return: folder metadata
         :rtype: dict
         """
-        response = self.controller.get_project_by_id(
-            project_id=project_id
+
+        response = self.controller.get_folder_by_id(
+            folder_id=folder_id, project_id=project_id
         )
 
-        return ProjectSerializer(response.data).serialize()
+        return FolderSerializer(response).serialize(
+            exclude={"completedCount", "is_root"}
+        )
 
     def get_item_by_id(self, project_id: int, item_id: int):
-        """Returns the project
-        :param item_id: the id of the item
+        """Returns the item metadata
+
         :param project_id: the id of the project
-        :return: folder information
+        :type project_id: int
+
+        :param item_id: the id of the item
+        :type item_id: int
+
+
+        :return: item metadata
         :rtype: dict
         """
 
         response = self.controller.get_item_by_id(
-            item_id=item_id,
-            project_id=project_id
+            item_id=item_id, project_id=project_id
         )
 
-        return ItemSerializer(response).serialize(exclude = {"url", "meta"})
-
+        return ItemSerializer(response).serialize(exclude={"url", "meta"})
 
     def get_team_metadata(self):
         """Returns team metadata
@@ -499,7 +510,7 @@ def get_project_metadata(
         include_settings: Optional[StrictBool] = False,
         include_workflow: Optional[StrictBool] = False,
         include_contributors: Optional[StrictBool] = False,
-        include_complete_image_count: Optional[StrictBool] = False
+        include_complete_image_count: Optional[StrictBool] = False,
     ):
         """Returns project metadata
 

src/superannotate/lib/app/serializers.py

@@ -165,6 +165,7 @@ def serialize(self):
             self.data["value"] = constance.ImageQuality.get_name(self.data["value"])
         return self.data
 
+
 class ItemSerializer(BaseSerializer):
     def serialize(
         self,
@@ -177,6 +178,7 @@ def serialize(
 
         return data
 
+
 class EntitySerializer:
     @classmethod
     def serialize(

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

@@ -3,12 +3,12 @@
 from lib.core.entities.classes import AnnotationClassEntity
 from lib.core.entities.folder import FolderEntity
 from lib.core.entities.integrations import IntegrationEntity
+from lib.core.entities.items import ClassificationEntity
 from lib.core.entities.items import DocumentEntity
 from lib.core.entities.items import ImageEntity
-from lib.core.entities.items import VideoEntity
-from lib.core.entities.items import ClassificationEntity
-from lib.core.entities.items import TiledEntity
 from lib.core.entities.items import PointCloudEntity
+from lib.core.entities.items import TiledEntity
+from lib.core.entities.items import VideoEntity
 from lib.core.entities.project import AttachmentEntity
 from lib.core.entities.project import MLModelEntity
 from lib.core.entities.project import ProjectEntity
@@ -30,6 +30,9 @@
     "ImageEntity",
     "BaseItemEntity",
     "VideoEntity",
+    "PointCloudEntity",
+    "TiledEntity",
+    "ClassificationEntity",
     "DocumentEntity",
     # Utils
     "AttachmentEntity",

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

@@ -28,18 +28,22 @@ class VideoEntity(BaseItemEntity):
     class Config:
         extra = Extra.ignore
 
+
 class DocumentEntity(BaseItemEntity):
     class Config:
         extra = Extra.ignore
 
+
 class TiledEntity(BaseItemEntity):
     class Config:
         extra = Extra.ignore
 
+
 class ClassificationEntity(BaseItemEntity):
     class Config:
         extra = Extra.ignore
 
+
 class PointCloudEntity(BaseItemEntity):
     class Config:
         extra = Extra.ignore

src/superannotate/lib/core/service_types.py

@@ -167,24 +167,31 @@ def set_error(self, value: Union[dict, str]):
 class ImageResponse(ServiceResponse):
     data: entities.ImageEntity = None
 
+
 class VideoResponse(ServiceResponse):
     data: entities.VideoEntity = None
 
+
 class DocumentResponse(ServiceResponse):
     data: entities.DocumentEntity = None
 
+
 class TiledResponse(ServiceResponse):
     data: entities.TiledEntity = None
 
+
 class ClassificationResponse(ServiceResponse):
     data: entities.ClassificationEntity = None
 
+
 class PointCloudResponse(ServiceResponse):
     data: entities.PointCloudEntity = None
 
+
 class TeamResponse(ServiceResponse):
     data: entities.TeamEntity = None
 
+
 class ModelListResponse(ServiceResponse):
     data: List[entities.AnnotationClassEntity] = None
 

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

@@ -25,12 +25,12 @@ def __init__(self, project_id, folder_id, team_id, service_provider):
     def execute(self):
         try:
             response = self._service_provider.folders.get_by_id(
-                folder_id = self._folder_id,
-                project_id = self._project_id,
-                team_id = self._team_id
+                folder_id=self._folder_id,
+                project_id=self._project_id,
+                team_id=self._team_id,
             )
         except AppException as e:
-            self._response.errors=e
+            self._response.errors = e
         else:
             self._response.data = response.data