Add function for custom format + tests

Author: gmuraru

friendlylog/colored_logger.py

@@ -50,6 +50,18 @@ def format(self, record):
         return super(_ColoredFormatter, self).format(record)
 
 
+def set_fmt(fmt_string):
+    assert isinstance(fmt_string, str), "fmt_string must be string"
+
+    global inner_formatter
+
+    formatter = _ColoredFormatter(
+        fmt=fmt_string
+    )
+    inner_stream_handler.setFormatter(formatter)
+    inner_formatter = formatter
+
+
 _logger = logging.getLogger("friendlylog.ColoredLogger" + "-" + __name__)
 do_not_propagate(_logger)
 

friendlylog/simple_logger.py

@@ -32,6 +32,18 @@ def format(self, record):
         return super(_SimpleFormatter, self).format(record)
 
 
+def set_fmt(fmt_string):
+    assert isinstance(fmt_string, str), "fmt_string must be string"
+
+    global inner_formatter
+
+    formatter = _SimpleFormatter(
+        fmt=fmt_string
+    )
+    inner_stream_handler.setFormatter(formatter)
+    inner_formatter = formatter
+
+
 _logger = logging.getLogger("friendlyLog.SimpleLogger" + "-" + __name__)
 do_not_propagate(_logger)
 
@@ -45,6 +57,7 @@ def format(self, record):
 _logger.setLevel(logging.DEBUG)
 
 
+
 # Export functions and objects.
 inner_logger = _logger  # Don't use this except if you know what you are doing.
 inner_stream_handler = _stream_handler  # Same thing for this object.

tests/test_colored_logger.py

@@ -13,6 +13,8 @@
 class TestColoredLogger(unittest.TestCase):
 
     def setUp(self):
+        self.saved_inner_formatter = logger.inner_formatter
+
         # Remove handler that outputs to STDERR.
         logger.inner_logger.removeHandler(logger.inner_stream_handler)
 
@@ -23,11 +25,12 @@ def setUp(self):
             self.log_capture = io.StringIO()
         handler = logging.StreamHandler(self.log_capture)
         handler.setFormatter(logger.inner_formatter)
+        logger.inner_stream_handler = handler
         logger.inner_logger.addHandler(handler)
         logger.setLevel(logging.DEBUG)
 
     def tearDown(self):
-        pass
+        logger.inner_formatter = self.saved_inner_formatter
 
     def last_line(self):
         log = self.log_capture.getvalue().splitlines()
@@ -210,6 +213,20 @@ def test_non_str_logging(self):
         logger.critical({})
         logger.warning(set([-1, 4]))
 
+    def test_set_custom_fmt(self):
+        dbg_lvls = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+        fmt_string = "[%(funcName)s] %(message)s"
+        logger.set_fmt(fmt_string)
+
+        for level in dbg_lvls:
+            getattr(logger, level.lower())("Hello")
+
+        last_n = self.last_n_lines(len(dbg_lvls))
+        for level, log in zip(dbg_lvls, last_n):
+            self.assertRegex(
+                log,
+                r"\[test_set_custom_fmt\] .*{0}: Hello.*".format(level))
+
 
 if __name__ == '__main__':
     unittest.main()

tests/test_simple_logger.py

@@ -6,13 +6,16 @@
 import unittest
 
 from friendlylog import simple_logger as logger
+
 from threading import Thread
 
 
 # Tests cannot be executed in parallel due to the hack in the setUp method.
 class TestSimpleLogger(unittest.TestCase):
 
     def setUp(self):
+        self.saved_inner_formatter = logger.inner_formatter
+
         # Remove handler that outputs to STDERR.
         logger.inner_logger.removeHandler(logger.inner_stream_handler)
 
@@ -24,10 +27,11 @@ def setUp(self):
         handler = logging.StreamHandler(self.log_capture)
         handler.setFormatter(logger.inner_formatter)
         logger.inner_logger.addHandler(handler)
+        logger.inner_stream_handler = handler
         logger.setLevel(logging.DEBUG)
 
     def tearDown(self):
-        pass
+        logger.inner_formatter = self.saved_inner_formatter
 
     def last_line(self):
         log = self.log_capture.getvalue().splitlines()
@@ -204,6 +208,18 @@ def test_non_str_logging(self):
         logger.critical({})
         logger.warning(set([-1, 4, 10, -100]))
 
+    def test_set_custom_fmt(self):
+        dbg_lvls = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+        fmt_string = "[%(funcName)s] %(message)s"
+        logger.set_fmt(fmt_string)
+
+        for level in dbg_lvls:
+            getattr(logger, level.lower())("Hello")
+
+        last_n = self.last_n_lines(len(dbg_lvls))
+        for level, log in zip(dbg_lvls, last_n):
+            self.assertEqual(f"[test_set_custom_fmt] {level}: Hello", log)
+
 
 if __name__ == '__main__':
     unittest.main()