More folder structure support

Author: hovnatan

superannotate/__init__.py

@@ -42,7 +42,6 @@ def consensus(*args, **kwargs):
 from .db.exports import (
     download_export, get_export_metadata, get_exports, prepare_export
 )
-from .db.folders import create_folder, get_folder_metadata, search_folders
 from .db.images import (
     add_annotation_bbox_to_image, add_annotation_comment_to_image,
     add_annotation_cuboid_to_image, add_annotation_ellipse_to_image,
@@ -53,6 +52,7 @@ def consensus(*args, **kwargs):
     get_image_metadata, get_image_preannotations, search_images,
     set_image_annotation_status, upload_image_annotations
 )
+from .db.project_api import create_folder, get_folder_metadata, search_folders
 from .db.project_images import (
     assign_images, copy_image, move_image, pin_image, upload_image_to_project
 )

superannotate/db/clone_project.py

@@ -9,7 +9,6 @@
 from .projects import create_project_from_metadata
 
 logger = logging.getLogger("superannotate-python-sdk")
-_api = API.get_instance()
 
 
 def clone_project(

superannotate/db/folders.py

@@ -24,8 +24,7 @@
     get_annotation_classes_id_to_name, get_annotation_classes_name_to_id,
     search_annotation_classes
 )
-from .folders import get_folder_metadata
-from .project_api import get_project_metadata_bare
+from .project_api import get_project_project_folder_metadata
 
 logger = logging.getLogger("superannotate-python-sdk")
 
@@ -36,8 +35,7 @@ def search_images(
     project,
     image_name_prefix=None,
     annotation_status=None,
-    return_metadata=False,
-    project_folder=None
+    return_metadata=False
 ):
     """Search images by name_prefix (case-insensitive) and annotation status
 
@@ -55,17 +53,14 @@ def search_images(
     :return: metadata of found images or image names
     :rtype: list of dicts or strs
     """
-    if not isinstance(project, dict):
-        project = get_project_metadata_bare(project)
+    project, project_folder = get_project_project_folder_metadata(project)
     team_id, project_id = project["team_id"], project["id"]
     if annotation_status is not None:
         annotation_status = common.annotation_status_str_to_int(
             annotation_status
         )
 
     if project_folder is not None:
-        if not isinstance(project_folder, dict):
-            project_folder = get_folder_metadata(project, project_folder)
         project_folder_id = project_folder["id"]
     else:
         project_folder_id = None
@@ -120,13 +115,7 @@ def process_result(x):
         return result_list
 
 
-@project_metadata
-def get_image_metadata(
-    project,
-    image_names,
-    return_dict_on_single_output=True,
-    project_folder=None
-):
+def get_image_metadata(project, image_names, return_dict_on_single_output=True):
     """Returns image metadata
 
     :param project: project name or metadata of the project
@@ -137,12 +126,11 @@ def get_image_metadata(
     :return: metadata of image
     :rtype: dict
     """
+    project, project_folder = get_project_project_folder_metadata(project)
     if isinstance(image_names, str):
         image_names = [image_names]
 
     if project_folder is not None:
-        if not isinstance(project_folder, dict):
-            project_folder = get_folder_metadata(project, project_folder)
         project_folder_id = project_folder["id"]
     else:
         project_folder_id = None
@@ -546,8 +534,7 @@ def download_image(
             0, "Image download variant should be either original or lores"
         )
 
-    if not isinstance(project, dict):
-        project = get_project_metadata_bare(project)
+    project, project_folder = get_project_project_folder_metadata(project)
     img = get_image_bytes(project, image_name, variant=variant)
     filepath_save = image_name
     if variant == "lores":
@@ -665,7 +652,7 @@ def get_image_preannotations(project, image_name):
     return _get_image_pre_or_annotations(project, image_name, "pre")
 
 
-def get_image_annotations(project, image_name, project_folder=None):
+def get_image_annotations(project, image_name):
     """Get annotations of the image.
 
     :param project: project name or metadata of the project
@@ -680,20 +667,16 @@ def get_image_annotations(project, image_name, project_folder=None):
         "annotation_mask_filename": mask filename on server
     :rtype: dict
     """
-    return _get_image_pre_or_annotations(
-        project, image_name, "", None, project_folder
-    )
+    return _get_image_pre_or_annotations(project, image_name, "", None)
 
 
-def _get_image_pre_or_annotations(
-    project, image_name, pre, project_type=None, project_folder=None
-):
-    image = get_image_metadata(project, image_name, True, project_folder)
+def _get_image_pre_or_annotations(project, image_name, pre, project_type=None):
+    image = get_image_metadata(project, image_name, True)
     team_id, project_id, image_id, project_folder_id = image["team_id"], image[
         "project_id"], image["id"], image['folder_id']
     if project_type is None:
         if not isinstance(project, dict):
-            project = get_project_metadata_bare(project)
+            project, _ = get_project_project_folder_metadata(project)
         project_type = project["type"]
     params = {
         'team_id': team_id,
@@ -790,11 +773,10 @@ def download_image_annotations(project, image_name, local_dir_path):
 def _download_image_pre_or_annotations(
     project, image_name, local_dir_path, pre
 ):
-    if not isinstance(project, dict):
-        project = get_project_metadata_bare(project)
+    project, project_folder = get_project_project_folder_metadata(project)
 
     annotation = _get_image_pre_or_annotations(
-        project, image_name, pre, project["type"]
+        (project, project_folder), image_name, pre, project["type"]
     )
 
     if annotation[f"{pre}annotation_json_filename"] is None:
@@ -869,9 +851,8 @@ def upload_image_annotations(
         if verbose:
             logger.info("Uploading annotations from %s.", annotation_json)
         annotation_json = json.load(open(annotation_json))
-    if not isinstance(project, dict):
-        project = get_project_metadata_bare(project)
-    image = get_image_metadata(project, image_name)
+    project, project_folder = get_project_project_folder_metadata(project)
+    image = get_image_metadata((project, project_folder), image_name)
     team_id, project_id, image_id, folder_id, image_name = image[
         "team_id"], image["project_id"], image["id"], image['folder_id'], image[
             'name']

superannotate/db/images.py

@@ -3,7 +3,7 @@
 from .. import common
 from ..api import API
 from ..exceptions import (
-    SABaseException, SAExistingProjectNameException,
+    SABaseException, SAExistingProjectNameException, SAIncorrectProjectArgument,
     SANonExistingProjectNameException
 )
 from .search_projects import search_projects
@@ -63,3 +63,118 @@ def get_project_metadata_with_users(project_metadata):
             contributor["user_role"]
         )
     return res
+
+
+def get_folder_metadata(project, folder_name):
+    if not isinstance(project, dict):
+        project = get_project_metadata_bare(project)
+    team_id, project_id = project["team_id"], project["id"]
+    params = {'team_id': team_id, 'project_id': project_id, 'name': folder_name}
+    response = _api.send_request(
+        req_type='GET', path='/folder/getFolderByName', params=params
+    )
+    if not response.ok:
+        raise SABaseException(
+            response.status_code,
+            "Couldn't get folder metadata " + response.text
+        )
+    res = response.json()
+    return res
+
+
+def search_folders(project, folder_name=None, return_metadata=False):
+    if not isinstance(project, dict):
+        project = get_project_metadata_bare(project)
+    team_id, project_id = project["team_id"], project["id"]
+    result_list = []
+    params = {
+        'team_id': team_id,
+        'project_id': project_id,
+        'offset': 0,
+        'name': folder_name,
+        'is_root': 0
+    }
+    total_folders = 0
+    while True:
+        response = _api.send_request(
+            req_type='GET', path='/folders', params=params
+        )
+        if not response.ok:
+            raise SABaseException(
+                response.status_code, "Couldn't search folders " + response.text
+            )
+        response = response.json()
+        results_folders = response["data"]
+        for r in results_folders:
+            if return_metadata:
+                result_list.append(r)
+            else:
+                result_list.append(r["name"])
+
+        total_folders += len(results_folders)
+        if response["count"] <= total_folders:
+            break
+
+        params["offset"] = total_folders
+
+    return result_list
+
+
+def create_folder(project, folder_name):
+    """Create a new folder in the project.
+
+    :param project: project name or metadata of the project to be deleted
+    :type project: str or dict
+    :param folder_name: the new folder's name
+    :type folder_name: str
+
+    :return: dict object metadata the new folder
+    :rtype: dict
+    """
+    if not isinstance(project, dict):
+        project = get_project_metadata_bare(project)
+    params = {"team_id": project["team_id"], "project_id": project["id"]}
+    data = {"name": folder_name}
+    response = _api.send_request(
+        req_type='POST', path='/folder', params=params, json_req=data
+    )
+    if not response.ok:
+        raise SABaseException(
+            response.status_code, "Couldn't create project " + response.text
+        )
+    res = response.json()
+    if res["name"] != folder_name:
+        logger.warning(
+            "Created folder has name %s, since folder with name %s already existed.",
+            res["name"], folder_name
+        )
+    return res
+
+
+def get_project_project_folder_metadata(project):
+    if isinstance(project, dict):
+        project = project
+        folder = None
+    elif isinstance(project, tuple):
+        if len(project) != 2:
+            raise SAIncorrectProjectArgument(project)
+        project, folder = project
+        if not isinstance(project, dict):
+            raise SAIncorrectProjectArgument(project)
+        if folder is not None and not isinstance(project, dict):
+            raise SAIncorrectProjectArgument(project)
+    elif isinstance(project, str):
+        parts = project.split('/')
+        if len(parts) == 1:
+            project_name = parts[0]
+            project = get_project_metadata_bare(project_name)
+            folder = None
+        elif len(parts) == 2:
+            project_name, folder_name = parts
+            project = get_project_metadata_bare(project_name)
+            folder = get_folder_metadata(project, folder_name)
+        else:
+            raise SAIncorrectProjectArgument(project)
+    else:
+        raise SAIncorrectProjectArgument(project)
+    return project, folder