Delegate attribute access to logging

Author: snejus

beets/art.py

@@ -38,7 +38,7 @@ def get_art(log, item):
     try:
         mf = mediafile.MediaFile(syspath(item.path))
     except mediafile.UnreadableFileError as exc:
-        log.warning("Could not extract art from {}: {}", item.filepath, exc)
+        log.warning("Could not extract art from {.filepath}: {}", item, exc)
         return
 
     return mf.art
@@ -88,7 +88,7 @@ def embed_item(
     # Make sure the image kind is safe (some formats only support PNG
     # and JPEG).
     if image.mime_type not in ("image/jpeg", "image/png"):
-        log.info("not embedding image of unsupported type: {}", image.mime_type)
+        log.info("not embedding image of unsupported type: {.mime_type}", image)
         return
 
     item.try_write(path=itempath, tags={"images": [image]}, id3v23=id3v23)
@@ -185,7 +185,7 @@ def extract(log, outpath, item):
     # Add an extension to the filename.
     ext = mediafile.image_extension(art)
     if not ext:
-        log.warning("Unknown image type in {}.", item.filepath)
+        log.warning("Unknown image type in {.filepath}.", item)
         return
     outpath += bytestring_path(f".{ext}")
 

beets/autotag/match.py

@@ -197,7 +197,7 @@ def _add_candidate(
     checking the track count, ordering the items, checking for
     duplicates, and calculating the distance.
     """
-    log.debug("Candidate: {} - {} ({})", info.artist, info.album, info.album_id)
+    log.debug("Candidate: {.artist} - {.album} ({.album_id})", info, info, info)
 
     # Discard albums with zero tracks.
     if not info.tracks:

beets/importer/stages.py

@@ -82,10 +82,10 @@ def query_tasks(session: ImportSession):
         # Search for albums.
         for album in session.lib.albums(session.query):
             log.debug(
-                "yielding album {}: {} - {}",
-                album.id,
-                album.albumartist,
-                album.album,
+                "yielding album {.id}: {.albumartist} - {.album}",
+                album,
+                album,
+                album,
             )
             items = list(album.items())
             _freshen_items(items)

beets/importer/tasks.py

@@ -271,7 +271,7 @@ def remove_duplicates(self, lib: library.Library):
         for item in duplicate_items:
             item.remove()
             if lib.directory in util.ancestry(item.path):
-                log.debug("deleting duplicate {}", item.filepath)
+                log.debug("deleting duplicate {.filepath}", item)
                 util.remove(item.path)
                 util.prune_dirs(os.path.dirname(item.path), lib.directory)
 
@@ -552,12 +552,12 @@ def _reduce_and_log(new_obj, existing_fields, overwrite_keys):
             ]
             if overwritten_fields:
                 log.debug(
-                    "Reimported {} {}. Not preserving flexible attributes {}. "
-                    "Path: {}",
+                    "Reimported {} {.id}. Not preserving flexible attributes {}. "
+                    "Path: {.filepath}",
                     noun,
-                    new_obj.id,
+                    new_obj,
                     overwritten_fields,
-                    new_obj.filepath,
+                    new_obj,
                 )
                 for key in overwritten_fields:
                     del existing_fields[key]
@@ -576,17 +576,17 @@ def _reduce_and_log(new_obj, existing_fields, overwrite_keys):
                 self.album.artpath = replaced_album.artpath
                 self.album.store()
                 log.debug(
-                    "Reimported album {}. Preserving attribute ['added']. "
-                    "Path: {}",
-                    self.album.id,
-                    self.album.filepath,
+                    "Reimported album {.album.id}. Preserving attribute ['added']. "
+                    "Path: {.album.filepath}",
+                    self,
+                    self,
                 )
                 log.debug(
-                    "Reimported album {}. Preserving flexible attributes {}. "
-                    "Path: {}",
-                    self.album.id,
+                    "Reimported album {.album.id}. Preserving flexible attributes {}. "
+                    "Path: {.album.filepath}",
+                    self,
                     list(album_fields.keys()),
-                    self.album.filepath,
+                    self,
                 )
 
         for item in self.imported_items():
@@ -595,21 +595,21 @@ def _reduce_and_log(new_obj, existing_fields, overwrite_keys):
                 if dup_item.added and dup_item.added != item.added:
                     item.added = dup_item.added
                     log.debug(
-                        "Reimported item {}. Preserving attribute ['added']. "
-                        "Path: {}",
-                        item.id,
-                        item.filepath,
+                        "Reimported item {.id}. Preserving attribute ['added']. "
+                        "Path: {.filepath}",
+                        item,
+                        item,
                     )
                 item_fields = _reduce_and_log(
                     item, dup_item._values_flex, REIMPORT_FRESH_FIELDS_ITEM
                 )
                 item.update(item_fields)
                 log.debug(
-                    "Reimported item {}. Preserving flexible attributes {}. "
-                    "Path: {}",
-                    item.id,
+                    "Reimported item {.id}. Preserving flexible attributes {}. "
+                    "Path: {.filepath}",
+                    item,
                     list(item_fields.keys()),
-                    item.filepath,
+                    item,
                 )
                 item.store()
 
@@ -619,7 +619,7 @@ def remove_replaced(self, lib):
         """
         for item in self.imported_items():
             for dup_item in self.replaced_items[item]:
-                log.debug("Replacing item {}: {}", dup_item.id, item.filepath)
+                log.debug("Replacing item {.id}: {.filepath}", dup_item, item)
                 dup_item.remove()
         log.debug(
             "{} of {} items replaced",
@@ -1067,7 +1067,7 @@ def unarchive(self):
 
         # Now read albums from the extracted directory.
         self.toppath = archive_task.toppath
-        log.debug("Archive extracted to: {}", self.toppath)
+        log.debug("Archive extracted to: {.toppath}", self)
         return archive_task
 
     def read_item(self, path: util.PathBytes):

beets/library/models.py

@@ -1012,7 +1012,7 @@ def try_sync(self, write, move, with_album=True):
         if move:
             # Check whether this file is inside the library directory.
             if self._db and self._db.directory in util.ancestry(self.path):
-                log.debug("moving {} to synchronize path", self.filepath)
+                log.debug("moving {.filepath} to synchronize path", self)
                 self.move(with_album=with_album)
         self.store()
 

beets/ui/commands.py

@@ -1282,11 +1282,11 @@ def _get_choices(self, task):
                 dup_choices = [c for c in all_choices if c.short == short]
                 for c in dup_choices[1:]:
                     log.warning(
-                        "Prompt choice '{}' removed due to conflict "
-                        "with '{}' (short letter: '{}')",
-                        c.long,
-                        dup_choices[0].long,
-                        c.short,
+                        "Prompt choice '{.long}' removed due to conflict "
+                        "with '{.long}' (short letter: '{.short}')",
+                        c,
+                        dup_choices[0],
+                        c,
                     )
                     extra_choices.remove(c)
 
@@ -1641,17 +1641,17 @@ def update_items(lib, query, album, move, pretend, fields, exclude_fields=None):
             # Did the item change since last checked?
             if item.current_mtime() <= item.mtime:
                 log.debug(
-                    "skipping {} because mtime is up to date ({})",
-                    item.filepath,
-                    item.mtime,
+                    "skipping {.filepath} because mtime is up to date ({.mtime})",
+                    item,
+                    item,
                 )
                 continue
 
             # Read new data.
             try:
                 item.read()
             except library.ReadError as exc:
-                log.error("error reading {}: {}", item.filepath, exc)
+                log.error("error reading {.filepath}: {}", item, exc)
                 continue
 
             # Special-case album artist when it matches track artist. (Hacky
@@ -1884,7 +1884,7 @@ def show_stats(lib, query, exact):
             try:
                 total_size += os.path.getsize(syspath(item.path))
             except OSError as exc:
-                log.info("could not get size of {}: {}", item.path, exc)
+                log.info("could not get size of {.path}: {}", item, exc)
         else:
             total_size += int(item.length * item.bitrate / 8)
         total_time += item.length
@@ -2175,7 +2175,7 @@ def isalbummoved(album):
             )
 
         for obj in objs:
-            log.debug("moving: {}", obj.filepath)
+            log.debug("moving: {.filepath}", obj)
 
             if export:
                 # Copy without affecting the database.
@@ -2258,14 +2258,14 @@ def write_items(lib, query, pretend, force):
     for item in items:
         # Item deleted?
         if not os.path.exists(syspath(item.path)):
-            log.info("missing file: {}", item.filepath)
+            log.info("missing file: {.filepath}", item)
             continue
 
         # Get an Item object reflecting the "clean" (on-disk) state.
         try:
             clean_item = library.Item.from_path(item.path)
         except library.ReadError as exc:
-            log.error("error reading {}: {}", item.filepath, exc)
+            log.error("error reading {.filepath}: {}", item, exc)
             continue
 
         # Check for and display changes.

beets/util/__init__.py

@@ -126,7 +126,7 @@ def log(self, logger):
         """
         if self.tb:
             logger.debug(self.tb)
-        logger.error("{}: {}", self.error_kind, self.args[0])
+        logger.error("{.error_kind}: {}", self, self.args[0])
 
 
 class FilesystemError(HumanReadableError):

beets/util/artresizer.py

@@ -306,9 +306,9 @@ def get_size(self, path_in: bytes) -> tuple[int, int] | None:
         except subprocess.CalledProcessError as exc:
             log.warning("ImageMagick size query failed")
             log.debug(
-                "`convert` exited with (status {}) when "
+                "`convert` exited with (status {.returncode}) when "
                 "getting size with command {}:\n{}",
-                exc.returncode,
+                exc,
                 cmd,
                 exc.output.strip(),
             )
@@ -441,8 +441,8 @@ def compare(
         convert_proc.wait()
         if convert_proc.returncode:
             log.debug(
-                "ImageMagick convert failed with status {}: {!r}",
-                convert_proc.returncode,
+                "ImageMagick convert failed with status {.returncode}: {!r}",
+                convert_proc,
                 convert_stderr,
             )
             return None

beetsplug/acousticbrainz.py

@@ -153,7 +153,7 @@ def _get_data(self, mbid):
             try:
                 data.update(res.json())
             except ValueError:
-                self._log.debug("Invalid Response: {}", res.text)
+                self._log.debug("Invalid Response: {.text}", res)
                 return {}
 
         return data

beetsplug/badfiles.py

@@ -127,12 +127,12 @@ def check_item(self, item):
         except CheckerCommandError as e:
             if e.errno == errno.ENOENT:
                 self._log.error(
-                    "command not found: {} when validating file: {}",
-                    e.checker,
-                    e.path,
+                    "command not found: {.checker} when validating file: {.path}",
+                    e,
+                    e,
                 )
             else:
-                self._log.error("error invoking {}: {}", e.checker, e.msg)
+                self._log.error("error invoking {.checker}: {.msg}", e, e)
             return []
 
         error_lines = []