Colored terminal output for warnings and errors

CHANGELOG.md

@@ -11,6 +11,7 @@ Copyright (c) 2021-2024 Claudio Satriano <[email protected]>
   - avoid duplicated column guessing
   - ensure that prefectly matching column field names are correctly guessed
   - warn if an invalid time format is found
+- Colored terminal output for warnings and errors
 
 ## v0.6 - 2024-05-04
 

requake/config/rq_setup.py

@@ -64,6 +64,33 @@ def _make_outdir(outdir):
 ''')
 
 
+def _color_handler_emit(fn):
+    """
+    Add color-coding to the logging handler emitter.
+
+    Source: https://stackoverflow.com/a/20707569/2021880
+    """
+    def new(*args):
+        levelno = args[0].levelno
+        if levelno >= logging.CRITICAL:
+            color = '\x1b[31;1m'  # red
+        elif levelno >= logging.ERROR:
+            color = '\x1b[31;1m'  # red
+        elif levelno >= logging.WARNING:
+            color = '\x1b[33;1m'  # yellow
+        elif levelno >= logging.INFO:
+            # color = '\x1b[32;1m'  # green
+            color = '\x1b[0m'  # no color
+        elif levelno >= logging.DEBUG:
+            color = '\x1b[35;1m'  # purple
+        else:
+            color = '\x1b[0m'  # no color
+        # Color-code the message
+        args[0].msg = f'{color}{args[0].msg}\x1b[0m'
+        return fn(*args)
+    return new
+
+
 def _setup_logging(progname, action_name):
     """Set up the logging infrastructure."""
     global logger
@@ -106,6 +133,9 @@ def emit(self, record):
                 self.handleError(record)
     console = TqdmLoggingHandler()
     console.setLevel(logging.INFO)
+    # Add logger color coding on all platforms but win32
+    if sys.platform != 'win32' and sys.stdout.isatty():
+        console.emit = _color_handler_emit(console.emit)
     logger_root.addHandler(console)
 
     logger = logging.getLogger(progname)