Feature/loggerclean3 (#16)

* doc: removed bitbucket pipeline [ci-skip]

* chore: moved pipeline and created reduced conda env spec

* fix: cleaned customised logger classes

* doc: added tags to sections of script templates

---------

Co-authored-by: Julien Lerat <[email protected]>

Author: jlerat

hydrodiy/io/iutils.py

@@ -121,11 +121,29 @@ def script_template(filename, comment,
     os.chmod(filename, st.st_mode | stat.S_IEXEC)
 
 
-class StartedCompletedLogger(logging.Logger):
+class StartedCompletedLogger():
     """ Add context to logging messages via the context attribute """
 
-    def __init__(self, *args, **kwargs):
-        super(StartedCompletedLogger, self).__init__(*args, **kwargs)
+    def __init__(self, logger):
+        errmess = "Expected a logger object"
+        assert isinstance(logger, logging.Logger), errmess
+        self._logger = logger
+
+    def error(self, msg, *args, **kwargs):
+        return self._logger.error(msg, *args, **kwargs)
+
+    def info(self, msg, *args, **kwargs):
+        return self._logger.info(msg, *args, **kwargs)
+
+    def warning(self, msg, *args, **kwargs):
+        return self._logger.warning(msg, *args, **kwargs)
+
+    def critical(self, msg, *args, **kwargs):
+        return self._logger.critical(msg, *args, **kwargs)
+
+    @property
+    def handlers(self):
+        return self._logger.handlers
 
     def started(self):
         self.info("@@@ Process started @@@")
@@ -138,37 +156,52 @@ def completed(self):
         self.info("@@@ Process completed @@@")
 
 
-class HydrodiyContextualLogger(StartedCompletedLogger):
+class ContextualLogger(StartedCompletedLogger):
     """ Add context to logging messages via the context attribute """
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, logger):
         self._context = ""
-        super(HydrodiyContextualLogger, self).__init__(*args, **kwargs)
+        super(ContextualLogger, self).__init__(logger)
 
     @property
     def context(self):
         return self._context
 
     @context.setter
     def context(self, value):
+        self._context = ""
+        self.info("")
         self._context = str(value)
         if self._context != "":
-            self.info("")
             sep = LOGGER_SEPARATOR_CONTEXTUAL\
                         *LOGGER_NSEPARATORS_CONTEXTUAL
             mess = sep+" "+self._context+" "+sep
             self.info(mess)
 
     def completed(self):
         self.context = ""
-        super(HydrodiyContextualLogger, self).completed()
+        super(ContextualLogger, self).completed()
 
-    def _log(self, level, msg, args, exc_info=None, extra=None):
+    def get_message(self, msg):
         if self.context != "":
-            msg = "{{ {0} }} {1}".format(self.context, msg)
+            return "{{ {0} }} {1}".format(self.context, msg)
+        return msg
+
+    def error(self, msg, *args, **kwargs):
+        msg = self.get_message(msg)
+        return self._logger.error(msg, *args, **kwargs)
 
-        super(HydrodiyContextualLogger, self)._log(\
-                        level, msg, args, exc_info, extra)
+    def info(self, msg, *args, **kwargs):
+        msg = self.get_message(msg)
+        return self._logger.info(msg, *args, **kwargs)
+
+    def warning(self, msg, *args, **kwargs):
+        msg = self.get_message(msg)
+        return self._logger.warning(msg, *args, **kwargs)
+
+    def critical(self, msg, *args, **kwargs):
+        msg = self.get_message(msg)
+        return self._logger.critical(msg, *args, **kwargs)
 
 
 def get_logger(name, level="INFO", \
@@ -271,17 +304,13 @@ def catcherr(exc_type, exc_value, exc_traceback):
     # Close all handlers
     [h.close() for h in logger.handlers]
 
-    # Create the contextual logger
-    if contextual:
-        # A bit dangerous, but will do for now
-        logger.__class__ = HydrodiyContextualLogger
-        logger.context = ""
-    else:
-        logger.__class__ = StartedCompletedLogger
+    # Create the extended logger
+    elogger = ContextualLogger(logger) if contextual else \
+                    StartedCompletedLogger(logger)
 
     if start_message:
-        logger.started()
+        elogger.started()
 
-    return logger
+    return elogger
 
 

hydrodiy/io/script_template_plot.py

@@ -41,7 +41,7 @@
 #importlib.reload(utils)
 
 #----------------------------------------------------------------------
-# Config
+# @Config
 #----------------------------------------------------------------------
 
 parser = argparse.ArgumentParser(\
@@ -81,7 +81,7 @@
 #proj = pyproj.Proj("+init=EPSG:{0}".format(args.projection))
 #
 #----------------------------------------------------------------------
-# Folders
+# @Folders
 #----------------------------------------------------------------------
 source_file = Path(__file__).resolve()
 
@@ -91,13 +91,13 @@
 fimg = [FIMG]
 
 #------------------------------------------------------------
-# Logging
+# @Logging
 #------------------------------------------------------------
 basename = source_file.stem
 LOGGER = iutils.get_logger(basename)
 
 #------------------------------------------------------------
-# Get data
+# @Get data
 #------------------------------------------------------------
 #fd = "%s/data.csv" % FDATA
 #data, comment = csv.read_csv(fd)
@@ -108,7 +108,7 @@
 LOGGER.info(mess)
 
 #------------------------------------------------------------
-# Plot
+# @Plot
 #------------------------------------------------------------
 
 # To use multipage pdf

hydrodiy/io/script_template_simple.py

@@ -24,7 +24,7 @@
 #spec.loader.exec_module(foo)
 
 #----------------------------------------------------------------------
-# Config
+# @Config
 #----------------------------------------------------------------------
 parser = argparse.ArgumentParser(\
     description="[DESCRIPTION]", \
@@ -59,7 +59,7 @@
 sitepattern = args.sitepattern
 
 #----------------------------------------------------------------------
-# Folders
+# @Folders
 #----------------------------------------------------------------------
 source_file = Path(__file__).resolve()
 froot = [FROOT]
@@ -68,15 +68,15 @@
 fimg = [FIMG]
 
 #----------------------------------------------------------------------
-# Logging
+# @Logging
 #----------------------------------------------------------------------
 basename = source_file.stem
 flog = froot / "logs" / f"{basename}.log"
 flog.parent.mkdir(exist_ok=True)
 LOGGER = iutils.get_logger(basename, console=False, contextual=True)
 
 #----------------------------------------------------------------------
-# Get data
+# @Get data
 #----------------------------------------------------------------------
 fs = fdata / "sites.csv"
 allsites, _ = csv.read_csv(fs, index_col="siteid")
@@ -92,7 +92,7 @@
         sites = allsites.iloc[idx, :]
 
 #----------------------------------------------------------------------
-# Process
+# @Process
 #----------------------------------------------------------------------
 nsites = len(sites)
 for isite, (siteid, sinfo) in enumerate(sites.iterrows()):

hydrodiy/io/tests/test_hyio_iutils.py

@@ -121,6 +121,9 @@ def test_get_logger():
     mess = ["flog1 A", "flog1 B"]
     logger1.info(mess[0])
     logger1.info(mess[1])
+    logger1.error("error")
+    logger1.critical("critical")
+    logger1.warning("warning")
 
     assert flog1.exists()
 
@@ -130,6 +133,9 @@ def test_get_logger():
     ck = txt[0].strip().endswith("INFO | @@@ Process started @@@")
     ck = ck & txt[3].strip().endswith("INFO | "+mess[0])
     ck = ck & txt[4].strip().endswith("INFO | "+mess[1])
+    ck = ck & txt[5].strip().endswith("ERROR | error")
+    ck = ck & txt[6].strip().endswith("CRITICAL | critical")
+    ck = ck & txt[7].strip().endswith("WARNING | warning")
     assert ck
 
     # Test logging with different format
@@ -172,6 +178,10 @@ def test_get_logger_contextual():
 
     logger.context = "context2"
     logger.info(mess[1])
+    logger.error("error")
+    logger.critical("critical")
+    logger.warning("warning")
+
     logger.completed()
 
     assert flog.exists()
@@ -180,9 +190,12 @@ def test_get_logger_contextual():
         txt = fl.readlines()
 
     ck = bool(re.search("@@@ Process started @@@", txt[0]))
-    ck &= bool(re.search("\\{ context1 \\}", txt[5]))
-    ck &= bool(re.search("\\{ context2 \\}", txt[8]))
-    ck &= bool(re.search("@@@ Process completed @@@", txt[11]))
+    ck &= bool(re.search("\\{ context1 \\}", txt[4]))
+    ck &= bool(re.search("\\{ context2 \\}", txt[7]))
+    ck &= bool(re.search("ERROR . \\{ context2 \\}", txt[9]))
+    ck &= bool(re.search("CRITICAL . \\{ context2 \\}", txt[10]))
+    ck &= bool(re.search("WARNING . \\{ context2 \\}", txt[11]))
+    ck &= bool(re.search("@@@ Process completed @@@", txt[15]))
     assert ck
 
     logger.handlers[1].close()