Create folders

Author: hovnatan

superannotate/__init__.py

@@ -42,15 +42,15 @@ 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,
     add_annotation_point_to_image, add_annotation_polygon_to_image,
     add_annotation_polyline_to_image, add_annotation_template_to_image,
-    create_folder, create_fuse_image, delete_image, download_image,
-    download_image_annotations, download_image_preannotations,
-    get_folder_metadata, get_image_annotations, get_image_bytes,
-    get_image_metadata, get_image_preannotations, search_folders, search_images,
+    create_fuse_image, delete_image, download_image, download_image_annotations,
+    download_image_preannotations, get_image_annotations, get_image_bytes,
+    get_image_metadata, get_image_preannotations, search_images,
     set_image_annotation_status, upload_image_annotations
 )
 from .db.project_images import (

superannotate/db/folders.py

@@ -0,0 +1,87 @@
+from ..api import API
+from ..exceptions import SABaseException
+from .project_api import get_project_metadata_bare
+
+_api = API.get_instance()
+
+
+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}
+    total_got = 0
+    total_folders = 0
+    while True:
+        response = _api.send_request(
+            req_type='GET', path='/images', params=params
+        )
+        if not response.ok:
+            raise SABaseException(
+                response.status_code, "Couldn't search images " + response.text
+            )
+        response = response.json()
+        images = response["images"]
+        folders = response["folders"]
+
+        results_folders = folders["data"]
+        for r in results_folders:
+            if folder_name is not None and r["name"] != folder_name:
+                continue
+            if return_metadata:
+                result_list.append(r)
+            else:
+                result_list.append(r["name"])
+
+        total_folders += len(results_folders)
+        if folders["count"] <= total_folders:
+            break
+
+        total_got += len(images["data"]) + len(results_folders)
+        params["offset"] = total_got
+
+    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()
+    return res

superannotate/db/images.py

@@ -24,58 +24,14 @@
     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
 
 logger = logging.getLogger("superannotate-python-sdk")
 
 _api = API.get_instance()
 
 
-def _get_project_root_folder_id(project):
-    """Get root folder ID
-    Returns
-    -------
-    int
-        Root folder ID
-    """
-    params = {'team_id': project['team_id']}
-    response = _api.send_request(
-        req_type='GET', path=f'/project/{project["id"]}', params=params
-    )
-    if not response.ok:
-        raise SABaseException(response.status_code, response.text)
-
-    response = response.json()
-
-    return response['folder_id']
-
-
-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()
-    return res
-
-
 def search_images(
     project,
     image_name_prefix=None,
@@ -163,62 +119,6 @@ def process_result(x):
         return result_list
 
 
-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}
-    total_got = 0
-    total_folders = 0
-    while True:
-        response = _api.send_request(
-            req_type='GET', path='/images', params=params
-        )
-        if not response.ok:
-            raise SABaseException(
-                response.status_code, "Couldn't search images " + response.text
-            )
-        response = response.json()
-        images = response["images"]
-        folders = response["folders"]
-
-        results_folders = folders["data"]
-        for r in results_folders:
-            if folder_name is not None and r["name"] != folder_name:
-                continue
-            if return_metadata:
-                result_list.append(r)
-            else:
-                result_list.append(r["name"])
-
-        total_folders += len(results_folders)
-        if folders["count"] <= total_folders:
-            break
-
-        total_got += len(images["data"]) + len(results_folders)
-        params["offset"] = total_got
-
-    return result_list
-
-
 @project_metadata
 def get_image_metadata(project, image_names, return_dict_on_single_output=True):
     """Returns image metadata

superannotate/db/projects.py

@@ -34,6 +34,7 @@
     fill_class_and_attribute_ids, get_annotation_classes_name_to_id,
     search_annotation_classes
 )
+from .folders import get_folder_metadata
 from .images import get_image_metadata, search_images
 from .project_api import get_project_metadata_bare
 from .users import get_team_contributor_metadata
@@ -438,7 +439,8 @@ def upload_images_from_folder_to_project(
     from_s3_bucket=None,
     exclude_file_patterns=None,
     recursive_subfolders=False,
-    image_quality_in_editor=None
+    image_quality_in_editor=None,
+    folder=None
 ):
     """Uploads all images with given extensions from folder_path to the project.
     Sets status of all the uploaded images to set_status if it is not None.
@@ -536,7 +538,7 @@ def upload_images_from_folder_to_project(
 
     return upload_images_to_project(
         project, filtered_paths, annotation_status, from_s3_bucket,
-        image_quality_in_editor
+        image_quality_in_editor, folder
     )
 
 
@@ -640,7 +642,7 @@ def get_image_array_to_upload(
 def __upload_images_to_aws_thread(
     res, img_paths, project, annotation_status, prefix, thread_id, chunksize,
     couldnt_upload, uploaded, tried_upload, image_quality_in_editor,
-    from_s3_bucket
+    from_s3_bucket, folder_id
 ):
     len_img_paths = len(img_paths)
     start_index = thread_id * chunksize
@@ -696,7 +698,8 @@ def __upload_images_to_aws_thread(
                 try:
                     __create_image(
                         uploaded_imgs_info[0], uploaded_imgs_info[1], project,
-                        annotation_status, prefix, uploaded_imgs_info[2]
+                        annotation_status, prefix, uploaded_imgs_info[2],
+                        folder_id
                     )
                 except SABaseException as e:
                     couldnt_upload[thread_id] += uploaded_imgs
@@ -708,7 +711,7 @@ def __upload_images_to_aws_thread(
     try:
         __create_image(
             uploaded_imgs_info[0], uploaded_imgs_info[1], project,
-            annotation_status, prefix, uploaded_imgs_info[2]
+            annotation_status, prefix, uploaded_imgs_info[2], folder_id
         )
     except SABaseException as e:
         couldnt_upload[thread_id] += uploaded_imgs
@@ -718,7 +721,8 @@ def __upload_images_to_aws_thread(
 
 
 def __create_image(
-    img_names, img_paths, project, annotation_status, remote_dir, sizes
+    img_names, img_paths, project, annotation_status, remote_dir, sizes,
+    folder_id
 ):
     if len(img_paths) == 0:
         return
@@ -733,6 +737,8 @@ def __create_image(
         "annotation_status": annotation_status,
         "meta": {}
     }
+    if folder_id is not None:
+        data["folder_id"] = folder_id
     for img_name, img_path, size in zip(img_names, img_paths, sizes):
         img_name_uuid = Path(img_path).name
         remote_path = remote_dir + f"{img_name_uuid}"
@@ -747,6 +753,7 @@ def __create_image(
     response = _api.send_request(
         req_type='POST', path='/image/ext-create', json_req=data
     )
+    print(data)
     if not response.ok:
         raise SABaseException(
             response.status_code, "Couldn't ext-create image " + response.text
@@ -758,7 +765,8 @@ def upload_images_to_project(
     img_paths,
     annotation_status="NotStarted",
     from_s3_bucket=None,
-    image_quality_in_editor=None
+    image_quality_in_editor=None,
+    folder=None
 ):
     """Uploads all images given in list of path objects in img_paths to the project.
     Sets status of all the uploaded images to set_status if it is not None.
@@ -794,7 +802,7 @@ def upload_images_to_project(
             project
         )
     team_id, project_id = project["team_id"], project["id"]
-    existing_images = search_images(project)
+    existing_images = search_images(project, folder=folder)
     duplicate_images = []
     for existing_image in existing_images:
         i = -1
@@ -831,6 +839,13 @@ def upload_images_to_project(
         raise SABaseException(
             response.status_code, "Couldn't get upload token " + response.text
         )
+    if folder is not None:
+        if not isinstance(folder, dict):
+            folder_id = get_folder_metadata(project, folder)
+        else:
+            folder_id = folder["id"]
+    else:
+        folder_id = None
     res = response.json()
     prefix = res['filePath']
     tqdm_thread = threading.Thread(
@@ -847,7 +862,7 @@ def upload_images_to_project(
             args=(
                 res, img_paths, project, annotation_status, prefix, thread_id,
                 chunksize, couldnt_upload, uploaded, tried_upload,
-                image_quality_in_editor, from_s3_bucket
+                image_quality_in_editor, from_s3_bucket, folder_id
             ),
             daemon=True
         )

tests/test_folders.py

@@ -49,4 +49,10 @@ def test_basic_folders(tmpdir):
 
     with pytest.raises(SABaseException) as e:
         folder = sa.get_folder_metadata(project, "folder2")
-    assert 'Folder not found' in str(e)
+    assert 'Folder not found' in str(e)
+
+    sa.upload_images_from_folder_to_project(
+        project, FROM_FOLDER, annotation_status="InProgress", folder="folder1"
+    )
+    images = sa.search_images(project, "example_image_1", folder="folder1")
+    assert len(images) == 1