refactor(logging): Type annotations

Author: tony

tmuxp/log.py

@@ -7,6 +7,8 @@
 """
 import logging
 import time
+import typing as t
+from typing import overload
 
 from colorama import Fore, Style
 
@@ -56,7 +58,21 @@ def set_style(
     return prefix + message + suffix
 
 
-def default_log_template(self, record, stylized=False):
+class LogTemplateFn(t.Protocol):
+    def __call__(
+        self,
+        record: logging.LogRecord,
+        stylized: t.Optional[bool],
+        **kwargs: t.Any,
+    ) -> str:
+        ...
+
+
+def default_log_template(
+    record: logging.LogRecord,
+    stylized: t.Optional[bool] = False,
+    **kwargs: t.Any,
+) -> str:
     """
     Return the prefix for the log message. Template for Formatter.
 
@@ -76,7 +92,7 @@ def default_log_template(self, record, stylized=False):
     levelname = set_style(
         "(%(levelname)s)",
         stylized,
-        style_before=(LEVEL_COLORS.get(record.levelname) + Style.BRIGHT),
+        style_before=(LEVEL_COLORS.get(record.levelname, "") + Style.BRIGHT),
         style_after=Style.RESET_ALL,
         suffix=" ",
     )
@@ -104,7 +120,7 @@ def default_log_template(self, record, stylized=False):
 
 
 class LogFormatter(logging.Formatter):
-    template = default_log_template
+    template: LogTemplateFn = default_log_template
 
     def __init__(self, color=True, *args, **kwargs):
         logging.Formatter.__init__(self, *args, **kwargs)
@@ -125,7 +141,12 @@ def format(self, record):
         return formatted.replace("\n", "\n" + parts[0] + " ")
 
 
-def debug_log_template(self, record):
+def debug_log_template(
+    record: logging.LogRecord,
+    stylized: t.Optional[bool] = False,
+    **kwargs: t.Any,
+) -> str:
+
     """
     Return the prefix for the log message. Template for Formatter.
 
@@ -143,7 +164,7 @@ def debug_log_template(self, record):
 
     reset = Style.RESET_ALL
     levelname = (
-        LEVEL_COLORS.get(record.levelname)
+        LEVEL_COLORS.get(record.levelname, "")
         + Style.BRIGHT
         + "(%(levelname)1.1s)"
         + Style.RESET_ALL
@@ -188,4 +209,4 @@ def debug_log_template(self, record):
 class DebugLogFormatter(LogFormatter):
     """Provides greater technical details than standard log Formatter."""
 
-    template = debug_log_template
+    template: LogTemplateFn = debug_log_template