logging: make log levels/format configurable

This allows users to prevent the root logger from swallowing logs, for
example logs emitted by plugins and dependencies (such as the
MusicBrainz API client).

Author: 9999years

beets/logging.py

@@ -22,18 +22,9 @@
 
 import threading
 from copy import copy
-from logging import (
-    DEBUG,
-    INFO,
-    NOTSET,
-    WARNING,
-    FileHandler,
-    Filter,
-    Handler,
-    Logger,
-    NullHandler,
-    StreamHandler,
-)
+from logging import (DEBUG, INFO, NOTSET, WARNING, FileHandler, Filter,
+                     Formatter, Handler, Logger, NullHandler, StreamHandler,
+                     getLevelNamesMapping)
 
 __all__ = [
     "DEBUG",
@@ -42,11 +33,13 @@
     "WARNING",
     "FileHandler",
     "Filter",
+    "Formatter",
     "Handler",
     "Logger",
     "NullHandler",
     "StreamHandler",
     "getLogger",
+    "getLevelNamesMapping",
 ]
 
 

beets/ui/__init__.py

@@ -29,7 +29,7 @@
 import textwrap
 import traceback
 from difflib import SequenceMatcher
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, OrderedDict, cast
 
 import confuse
 
@@ -1637,11 +1637,7 @@ def _configure(options):
         overlay_path = None
     config.set_args(options)
 
-    # Configure the logger.
-    if config["verbose"].get(int):
-        log.set_global_level(logging.DEBUG)
-    else:
-        log.set_global_level(logging.INFO)
+    _configure_logging()
 
     if overlay_path:
         log.debug(
@@ -1661,6 +1657,71 @@ def _configure(options):
     return config
 
 
+def _configure_logging():
+    """Configure logging levels and handlers."""
+    root_logger = logging.getLogger()
+
+    if config["verbose"].get(int):
+        level = logging.DEBUG
+    else:
+        level = logging.INFO
+
+    log.set_global_level(level)
+    root_logger.setLevel(level)
+
+    log_format = config["logging"]["format"].get(
+        confuse.String(default="{message}")
+    )
+    date_format = config["logging"]["date_format"].get(
+        confuse.String(default="%Y-%m-%d %H:%M:%S")
+    )
+
+    # Remove the `StreamHandler` we added earlier so we can make a new one with
+    # the user's format.
+    for logger in [log, root_logger]:
+        stream_handlers = [
+            handler
+            for handler in logger.handlers
+            if isinstance(handler, logging.StreamHandler)
+        ]
+        for handler in stream_handlers:
+            logger.removeHandler(handler)
+
+        handler = logging.StreamHandler()
+        handler.setFormatter(
+            logging.Formatter(
+                fmt=cast(str, log_format),
+                datefmt=cast(str, date_format),
+                style="{",
+                validate=True,
+            )
+        )
+        logger.addHandler(handler)
+
+    level_names_mapping = logging.getLevelNamesMapping()
+    log_levels = config["logging"]["levels"].get(
+        confuse.MappingValues(
+            confuse.OneOf(
+                allowed=[
+                    confuse.Integer(),
+                    confuse.OneOf(allowed=level_names_mapping.keys()),
+                ]
+            )
+        )
+    )
+
+    if log_levels:
+        for name, level in cast(OrderedDict, log_levels).items():
+            name = None if name == "root" else name
+            logger = logging.getLogger(name)
+            if isinstance(level, int):
+                logger.setLevel(level)
+            else:
+                logger.setLevel(level_names_mapping[level])
+
+    logging.getLogger("musicbrainzngs.mbxml").setLevel(logging.WARNING)
+
+
 def _ensure_db_directory_exists(path):
     if path == b":memory:":  # in memory db
         return