Function get_plugin_names

beets/plugins.py:379–417

Discover and return the set of plugin names to be loaded. Configures the plugin search paths and resolves the final set of plugins based on configuration settings, inclusion filters, and exclusion rules. Automatically includes the musicbrainz plugin when enabled in configuration.

()

def get_plugin_names() -> list[str]:
    """Discover and return the set of plugin names to be loaded.

    Configures the plugin search paths and resolves the final set of plugins
    based on configuration settings, inclusion filters, and exclusion rules.
    Automatically includes the musicbrainz plugin when enabled in configuration.
    """
    paths = [
        str(Path(p).expanduser().absolute())
        for p in beets.config["pluginpath"].as_str_seq(split=False)
    ]
    log.debug("plugin paths: {}", paths)

    # Extend the `beetsplug` package to include the plugin paths.
    import beetsplug

    beetsplug.__path__ = paths + list(beetsplug.__path__)

    # For backwards compatibility, also support plugin paths that
    # *contain* a `beetsplug` package.
    sys.path += paths
    plugins = unique_list(beets.config["plugins"].as_str_seq())
    beets.config.add({"disabled_plugins": []})
    disabled_plugins = set(beets.config["disabled_plugins"].as_str_seq())
    # TODO: Remove in v3.0.0
    mb_enabled = beets.config["musicbrainz"].flatten().get("enabled")
    if mb_enabled:
        deprecate_for_user(
            log,
            "'musicbrainz.enabled' configuration option",
            "'plugins' configuration to explicitly add 'musicbrainz'",
        )
        if "musicbrainz" not in plugins:
            plugins.append("musicbrainz")
    elif mb_enabled is False:
        deprecate_for_user(log, "'musicbrainz.enabled' configuration option")
        disabled_plugins.add("musicbrainz")

    return [p for p in plugins if p not in disabled_plugins]


def _get_plugin(name: str) -> BeetsPlugin | None: