Merge pull request #198 from superannotateai/sdk_argumnets_validation

Add validator decorator

Author: VaghinakDev

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

@@ -31,6 +31,7 @@
 from lib.app.helpers import extract_project_folder
 from lib.app.helpers import get_annotation_paths
 from lib.app.helpers import reformat_metrics_json
+from lib.app.interface.types import AnnotationType
 from lib.app.interface.types import ClassesJson
 from lib.app.interface.types import NotEmptyStr
 from lib.app.interface.types import Status
@@ -2742,7 +2743,7 @@ def benchmark(
     folder_names: List[str],
     export_root: Optional[Union[str, Path]] = None,
     image_list=None,
-    annot_type="bbox",
+    annot_type: Optional[AnnotationType] = "bbox",
     show_plots=False,
 ):
     """Computes benchmark score for each instance of given images that are present both gt_project_name project and projects in folder_names list:
@@ -2798,13 +2799,14 @@ def benchmark(
 
 
 @Trackable
+@validate_arguments
 def consensus(
-    project: str,
-    folder_names,
-    export_root=None,
-    image_list=None,
-    annot_type="bbox",
-    show_plots=False,
+    project: NotEmptyStr,
+    folder_names: NotEmptyStr,
+    export_root: Optional[Union[NotEmptyStr, Path]] = None,
+    image_list: Optional[List[NotEmptyStr]] = None,
+    annot_type: Optional[AnnotationType] = "bbox",
+    show_plots: Optional[StrictBool] = False,
 ):
     """Computes consensus score for each instance of given images that are present in at least 2 of the given projects:
 
@@ -2852,11 +2854,18 @@ def consensus(
 
 
 @Trackable
-def run_segmentation(project, images_list, model):
+@validate_arguments
+def run_segmentation(
+    project: Union[NotEmptyStr, dict],
+    images_list: List[NotEmptyStr],
+    model: Union[NotEmptyStr, dict],
+):
     """Starts smart segmentation on a list of images using the specified model
 
     :param project: project name of metadata of the project
     :type  project: str or dict
+    :param images_list: image list
+    :type  images_list: list of str
     :param model: The model name or metadata of the model
     :type  model: str or dict
     :return: tupe of two lists, list of images on which the segmentation has succeeded and failed respectively
@@ -2887,7 +2896,12 @@ def run_segmentation(project, images_list, model):
 
 
 @Trackable
-def run_prediction(project, images_list, model):
+@validate_arguments
+def run_prediction(
+    project: Union[NotEmptyStr, dict],
+    images_list: List[NotEmptyStr],
+    model: Union[NotEmptyStr, dict],
+):
     """This function runs smart prediction on given list of images from a given project using the neural network of your choice
 
     :param project: the project in which the target images are uploaded.
@@ -2922,8 +2936,9 @@ def run_prediction(project, images_list, model):
 
 
 @Trackable
+@validate_arguments
 # todo test
-def plot_model_metrics(metric_json_list):
+def plot_model_metrics(metric_json_list=List[NotEmptyStr]):
     """plots the metrics generated by neural network using plotly
 
        :param metric_json_list: list of <model_name>.json files
@@ -2983,13 +2998,14 @@ def get_plottable_cols(df):
 
 
 @Trackable
+@validate_arguments
 def add_annotation_bbox_to_image(
-    project,
-    image_name,
-    bbox,
-    annotation_class_name,
-    annotation_class_attributes=None,
-    error=None,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    bbox: List[float],
+    annotation_class_name: NotEmptyStr,
+    annotation_class_attributes: Optional[List[NotEmptyStr]] = None,
+    error: Optional[StrictBool] = None,
 ):
     """Add a bounding box annotation to image annotations
 
@@ -3017,13 +3033,14 @@ def add_annotation_bbox_to_image(
 
 
 @Trackable
+@validate_arguments
 def add_annotation_polyline_to_image(
-    project,
-    image_name,
-    polyline,
-    annotation_class_name,
-    annotation_class_attributes=None,
-    error=None,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    polyline: List[float],
+    annotation_class_name: NotEmptyStr,
+    annotation_class_attributes: Optional[List[NotEmptyStr]] = None,
+    error: Optional[StrictBool] = None,
 ):
     """Add a polyline annotation to image annotations
 
@@ -3050,13 +3067,14 @@ def add_annotation_polyline_to_image(
 
 
 @Trackable
+@validate_arguments
 def add_annotation_polygon_to_image(
-    project,
-    image_name,
-    polygon,
-    annotation_class_name,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    polygon: List[float],
+    annotation_class_name: NotEmptyStr,
     annotation_class_attributes=None,
-    error=None,
+    error: Optional[StrictBool] = None,
 ):
     """Add a polygon annotation to image annotations
 
@@ -3084,13 +3102,14 @@ def add_annotation_polygon_to_image(
 
 
 @Trackable
+@validate_arguments
 def add_annotation_point_to_image(
-    project,
-    image_name,
-    point,
-    annotation_class_name,
-    annotation_class_attributes=None,
-    error=None,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    point: List[float],
+    annotation_class_name: NotEmptyStr,
+    annotation_class_attributes: Optional[List[NotEmptyStr]] = None,
+    error: Optional[StrictBool] = None,
 ):
     """Add a point annotation to image annotations
 
@@ -3118,12 +3137,12 @@ def add_annotation_point_to_image(
 
 @Trackable
 def add_annotation_ellipse_to_image(
-    project,
-    image_name,
-    ellipse,
-    annotation_class_name,
-    annotation_class_attributes=None,
-    error=None,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    ellipse: List[float],
+    annotation_class_name: NotEmptyStr,
+    annotation_class_attributes: Optional[List[NotEmptyStr]] = None,
+    error: Optional[StrictBool] = None,
 ):
     """Add an ellipse annotation to image annotations
 
@@ -3150,14 +3169,15 @@ def add_annotation_ellipse_to_image(
 
 
 @Trackable
+@validate_arguments
 def add_annotation_template_to_image(
-    project,
-    image_name,
-    template_points,
-    template_connections,
-    annotation_class_name,
-    annotation_class_attributes=None,
-    error=None,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    template_points: List[float],
+    template_connections: List[int],
+    annotation_class_name: NotEmptyStr,
+    annotation_class_attributes: Optional[List[NotEmptyStr]] = None,
+    error: Optional[StrictBool] = None,
 ):
     """Add a template annotation to image annotations
 
@@ -3195,13 +3215,14 @@ def add_annotation_template_to_image(
 
 
 @Trackable
+@validate_arguments
 def add_annotation_cuboid_to_image(
-    project,
-    image_name,
-    cuboid,
-    annotation_class_name,
-    annotation_class_attributes=None,
-    error=None,
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    cuboid: List[float],
+    annotation_class_name: NotEmptyStr,
+    annotation_class_attributes: Optional[List[NotEmptyStr]] = None,
+    error: Optional[StrictBool] = None,
 ):
     """Add a cuboid annotation to image annotations
 
@@ -3232,7 +3253,12 @@ def add_annotation_cuboid_to_image(
 
 @Trackable
 def add_annotation_comment_to_image(
-    project, image_name, comment_text, comment_coords, comment_author, resolved=False
+    project: NotEmptyStr,
+    image_name: NotEmptyStr,
+    comment_text: NotEmptyStr,
+    comment_coords: List[float],
+    comment_author: NotEmptyStr,
+    resolved: Optional[StrictBool] = False,
 ):
     """Add a comment to SuperAnnotate format annotation JSON
 
@@ -3256,8 +3282,12 @@ def add_annotation_comment_to_image(
     upload_image_annotations(project, image_name, annotations, verbose=False)
 
 
+@validate_arguments
 def search_images_all_folders(
-    project, image_name_prefix=None, annotation_status=None, return_metadata=False
+    project: NotEmptyStr,
+    image_name_prefix: Optional[NotEmptyStr] = None,
+    annotation_status: Optional[NotEmptyStr] = None,
+    return_metadata: Optional[StrictBool] = False,
 ):
     """Search images by name_prefix (case-insensitive) and annotation status in
     project and all of its folders
@@ -3288,13 +3318,14 @@ def search_images_all_folders(
 
 
 @Trackable
+@validate_arguments
 def upload_image_to_project(
-    project,
+    project: NotEmptyStr,
     img,
-    image_name=None,
-    annotation_status="NotStarted",
+    image_name: Optional[NotEmptyStr] = None,
+    annotation_status: Optional[Status] = "NotStarted",
     from_s3_bucket=None,
-    image_quality_in_editor=None,
+    image_quality_in_editor: Optional[NotEmptyStr] = None,
 ):
     """Uploads image (io.BytesIO() or filepath to image) to project.
     Sets status of the uploaded image to set_status if it is not None.
@@ -3345,7 +3376,11 @@ def upload_image_to_project(
 
 
 def search_models(
-    name=None, type_=None, project_id=None, task=None, include_global=True,
+    name: Optional[NotEmptyStr] = None,
+    type_: Optional[NotEmptyStr] = None,
+    project_id: Optional[int] = None,
+    task: Optional[NotEmptyStr] = None,
+    include_global: Optional[StrictBool] = True,
 ):
     """Search for ML models.
 
@@ -3374,12 +3409,13 @@ def search_models(
 
 
 @Trackable
+@validate_arguments
 def upload_images_to_project(
-    project,
-    img_paths,
-    annotation_status="NotStarted",
+    project: NotEmptyStr,
+    img_paths: List[NotEmptyStr],
+    annotation_status: Optional[Status] = "NotStarted",
     from_s3_bucket=None,
-    image_quality_in_editor=None,
+    image_quality_in_editor: Optional[NotEmptyStr] = 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.
@@ -3503,13 +3539,14 @@ def _upload_s3_image(image_path: str):
 
 
 @Trackable
+@validate_arguments
 def aggregate_annotations_as_df(
-    project_root,
-    include_classes_wo_annotations=False,
-    include_comments=False,
-    include_tags=False,
-    verbose=True,
-    folder_names=None,
+    project_root: Union[NotEmptyStr, Path],
+    include_classes_wo_annotations: Optional[StrictBool] = False,
+    include_comments: Optional[StrictBool] = False,
+    include_tags: Optional[StrictBool] = False,
+    verbose: Optional[StrictBool] = True,
+    folder_names: Optional[NotEmptyStr] = None,
 ):
     """Aggregate annotations as pandas dataframe from project root.
 
@@ -3522,6 +3559,8 @@ def aggregate_annotations_as_df(
     :type include_comments: bool
     :param include_tags: enables inclusion of tags info as tag column
     :type include_tags: bool
+    :param verbose: enables logging
+    :type verbose: bool
     :param folder_names: Aggregate the specified folders from project_root.
                                 If None aggregate all folders in the project_root.
     :type folder_names: (list of str)
@@ -3550,7 +3589,9 @@ def aggregate_annotations_as_df(
 
 @Trackable
 @validate_arguments
-def delete_annotations(project: str, image_names: List[str] = None):
+def delete_annotations(
+    project: NotEmptyStr, image_names: Optional[List[NotEmptyStr]] = None
+):
     """
     Delete image annotations from a given list of images.
 

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

@@ -24,6 +24,18 @@ def validate(cls, value: Union[str]) -> Union[str]:
         return value
 
 
+class AnnotationType(StrictStr):
+    VALID_TYPES = ["bbox", "polygon", "point"]
+
+    @classmethod
+    def validate(cls, value: Union[str]) -> Union[str]:
+        if value.lower() not in cls.VALID_TYPES:
+            raise TypeError(
+                f"Available annotation_types are {', '.join(cls.VALID_TYPES)}. "
+            )
+        return value
+
+
 class AttributeGroup(BaseModel):
     name: StrictStr
     is_multiselect: Optional[bool]