Add a way to select extra debug output

Web service replies can be very long, and it makes debug output rather hard to read.

A debug option mechanism is now added, it is controlled by a new class
`DebugOpt`.

A command-line option `--debug-opts` allows selection of extra debug
output, for now the sole option is `ws_replies`.

A matching menu was added in View Debug Log dialog.

It is important to note those aren't saved in config file, as they are
meant to be disabled by default and only enabled when needed.

picard/debug_opts.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+#
+# Picard, the next-generation MusicBrainz tagger
+#
+# Copyright (C) 2024 Laurent Monin
+#
+# 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.
+
+from enum import IntEnum
+
+
+class DebugOptMeta(IntEnum):
+
+    @property
+    def optname(self):
+        return self.name.lower()
+
+    @property
+    def title(self):
+        return self._descriptions[self][0]
+
+    @property
+    def description(self):
+        return self._descriptions[self][1]
+
+    @property
+    def enabled(self):
+        return self in self._registry
+
+    @enabled.setter
+    def enabled(self, enable):
+        if enable:
+            self._registry.add(self)
+        else:
+            self._registry.discard(self)
+
+    @classmethod
+    def set_registry(cls, registry):
+        cls._registry = registry
+
+    @classmethod
+    def set_descriptions(cls, descriptions):
+        cls._descriptions = descriptions
+
+    @classmethod
+    def opt_names(cls):
+        """Returns a string listing all valid names for debug options"""
+        return ",".join(sorted(o.optname for o in cls))
+
+    @classmethod
+    def from_string(cls, string):
+        """Parse command line argument, a string with comma-separated values,
+        and enable corresponding debug options"""
+        opts = {str(o).strip().lower() for o in string.split(',')}
+        for o in cls:
+            o.enabled = o.optname in opts
+
+
+class DebugOpt(DebugOptMeta):
+    WS_REPLIES = 1
+
+
+DebugOpt.set_descriptions({
+    DebugOpt.WS_REPLIES: (N_('WS Replies'), N_('Log web service replies')),
+})
+_debug_opts = set()
+DebugOpt.set_registry(_debug_opts)

picard/tagger.py

@@ -101,6 +101,7 @@
     IS_WIN,
 )
 from picard.dataobj import DataObject
+from picard.debug_opts import DebugOpt
 from picard.disc import (
     Disc,
     dbpoweramplog,
@@ -259,6 +260,9 @@ def __init__(self, picard_args, localedir, autoupdate, pipe_handler=None):
         if picard_args.audit:
             setup_audit(picard_args.audit)
 
+        if picard_args.debug_opts:
+            DebugOpt.from_string(picard_args.debug_opts)
+
         # Main thread pool used for most background tasks
         self.thread_pool = QtCore.QThreadPool(self)
         # Two threads are needed for the pipe handler and command processing.
@@ -1464,6 +1468,9 @@ def process_picard_args():
                         help="do not load any plugins")
     parser.add_argument('--no-crash-dialog', action='store_true',
                         help="disable the crash dialog")
+    parser.add_argument('--debug-opts', action='store',
+                        default=None,
+                        help="Comma-separated list of debug options to enable: %s" % DebugOpt.opt_names())
     parser.add_argument('-s', '--stand-alone-instance', action='store_true',
                         help="force Picard to create a new, stand-alone instance")
     parser.add_argument('-v', '--version', action='store_true',

picard/ui/logview.py

@@ -43,6 +43,7 @@
     IntOption,
     get_config,
 )
+from picard.debug_opts import DebugOpt
 from picard.util import (
     reconnect,
     wildcards_to_regex_pattern,
@@ -159,6 +160,23 @@ def set_verbosity(self, level):
         self.actions[level].setChecked(True)
 
 
+class DebugOptsMenu(QtWidgets.QMenu):
+
+    def __init__(self, parent=None):
+        super().__init__(parent=parent)
+
+        self.actions = {}
+        for debug_opt in DebugOpt:
+            action = QtGui.QAction(_(debug_opt.title), self, checkable=True, checked=debug_opt.enabled)
+            action.setToolTip(_(debug_opt.description))
+            action.triggered.connect(partial(self.debug_opt_changed, debug_opt))
+            self.addAction(action)
+            self.actions[debug_opt] = action
+
+    def debug_opt_changed(self, debug_opt, checked):
+        debug_opt.enabled = checked
+
+
 class LogView(LogViewCommon):
 
     options = [
@@ -181,10 +199,18 @@ def __init__(self, parent=None):
         self.hbox.addWidget(self.verbosity_menu_button)
 
         self.verbosity_menu = VerbosityMenu()
-        self._set_verbosity(self.verbosity)
         self.verbosity_menu.verbosity_changed.connect(self._verbosity_changed)
         self.verbosity_menu_button.setMenu(self.verbosity_menu)
 
+        self.debug_opts_menu_button = QtWidgets.QPushButton(_("Debug Options"))
+        self.debug_opts_menu_button.setAccessibleName(_("Debug Options"))
+        self.hbox.addWidget(self.debug_opts_menu_button)
+
+        self.debug_opts_menu = DebugOptsMenu()
+        self.debug_opts_menu_button.setMenu(self.debug_opts_menu)
+
+        self._set_verbosity(self.verbosity)
+
         # highlight input
         self.highlight_text = QtWidgets.QLineEdit()
         self.highlight_text.setPlaceholderText(_("String to highlight"))
@@ -331,6 +357,7 @@ def _update_verbosity_label(self):
         feat = log.levels_features.get(self.verbosity)
         label = _(feat.name) if feat else _("Verbosity")
         self.verbosity_menu_button.setText(label)
+        self.debug_opts_menu_button.setEnabled(self.verbosity == logging.DEBUG)
 
 
 class HistoryView(LogViewCommon):

picard/webservice/__init__.py

@@ -60,6 +60,7 @@
     CACHE_SIZE_IN_BYTES,
     appdirs,
 )
+from picard.debug_opts import DebugOpt
 from picard.oauth import OAuthManager
 from picard.util import (
     build_qurl,
@@ -530,7 +531,8 @@ def _handle_reply(self, reply, request):
                 elif request.response_parser:
                     try:
                         document = request.response_parser(reply)
-                        log.debug("Response received: %s", document)
+                        if DebugOpt.WS_REPLIES.enabled:
+                            log.debug("Response received: %s", document)
                     except Exception as e:
                         log.error("Unable to parse the response for %s -> %s", display_reply_url, e)
                         document = reply.readAll()

test/test_debug_opt.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+#
+# Picard, the next-generation MusicBrainz tagger
+#
+# Copyright (C) 2024 Laurent Monin
+#
+# 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.
+
+from test.picardtestcase import PicardTestCase
+
+from picard.debug_opts import DebugOptMeta
+
+
+class TestDebugOpt(DebugOptMeta):
+    A = 1
+    B = 2
+
+
+_descriptions = {
+    TestDebugOpt.A: ('titleA', 'descA'),
+    TestDebugOpt.B: ('titleB', 'descB'),
+}
+TestDebugOpt.set_descriptions(_descriptions)
+
+
+class DebugOptTest(PicardTestCase):
+    def setUp(self):
+        TestDebugOpt.set_registry(set())
+
+    def test_enabled(self):
+        self.assertFalse(TestDebugOpt.A.enabled)
+        self.assertFalse(TestDebugOpt.B.enabled)
+        TestDebugOpt.A.enabled = True
+        self.assertTrue(TestDebugOpt.A.enabled)
+
+    def test_optname(self):
+        self.assertEqual(TestDebugOpt.A.optname, 'a')
+        self.assertEqual(TestDebugOpt.B.optname, 'b')
+
+    def test_title(self):
+        self.assertEqual(TestDebugOpt.A.title, _descriptions[TestDebugOpt.A][0])
+        self.assertEqual(TestDebugOpt.B.title, _descriptions[TestDebugOpt.B][0])
+
+    def test_description(self):
+        self.assertEqual(TestDebugOpt.A.description, _descriptions[TestDebugOpt.A][1])
+        self.assertEqual(TestDebugOpt.B.description, _descriptions[TestDebugOpt.B][1])
+
+    def test_opt_names(self):
+        self.assertEqual(TestDebugOpt.opt_names(), 'a,b')
+
+    def test_from_string_simple(self):
+        TestDebugOpt.from_string('a')
+        self.assertTrue(TestDebugOpt.A.enabled)
+        self.assertFalse(TestDebugOpt.B.enabled)
+        TestDebugOpt.from_string('a,b')
+        self.assertTrue(TestDebugOpt.A.enabled)
+        self.assertTrue(TestDebugOpt.B.enabled)
+
+    def test_from_string_complex(self):
+        TestDebugOpt.from_string('something, A,x,b')
+        self.assertTrue(TestDebugOpt.A.enabled)
+        self.assertTrue(TestDebugOpt.B.enabled)
+
+    def test_from_string_remove(self):
+        TestDebugOpt.set_registry({TestDebugOpt.B})
+        self.assertTrue(TestDebugOpt.B.enabled)
+        TestDebugOpt.from_string('A')
+        self.assertTrue(TestDebugOpt.A.enabled)
+        self.assertFalse(TestDebugOpt.B.enabled)