lyrics/LRCLib: handle instrumental lyrics

Author: snejus

beetsplug/lyrics.py

@@ -60,6 +60,7 @@
 TAG_RE = re.compile(r"<[^>]*>")
 BREAK_RE = re.compile(r"\n?\s*<br([\s|/][^>]*)*>\s*\n?", re.I)
 USER_AGENT = f"beets/{beets.__version__}"
+INSTRUMENTAL_LYRICS = "[Instrumental]"
 
 # The content for the base index.rst generated in ReST mode.
 REST_INDEX_TEMPLATE = """Lyrics
@@ -349,6 +350,9 @@ def fetch(
             if data:
                 item = self.pick_lyrics(length, data)
 
+                if item["instrumental"]:
+                    return INSTRUMENTAL_LYRICS
+
                 if self.config["synced"] and (synced := item["syncedLyrics"]):
                     return synced
 
@@ -536,7 +540,7 @@ def _try_extracting_lyrics_from_non_data_lyrics_container(self, soup):
                 string="This song is an instrumental",
             ):
                 self._log.debug("Detected instrumental")
-                return "[Instrumental]"
+                return INSTRUMENTAL_LYRICS
             else:
                 self._log.debug("Couldn't scrape page using known layouts")
                 return None

test/plugins/test_lyrics.py

@@ -347,6 +347,7 @@ def test_scrape(self, backend, lyrics_html, expecting_lyrics):
 
 def lyrics_match(**overrides):
     return {
+        "instrumental": False,
         "duration": LYRICS_DURATION,
         "syncedLyrics": "synced",
         "plainLyrics": "plain",
@@ -386,6 +387,11 @@ def test_synced_config_option(self, fetch_lyrics, expected_lyrics):
             pytest.param(
                 [lyrics_match()], "synced", id="synced when available"
             ),
+            pytest.param(
+                [lyrics_match(instrumental=True)],
+                "[Instrumental]",
+                id="instrumental track",
+            ),
             pytest.param(
                 [lyrics_match(syncedLyrics=None)],
                 "plain",