Add delete images function

Author: hovnatan

docs/source/superannotate.sdk.rst

@@ -87,6 +87,7 @@ ______
 .. autofunction:: superannotate.pin_image
 .. autofunction:: superannotate.assign_images
 .. autofunction:: superannotate.delete_image
+.. autofunction:: superannotate.delete_images
 .. autofunction:: superannotate.add_annotation_bbox_to_image
 .. autofunction:: superannotate.add_annotation_polygon_to_image
 .. autofunction:: superannotate.add_annotation_polyline_to_image

superannotate/__init__.py

@@ -47,10 +47,11 @@ def consensus(*args, **kwargs):
     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_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
+    create_fuse_image, delete_image, delete_images, 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_api import (
     create_folder, delete_folders, get_folder_metadata,

superannotate/db/images.py

@@ -587,6 +587,34 @@ def delete_image(project, image_name):
     logger.info("Successfully deleted image  %s.", image_name)
 
 
+def delete_images(project, image_names):
+    """Delete images in project.
+
+    :param project: project name or metadata of the project to be deleted
+    :type project: str or dict
+    :param folder_names: to be deleted folders' names
+    :type folder_names: str or list of strs
+    """
+    if not isinstance(image_names, list):
+        raise SABaseException(0, "image_names should be a list of strs")
+    images = get_image_metadata(project, image_names)
+    project, _ = get_project_and_folder_metadata(project)
+
+    params = {"team_id": project["team_id"], "project_id": project["id"]}
+    data = {"image_ids": [image["id"] for image in images]}
+    response = _api.send_request(
+        req_type='PUT',
+        path='/image/delete/images',
+        params=params,
+        json_req=data
+    )
+    if not response.ok:
+        raise SABaseException(
+            response.status_code, "Couldn't delete images " + response.text
+        )
+    logger.info("Images %s deleted in project %s", image_names, project["name"])
+
+
 def get_image_bytes(project, image_name, variant='original'):
     """Returns an io.BytesIO() object of the image. Suitable for creating
     PIL.Image out of it.

tests/test_folders.py

@@ -4,22 +4,18 @@
 import superannotate as sa
 from superannotate.exceptions import SABaseException
 
-PROJECT_NAME1 = "test folder simple"
-PROJECT_NAME2 = "test folder annotations"
-PROJECT_NAME3 = "test folder deletes"
-PROJECT_NAME4 = "test folder image count"
-
 FROM_FOLDER = Path("./tests/sample_project_vector")
 
 
 def test_basic_folders(tmpdir):
+    PROJECT_NAME = "test folder simple"
     tmpdir = Path(tmpdir)
 
-    projects_found = sa.search_projects(PROJECT_NAME1, return_metadata=True)
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
     for pr in projects_found:
         sa.delete_project(pr)
 
-    project = sa.create_project(PROJECT_NAME1, 'test', 'Vector')
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
     project = project["name"]
     sa.upload_images_from_folder_to_project(
         project, FROM_FOLDER, annotation_status="InProgress"
@@ -94,13 +90,14 @@ def test_basic_folders(tmpdir):
 
 
 def test_folder_annotations(tmpdir):
+    PROJECT_NAME = "test folder annotations"
     tmpdir = Path(tmpdir)
 
-    projects_found = sa.search_projects(PROJECT_NAME2, return_metadata=True)
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
     for pr in projects_found:
         sa.delete_project(pr)
 
-    project = sa.create_project(PROJECT_NAME2, 'test', 'Vector')
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
     project = project["name"]
     sa.upload_images_from_folder_to_project(
         project, FROM_FOLDER, annotation_status="InProgress"
@@ -132,13 +129,15 @@ def test_folder_annotations(tmpdir):
 
 
 def test_delete_folders(tmpdir):
+    PROJECT_NAME = "test folder deletes"
+
     tmpdir = Path(tmpdir)
 
-    projects_found = sa.search_projects(PROJECT_NAME3, return_metadata=True)
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
     for pr in projects_found:
         sa.delete_project(pr)
 
-    project = sa.create_project(PROJECT_NAME3, 'test', 'Vector')
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
     sa.create_folder(project, "folder1")
     sa.create_folder(project, "folder2")
     sa.create_folder(project, "folder3")
@@ -160,13 +159,14 @@ def test_delete_folders(tmpdir):
 
 
 def test_rename_folder(tmpdir):
+    PROJECT_NAME = "test folder image count"
     tmpdir = Path(tmpdir)
 
-    projects_found = sa.search_projects(PROJECT_NAME3, return_metadata=True)
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
     for pr in projects_found:
         sa.delete_project(pr)
 
-    project = sa.create_project(PROJECT_NAME3, 'test', 'Vector')
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
     sa.create_folder(project, "folder1")
     sa.create_folder(project, "folder2")
     sa.create_folder(project, "folder3")
@@ -184,13 +184,14 @@ def test_rename_folder(tmpdir):
 
 
 def test_project_folder_image_count(tmpdir):
+    PROJECT_NAME = "test folder image count"
     tmpdir = Path(tmpdir)
 
-    projects_found = sa.search_projects(PROJECT_NAME4, return_metadata=True)
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
     for pr in projects_found:
         sa.delete_project(pr)
 
-    project = sa.create_project(PROJECT_NAME4, 'test', 'Vector')
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
     project = project["name"]
     sa.upload_images_from_folder_to_project(
         project, FROM_FOLDER, annotation_status="InProgress"
@@ -207,4 +208,27 @@ def test_project_folder_image_count(tmpdir):
     assert num_images == 4
 
     num_images = sa.get_project_image_count(project + "/folder1")
-    assert num_images == 4
+    assert num_images == 4
+
+
+def test_delete_images(tmpdir):
+    PROJECT_NAME = "test delete folder images"
+    tmpdir = Path(tmpdir)
+
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
+    for pr in projects_found:
+        sa.delete_project(pr)
+
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
+    sa.create_folder(project, "folder1")
+    project = project["name"] + "/folder1"
+    sa.upload_images_from_folder_to_project(
+        project, FROM_FOLDER, annotation_status="InProgress"
+    )
+    num_images = sa.get_project_image_count(project)
+    assert num_images == 4
+
+    sa.delete_images(project, ["example_image_2.jpg", "example_image_3.jpg"])
+
+    num_images = sa.get_project_image_count(project)
+    assert num_images == 2