refactor: 🛠️ update import paths from import_utils to package_utils and enhance CLI command structure

onuralpszr · onuralpszr · commit d4da76dd5f37 · 2025-08-23T19:55:06.000+03:00
Signed-off-by: Onuralp SEZER &lt;thunderbirdtr@gmail.com&gt;
diff --git a/docs/cli.md b/docs/cli.md
@@ -1,4 +1,14 @@
-# CLI Commands
+## CLI commands
+
+This page documents the SAHI CLI (the program exposed by `sahi/cli.py`).
+
+### Top-level commands
+
+- `predict` — run sliced/standard prediction pipeline and export results (images, COCO json, pickles)
+- `predict-fiftyone` — run prediction and open results in FiftyOne
+- `coco` — subgroup for COCO-format utilities (evaluate, analyse, convert, slice)
+- `version` — print SAHI package version
+- `env` — print environment and dependency versions
 
 ## `predict` command usage
 
diff --git a/sahi/cli.py b/sahi/cli.py
@@ -7,13 +7,16 @@
 from sahi.scripts.coco_error_analysis import analyse
 from sahi.scripts.coco_evaluation import evaluate
 from sahi.scripts.slice_coco import slice
-from sahi.utils.import_utils import print_environment_info
+from sahi.utils.cli_helper import make_click_command
+from sahi.utils.package_utils import print_environment_info
 
 
-@click.group()
+@click.group(help="SAHI command-line utilities: slicing-aided high-resolution inference and COCO tools")
 def cli():
+    """Top-level click group for SAHI CLI."""
     pass
 
+
 coco_app = {
     "evaluate": evaluate,
     "analyse": analyse,
@@ -31,90 +34,23 @@ def cli():
     "env": print_environment_info,
 }
 
-def _make_callback(obj):
-    """Return a callable suitable for click.Command:
-    - if obj is callable, call it with whatever click passes;
-    - otherwise print the object (e.g. version string).
-    """
-    if callable(obj):
-        def _cb(*args, **kwargs):
-            return obj(*args, **kwargs)
-    else:
-        def _cb(*args, **kwargs):
-            click.echo(str(obj))
-    return _cb
-
-import inspect
-
-
-def _click_params_from_signature(func):
-    """Create a list of click.Parameter (Argument/Option) objects from a Python
-    callable's signature. This provides a lightweight automatic mapping so
-    CLI options are available without manually writing decorators.
-
-    Rules (simple, pragmatic):
-    - positional parameters without default -> click.Argument (required)
-    - parameters with a default -> click.Option named --param-name
-    - bool defaults -> is_flag option
-    - list/tuple defaults -> multiple option
-    - skip *args/**kwargs and (self, cls)
-    - use annotation or default value to infer type when possible
-    """
-    params = []
-    sig = inspect.signature(func)
-    for name, p in sig.parameters.items():
-        # skip common unrepresentable params
-        if name in ("self", "cls"):
-            continue
-        if p.kind in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD):
-            # skip *args/**kwargs
-            continue
-
-        if p.default is inspect._empty:
-            # required positional argument
-            params.append(click.Argument([name]))
-        else:
-            opt_name = f"--{name}"
-            # boolean flags
-            if isinstance(p.default, bool):
-                params.append(click.Option([opt_name], is_flag=True, default=p.default, help=f"(auto) default={p.default}"))
-            # lists/tuples -> multiple
-            elif isinstance(p.default, (list, tuple)):
-                params.append(click.Option([opt_name], multiple=True, default=tuple(p.default), help="(auto) multiple"))
-            else:
-                # infer type from annotation or default value
-                param_type = None
-                if p.annotation is not inspect._empty and p.annotation in (int, float, str, bool):
-                    param_type = p.annotation
-                elif p.default is not None:
-                    param_type = type(p.default)
-                else:
-                    param_type = str
-                params.append(click.Option([opt_name], default=p.default, type=param_type, help=f"(auto) default={p.default}"))
-    return params
-
-
-def _make_click_command(name, func):
-    """Build a click.Command for `func`, auto-generating params from signature if callable."""
-    params = _click_params_from_signature(func) if callable(func) else []
-    return click.Command(name, params=params, callback=_make_callback(func))
-
 
 def app() -> None:
     """Cli app."""
-    #fire.Fire(sahi_app)
-    # for loop to add commands to cli
+
     for command_name, command_func in sahi_app.items():
         if isinstance(command_func, dict):
-            # add subcommands
-            sub_cli = click.Group(command_name)
+            # add subcommands (create a named Group with help text)
+            sub_cli = click.Group(command_name, help=f"{command_name} related commands")
             for sub_command_name, sub_command_func in command_func.items():
-                sub_cli.add_command(_make_click_command(sub_command_name, sub_command_func))
+                sub_cli.add_command(make_click_command(sub_command_name, sub_command_func))
             cli.add_command(sub_cli)
         else:
-            cli.add_command(_make_click_command(command_name, command_func))
+            cli.add_command(make_click_command(command_name, command_func))
 
     cli()
 
+
 if __name__ == "__main__":
-    cli()
+    # build the application (register commands) and run
+    app()
diff --git a/sahi/models/base.py b/sahi/models/base.py
@@ -4,7 +4,7 @@
 
 from sahi.logger import logger
 from sahi.prediction import ObjectPrediction
-from sahi.utils.import_utils import check_requirements
+from sahi.utils.package_utils import check_requirements
 from sahi.utils.torch_utils import empty_cuda_cache, select_device
 
 
diff --git a/sahi/models/huggingface.py b/sahi/models/huggingface.py
@@ -7,7 +7,7 @@
 from sahi.models.base import DetectionModel
 from sahi.prediction import ObjectPrediction
 from sahi.utils.compatibility import fix_full_shape_list, fix_shift_amount_list
-from sahi.utils.import_utils import ensure_package_minimum_version
+from sahi.utils.package_utils import ensure_package_minimum_version
 
 
 class HuggingfaceDetectionModel(DetectionModel):
diff --git a/sahi/models/mmdet.py b/sahi/models/mmdet.py
@@ -7,7 +7,7 @@
 from sahi.prediction import ObjectPrediction
 from sahi.utils.compatibility import fix_full_shape_list, fix_shift_amount_list
 from sahi.utils.cv import get_bbox_from_bool_mask, get_coco_segmentation_from_bool_mask
-from sahi.utils.import_utils import check_requirements
+from sahi.utils.package_utils import check_requirements
 
 check_requirements(["torch", "mmdet", "mmcv", "mmengine"])  # noqa: E402
 
diff --git a/sahi/models/ultralytics.py b/sahi/models/ultralytics.py
@@ -9,7 +9,7 @@
 from sahi.prediction import ObjectPrediction
 from sahi.utils.compatibility import fix_full_shape_list, fix_shift_amount_list
 from sahi.utils.cv import get_coco_segmentation_from_bool_mask
-from sahi.utils.import_utils import check_requirements
+from sahi.utils.package_utils import check_requirements
 
 
 class UltralyticsDetectionModel(DetectionModel):
diff --git a/sahi/models/yolov5.py b/sahi/models/yolov5.py
@@ -6,7 +6,7 @@
 from sahi.models.base import DetectionModel
 from sahi.prediction import ObjectPrediction
 from sahi.utils.compatibility import fix_full_shape_list, fix_shift_amount_list
-from sahi.utils.import_utils import check_package_minimum_version, check_requirements
+from sahi.utils.package_utils import check_package_minimum_version, check_requirements
 
 
 class Yolov5DetectionModel(DetectionModel):
diff --git a/sahi/postprocess/combine.py b/sahi/postprocess/combine.py
@@ -5,7 +5,7 @@
 from sahi.logger import logger
 from sahi.postprocess.utils import ObjectPredictionList, has_match, merge_object_prediction_pair
 from sahi.prediction import ObjectPrediction
-from sahi.utils.import_utils import check_requirements
+from sahi.utils.package_utils import check_requirements
 
 
 def batched_nms(predictions: torch.tensor, match_metric: str = "IOU", match_threshold: float = 0.5):
diff --git a/sahi/predict.py b/sahi/predict.py
@@ -5,7 +5,7 @@
 from PIL import Image
 
 from sahi.logger import logger
-from sahi.utils.import_utils import is_available
+from sahi.utils.package_utils import is_available
 
 # TODO: This does nothing for this module. The issue named here does not exist
 # https://github.com/obss/sahi/issues/526
@@ -39,7 +39,7 @@
     visualize_object_predictions,
 )
 from sahi.utils.file import Path, increment_path, list_files, save_json, save_pickle
-from sahi.utils.import_utils import check_requirements
+from sahi.utils.package_utils import check_requirements
 
 POSTPROCESS_NAME_TO_CLASS = {
     "GREEDYNMM": GreedyNMMPostprocess,
diff --git a/sahi/scripts/coco2fiftyone.py b/sahi/scripts/coco2fiftyone.py
@@ -1,8 +1,6 @@
 import time
 from pathlib import Path
 
-import click
-
 from sahi.utils.file import load_json
 
 
@@ -75,7 +73,3 @@ def main(
         print(f"SAHI has successfully launched a Fiftyone app at http://localhost:{fo.config.default_app_port}")
     while 1:
         time.sleep(3)
-
-
-if __name__ == "__main__":
-    fire.Fire(main)
diff --git a/sahi/scripts/coco2yolo.py b/sahi/scripts/coco2yolo.py
@@ -1,7 +1,5 @@
 from typing import Union
 
-import click
-
 from sahi.utils.coco import Coco
 from sahi.utils.file import Path, increment_path
 
@@ -42,7 +40,3 @@ def main(
     )
 
     print(f"COCO to YOLO conversion results are successfully exported to {save_dir}")
-
-
-if __name__ == "__main__":
-    fire.Fire(main)
diff --git a/sahi/scripts/coco_error_analysis.py b/sahi/scripts/coco_error_analysis.py
@@ -5,7 +5,6 @@
 from pathlib import Path
 from typing import List, Optional, Union
 
-import click
 import numpy as np
 
 from sahi.logger import logger
@@ -479,7 +478,3 @@ def analyse(
     )
     if return_dict:
         return result
-
-
-if __name__ == "__main__":
-    fire.Fire(analyse)
diff --git a/sahi/scripts/coco_evaluation.py b/sahi/scripts/coco_evaluation.py
@@ -5,7 +5,6 @@
 from pathlib import Path
 from typing import List, Literal, Optional, Union
 
-import click
 import numpy as np
 from terminaltables import AsciiTable
 
@@ -393,8 +392,3 @@ def evaluate(
     )
     if return_dict:
         return result
-
-
-if __name__ == "__main__":
-    #fire.Fire(evaluate)
-    ...
diff --git a/sahi/scripts/predict.py b/sahi/scripts/predict.py
diff --git a/sahi/scripts/predict_fiftyone.py b/sahi/scripts/predict_fiftyone.py
diff --git a/sahi/scripts/slice_coco.py b/sahi/scripts/slice_coco.py
@@ -1,7 +1,5 @@
 import os
 
-import click
-
 from sahi.slicing import slice_coco
 from sahi.utils.file import Path, save_json
 
@@ -61,7 +59,3 @@ def slice(
         output_coco_annotation_file_path = os.path.join(output_dir, sliced_coco_name + ".json")
         save_json(coco_dict, output_coco_annotation_file_path)
         print(f"Sliced dataset for 'slice_size: {slice_size}' is exported to {output_dir}")
-
-
-if __name__ == "__main__":
-    fire.Fire(slice)
diff --git a/sahi/utils/cli_helper.py b/sahi/utils/cli_helper.py
@@ -0,0 +1,82 @@
+import inspect
+
+import click
+
+
+def _make_callback(obj):
+    """Return a callable suitable for click.Command:
+    - if obj is callable, call it with whatever click passes;
+    - otherwise print the object (e.g. version string).
+
+    """
+    if callable(obj):
+
+        def _cb(*args, **kwargs):
+            return obj(*args, **kwargs)
+    else:
+
+        def _cb(*args, **kwargs):
+            click.echo(str(obj))
+
+    return _cb
+
+
+def _click_params_from_signature(func):
+    """Create a list of click.Parameter (Argument/Option) objects from a Python
+    callable's signature. This provides a lightweight automatic mapping so
+    CLI options are available without manually writing decorators.
+
+    Rules (simple, pragmatic):
+    - positional parameters without default -> click.Argument (required)
+    - parameters with a default -> click.Option named --param-name
+    - bool defaults -> is_flag option
+    - list/tuple defaults -> multiple option
+    - skip *args/**kwargs and (self, cls)
+    - use annotation or default value to infer type when possible
+    """
+    params = []
+    sig = inspect.signature(func)
+    for name, p in sig.parameters.items():
+        # skip common unrepresentable params
+        if name in ("self", "cls"):
+            continue
+        if p.kind in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD):
+            # skip *args/**kwargs
+            continue
+
+        if p.default is inspect._empty:
+            # required positional argument
+            params.append(click.Argument([name]))
+        else:
+            opt_name = f"--{name}"
+            # boolean flags
+            if isinstance(p.default, bool):
+                params.append(
+                    click.Option([opt_name], is_flag=True, default=p.default, help=f"(auto) default={p.default}")
+                )
+            # lists/tuples -> multiple
+            elif isinstance(p.default, (list, tuple)):
+                params.append(click.Option([opt_name], multiple=True, default=tuple(p.default), help="(auto) multiple"))
+            else:
+                # infer type from annotation or default value
+                param_type = None
+                if p.annotation is not inspect._empty and p.annotation in (int, float, str, bool):
+                    param_type = p.annotation
+                elif p.default is not None:
+                    param_type = type(p.default)
+                else:
+                    param_type = str
+                params.append(
+                    click.Option([opt_name], default=p.default, type=param_type, help=f"(auto) default={p.default}")
+                )
+    return params
+
+
+def make_click_command(name, func):
+    """Build a click.Command for `func`, auto-generating params from signature if callable."""
+    params = _click_params_from_signature(func) if callable(func) else []
+    # use function docstring as help when available
+    help_text = None
+    if callable(func):
+        help_text = func.__doc__ if getattr(func, "__doc__", None) else None
+    return click.Command(name, params=params, callback=_make_callback(func), help=help_text)
diff --git a/sahi/utils/fiftyone.py b/sahi/utils/fiftyone.py
diff --git a/sahi/utils/package_utils.py b/sahi/utils/package_utils.py
diff --git a/scripts/utils.py b/scripts/utils.py
diff --git a/tests/test_detectron2_model.py b/tests/test_detectron2_model.py
