Deprecate musicbrainz.enabled configuration

Author: snejus

beets/ui/__init__.py

@@ -17,6 +17,8 @@
 CLI commands are implemented in the ui.commands module.
 """
 
+from __future__ import annotations
+
 import errno
 import optparse
 import os.path
@@ -27,7 +29,7 @@
 import textwrap
 import traceback
 from difflib import SequenceMatcher
-from typing import Any, Callable
+from typing import TYPE_CHECKING, Any, Callable
 
 import confuse
 
@@ -37,6 +39,9 @@
 from beets.util import as_string
 from beets.util.functemplate import template
 
+if TYPE_CHECKING:
+    from types import ModuleType
+
 # On Windows platforms, use colorama to support "ANSI" terminal colors.
 if sys.platform == "win32":
     try:
@@ -569,7 +574,7 @@ def human_seconds_short(interval):
     "text_diff_removed",
     "text_diff_changed",
 ]
-COLORS = None
+COLORS: dict[str, list[str]] | None = None
 
 
 def _colorize(color, text):
@@ -1622,7 +1627,9 @@ def parse_subcommand(self, args):
 # The main entry point and bootstrapping.
 
 
-def _load_plugins(options, config):
+def _load_plugins(
+    options: optparse.Values, config: confuse.LazyConfig
+) -> ModuleType:
     """Load the plugins specified on the command line or in the configuration."""
     paths = config["pluginpath"].as_str_seq(split=False)
     paths = [util.normpath(p) for p in paths]
@@ -1647,6 +1654,11 @@ def _load_plugins(options, config):
         )
     else:
         plugin_list = config["plugins"].as_str_seq()
+        # TODO: Remove in v2.4 or v3
+        if "musicbrainz" in config and config["musicbrainz"].get().get(
+            "enabled"
+        ):
+            plugin_list.append("musicbrainz")
 
     # Exclude any plugins that were specified on the command line
     if options.exclude is not None:

docs/changelog.rst

@@ -40,6 +40,7 @@ New features:
   a separate plugin. The default :ref:`plugins-config` includes `musicbrainz`,
   but if you've customized your `plugins` list in your configuration, you'll
   need to explicitly add `musicbrainz` to continue using this functionality.
+  Configuration option `musicbrainz.enabled` has thus been deprecated.
   :bug:`2686`
   :bug:`4605`
 * :doc:`plugins/lastgenre`: The new configuration option, ``keep_existing``,

docs/plugins/musicbrainz.rst

@@ -71,6 +71,9 @@ to one request per second.
 enabled
 ~~~~~~~
 
+.. deprecated:: 2.3
+  Add `musicbrainz` to the `plugins` list instead.
+
 This option allows you to disable using MusicBrainz as a metadata source. This applies
 if you use plugins that fetch data from alternative sources and should make the import
 process quicker.