From 35e17ad35e89003f1d1eb2ab97e88717556d0c72 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0ar=C5=ABnas=20Nejus?= <snejus@protonmail.com>
Date: Mon, 9 Sep 2024 16:23:38 +0100
Subject: [PATCH] Create BackendType metaclass for easy access to backends

---
 beetsplug/lyrics.py | 111 +++++++++++++++++++++++---------------------
 1 file changed, 58 insertions(+), 53 deletions(-)

diff --git a/beetsplug/lyrics.py b/beetsplug/lyrics.py
index d6f109c5d9..7ba179e427 100644
--- a/beetsplug/lyrics.py
+++ b/beetsplug/lyrics.py
@@ -25,8 +25,9 @@
 import unicodedata
 import urllib
 import warnings
+from functools import cached_property
 from html import unescape
-from typing import Any
+from typing import Any, Iterator
 
 import requests
 from typing_extensions import TypedDict
@@ -209,7 +210,36 @@ def try_parse_html(html, **kwargs):
         return None
 
 
-class Backend:
+class BackendType(type):
+    """Metaclass for the :class:`Backend` class.
+
+    It keeps track of defined subclasses and provides access to them through
+    the base class:
+
+    >>> Backend["genius"]  # beetsplug.lyrics.Genius
+    >>> list(Backend)  # ["lrclib", "musixmatch", "genius", "tekstowo", "google"]
+    """
+
+    _registry: dict[str, BackendType] = {}
+    REQUIRES_BS: bool
+
+    def __new__(cls, name: str, bases: tuple[type, ...], attrs) -> BackendType:
+        """Create a new instance of the class and add it to the registry."""
+        new_class = super().__new__(cls, name, bases, attrs)
+        if bases:
+            cls._registry[name.lower()] = new_class
+        return new_class
+
+    @classmethod
+    def __getitem__(cls, key: str) -> BackendType:
+        return cls._registry[key]
+
+    @classmethod
+    def __iter__(cls) -> Iterator[str]:
+        return iter(cls._registry)
+
+
+class Backend(metaclass=BackendType):
     REQUIRES_BS = False
 
     def __init__(self, config, log):
@@ -817,14 +847,29 @@ def fetch(self, artist, title, album=None, length=None):
 
 
 class LyricsPlugin(plugins.BeetsPlugin):
-    SOURCES = ["lrclib", "google", "musixmatch", "genius", "tekstowo"]
-    SOURCE_BACKENDS = {
-        "google": Google,
-        "musixmatch": MusiXmatch,
-        "genius": Genius,
-        "tekstowo": Tekstowo,
-        "lrclib": LRCLib,
-    }
+    @cached_property
+    def backends(self) -> dict[str, Backend]:
+        user_sources = self.config["sources"].get()
+        chosen = plugins.sanitize_choices(user_sources, Backend)
+
+        disabled = set()
+        if not HAS_BEAUTIFUL_SOUP:
+            disabled |= {n for n in chosen if Backend[n].REQUIRES_BS}
+            if disabled:
+                self._log.debug(
+                    "Disabling {} sources: missing beautifulsoup4 module",
+                    disabled,
+                )
+
+        elif "google" in chosen and not self.config["google_API_key"].get():
+            self._log.debug("Disabling Google source: no API key configured.")
+            disabled.add("google")
+
+        return {
+            s: Backend[s](self.config, self._log)
+            for s in chosen
+            if s not in disabled
+        }
 
     def __init__(self):
         super().__init__()
@@ -847,7 +892,7 @@ def __init__(self):
                 "synced": False,
                 # Musixmatch is disabled by default as they are currently blocking
                 # requests with the beets user agent.
-                "sources": [s for s in self.SOURCES if s != "musixmatch"],
+                "sources": [s for s in Backend if s != "musixmatch"],
                 "dist_thresh": 0.1,
             }
         )
@@ -865,25 +910,6 @@ def __init__(self):
         # open yet.
         self.rest = None
 
-        available_sources = list(self.SOURCES)
-        sources = plugins.sanitize_choices(
-            self.config["sources"].as_str_seq(), available_sources
-        )
-
-        if not HAS_BEAUTIFUL_SOUP:
-            sources = self.sanitize_bs_sources(sources)
-
-        if "google" in sources:
-            if not self.config["google_API_key"].get():
-                # We log a *debug* message here because the default
-                # configuration includes `google`. This way, the source
-                # is silent by default but can be enabled just by
-                # setting an API key.
-                self._log.debug(
-                    "Disabling google source: " "no API key configured."
-                )
-                sources.remove("google")
-
         self.config["bing_lang_from"] = [
             x.lower() for x in self.config["bing_lang_from"].as_str_seq()
         ]
@@ -896,25 +922,6 @@ def __init__(self):
                 "documentation for further details."
             )
 
-        self.backends = [
-            self.SOURCE_BACKENDS[source](self.config, self._log)
-            for source in sources
-        ]
-
-    def sanitize_bs_sources(self, sources):
-        enabled_sources = []
-        for source in sources:
-            if self.SOURCE_BACKENDS[source].REQUIRES_BS:
-                self._log.debug(
-                    "To use the %s lyrics source, you must "
-                    "install the beautifulsoup4 module. See "
-                    "the documentation for further details." % source
-                )
-            else:
-                enabled_sources.append(source)
-
-        return enabled_sources
-
     def get_bing_access_token(self):
         params = {
             "client_id": "beets",
@@ -1131,12 +1138,10 @@ def get_lyrics(self, artist, title, album=None, length=None):
         """Fetch lyrics, trying each source in turn. Return a string or
         None if no lyrics were found.
         """
-        for backend in self.backends:
+        for name, backend in self.backends.items():
             lyrics = backend.fetch(artist, title, album=album, length=length)
             if lyrics:
-                self._log.debug(
-                    "got lyrics from backend: {0}", backend.__class__.__name__
-                )
+                self._log.debug("got lyrics from backend: {0}", name)
                 return _scrape_strip_cruft(lyrics, True)
 
     def append_translation(self, text, to_lang):