implement % sytle and change default to it

Author: FoamyGuy

adafruit_logging.py

@@ -64,7 +64,7 @@
 
 try:
     # pylint: disable=deprecated-class
-    from typing import Optional, Hashable
+    from typing import Optional, Hashable, Dict
     from typing_extensions import Protocol
 
     class WriteableStream(Protocol):
@@ -156,23 +156,28 @@ class Formatter:
     Only implements a sub-set of CPython logging.Formatter behavior,
     but retains all the same arguments in order to match the API.
 
-    The only init arguments currently supported are: fmt and defaults.
-    All others are currently ignored
+    The only init arguments currently supported are: fmt, defaults and
+    style. All others are currently ignored
 
-    The only style value currently supported is '{'. CPython has support
-    for some others, but this implementation does not. Additionally, the
-    default value for style in this implementation is '{' whereas the default
-    style value in CPython is '%'
+    The only two styles currently supported are '%' and '{'. The default
+    style is '{'
     """
 
     def __init__(  # pylint: disable=too-many-arguments
-        self, fmt=None, datefmt=None, style="{", validate=True, defaults=None
+        self,
+        fmt: Optional[str] = None,
+        datefmt: Optional[str] = None,
+        style: str = "%",
+        validate: bool = True,
+        defaults: Dict = None,
     ):
         self.fmt = fmt
         self.datefmt = datefmt
         self.style = style
-        if self.style != "{":
-            raise ValueError("Only '{' formatting sytle is supported at this time.")
+        if self.style not in ("{", "%"):
+            raise ValueError(
+                "Only '%' and '{' formatting style are supported at this time."
+            )
 
         self.validate = validate
         self.defaults = defaults
@@ -192,7 +197,7 @@ def format(self, record: LogRecord) -> str:
             "created": record.created,
             "args": record.args,
         }
-        if "{asctime}" in self.fmt:
+        if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt:
             now = time.localtime()
             # pylint: disable=line-too-long
             vals[
@@ -203,6 +208,14 @@ def format(self, record: LogRecord) -> str:
             for key, val in self.defaults.items():
                 vals[key] = val
 
+        if self.style not in ("{", "%"):
+            raise ValueError(
+                "Only '%' and '{' formatting style are supported at this time."
+            )
+
+        if self.style == "%":
+            return self.fmt % vals
+
         return self.fmt.format(**vals)
 
 

examples/logging_formatter_example.py

@@ -17,19 +17,32 @@
 logger.addHandler(print_handler)
 
 default_formatter = logging.Formatter()
+
 print_handler.setFormatter(default_formatter)
 logger.info("Default formatter example")
 
 
-timestamp_formatter = logging.Formatter(
-    fmt="{asctime} {levelname}: {message}", style="{"
-)
+timestamp_formatter = logging.Formatter(fmt="%(asctime)s %(levelname)s: %(message)s")
 print_handler.setFormatter(timestamp_formatter)
 logger.info("Timestamp formatter example")
 
 
 custom_vals_formatter = logging.Formatter(
-    fmt="{ip} {levelname}: {message}", style="{", defaults={"ip": "192.168.1.188"}
+    fmt="%(ip)s %(levelname)s: %(message)s", defaults={"ip": "192.168.1.188"}
 )
 print_handler.setFormatter(custom_vals_formatter)
 logger.info("Custom formatter example")
+
+
+bracket_timestamp_formatter = logging.Formatter(
+    fmt="{asctime} {levelname}: {message}", style="{"
+)
+print_handler.setFormatter(bracket_timestamp_formatter)
+logger.info("Timestamp formatter bracket style example")
+
+
+bracket_custom_vals_formatter = logging.Formatter(
+    fmt="{ip} {levelname}: {message}", style="{", defaults={"ip": "192.168.1.188"}
+)
+print_handler.setFormatter(bracket_custom_vals_formatter)
+logger.info("Custom formatter bracket style example")