Add method and context manager to suppress warnings

Author: shoumikchow

bbox_visualizer/__init__.py

@@ -10,6 +10,8 @@
     draw_multiple_flags_with_labels,
     draw_multiple_rectangles,
     draw_rectangle,
+    suppress_warnings,
+    warnings_suppressed,
 )
 
 __all__ = [
@@ -22,6 +24,8 @@
     "draw_multiple_flags_with_labels",
     "draw_multiple_rectangles",
     "draw_rectangle",
+    "suppress_warnings",
+    "warnings_suppressed",
 ]
 
 __author__ = """Shoumik Sharar Chowdhury"""

bbox_visualizer/core/_utils.py

@@ -1,5 +1,41 @@
 """Internal utilities for bbox-visualizer."""
 
+import logging
+from contextlib import contextmanager
+from typing import List, Tuple
+
+# Global flag to track warning suppression state
+_warnings_suppressed = False
+
+def suppress_warnings(suppress: bool = True) -> None:
+    """Suppress or enable warning messages from bbox-visualizer.
+
+    Args:
+        suppress: If True, suppress all warnings. If False, enable warnings.
+    """
+    global _warnings_suppressed
+    _warnings_suppressed = suppress
+
+@contextmanager
+def warnings_suppressed():
+    """Context manager to temporarily suppress warnings.
+
+    Example:
+        >>> with warnings_suppressed():
+        ...     # Warnings will be suppressed in this block
+        ...     pass
+    """
+    previous_state = _warnings_suppressed
+    suppress_warnings(True)
+    try:
+        yield
+    finally:
+        suppress_warnings(previous_state)
+
+def _should_suppress_warning() -> bool:
+    """Internal function to check if warnings should be suppressed."""
+    return _warnings_suppressed
+
 from typing import List, Tuple
 
 

bbox_visualizer/core/flags.py

@@ -6,7 +6,7 @@
 import cv2
 import numpy as np
 
-from ._utils import _check_and_modify_bbox, _validate_color
+from ._utils import _check_and_modify_bbox, _validate_color, _should_suppress_warning
 from .labels import add_label
 from .rectangle import draw_rectangle
 
@@ -59,9 +59,10 @@ def add_T_label(
     y_top = y_bottom - label_height - 2 * padding
 
     if y_top < 0:
-        logging.warning(
-            "Labelling style 'T' going out of frame. Falling back to normal labeling."
-        )
+        if not _should_suppress_warning():
+            logging.warning(
+                "Labelling style 'T' going out of frame. Falling back to normal labeling."
+            )
         return add_label(img, label, bbox)
 
     cv2.line(img, (x_center, bbox[1]), (x_center, line_top), text_bg_color, 3)
@@ -139,9 +140,10 @@ def draw_flag_with_label(
     y_bottom = int(bbox[1] * 0.75 + bbox[3] * 0.25)
     y_top = bbox[1] - (y_bottom - bbox[1])
     if y_top < 0:
-        logging.warning(
-            "Labelling style 'Flag' going out of frame. Falling back to normal labeling."
-        )
+        if not _should_suppress_warning():
+            logging.warning(
+                "Labelling style 'Flag' going out of frame. Falling back to normal labeling."
+            )
         img = draw_rectangle(img, bbox, bbox_color=line_color)
         return add_label(img, label, bbox)
 

docs/api.rst

@@ -4,6 +4,15 @@ API Reference
 Core Functionality
 ----------------
 
+Warning Control
+~~~~~~~~~~~~~
+
+.. automodule:: bbox_visualizer.core._utils
+   :members: suppress_warnings, warnings_suppressed
+   :undoc-members:
+   :show-inheritance:
+   :no-index:
+
 Rectangle Drawing
 ~~~~~~~~~~~~~~~
 

docs/usage.rst

@@ -15,6 +15,24 @@ To use bbox-visualizer in a project:
     # Load an image
     image = cv2.imread('image.jpg')
 
+Warning Control
+-------------
+
+The library provides functionality to control warning messages:
+
+.. code-block:: python
+
+    # Suppress all warnings
+    bbv.suppress_warnings(True)
+
+    # Enable warnings
+    bbv.suppress_warnings(False)
+
+    # Temporarily suppress warnings using context manager
+    with bbv.warnings_suppressed():
+        # Warnings will be suppressed in this block
+        image = bbv.draw_flag_with_label(image, "Object", bbox)
+
 Drawing Rectangles
 ----------------
 

tests/test_bbox_visualizer.py

@@ -4,6 +4,7 @@
 import pytest
 
 from bbox_visualizer.core import flags, labels, rectangle
+from bbox_visualizer.core._utils import suppress_warnings, warnings_suppressed
 
 
 @pytest.fixture
@@ -328,3 +329,32 @@ def test_color_parameters(sample_image, sample_bbox):
         flags.add_T_label(
             sample_image, "test", sample_bbox, text_bg_color=(0, 0, 300)
         )  # Invalid RGB
+
+
+def test_warning_suppression(sample_image, sample_bbox, sample_label, caplog):
+    """Test warning suppression functionality."""
+    # Test global warning suppression
+    suppress_warnings(True)
+    with caplog.at_level(logging.WARNING):
+        flags.draw_flag_with_label(sample_image, sample_label, [10, 0, 50, 10])
+    assert len(caplog.records) == 0  # No warnings should be logged
+
+    # Test warning re-enabling
+    suppress_warnings(False)
+    with caplog.at_level(logging.WARNING):
+        flags.draw_flag_with_label(sample_image, sample_label, [10, 0, 50, 10])
+    assert len(caplog.records) > 0  # Warnings should be logged
+    assert "Labelling style 'Flag' going out of frame" in caplog.text
+
+    # Test context manager
+    caplog.clear()
+    with warnings_suppressed():
+        with caplog.at_level(logging.WARNING):
+            flags.draw_flag_with_label(sample_image, sample_label, [10, 0, 50, 10])
+    assert len(caplog.records) == 0  # No warnings should be logged
+
+    # Test warning restoration after context manager
+    with caplog.at_level(logging.WARNING):
+        flags.draw_flag_with_label(sample_image, sample_label, [10, 0, 50, 10])
+    assert len(caplog.records) > 0  # Warnings should be logged again
+    assert "Labelling style 'Flag' going out of frame" in caplog.text