Merge pull request #544 from superannotateai/get_things_by_id

Get things by

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/__init__.py

@@ -2,7 +2,8 @@
 import sys
 
 
-__version__ = "4.4.8dev1"
+__version__ = "4.4.8dev2"
+
 
 
 sys.path.append(os.path.split(os.path.realpath(__file__))[0])

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,6 +35,7 @@
 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
@@ -85,6 +86,60 @@ def __init__(
     ):
         super().__init__(token, config_path)
 
+    def get_project_by_id(self, project_id: int):
+        """Returns the project metadata
+
+        :param project_id: the id of the project
+        :type project_id: int
+
+        :return: project metadata
+        :rtype: dict
+        """
+        response = self.controller.get_project_by_id(project_id=project_id)
+
+        return ProjectSerializer(response.data).serialize()
+
+    def get_folder_by_id(self, project_id: int, folder_id: int):
+        """Returns the folder metadata
+
+        :param project_id: the id of the project
+        :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_folder_by_id(
+            folder_id=folder_id, project_id=project_id
+        )
+
+        return FolderSerializer(response).serialize(
+            exclude={"completedCount", "is_root"}
+        )
+
+    def get_item_by_id(self, project_id: int, item_id: int):
+        """Returns the item metadata
+
+        :param project_id: the id of the project
+        :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
+        )
+
+        return ItemSerializer(response).serialize(exclude={"url", "meta"})
+
     def get_team_metadata(self):
         """Returns team metadata
 
@@ -214,7 +269,7 @@ def create_project(
             ProjectTypes.validate(project_type)
         except TypeError:
             raise AppException(
-                "Please provide a valid project type: Vector, Pixel, Document, or Video."
+                f"Please provide a valid project type: {', '.join(constants.ProjectType.titles())}"
             )
         response = self.controller.projects.create(
             entities.ProjectEntity(
@@ -1563,10 +1618,7 @@ def upload_image_annotations(
         project_name, folder_name = extract_project_folder(project)
 
         project = self.controller.projects.get_by_name(project_name).data
-        if project.type in [
-            constants.ProjectType.VIDEO,
-            constants.ProjectType.DOCUMENT,
-        ]:
+        if project.type not in constants.ProjectType.images:
             raise AppException(LIMITED_FUNCTIONS[project.type])
 
         if not mask:
@@ -1659,10 +1711,7 @@ def benchmark(
             project_name = project["name"]
 
         project = self.controller.projects.get_by_name(project_name).data
-        if project.type in [
-            constants.ProjectType.VIDEO,
-            constants.ProjectType.DOCUMENT,
-        ]:
+        if project.type not in constants.ProjectType.images:
             raise AppException(LIMITED_FUNCTIONS[project.type])
 
         if not export_root:

src/superannotate/lib/app/serializers.py

@@ -166,6 +166,19 @@ def serialize(self):
         return self.data
 
 
+class ItemSerializer(BaseSerializer):
+    def serialize(
+        self,
+        fields: List[str] = None,
+        by_alias: bool = False,
+        flat: bool = False,
+        exclude: Set[str] = None,
+    ):
+        data = super().serialize(fields, by_alias, flat, exclude)
+
+        return data
+
+
 class EntitySerializer:
     @classmethod
     def serialize(

src/superannotate/lib/core/__init__.py

@@ -50,10 +50,15 @@
 DEPRECATED_DOCUMENT_PROJECTS_MESSAGE = (
     "The function does not support projects containing documents attached with URLs"
 )
+DEPRECATED_PROJECTS_MESSAGE = (
+    "The function does not support projects containing items attached with URLs"
+)
 
 LIMITED_FUNCTIONS = {
     ProjectType.VIDEO: DEPRECATED_VIDEO_PROJECTS_MESSAGE,
     ProjectType.DOCUMENT: DEPRECATED_DOCUMENT_PROJECTS_MESSAGE,
+    ProjectType.OTHER: DEPRECATED_PROJECTS_MESSAGE,
+    ProjectType.POINT_CLOUD: DEPRECATED_PROJECTS_MESSAGE,
 }
 
 METADATA_DEPRICATED_FOR_PIXEL = (

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

@@ -3,8 +3,11 @@
 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 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
@@ -27,6 +30,9 @@
     "ImageEntity",
     "BaseItemEntity",
     "VideoEntity",
+    "PointCloudEntity",
+    "TiledEntity",
+    "ClassificationEntity",
     "DocumentEntity",
     # Utils
     "AttachmentEntity",

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

@@ -32,3 +32,18 @@ class Config:
 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/enums.py

@@ -2,7 +2,7 @@
 from types import DynamicClassAttribute
 
 
-class classproperty:
+class classproperty:  # noqa
     def __init__(self, getter):
         self.getter = getter
 
@@ -78,14 +78,12 @@ class ProjectType(BaseTitledEnum):
     VIDEO = "Video", 3
     DOCUMENT = "Document", 4
     TILED = "Tiled", 5
-    CLASSIFICATION = "Classification", 6
-    POINT_CLOUD = "Point Cloud", 7
-
-
+    OTHER = "Other", 6
+    POINT_CLOUD = "PointCloud", 7
 
     @classproperty
     def images(self):
-        return self.VECTOR.value, self.PIXEL.value
+        return self.VECTOR.value, self.PIXEL.value, self.TILED.value
 
 
 class UserRole(BaseTitledEnum):