feat: clarified logger messages

Author: jlerat

hydrodiy/io/iutils.py

@@ -18,6 +18,12 @@
 import numpy as np
 import pandas as pd
 
+# Configuration of logging messages
+LOGGER_NSEPARATORS = 50
+LOGGER_SEPARATOR = "-"
+LOGGER_NSEPARATORS_CONTEXTUAL = 3
+LOGGER_SEPARATOR_CONTEXTUAL = "#"
+
 
 def script_template(filename, comment,
         type="simple",
@@ -119,25 +125,44 @@ class StartedCompletedLogger(logging.Logger):
     """ Add context to logging messages via the context attribute """
 
     def __init__(self, *args, **kwargs):
-        self.context = ""
         super(StartedCompletedLogger, self).__init__(*args, **kwargs)
 
     def started(self):
         self.info("@@@ Process started @@@")
+        self.info(LOGGER_SEPARATOR*LOGGER_NSEPARATORS)
+        self.info("")
 
     def completed(self):
-        self.context = ""
         self.info("")
+        self.info(LOGGER_SEPARATOR*LOGGER_NSEPARATORS)
         self.info("@@@ Process completed @@@")
 
 
 class HydrodiyContextualLogger(StartedCompletedLogger):
     """ Add context to logging messages via the context attribute """
 
     def __init__(self, *args, **kwargs):
-        self.context = ""
+        self._context = ""
         super(HydrodiyContextualLogger, self).__init__(*args, **kwargs)
 
+    @property
+    def context(self):
+        return self._context
+
+    @context.setter
+    def context(self, value):
+        self._context = str(value)
+        if self._context != "":
+            self.info(LOGGER_SEPARATOR*LOGGER_NSEPARATORS)
+            sep = LOGGER_SEPARATOR_CONTEXTUAL\
+                        *LOGGER_NSEPARATORS_CONTEXTUAL
+            mess = sep+" "+self._context+" "+sep
+            self.info(mess)
+
+    def completed(self):
+        self.context = ""
+        super(HydrodiyContextualLogger, self).completed()
+
     def _log(self, level, msg, args, exc_info=None, extra=None):
         if self.context != "":
             msg = "{{ {0} }} {1}".format(self.context, msg)

hydrodiy/io/tests/test_hyio_iutils.py

@@ -126,9 +126,10 @@ def test_get_logger():
 
     with open(flog1, "r") as fl:
         txt = fl.readlines()
+
     ck = txt[0].strip().endswith("INFO | @@@ Process started @@@")
-    ck = ck & txt[1].strip().endswith("INFO | "+mess[0])
-    ck = ck & txt[2].strip().endswith("INFO | "+mess[1])
+    ck = ck & txt[3].strip().endswith("INFO | "+mess[0])
+    ck = ck & txt[4].strip().endswith("INFO | "+mess[1])
     assert ck
 
     # Test logging with different format
@@ -145,8 +146,8 @@ def test_get_logger():
 
     with open(flog2, "r") as fl:
         txt = fl.readlines()
-    expected = ["@@@ Process started @@@"]+mess+\
-                ["", "@@@ Process completed @@@"]
+    expected = ["@@@ Process started @@@", "-"*50, ""]+mess+\
+                ["", "-"*50, "@@@ Process completed @@@"]
     assert expected == [t.strip() for t in txt]
 
     # Close log file handler and delete files
@@ -179,9 +180,9 @@ def test_get_logger_contextual():
         txt = fl.readlines()
 
     ck = bool(re.search("@@@ Process started @@@", txt[0]))
-    ck &= bool(re.search("\\{ context1 \\}", txt[1]))
-    ck &= bool(re.search("\\{ context2 \\}", txt[2]))
-    ck &= bool(re.search("@@@ Process completed @@@", txt[4]))
+    ck &= bool(re.search("\\{ context1 \\}", txt[5]))
+    ck &= bool(re.search("\\{ context2 \\}", txt[8]))
+    ck &= bool(re.search("@@@ Process completed @@@", txt[11]))
     assert ck
 
     logger.handlers[1].close()