Create custom logger

condense/logging_.py

@@ -0,0 +1,73 @@
+# Copyright (C) 2024 Condense, Inc. All Rights Reserved.
+
+import logging
+from enum import Enum
+
+TRACE = logging.DEBUG - 1
+setattr(logging, "TRACE", TRACE)
+logging.addLevelName(TRACE, "TRACE")
+
+
+class DebugLevel(int, Enum):
+    NONE = 0
+    DEFAULT = 1
+    TRACE = 2
+    SUPERTRACE = 3
+
+
+GREY = "\x1b[38;21m"
+CYAN = "\x1b[36;21m"
+MAUVE = "\x1b[34;21m"
+YELLOW = "\x1b[33;21m"
+RED = "\x1b[31;21m"
+BOLD_RED = "\x1b[31;1m"
+RESET = "\x1b[0m"
+
+
+def make_format(color):
+    return f"{color}%(levelname)s{RESET}: %(name)s: %(message)s"
+
+
+FORMATS = {
+    logging.TRACE: make_format(MAUVE),  # type: ignore
+    logging.DEBUG: make_format(GREY),
+    logging.INFO: make_format(CYAN),
+    logging.WARNING: make_format(YELLOW),
+    logging.ERROR: make_format(RED),
+    logging.CRITICAL: make_format(BOLD_RED),
+}
+
+FORMATTERS = {level: logging.Formatter(FORMATS[level]) for level in FORMATS.keys()}
+
+
+class ColorFormatter(logging.Formatter):
+    """
+    Logging Formatter to add colors and count warning / errors
+
+    via: https://stackoverflow.com/a/56944256/87207
+    """
+
+    def format(self, record):
+        return FORMATTERS[record.levelno].format(record)
+
+
+class LoggerWithTrace(logging.getLoggerClass()):  # type: ignore
+    def trace(self, msg, *args, **kwargs):
+        self.log(TRACE, msg, *args, **kwargs)
+
+
+logging.setLoggerClass(LoggerWithTrace)
+
+
+def getLogger(name) -> LoggerWithTrace:
+    """
+    a logging constructor that guarantees that the TRACE level is available.
+    use this just like `logging.getLogger`.
+
+    because we patch stdlib logging upon import of this module (side-effect),
+    and we can't be sure how callers order their imports,
+    then we want to provide a way to ensure that callers can access TRACE consistently.
+    if callers use `condense.logging.getLogger()` intead of `logging.getLogger()`,
+    then they'll be guaranteed to have access to TRACE.
+    """
+    return logging.getLogger(name)  # type: ignore