logging: Add support for custom handlers.

dpgeorge · dpgeorge · commit 7b1161dd1b07 · 2020-07-08T15:59:01.000+10:00
Any custom handlers will be passed a LogRecord instance which has members
and a dict with "levelname", "message" and "name", to be used for creating
a log message.  The handler list is a global singleton so that sub-logging
objects all use the same set of (root) handlers.

The name of the root handler is also changed from None to "root", to match
CPython.

Signed-off-by: Damien George &lt;damien@micropython.org&gt;
diff --git a/logging/example_logging.py b/logging/example_logging.py
@@ -13,3 +13,10 @@
     1/0
 except:
     log.exception("Some trouble (%s)", "expected")
+
+class MyHandler(logging.Handler):
+    def emit(self, record):
+        print("levelname=%(levelname)s name=%(name)s message=%(message)s" % record.__dict__)
+
+logging.getLogger().addHandler(MyHandler())
+logging.info("Test message7")
diff --git a/logging/logging.py b/logging/logging.py
@@ -17,9 +17,25 @@
 
 _stream = sys.stderr
 
+class LogRecord:
+    def __init__(self):
+        self.__dict__ = {}
+
+    def __getattr__(self, key):
+        return self.__dict__[key]
+
+class Handler:
+    def __init__(self):
+        pass
+
+    def setFormatter(self, fmtr):
+        pass
+
 class Logger:
 
     level = NOTSET
+    handlers = []
+    record = LogRecord()
 
     def __init__(self, name):
         self.name = name
@@ -37,12 +53,19 @@ def isEnabledFor(self, level):
         return level >= (self.level or _level)
 
     def log(self, level, msg, *args):
-        if level >= (self.level or _level):
-            _stream.write("%s:%s:" % (self._level_str(level), self.name))
-            if not args:
-                print(msg, file=_stream)
+        if self.isEnabledFor(level):
+            level = self._level_str(level)
+            if args:
+                msg = msg % args
+            if self.handlers:
+                d = self.record.__dict__
+                d["levelname"] = level
+                d["message"] = msg
+                d["name"] = self.name
+                for h in self.handlers:
+                    h.emit(self.record)
             else:
-                print(msg % args, file=_stream)
+                print(level, ":", self.name, ":", msg, sep="", file=_stream)
 
     def debug(self, msg, *args):
         self.log(DEBUG, msg, *args)
@@ -66,22 +89,24 @@ def exc(self, e, msg, *args):
     def exception(self, msg, *args):
         self.exc(sys.exc_info()[1], msg, *args)
 
+    def addHandler(self, hndlr):
+        self.handlers.append(hndlr)
 
 _level = INFO
 _loggers = {}
 
-def getLogger(name):
+def getLogger(name="root"):
     if name in _loggers:
         return _loggers[name]
     l = Logger(name)
     _loggers[name] = l
     return l
 
 def info(msg, *args):
-    getLogger(None).info(msg, *args)
+    getLogger().info(msg, *args)
 
 def debug(msg, *args):
-    getLogger(None).debug(msg, *args)
+    getLogger().debug(msg, *args)
 
 def basicConfig(level=INFO, filename=None, stream=None, format=None):
     global _level, _stream
