Merge pull request #302 from superannotateai/friday

Friday

Author: dshabin

docs/source/cli.rst

@@ -191,7 +191,7 @@ To export project
 
    superannotatecli export-project --project <project_name> --folder <folder_path> 
                                    [--include-fuse]
-                                   [--disable_extract_zip_contents] 
+                                   [--disable-extract-zip-contents] 
                                    [--annotation-statuses <comma separated list of annotation statuses to export>]
 
 ----------

src/superannotate/__init__.py

@@ -312,16 +312,19 @@
 local_version = parse(__version__)
 if local_version.is_prerelease:
     logging.info(constances.PACKAGE_VERSION_INFO_MESSAGE.format(__version__))
-req = requests.get('https://pypi.python.org/pypi/superannotate/json')
+req = requests.get("https://pypi.python.org/pypi/superannotate/json")
 if req.ok:
-    releases = req.json().get('releases', [])
-    pip_version = parse('0')
+    releases = req.json().get("releases", [])
+    pip_version = parse("0")
     for release in releases:
         ver = parse(release)
         if not ver.is_prerelease or local_version.is_prerelease:
             pip_version = max(pip_version, ver)
     if pip_version.major > local_version.major:
-        logging.warning(constances.PACKAGE_VERSION_MAJOR_UPGRADE.format(local_version, pip_version))
+        logging.warning(
+            constances.PACKAGE_VERSION_MAJOR_UPGRADE.format(local_version, pip_version)
+        )
     elif pip_version > local_version:
-        logging.warning(constances.PACKAGE_VERSION_UPGRADE.format(local_version, pip_version)
+        logging.warning(
+            constances.PACKAGE_VERSION_UPGRADE.format(local_version, pip_version)
         )

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

@@ -3,8 +3,8 @@
 
 import pandas as pd
 import plotly.express as px
+from lib.app.mixp.decorators import Trackable
 from superannotate.lib.app.exceptions import AppException
-from superannotate.lib.app.mixp.decorators import Trackable
 from superannotate.lib.core import DEPRICATED_DOCUMENT_VIDEO_MESSAGE
 
 from .common import aggregate_annotations_as_df

src/superannotate/lib/app/annotation_helpers.py

@@ -4,23 +4,23 @@
 from superannotate.lib.app.exceptions import AppException
 
 
-def fill_in_missing(annotation_json):
+def fill_in_missing(annotation_json, image_name: str = ""):
     for field in ["instances", "comments", "tags"]:
         if field not in annotation_json:
             annotation_json[field] = []
     if "metadata" not in annotation_json:
-        annotation_json["metadata"] = {}
+        annotation_json["metadata"] = {"name": image_name}
 
 
-def _preprocess_annotation_json(annotation_json):
+def _preprocess_annotation_json(annotation_json, image_name: str = ""):
     path = None
     if not isinstance(annotation_json, dict) and annotation_json is not None:
         path = annotation_json
         annotation_json = json.load(open(annotation_json))
     elif annotation_json is None:
         annotation_json = {}
 
-    fill_in_missing(annotation_json)
+    fill_in_missing(annotation_json, image_name)
 
     return (annotation_json, path)
 
@@ -60,7 +60,7 @@ def add_annotation_comment_to_json(
         "type": "comment",
         "x": comment_coords[0],
         "y": comment_coords[1],
-        "correspondence": [{"text": comment_text, "id": comment_author}],
+        "correspondence": [{"text": comment_text, "email": comment_author}],
         "resolved": resolved,
     }
     annotation_json["comments"].append(annotation)
@@ -74,6 +74,7 @@ def add_annotation_bbox_to_json(
     annotation_class_name,
     annotation_class_attributes=None,
     error=None,
+    image_name: str = "",
 ):
     """Add a bounding box annotation to SuperAnnotate format annotation JSON
 
@@ -94,7 +95,7 @@ def add_annotation_bbox_to_json(
     if len(bbox) != 4:
         raise AppException("Bounding boxes should have 4 float elements")
 
-    annotation_json, path = _preprocess_annotation_json(annotation_json)
+    annotation_json, path = _preprocess_annotation_json(annotation_json, image_name)
 
     annotation = {
         "type": "bbox",

src/superannotate/lib/app/input_converters/df_converter.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 
 import pandas as pd
-from superannotate.lib.app.mixp.decorators import Trackable
+from lib.app.mixp.decorators import Trackable
 
 
 @Trackable

src/superannotate/lib/app/input_converters/dicom_converter.py

@@ -2,8 +2,8 @@
 
 import numpy as np
 import pydicom
+from lib.app.mixp.decorators import Trackable
 from PIL import Image
-from superannotate.lib.app.mixp.decorators import Trackable
 
 
 @Trackable

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

@@ -2355,6 +2355,7 @@ def attach_image_urls_to_project(
     raise AppException(use_case.response.errors)
 
 
+@Trackable
 @validate_arguments
 def attach_video_urls_to_project(
     project: Union[NotEmptyStr, dict],
@@ -2476,6 +2477,7 @@ def upload_annotations_from_folder_to_project(
         folder_name=folder_name,
         annotation_paths=annotation_paths,  # noqa: E203
         client_s3_bucket=from_s3_bucket,
+        folder_path=folder_path,
     )
     if response.errors:
         raise AppException(response.errors)
@@ -3069,7 +3071,12 @@ def add_annotation_bbox_to_image(
     """
     annotations = get_image_annotations(project, image_name)["annotation_json"]
     annotations = add_annotation_bbox_to_json(
-        annotations, bbox, annotation_class_name, annotation_class_attributes, error,
+        annotations,
+        bbox,
+        annotation_class_name,
+        annotation_class_attributes,
+        error,
+        image_name,
     )
     upload_image_annotations(project, image_name, annotations, verbose=False)
 
@@ -3638,12 +3645,23 @@ def attach_document_urls_to_project(
 def validate_annotations(
     project_type: ProjectTypes, annotations_json: Union[NotEmptyStr, Path]
 ):
+    """
+    Validates given annotation JSON.
+        :param project_type: project_type (str) – the project type Vector, Pixel, Video or Document
+        :type project_type: str
+        :param annotations_json: path to annotation JSON
+        :type annotations_json: Path-like (str or Path)
+
+        :return: The success of the validation
+        :rtype: bool
+        """
     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)
-        if response.data:
+        is_valid, _ = response.data
+        if is_valid:
             return True
         print(response.report)
         return False

src/superannotate/lib/app/mixp/decorators.py

@@ -8,6 +8,7 @@
 from .config import TOKEN
 from .utils import parsers
 
+controller = Controller.get_instance()
 mp = Mixpanel(TOKEN)
 
 
@@ -25,18 +26,32 @@ def get_default(team_name, user_id, project_name=None):
 
 class Trackable:
     TEAM_DATA = None
+    INITIAL_EVENT = {"event_name": "SDK init", "properties": {}}
+    INITIAL_LOGGED = False
 
-    def __init__(self, function):
+    def __init__(self, function, initial=False):
         self.function = function
         self._success = False
+        self._initial = initial
+        if initial:
+            self.track()
         functools.update_wrapper(self, function)
 
+    @property
+    def team(self):
+        return controller.get_team()
+
     def track(self, *args, **kwargs):
         try:
-            data = getattr(parsers, self.function.__name__)(*args, **kwargs)
+            if self._initial:
+                data = self.INITIAL_EVENT
+                Trackable.INITIAL_LOGGED = True
+                self._success = True
+            else:
+                data = getattr(parsers, self.function.__name__)(*args, **kwargs)
             event_name = data["event_name"]
             properties = data["properties"]
-            team_data = self.__class__.TEAM_DATA.data
+            team_data = self.team.data
             user_id = team_data.creator_id
             team_name = team_data.name
             properties["Success"] = self._success
@@ -55,16 +70,20 @@ def track(self, *args, **kwargs):
 
     def __call__(self, *args, **kwargs):
         try:
-            self.__class__.TEAM_DATA = Controller.get_instance().get_team()
-            ret = self.function(*args, **kwargs)
+            self.__class__.TEAM_DATA = controller.get_team()
+            result = self.function(*args, **kwargs)
             self._success = True
         except Exception as e:
             self._success = False
             raise e
         else:
-            return ret
+            return result
         finally:
             try:
                 self.track(*args, **kwargs)
             except Exception:
                 pass
+
+
+if __name__ == "lib.app.mixp.decorators" and not Trackable.INITIAL_LOGGED:
+    Trackable(None, initial=True)

src/superannotate/lib/app/mixp/utils/parsers.py

@@ -1488,3 +1488,37 @@ def unassign_images(*args, **kwargs):
         "event_name": "unassign_images",
         "properties": {"Assign Folder": is_root, "Image Count": len(image_names)},
     }
+
+
+def attach_video_urls_to_project(*args, **kwargs):
+    project = kwargs.get("project", None)
+    if not project:
+        project = args[0]
+    return {
+        "event_name": "attach_video_urls_to_project",
+        "properties": {
+            "project_name": get_project_name(project),
+            "Annotation Status": bool(
+                args[2:3] or kwargs.get("annotation_status", None)
+            ),
+        },
+    }
+
+
+def attach_document_urls_to_project(*args, **kwargs):
+    project = kwargs.get("project", None)
+    if not project:
+        project = args[0]
+    return {
+        "event_name": "attach_document_urls_to_project",
+        "properties": {
+            "project_name": get_project_name(project),
+            "Annotation Status": bool(
+                args[2:3] or kwargs.get("annotation_status", None)
+            ),
+        },
+    }
+
+
+def delete_annotations(*args, **kwargs):
+    return {"event_name": "delete_annotations", "properties": {}}

src/superannotate/lib/core/__init__.py

@@ -102,15 +102,21 @@
 )
 MOVE_PROJECT_LIMIT_ERROR_MESSAGE = "The number of items you want to move exceeds the limit of 500 000 items per project."
 
-PACKAGE_VERSION_INFO_MESSAGE = "Development version {} of SuperAnnotate SDK is being used."
+PACKAGE_VERSION_INFO_MESSAGE = (
+    "Development version {} of SuperAnnotate SDK is being used."
+)
 
-PACKAGE_VERSION_MAJOR_UPGRADE = "There is a major upgrade of SuperAnnotate Python SDK available on PyPI. " \
-                          "We recommend upgrading. Run 'pip install --upgrade superannotate' to " \
-                          "upgrade from your version {} to {}."
+PACKAGE_VERSION_MAJOR_UPGRADE = (
+    "There is a major upgrade of SuperAnnotate Python SDK available on PyPI. "
+    "We recommend upgrading. Run 'pip install --upgrade superannotate' to "
+    "upgrade from your version {} to {}."
+)
 
-PACKAGE_VERSION_UPGRADE = "There is a newer version of SuperAnnotate Python SDK available on PyPI." \
-                      " Run 'pip install --upgrade superannotate' to" \
-                      " upgrade from your version {} to {}"
+PACKAGE_VERSION_UPGRADE = (
+    "There is a newer version of SuperAnnotate Python SDK available on PyPI."
+    " Run 'pip install --upgrade superannotate' to"
+    " upgrade from your version {} to {}"
+)
 __alL__ = (
     ProjectType,
     UserRole,