Generate traceback when running with --debug

The logging module already has support for this via the exc_info argument.

Making this work requires a small change to our custom Formatter, since it's
the Formatter's job to inspect exc_info and include the traceback in the
string output.

Signed-off-by: John Pennycook <john.pennycook@intel.com>

Author: Pennycook

codebasin/__main__.py

@@ -16,6 +16,8 @@
 log = logging.getLogger("codebasin")
 version = "1.2.0"
 
+_traceback = False
+
 
 def _help_string(*lines: str, is_long=False, is_last=False):
     """
@@ -166,6 +168,8 @@ def _main():
     log.setLevel(logging.DEBUG)
     if args.debug:
         min_log_level = logging.DEBUG
+        global _traceback
+        _traceback = True
     else:
         min_log_level = logging.INFO
 
@@ -285,7 +289,7 @@ def main():
     try:
         _main()
     except Exception as e:
-        log.error(str(e))
+        log.error(str(e), exc_info=_traceback)
         sys.exit(1)
 
 

codebasin/_detail/logging.py

@@ -61,6 +61,11 @@ def format(self, record: logging.LogRecord) -> str:
             color = RED
         else:
             color = DEFAULT
+
+        # Print a stack trace if explicitly requested.
+        if record.exc_info:
+            return self.formatException(record.exc_info)
+
         return f"{BOLD}{color}{level}{RESET}: {msg}"