Rename validation functions to private by prefixing with an underscore and update references accordingly.

Author: shoumikchow

bbox_visualizer/core/_utils.py

@@ -3,7 +3,7 @@
 from typing import List, Tuple
 
 
-def validate_bbox(bbox: List[int]) -> None:
+def _validate_bbox(bbox: List[int]) -> None:
     """Validate bounding box format and values.
 
     Args:
@@ -24,7 +24,7 @@ def validate_bbox(bbox: List[int]) -> None:
         )
 
 
-def validate_color(color: Tuple[int, int, int]) -> None:
+def _validate_color(color: Tuple[int, int, int]) -> None:
     """Validate BGR color values.
 
     Args:
@@ -56,7 +56,7 @@ def _check_and_modify_bbox(
     Returns:
         Adjusted bounding box coordinates [x_min, y_min, x_max, y_max]
     """
-    validate_bbox(bbox)
+    _validate_bbox(bbox)
     bbox = [value if value > 0 else margin for value in bbox]
     bbox[2] = bbox[2] if bbox[2] < img_size[1] else img_size[1] - margin
     bbox[3] = bbox[3] if bbox[3] < img_size[0] else img_size[0] - margin

bbox_visualizer/core/flags.py

@@ -5,7 +5,7 @@
 import numpy as np
 from typing import List, Tuple
 
-from ._utils import _check_and_modify_bbox, validate_bbox, validate_color
+from ._utils import _check_and_modify_bbox, _validate_bbox, _validate_color
 from .rectangle import draw_rectangle
 from .labels import add_label
 
@@ -41,8 +41,8 @@ def add_T_label(
     Returns:
         Image with added T-shaped label
     """
-    validate_color(text_bg_color)
-    validate_color(text_color)
+    _validate_color(text_bg_color)
+    _validate_color(text_color)
     bbox = _check_and_modify_bbox(bbox, img.shape)
     (label_width, label_height), baseline = cv2.getTextSize(
         label, font, size, thickness
@@ -126,9 +126,9 @@ def draw_flag_with_label(
     Returns:
         Image with added flag label
     """
-    validate_color(line_color)
-    validate_color(text_bg_color)
-    validate_color(text_color)
+    _validate_color(line_color)
+    _validate_color(text_bg_color)
+    _validate_color(text_color)
     bbox = _check_and_modify_bbox(bbox, img.shape)
     (label_width, label_height), baseline = cv2.getTextSize(
         label, font, size, thickness
@@ -204,8 +204,8 @@ def add_multiple_T_labels(
     if len(bboxes) != len(labels):
         raise ValueError("Number of bounding boxes must match number of labels")
 
-    validate_color(text_bg_color)
-    validate_color(text_color)
+    _validate_color(text_bg_color)
+    _validate_color(text_color)
     for label, bbox in zip(labels, bboxes):
         img = add_T_label(
             img,
@@ -249,9 +249,9 @@ def draw_multiple_flags_with_labels(
     if len(bboxes) != len(labels):
         raise ValueError("Number of bounding boxes must match number of labels")
 
-    validate_color(line_color)
-    validate_color(text_bg_color)
-    validate_color(text_color)
+    _validate_color(line_color)
+    _validate_color(text_bg_color)
+    _validate_color(text_color)
     for label, bbox in zip(labels, bboxes):
         img = draw_flag_with_label(
             img,

bbox_visualizer/core/labels.py

@@ -1,10 +1,10 @@
-"""Functions for drawing labels."""
+"""Functions for adding text labels to bounding boxes."""
 
 import cv2
 import numpy as np
 from typing import List, Tuple
 
-from ._utils import _check_and_modify_bbox, validate_bbox, validate_color
+from ._utils import _check_and_modify_bbox, _validate_bbox, _validate_color
 
 font = cv2.FONT_HERSHEY_SIMPLEX
 
@@ -39,8 +39,8 @@ def add_label(
     Returns:
         Image with added label
     """
-    validate_color(text_bg_color)
-    validate_color(text_color)
+    _validate_color(text_bg_color)
+    _validate_color(text_color)
     bbox = _check_and_modify_bbox(bbox, img.shape)
 
     (text_width, text_height), baseline = cv2.getTextSize(label, font, size, thickness)
@@ -147,8 +147,8 @@ def add_multiple_labels(
     if len(bboxes) != len(labels):
         raise ValueError("Number of bounding boxes must match number of labels")
 
-    validate_color(text_bg_color)
-    validate_color(text_color)
+    _validate_color(text_bg_color)
+    _validate_color(text_color)
     for label, bbox in zip(labels, bboxes):
         img = add_label(
             img, label, bbox, size, thickness, draw_bg, text_bg_color, text_color, top

bbox_visualizer/core/rectangle.py

@@ -4,7 +4,7 @@
 import numpy as np
 from typing import List, Tuple
 
-from ._utils import _check_and_modify_bbox, validate_bbox, validate_color
+from ._utils import _check_and_modify_bbox, _validate_bbox, _validate_color
 
 
 def draw_rectangle(
@@ -28,7 +28,7 @@ def draw_rectangle(
     Returns:
         Image with drawn rectangle
     """
-    validate_color(bbox_color)
+    _validate_color(bbox_color)
     bbox = _check_and_modify_bbox(bbox, img.shape)
 
     output = img.copy()
@@ -67,7 +67,7 @@ def draw_multiple_rectangles(
     """
     if not bboxes:
         raise ValueError("List of bounding boxes cannot be empty")
-    validate_color(bbox_color)
+    _validate_color(bbox_color)
     for bbox in bboxes:
         img = draw_rectangle(img, bbox, bbox_color, thickness, is_opaque, alpha)
     return img