From a157d2bd0a1cf26c1c5d582028d287160f377755 Mon Sep 17 00:00:00 2001
From: Tim Rowe <tim@tjsr.id.au>
Date: Tue, 4 Feb 2025 08:01:49 +1100
Subject: [PATCH] Add Log util class

---
 Log.py | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 Log.py

diff --git a/Log.py b/Log.py
new file mode 100644
index 00000000..dbfa7a56
--- /dev/null
+++ b/Log.py
@@ -0,0 +1,79 @@
+import inspect
+import logging
+import sys
+import threading
+from typing import Any
+
+lock = threading.Lock()
+
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+traceFormatter = logging.Formatter('%(asctime)s - %(name)s@%(filename)s:%(lineno)d:%(funcName)s - %(levelname)s - %(message)s')
+# Create a handler that writes log messages to stdout
+handler = logging.StreamHandler(sys.stdout)
+handler.setLevel(logging.DEBUG)
+
+errHandler = logging.StreamHandler(sys.stderr)
+errHandler.setLevel(logging.ERROR)
+
+# Create a formatter and set it for the handler
+handler.setFormatter(formatter)
+errHandler.setFormatter(formatter)
+
+class Log:
+	TRACE = 6
+	ENTER = 4
+	EXIT = 2
+	RETURN = 3
+	APPLICATION_END = 5
+
+class CrossMgrLogger(logging.Logger):
+	def __init__(self, name: str, level: int | str = 0) -> None:
+		super().__init__(name, level)
+		super().addHandler(handler)
+		super().addHandler(errHandler)
+
+	def log(self, level: int, msg: object, *args: object, **kwargs: Any) -> None:
+		if level == Log.ENTER < logging.DEBUG:
+			filename, lineNumber, functionName, stack = self.findCaller()
+			caller = '{}:{}#{}'.format(filename, lineNumber, functionName)
+			updatedMsg = '{}: {}'.format(caller, msg)
+			return super().log(level, updatedMsg, *args, **kwargs)
+
+		return super().log(level, msg, args, kwargs)
+
+	def entering(self, msg: object, *args: object, **kwargs: Any) -> None:
+		return self.log(Log.ENTER, msg, *args, **kwargs)
+
+	def exiting(self, msg: object, *args: object, **kwargs: Any) -> None:
+		return self.log(Log.EXIT, msg, *args, **kwargs)
+
+	def trace(self, msg: object, *args: object, **kwargs: Any) -> None:
+		return self.log(Log.TRACE, msg, *args, **kwargs)
+
+	def returning(self, msg: object, *args: object, **kwargs: Any) -> None:
+		return self.log(Log.RETURN, msg, *args, **kwargs)
+
+	def exitApp(self, msg: object = 'Application exiting', *args: object, **kwargs: Any) -> None:
+		return self.log(Log.APPLICATION_END, msg, *args, **kwargs)
+
+def getLogger(name: str = None, level: int = logging.INFO) -> CrossMgrLogger:
+	if name is None:
+		frame = inspect.stack()[1]
+		module = inspect.getmodule(frame[0])
+		logger_name = module.__name__ if module else '__main__'
+	else:
+		logger_name = name
+
+	with lock:
+		lastLogger = logging.getLoggerClass()
+		logging.setLoggerClass(CrossMgrLogger)
+
+		log = logging.getLogger(logger_name)
+		assert isinstance(log, CrossMgrLogger)
+		if lastLogger != CrossMgrLogger:
+			logging.setLoggerClass(lastLogger)
+
+		log.setLevel(level)
+
+	return log
+