[shared] Fix tqdm.logging_redirect_tqdm not respecting logger verbosity

Being tracked by tqdm/tqdm#1272 upstream.

Author: Breakthrough

dvr_scan/__main__.py

@@ -18,9 +18,9 @@
 from subprocess import CalledProcessError
 
 from scenedetect import VideoOpenFailure
-from scenedetect.platform import FakeTqdmLoggingRedirect, logging_redirect_tqdm
 
 from dvr_scan.controller import parse_settings, run_dvr_scan
+from dvr_scan.shared import logging_redirect_tqdm
 
 EXIT_SUCCESS: int = 0
 EXIT_ERROR: int = 1
@@ -32,14 +32,9 @@ def main():
     if settings is None:
         sys.exit(EXIT_ERROR)
     logger = logging.getLogger("dvr_scan")
-    # TODO(1.7): The logging redirect does not respect the original log level, which is now set to
-    # DEBUG mode for rolling log files. https://github.com/tqdm/tqdm/issues/1272
-    # We might have to just roll our own instead of relying on this one.
-    redirect = FakeTqdmLoggingRedirect if settings.get("quiet-mode") else logging_redirect_tqdm
-    # TODO: Use Python __debug__ mode instead of hard-coding as config option.
     debug_mode = settings.get("debug")
     show_traceback = getattr(logging, settings.get("verbosity").upper()) == logging.DEBUG
-    with redirect(loggers=[logger]):
+    with logging_redirect_tqdm(loggers=[logger]):
         try:
             run_dvr_scan(settings)
         except ValueError as ex:

dvr_scan/app/__main__.py

@@ -15,13 +15,18 @@
 from subprocess import CalledProcessError
 
 from scenedetect import VideoOpenFailure
-from scenedetect.platform import FakeTqdmLoggingRedirect, logging_redirect_tqdm
 
 import dvr_scan
 from dvr_scan import get_license_info
 from dvr_scan.app.application import Application
 from dvr_scan.config import CHOICE_MAP, USER_CONFIG_FILE_PATH, ConfigLoadFailure, ConfigRegistry
-from dvr_scan.shared import ScanSettings, init_logging, logfile_path, setup_logger
+from dvr_scan.shared import (
+    ScanSettings,
+    init_logging,
+    logfile_path,
+    logging_redirect_tqdm,
+    setup_logger,
+)
 from dvr_scan.shared.cli import VERSION_STRING, LicenseAction, VersionAction, string_type_check
 
 logger = logging.getLogger("dvr_scan")
@@ -163,15 +168,10 @@ def main():
         # failure reason to the user above. We can now exit with an error code.
         raise SystemExit(1)
 
-    # TODO(1.7): The logging redirect does not respect the original log level, which is now set to
-    # DEBUG mode for rolling log files. https://github.com/tqdm/tqdm/issues/1272
-    # We can just remove the use of a context manager here and install our own hooks into the
-    # loggers instead as a follow-up action.
-    redirect = FakeTqdmLoggingRedirect if settings.get("quiet-mode") else logging_redirect_tqdm
     show_traceback = getattr(logging, settings.get("verbosity").upper()) == logging.DEBUG
     # TODO: Use Python __debug__ mode instead of hard-coding as config option.
     debug_mode = settings.get("debug")
-    with redirect(loggers=[logger]):
+    with logging_redirect_tqdm(loggers=[logger]):
         try:
             app = Application(
                 settings=settings, initial_videos=args.input if hasattr(args, "input") else []

dvr_scan/shared/__init__.py

@@ -14,12 +14,23 @@
 import argparse
 import logging
 import typing as ty
+from contextlib import contextmanager
 from logging.handlers import RotatingFileHandler
 from pathlib import Path
 
+import tqdm
 from platformdirs import user_log_path
 from scenedetect import FrameTimecode
 
+# TODO: This is a hack and will break eventually, but this is the only way to handle this
+# right now unfortunately. logging_redirect_tqdm from the tqdm contrib module doesn't respect
+# verbosity unfortunately. This is being tracked by https://github.com/tqdm/tqdm/issues/1272.
+from tqdm.contrib.logging import (
+    _get_first_found_console_logging_handler,
+    _is_console_logging_handler,
+    _TqdmLoggingHandler,
+)
+
 from dvr_scan.overlays import BoundingBoxOverlay, TextOverlay
 from dvr_scan.platform import LOG_FORMAT_ROLLING_LOGS, attach_log_handler
 from dvr_scan.platform import init_logger as _init_logger
@@ -186,3 +197,57 @@ def init_scanner(
     )
 
     return scanner
+
+
+@contextmanager
+def logging_redirect_tqdm(
+    loggers: ty.Optional[ty.List[logging.Logger]], instance: ty.Type = tqdm.tqdm
+):
+    """
+    Context manager redirecting console logging to `tqdm.write()`, leaving
+    other logging handlers (e.g. log files) unaffected.
+
+    Parameters
+    ----------
+    loggers  : list, optional
+      Which handlers to redirect (default: [logging.root]).
+    tqdm_class  : optional
+
+    Example
+    -------
+    ```python
+    import logging
+    from tqdm import trange
+    from tqdm.contrib.logging import logging_redirect_tqdm
+
+    LOG = logging.getLogger(__name__)
+
+    if __name__ == "__main__":
+        logging.basicConfig(level=logging.INFO)
+        with logging_redirect_tqdm():
+            for i in trange(9):
+                if i == 4:
+                    LOG.info("console logging redirected to `tqdm.write()`")
+        # logging restored
+    ```
+    """
+    if loggers is None:
+        loggers = [logging.root]
+    original_handlers_list = [logger.handlers for logger in loggers]
+    try:
+        for logger in loggers:
+            tqdm_handler = _TqdmLoggingHandler(instance)
+            orig_handler = _get_first_found_console_logging_handler(logger.handlers)
+            if orig_handler is not None:
+                tqdm_handler.setFormatter(orig_handler.formatter)
+                tqdm_handler.stream = orig_handler.stream
+                # The following is missing from the original logging_redirect_tqdm.
+                # This is being tracked by https://github.com/tqdm/tqdm/issues/1272.
+                tqdm_handler.setLevel(orig_handler.level)
+            logger.handlers = [
+                handler for handler in logger.handlers if not _is_console_logging_handler(handler)
+            ] + [tqdm_handler]
+        yield
+    finally:
+        for logger, original_handlers in zip(loggers, original_handlers_list):
+            logger.handlers = original_handlers