eegprep.plugin_status#

eegprep.plugin_status(pluginname, *, exactmatch=False, pluginlist=None, registry=None, catalog=None, catalog_path=None, include_bundled=True, include_entry_points=True, disabled_extensions=None)#

Return EEGLAB-style installed status for EEGPrep extensions.

Parameters:

  • pluginname (str) – Plugin or extension name, package name, or substring to search.

  • exactmatch (bool) – Require exact case-insensitive name matching.

  • pluginlist (list[dict[str, Any]] | tuple[dict[str, Any], ...] | None) – Optional precomputed extension inventory. Defaults to the registry plus the curated catalog.

  • registry (ExtensionRegistry | None) – Optional discovered registry for tests or callers that need explicit discovery control.

  • catalog (ExtensionCatalog | None) – Optional loaded catalog. Defaults to the packaged/local catalog.

  • catalog_path (str | None) – Optional JSON catalog path.

  • include_bundled (bool) – Include bundled EEGPrep plugin ports in default discovery.

  • include_entry_points (bool) – Include installed entry-point extensions in default discovery.

  • disabled_extensions (set[str] | list[str] | tuple[str, ...] | None) – Registry names to mark disabled during default discovery.

Returns:

A tuple (status, names, pluginstruct) where status values are 1 for active installed/bundled extensions and 0 for curated-only, disabled, incompatible, failed, or missing-dependency matches.

Return type:

tuple[list[int], list[str], list[dict[str, Any]]]

On this page