Merge pull request #2614 from phw/PICARD-3042-discid-format

PICARD-3042: Include format in disc ID lookup result table

Author: phw

picard/ui/cdlookup.py

@@ -3,7 +3,7 @@
 # Picard, the next-generation MusicBrainz tagger
 #
 # Copyright (C) 2006-2007 Lukáš Lalinský
-# Copyright (C) 2009, 2018-2023 Philipp Wolfer
+# Copyright (C) 2009, 2018-2023, 2025 Philipp Wolfer
 # Copyright (C) 2011-2013 Michael Wiencek
 # Copyright (C) 2012 Chad Wilson
 # Copyright (C) 2013-2014, 2018, 2020-2021, 2023-2024 Laurent Monin
@@ -25,6 +25,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
+from html import escape
 
 from PyQt6 import (
     QtCore,
@@ -41,6 +42,7 @@
 from picard.mbjson import (
     artist_credit_from_node,
     label_info_from_node,
+    media_formats_from_node,
     release_dates_and_countries_from_node,
 )
 from picard.util import (
@@ -53,6 +55,7 @@
     Column,
     Columns,
 )
+from picard.ui.formattedtextdelegate import FormattedTextDelegate
 from picard.ui.forms.ui_cdlookup import Ui_CDLookupDialog
 
 
@@ -64,10 +67,12 @@
     Column(N_("Labels"), 'labels'),
     Column(N_("Catalog #s"), 'catnos'),
     Column(N_("Barcode"), 'barcode'),
+    Column(N_("Format"), 'format'),
     Column(N_("Disambiguation"), 'disambiguation'),
 ))
 
 _DATA_COLUMN = _COLUMNS.pos('album')
+_FORMAT_COLUMN = _COLUMNS.pos('format')
 
 
 class CDLookupDialog(PicardDialog):
@@ -86,6 +91,8 @@ def __init__(self, releases, disc, parent=None):
         release_list.setAlternatingRowColors(True)
         labels = [_(c.title) for c in _COLUMNS]
         release_list.setHeaderLabels(labels)
+        delegate = FormattedTextDelegate(release_list)
+        release_list.setItemDelegateForColumn(_FORMAT_COLUMN, delegate)
         self.ui.submit_button.setIcon(QtGui.QIcon(":/images/cdrom.png"))
         if self.releases:
             def myjoin(values):
@@ -108,6 +115,7 @@ def myjoin(values):
                     'labels': myjoin(labels),
                     'catnos': myjoin(catalog_numbers),
                     'barcode': barcode,
+                    'format': self._get_format(release),
                     'disambiguation': release.get('disambiguation', ''),
                 }
                 for i, column in enumerate(_COLUMNS):
@@ -163,3 +171,16 @@ def save_header_state(self):
             config = get_config()
             config.persist[self.dialog_header_state] = state
             log.debug("save_state: %s", self.dialog_header_state)
+
+    def _get_format(self, release):
+        format = escape(media_formats_from_node(release.get('media', [])))
+        selected_medium = self._get_selected_medium(release)
+        if selected_medium:
+            selected_format = escape(selected_medium.get('format', format))
+            format = format.replace(selected_format, f"<b>{selected_format}</b>")
+        return format
+
+    def _get_selected_medium(self, release):
+        for medium in release.get('media', []):
+            if any(disc.get('id') == self.disc.id for disc in medium.get('discs', [])):
+                return medium

picard/ui/formattedtextdelegate.py

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+#
+# Picard, the next-generation MusicBrainz tagger
+#
+# Copyright (C) 2025 Philipp Wolfer
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+import math
+
+from PyQt6 import (
+    QtCore,
+    QtGui,
+    QtWidgets,
+)
+
+
+class FormattedTextDelegate(QtWidgets.QStyledItemDelegate):
+    def __init__(self, parent=None, markup_format='html'):
+        """
+        A QStyledItemDelegate that renders formatted text in a QTreeWidget.
+
+        :param markup_format: Specify the format of the markup, either "html" or "markdown".
+        """
+        super().__init__(parent)
+        self.markup_format = markup_format
+
+    def paint(self, painter, option, index):
+        # Initialize the style option
+        self.initStyleOption(option, index)
+
+        # Draw the background
+        if option.state & QtWidgets.QStyle.StateFlag.State_Selected:
+            fill_brush = option.palette.highlight()
+            text_color_role = QtGui.QPalette.ColorRole.HighlightedText
+        else:
+            fill_brush = option.palette.base()
+            text_color_role = QtGui.QPalette.ColorRole.Text
+        painter.fillRect(option.rect, fill_brush)
+
+        # Get the formatted text from the model
+        text = index.data(QtCore.Qt.ItemDataRole.DisplayRole)
+        if not text:
+            return
+
+        # Create a QTextDocument to render the formatted text
+        doc = self._create_doc(text, option)
+
+        # Set the text color based on the current palette
+        text_color = option.palette.color(text_color_role)
+        doc.setDefaultStyleSheet(f"body {{ color: {text_color.name()}; }}")
+
+        # Draw the text
+        painter.save()
+        painter.translate(option.rect.topLeft())
+        doc.drawContents(painter)
+        painter.restore()
+
+    def sizeHint(self, option, index):
+        # Provide a size hint based on the QTextDocument's size
+        text = index.data(QtCore.Qt.ItemDataRole.DisplayRole)
+        if not text:
+            return super().sizeHint(option, index)
+
+        # Create a QTextDocument to render the formatted text
+        doc = self._create_doc(text, option)
+
+        return QtCore.QSize(
+            math.ceil(doc.idealWidth()),
+            math.ceil(doc.size().height()))
+
+    def _create_doc(self, text, option):
+        doc = QtGui.QTextDocument()
+        if self.markup_format == 'html':
+            doc.setHtml(text)
+        elif self.markup_format == 'markdown':
+            doc.setMarkdown(text)
+        else:
+            doc.setPlainText(text)
+
+        doc.setDefaultFont(option.font)
+        doc.setTextWidth(option.rect.width())
+        text_option = doc.defaultTextOption()
+        text_option.setWrapMode(QtGui.QTextOption.WrapMode.NoWrap)
+        doc.setDefaultTextOption(text_option)
+        return doc