From 7ddb9f5892c04ffbd4aedd9f713b82c8ce74ff3f Mon Sep 17 00:00:00 2001
From: "Salvador E. Tropea" <salvador@inti.gob.ar>
Date: Thu, 28 Apr 2022 14:43:08 -0300
Subject: [PATCH] Modified the log system to allow parallel file logging

- During quick start targets generation we log with full verbosity
  to a file and with the selected verbosity to the console.
---
 kibot/__main__.py        |  4 +---
 kibot/bom/xlsx_writer.py |  7 ++++++-
 kibot/log.py             | 33 +++++++++++++++++++++++++++++----
 3 files changed, 36 insertions(+), 8 deletions(-)

diff --git a/kibot/__main__.py b/kibot/__main__.py
index 6f095b18..1283cea8 100644
--- a/kibot/__main__.py
+++ b/kibot/__main__.py
@@ -70,7 +70,6 @@ import re
 import gzip
 import locale
 from glob import glob
-from logging import DEBUG
 
 # Import log first to set the domain
 from . import log
@@ -234,8 +233,7 @@ def main():
     args = docopt(__doc__, version=ver, options_first=True)
 
     # Set the specified verbosity
-    log.set_verbosity(logger, args.verbose, args.quiet)
-    GS.debug_enabled = logger.getEffectiveLevel() <= DEBUG
+    GS.debug_enabled = log.set_verbosity(logger, args.verbose, args.quiet)
     GS.debug_level = args.verbose
     # Now we have the debug level set we can check (and optionally inform) KiCad info
     detect_kicad()
diff --git a/kibot/bom/xlsx_writer.py b/kibot/bom/xlsx_writer.py
index 9a27335f..31777791 100644
--- a/kibot/bom/xlsx_writer.py
+++ b/kibot/bom/xlsx_writer.py
@@ -54,7 +54,12 @@ try:
     from kicost.config import load_config
     # Progress mechanism: use the one declared in __main__ (TQDM)
     from kicost.__main__ import ProgressConsole
-    set_distributors_progress(ProgressConsole)
+
+    class ProgressConsole2(ProgressConsole):
+        def __init__(self, total, logger):
+            super().__init__(total, logger)
+            self.logTqdmHandler.addFilter(log.FilterNoInfo())
+    set_distributors_progress(ProgressConsole2)
     KICOST_SUPPORT = True
 except ModuleNotFoundError:
     KICOST_SUPPORT = False
diff --git a/kibot/log.py b/kibot/log.py
index e4713ff1..13934510 100644
--- a/kibot/log.py
+++ b/kibot/log.py
@@ -24,6 +24,8 @@ else:
 # Default domain, base name for the tool
 domain = 'kilog'
 filters = None
+root_logger = None
+visual_level = None
 
 
 def get_logger(name=None):
@@ -117,16 +119,25 @@ def set_verbosity(logger, verbose, quiet):
         log_level = logging.DEBUG
     if quiet:
         log_level = logging.WARNING
-    logger.setLevel(log_level)
+    # We use debug level but we then filter according to the desired level (visual_level)
+    # In this way we can log debug to files and only the user level to the console
+    logger.setLevel(logging.DEBUG)
+    global visual_level
+    visual_level = log_level
+    return log_level <= logging.DEBUG
 
 
 class FilterOnlyInfo(object):
     def filter(self, record):
+        if visual_level is not None and record.levelno < visual_level:
+            return False
         return record.levelno == logging.INFO
 
 
 class FilterNoInfo(object):
     def filter(self, record):
+        if visual_level is not None and record.levelno < visual_level:
+            return False
         return record.levelno != logging.INFO
 
 
@@ -141,21 +152,23 @@ def init():
     ch.addFilter(FilterNoInfo())
     ch.setFormatter(CustomFormatter(sys.stderr))
     logger.addHandler(ch)
-    # Handler for t info.
+    # Handler for info.
     # Outputs to stdout
     ch = logging.StreamHandler(sys.stdout)
     ch.addFilter(FilterOnlyInfo())
     ch.setFormatter(CustomFormatter(sys.stdout))
     logger.addHandler(ch)
+    global root_logger
+    root_logger = logger
     return logger
 
 
 class CustomFormatter(logging.Formatter):
     """Logging Formatter to add colors"""
 
-    def __init__(self, stream):
+    def __init__(self, stream=None):
         super(logging.Formatter, self).__init__()
-        if stream.isatty():
+        if stream is not None and stream.isatty():
             white = Fore.WHITE
             yellow = Fore.YELLOW + Style.BRIGHT
             red = Fore.RED + Style.BRIGHT
@@ -186,3 +199,15 @@ class CustomFormatter(logging.Formatter):
         log_fmt = self.FORMATS.get(record.levelno)
         formatter = logging.Formatter(log_fmt)
         return formatter.format(record)
+
+
+def set_file_log(fname):
+    fh = logging.FileHandler(fname)
+    fh.setLevel(logging.DEBUG)
+    fh.setFormatter(CustomFormatter())
+    root_logger.addHandler(fh)
+    return fh
+
+
+def remove_file_log(fh):
+    root_logger.removeHandler(fh)