Use rich library for logging

Author: snejus

beets/autotag/__init__.py

@@ -31,7 +31,7 @@
 from .match import Proposal, current_metadata, tag_album, tag_item  # noqa
 
 # Global logger.
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 # Metadata fields that are already hardcoded, or where the tag name changes.
 SPECIAL_FIELDS = {

beets/autotag/hooks.py

@@ -47,7 +47,7 @@
 
 JSONDict = Dict[str, Any]
 
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 
 # Classes used to represent candidate options.

beets/autotag/match.py

@@ -55,7 +55,7 @@
 VA_ARTISTS = ("", "various artists", "various", "va", "unknown")
 
 # Global logger.
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 
 # Recommendation enumeration.

beets/autotag/mb.py

@@ -12,8 +12,8 @@
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
 
-"""Searches for albums in the MusicBrainz database.
-"""
+"""Searches for albums in the MusicBrainz database."""
+
 from __future__ import annotations
 
 import re
@@ -70,7 +70,7 @@ def get_message(self):
         )
 
 
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 RELEASE_INCLUDES = [
     "artists",

beets/importer.py

@@ -71,7 +71,7 @@
 ]
 
 # Global logger.
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 
 class ImportAbort(Exception):

beets/library.py

@@ -43,7 +43,7 @@
 # `memoryview` tells it that we actually mean non-text data.
 BLOB_TYPE = memoryview
 
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 
 # Library-specific query types.

beets/logging.py

@@ -20,9 +20,7 @@
 calls (`debug`, `info`, etc).
 """
 
-
 import logging
-import sys
 import threading
 from copy import copy
 
@@ -47,7 +45,7 @@ def logsafe(val):
     return val
 
 
-class StrFormatLogger(logging.Logger):
+class StrFormatLogRecord(logging.LogRecord):
     """A version of `Logger` that uses `str.format`-style formatting
     instead of %-style formatting and supports keyword arguments.
 
@@ -59,47 +57,9 @@ class StrFormatLogger(logging.Logger):
     achieve this with less code.
     """
 
-    class _LogMessage:
-        def __init__(self, msg, args, kwargs):
-            self.msg = msg
-            self.args = args
-            self.kwargs = kwargs
-
-        def __str__(self):
-            args = [logsafe(a) for a in self.args]
-            kwargs = {k: logsafe(v) for (k, v) in self.kwargs.items()}
-            return self.msg.format(*args, **kwargs)
-
-    def _log(
-        self,
-        level,
-        msg,
-        args,
-        exc_info=None,
-        extra=None,
-        stack_info=False,
-        **kwargs,
-    ):
-        """Log msg.format(*args, **kwargs)"""
-        m = self._LogMessage(msg, args, kwargs)
-
-        stacklevel = kwargs.pop("stacklevel", 1)
-        if sys.version_info >= (3, 8):
-            stacklevel = {"stacklevel": stacklevel}
-        else:
-            # Simply ignore this when not supported by current Python version.
-            # Can be dropped when we remove support for Python 3.7.
-            stacklevel = {}
-
-        return super()._log(
-            level,
-            m,
-            (),
-            exc_info=exc_info,
-            extra=extra,
-            stack_info=stack_info,
-            **stacklevel,
-        )
+    def getMessage(self):
+        args = [logsafe(a) for a in self.args]
+        return self.msg.format(*args)
 
 
 class ThreadLocalLevelLogger(logging.Logger):
@@ -130,12 +90,13 @@ def set_global_level(self, level):
         self.setLevel(level)
 
 
-class BeetsLogger(ThreadLocalLevelLogger, StrFormatLogger):
+class BeetsLogger(ThreadLocalLevelLogger):
     pass
 
 
 my_manager = copy(logging.Logger.manager)
-my_manager.loggerClass = BeetsLogger
+my_manager.setLoggerClass(BeetsLogger)
+logging.setLogRecordFactory(StrFormatLogRecord)
 
 
 # Act like the stdlib logging module by re-exporting its namespace.

beets/plugins.py

@@ -33,7 +33,7 @@
 LASTFM_KEY = "2dc3914abf35f0d9c92d97d8f8e42b43"
 
 # Global logger.
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 
 class PluginConflictException(Exception):
@@ -44,23 +44,6 @@ class PluginConflictException(Exception):
     """
 
 
-class PluginLogFilter(logging.Filter):
-    """A logging filter that identifies the plugin that emitted a log
-    message.
-    """
-
-    def __init__(self, plugin):
-        self.prefix = f"{plugin.name}: "
-
-    def filter(self, record):
-        if hasattr(record.msg, "msg") and isinstance(record.msg.msg, str):
-            # A _LogMessage from our hacked-up Logging replacement.
-            record.msg.msg = self.prefix + record.msg.msg
-        elif isinstance(record.msg, str):
-            record.msg = self.prefix + record.msg
-        return True
-
-
 # Managing the plugins themselves.
 
 
@@ -85,8 +68,6 @@ def __init__(self, name=None):
 
         self._log = log.getChild(self.name)
         self._log.setLevel(logging.NOTSET)  # Use `beets` logger level.
-        if not any(isinstance(f, PluginLogFilter) for f in self._log.filters):
-            self._log.addFilter(PluginLogFilter(self))
 
     def commands(self):
         """Should return a list of beets.ui.Subcommand objects for

beets/ui/__init__.py

@@ -17,7 +17,6 @@
 CLI commands are implemented in the ui.commands module.
 """
 
-
 import errno
 import optparse
 import os.path
@@ -31,6 +30,8 @@
 
 import confuse
 from rich_tables.utils import diff, make_console
+from rich.logging import RichHandler
+from rich.traceback import install
 
 from beets import config, library, logging, plugins, util
 from beets.autotag import mb
@@ -50,12 +51,31 @@
     else:
         colorama.init()
 
-
 log = logging.getLogger("beets")
+
 if not log.handlers:
-    log.addHandler(logging.StreamHandler())
+    handler = RichHandler(
+        show_path=False,
+        show_level=True,
+        omit_repeated_times=False,
+        rich_tracebacks=True,
+        tracebacks_show_locals=True,
+        tracebacks_width=console.width,
+        tracebacks_extra_lines=1,
+        keywords=["Sending event", "import"],
+        markup=True,
+    )
+    handler.setFormatter(
+        logging.Formatter(
+            "[b grey42]{name:<20}[/] {message}", datefmt="%T", style="{"
+        )
+    )
+    log.addHandler(handler)
+
 log.propagate = False  # Don't propagate to root handler.
 
+install(console=console, show_locals=True)
+
 
 PF_KEY_QUERIES = {
     "comp": "comp:true",
@@ -122,14 +142,14 @@ def print_(*strings, **kwargs):
     (it defaults to a newline).
     """
     if not strings:
-        strings = ['']
+        strings = [""]
 
     try:
         for string in strings:
             if isinstance(string, str):
                 console.print(string)
             else:
-                console.print(string, end='\n')
+                console.print(string, end="\n")
     except:
         console.print_exception(show_locals=True)
 
@@ -311,7 +331,7 @@ def input_options(
 
         # Wrap the query text.
         # Start prompt with U+279C: Heavy Round-Tipped Rightwards Arrow
-        prompt = colorize("action", "\u279C ")
+        prompt = colorize("action", "\u279c ")
         line_length = 0
         for i, (part, length) in enumerate(
             zip(prompt_parts, prompt_part_lengths)
@@ -380,7 +400,7 @@ def input_yn(prompt, require=False):
     "yes" unless `require` is `True`, in which case there is no default.
     """
     # Start prompt with U+279C: Heavy Round-Tipped Rightwards Arrow
-    yesno = colorize("action", "\u279C ") + colorize(
+    yesno = colorize("action", "\u279c ") + colorize(
         "action_description", "Enter Y or N:"
     )
     sel = input_options(("y", "n"), require, prompt, yesno)
@@ -884,8 +904,8 @@ def _field_diff(field, old, old_fmt, new, new_fmt):
         return None
 
     # Get formatted values for output.
-    oldval = old_fmt.get(field, u'')
-    newval = new_fmt.get(field, u'')
+    oldval = old_fmt.get(field, "")
+    newval = new_fmt.get(field, "")
 
     return diff(str(oldval), str(newval))
 
@@ -1188,9 +1208,7 @@ def __init__(self, *args, **kwargs):
         """
         # A more helpful default usage.
         if "usage" not in kwargs:
-            kwargs[
-                "usage"
-            ] = """
+            kwargs["usage"] = """
   %prog COMMAND [ARGS...]
   %prog help COMMAND"""
         kwargs["add_help_option"] = False
@@ -1560,8 +1578,8 @@ def main(args=None):
             raise
     except UserError as exc:
         message = exc.args[0] if exc.args else None
-        if 'No matching' in message:
-            log.error(u'error: {0}', message)
+        if "No matching" in message:
+            log.error("error: {0}", message)
         else:
             console.print_exception(extra_lines=4, show_locals=True)
         sys.exit(1)

beets/ui/commands.py

@@ -54,7 +54,7 @@
 console = Console(force_terminal=True, force_interactive=True)
 
 # Global logger.
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 # The list of default subcommands. This is populated with Subcommand
 # objects that can be fed to a SubcommandsOptionParser.

beets/util/artresizer.py

@@ -30,7 +30,7 @@
 
 PROXY_URL = "https://images.weserv.nl/"
 
-log = logging.getLogger("beets")
+log = logging.getLogger(__name__)
 
 
 def resize_url(url, maxwidth, quality=0):