feat: beets info --links to make external ids links

Author: Nukesor

beets/ui/__init__.py

@@ -585,6 +585,20 @@ def colorize(color_name: ColorName, text: str) -> str:
     return text
 
 
+def terminal_link(url: str, text: str | None = None) -> str:
+    """Create a clickable terminal hyperlink using a OSC 8 escape sequence.
+
+    `text` falls back to `url` if `None`.
+    """
+    display = text if text is not None else url
+
+    return (
+        f"{COLOR_ESCAPE}]8;;{url}{COLOR_ESCAPE}\\"
+        f"{display}"
+        f"{COLOR_ESCAPE}]8;;{COLOR_ESCAPE}\\"
+    )
+
+
 def uncolorize(colored_text):
     """Remove colors from a string."""
     # Define a regular expression to match ANSI codes.

beetsplug/info.py

@@ -23,6 +23,20 @@
 from beets.plugins import BeetsPlugin
 from beets.util import displayable_path, normpath, syspath
 
+# Mapping from beets field names to URL templates.
+FIELD_LINK_TEMPLATES: dict[str, str] = {
+    "mb_trackid": "https://musicbrainz.org/recording/{value}",
+    "mb_albumid": "https://musicbrainz.org/release/{value}",
+    "mb_artistid": "https://musicbrainz.org/artist/{value}",
+    "mb_albumartistid": "https://musicbrainz.org/artist/{value}",
+    "mb_releasetrackid": "https://musicbrainz.org/track/{value}",
+    "mb_releasegroupid": "https://musicbrainz.org/release-group/{value}",
+    "mb_workid": "https://musicbrainz.org/work/{value}",
+    "discogs_albumid": "https://www.discogs.com/release/{value}",
+    "discogs_artistid": "https://www.discogs.com/artist/{value}",
+    "discogs_labelid": "https://www.discogs.com/label/{value}",
+}
+
 
 def tag_data(lib, args, album=False):
     query = []
@@ -92,13 +106,16 @@ def update_summary(summary, tags):
     return summary
 
 
-def print_data(data, item=None, fmt=None):
+def print_data(data, item=None, fmt=None, links=False):
     """Print, with optional formatting, the fields of a single element.
 
     If no format string `fmt` is passed, the entries on `data` are printed one
     in each line, with the format 'field: value'. If `fmt` is not `None`, the
     `item` is printed according to `fmt`, using the `Item.__format__`
     machinery.
+
+    When `links == True`, external ID fields will be rendered as clickable
+    terminal hyperlinks using OSC 8 escape sequences.
     """
     if fmt:
         # use fmt specified by the user
@@ -110,7 +127,10 @@ def print_data(data, item=None, fmt=None):
     for key, value in data.items():
         if isinstance(value, list):
             formatted[key] = "; ".join(value)
-        if value is not None:
+        elif value is not None:
+            if links and key in FIELD_LINK_TEMPLATES:
+                url = FIELD_LINK_TEMPLATES[key].format(value=value)
+                value = ui.terminal_link(url, value)
             formatted[key] = value
 
     if len(formatted) == 0:
@@ -181,6 +201,11 @@ def commands(self):
             action="store_true",
             help="show only the keys",
         )
+        cmd.parser.add_option(
+            "--links",
+            action="store_true",
+            help="make ID fields (MusicBrainz, Discogs) clickable terminal hyperlinks",
+        )
         cmd.parser.add_format_option(target="item")
         return [cmd]
 
@@ -231,8 +256,8 @@ def run(self, lib, opts, args):
                     print_data_keys(data, item)
                 else:
                     fmt = [opts.format][0] if opts.format else None
-                    print_data(data, item, fmt)
+                    print_data(data, item, fmt, links=opts.links)
                 first = False
 
         if opts.summarize:
-            print_data(summary)
+            print_data(summary, links=opts.links)

docs/changelog.rst

@@ -12,6 +12,8 @@ Unreleased
 New features
 ~~~~~~~~~~~~
 
+- :doc:`plugins/info`: Added ``--links`` commandline flag, which results in
+  external ids (musicbrainz,discogs) being clickable links in the terminal.
 - :doc:`plugins/lastgenre`: Added ``cleanup_existing`` configuration flag to
   allow whitelist canonicalization of existing genres.
 - Add native support for multiple genres per album/track. The ``genres`` field

docs/plugins/info.rst

@@ -46,6 +46,8 @@ Additional command-line options include:
   item. This uses the same template syntax as beets’ :doc:`path formats
   </reference/pathformat>`.
 - ``--keys-only`` or ``-k``: Show the name of the tags without the values.
+- ``--links``: Make external ids (Discogs/Musicbrainz) clickable links in the
+  terminal.
 
 .. _id3v2: http://id3v2.sourceforge.net
 

test/plugins/test_info.py

@@ -15,6 +15,7 @@
 
 from mediafile import MediaFile
 
+from beets import ui
 from beets.test.helper import IOMixin, PluginTestCase
 from beets.util import displayable_path
 
@@ -116,3 +117,38 @@ def test_custom_format(self):
             "$track. $title - $artist ($length)",
         )
         assert "02. tïtle 0 - the artist (0:01)\n" == out
+
+    def test_links(self):
+        (item,) = self.add_item_fixtures()
+        item.mb_albumid = "album-uuid"
+        item.mb_trackid = "track-uuid"
+        item.discogs_albumid = 99999
+        item.album = "MyAlbum"
+        item.store()
+
+        out = self.run_with_output(
+            "info",
+            "--library",
+            "--include-keys",
+            "mb_albumid,mb_trackid,discogs_albumid,album",
+            "--links",
+        )
+
+        # ID fields are wrapped in terminal hyperlinks
+        mb_album_link = ui.terminal_link(
+            "https://musicbrainz.org/release/album-uuid", "album-uuid"
+        )
+        assert f"mb_albumid: {mb_album_link}" in out
+
+        mb_track_link = ui.terminal_link(
+            "https://musicbrainz.org/recording/track-uuid", "track-uuid"
+        )
+        assert f"mb_trackid: {mb_track_link}" in out
+
+        discogs_link = ui.terminal_link(
+            "https://www.discogs.com/release/99999", "99999"
+        )
+        assert f"discogs_albumid: {discogs_link}" in out
+
+        # Non-ID fields remain plain text
+        assert "album: MyAlbum" in out