Moved everything that is needed for autotagging into metadata_plugins

file.

Author: semohr

beets/autotag/match.py

@@ -27,7 +27,7 @@
 import lap
 import numpy as np
 
-from beets import config, logging, plugins
+from beets import config, logging, metadata_plugins
 from beets.autotag import (
     AlbumInfo,
     AlbumMatch,
@@ -213,7 +213,7 @@ def track_distance(
         dist.add_expr("medium", item.disc != track_info.medium)
 
     # Plugins.
-    dist.update(plugins.track_distance(item, track_info))
+    dist.update(metadata_plugins.track_distance(item, track_info))
 
     return dist
 
@@ -330,7 +330,7 @@ def distance(
         dist.add("unmatched_tracks", 1.0)
 
     # Plugins.
-    dist.update(plugins.album_distance(items, album_info, mapping))
+    dist.update(metadata_plugins.album_distance(items, album_info, mapping))
 
     return dist
 
@@ -356,7 +356,7 @@ def match_by_id(items: Iterable[Item]) -> AlbumInfo | None:
             return None
     # If all album IDs are equal, look up the album.
     log.debug("Searching for discovered album ID: {0}", first)
-    return plugins.album_for_id(first)
+    return metadata_plugins.album_for_id(first)
 
 
 def _recommendation(
@@ -511,7 +511,7 @@ def tag_album(
     if search_ids:
         for search_id in search_ids:
             log.debug("Searching for album ID: {0}", search_id)
-            if info := plugins.album_for_id(search_id):
+            if info := metadata_plugins.album_for_id(search_id):
                 _add_candidate(items, candidates, info)
 
     # Use existing metadata or text search.
@@ -548,7 +548,7 @@ def tag_album(
         log.debug("Album might be VA: {0}", va_likely)
 
         # Get the results from the data sources.
-        for matched_candidate in plugins.candidates(
+        for matched_candidate in metadata_plugins.candidates(
             items, search_artist, search_album, va_likely
         ):
             _add_candidate(items, candidates, matched_candidate)
@@ -583,7 +583,7 @@ def tag_item(
     if trackids:
         for trackid in trackids:
             log.debug("Searching for track ID: {0}", trackid)
-            if info := plugins.track_for_id(trackid):
+            if info := metadata_plugins.track_for_id(trackid):
                 dist = track_distance(item, info, incl_artist=True)
                 candidates[info.track_id] = hooks.TrackMatch(dist, info)
                 # If this is a good match, then don't keep searching.
@@ -609,7 +609,7 @@ def tag_item(
     log.debug("Item search terms: {0} - {1}", search_artist, search_title)
 
     # Get and evaluate candidate metadata.
-    for track_info in plugins.item_candidates(
+    for track_info in metadata_plugins.item_candidates(
         item, search_artist, search_title
     ):
         dist = track_distance(item, track_info, incl_artist=True)

beets/metadata_plugins.py

@@ -84,6 +84,32 @@ def track_for_id(_id: str) -> TrackInfo | None:
     return None
 
 
+def track_distance(item: Item, info: TrackInfo) -> Distance:
+    """Gets the track distance calculated by all loaded plugins.
+    Returns a Distance object.
+    """
+    from beets.autotag.hooks import Distance
+
+    dist = Distance()
+    for plugin in find_metadata_source_plugins():
+        dist.update(plugin.track_distance(item, info))
+    return dist
+
+
+def album_distance(
+    items: Sequence[Item],
+    album_info: AlbumInfo,
+    mapping: dict[Item, TrackInfo],
+) -> Distance:
+    """Returns the album distance calculated by plugins."""
+    from beets.autotag.hooks import Distance
+
+    dist = Distance()
+    for plugin in find_metadata_source_plugins():
+        dist.update(plugin.album_distance(items, album_info, mapping))
+    return dist
+
+
 def _get_distance(
     config: ConfigView, data_source: str, info: AlbumInfo | TrackInfo
 ) -> Distance:
@@ -157,7 +183,7 @@ def track_for_id(self, track_id: str) -> TrackInfo | None:
     @abc.abstractmethod
     def candidates(
         self,
-        items: list[Item],
+        items: Sequence[Item],
         artist: str,
         album: str,
         va_likely: bool,
@@ -196,7 +222,7 @@ def item_candidates(
 
     def album_distance(
         self,
-        items: list[Item],
+        items: Sequence[Item],
         album_info: AlbumInfo,
         mapping: dict[Item, TrackInfo],
     ) -> Distance:
@@ -259,7 +285,7 @@ def _search_api(
 
     def candidates(
         self,
-        items: list[Item],
+        items: Sequence[Item],
         artist: str,
         album: str,
         va_likely: bool,

beets/plugins.py

@@ -41,7 +41,6 @@
 
     from confuse import ConfigView
 
-    from beets.autotag import AlbumInfo, Distance, TrackInfo
     from beets.dbcore import Query
     from beets.dbcore.db import FieldQueryType
     from beets.dbcore.types import Type
@@ -204,62 +203,6 @@ def queries(self) -> dict[str, type[Query]]:
         """Return a dict mapping prefixes to Query subclasses."""
         return {}
 
-    def track_distance(
-        self,
-        item: Item,
-        info: TrackInfo,
-    ) -> Distance:
-        """Should return a Distance object to be added to the
-        distance for every track comparison.
-        """
-        from beets.autotag.hooks import Distance
-
-        return Distance()
-
-    def album_distance(
-        self,
-        items: Sequence[Item],
-        album_info: AlbumInfo,
-        mapping: dict[Item, TrackInfo],
-    ) -> Distance:
-        """Should return a Distance object to be added to the
-        distance for every album-level comparison.
-        """
-        from beets.autotag.hooks import Distance
-
-        return Distance()
-
-    def candidates(
-        self,
-        items: list[Item],
-        artist: str,
-        album: str,
-        va_likely: bool,
-        extra_tags: dict[str, Any] | None = None,
-    ) -> Iterator[AlbumInfo]:
-        """Return :py:class:`AlbumInfo` candidates that match the given album.
-
-        :param items: List of items in the album
-        :param artist: Album artist
-        :param album: Album name
-        :param va_likely: Whether the album is likely to be by various artists
-        :param extra_tags: is a an optional dictionary of extra tags to search.
-            Only relevant to :py:class:`MusicBrainzPlugin` autotagger and can be
-            ignored by other plugins
-        """
-        yield from ()
-
-    def item_candidates(
-        self, item: Item, artist: str, title: str
-    ) -> Iterator[TrackInfo]:
-        """Return :py:class:`TrackInfo` candidates that match the given track.
-
-        :param item: Track item
-        :param artist: Track artist
-        :param title: Track title
-        """
-        yield from ()
-
     def add_media_field(
         self, name: str, descriptor: mediafile.MediaField
     ) -> None:
@@ -438,32 +381,6 @@ def named_queries(model_cls: type[AnyModel]) -> dict[str, FieldQueryType]:
     return queries
 
 
-def track_distance(item: Item, info: TrackInfo) -> Distance:
-    """Gets the track distance calculated by all loaded plugins.
-    Returns a Distance object.
-    """
-    from beets.autotag.hooks import Distance
-
-    dist = Distance()
-    for plugin in find_plugins():
-        dist.update(plugin.track_distance(item, info))
-    return dist
-
-
-def album_distance(
-    items: Sequence[Item],
-    album_info: AlbumInfo,
-    mapping: dict[Item, TrackInfo],
-) -> Distance:
-    """Returns the album distance calculated by plugins."""
-    from beets.autotag.hooks import Distance
-
-    dist = Distance()
-    for plugin in find_plugins():
-        dist.update(plugin.album_distance(items, album_info, mapping))
-    return dist
-
-
 def notify_info_yielded(event: str) -> Callable[[IterF[P, Ret]], IterF[P, Ret]]:
     """Makes a generator send the event 'event' every time it yields.
     This decorator is supposed to decorate a generator, but any function