Skip to content
Reference of plugins_api 3.0.0.

plugins_api.utils.plugin_utils

Plugin utilities.

This module contains utility functions for plugin discovery and management.

Attributes

NameDescription
loggerNo description.
pluginsNo description.

Functions

NameDescription
find_plugins_in_moduleFind and return all plugin classes defined in the specified module.
get_plugin_classReturn the class object of a plugin based on its ID.
get_plugin_instanceGet an instance of a connection plugin.
get_plugin_versionGet the version of a plugin.
get_pluginsRetrieve dynamically all implementations of plugins in apps, optionally filtered by plugin type.
is_plugin_in_dev_modeCheck if a plugin is installed in development mode (editable install).
reload_pluginsRetrieve all available plugins.

loggerattributemodule attribute#

logger = logging.getLogger(__name__)

pluginsattributemodule attribute#

plugins: list[type[MadbotPlugin]] = []

find_plugins_in_modulefunction#

def find_plugins_in_module(module: types.ModuleType) -> list[type[MadbotPlugin]]

Find and return all plugin classes defined in the specified module.

Parameters

NameTypeDescription
moduleanyThe module to inspect for plugin classes.

Returns

list
A list of plugin classes found in the module.

get_plugin_classfunction#

def get_plugin_class(plugin_id: str) -> type[MadbotPlugin]

Return the class object of a plugin based on its ID.

Parameters

NameTypeDescription
plugin_idstrThe unique ID of the plugin in the module.class format.

Returns

type
The class object of the plugin.

Raises

PluginNotFoundError
If the plugin cannot be found.

get_plugin_instancefunction#

def get_plugin_instance(plugin_id: str, connection_parameters: dict[str, Any], settings: dict[str, Settings] | None = None) -> ConnectionPlugin

Get an instance of a connection plugin.

Parameters

NameTypeDefaultDescription
plugin_idstrrequiredThe unique ID of the plugin in the module.class format.
connection_parametersDict[str, Any]requiredConnection parameters (URLs, credentials, etc.)
settingsDict[str, Any]NoneSettings parameters (only for SubmissionPlugin)

Returns

ConnectionPlugin
The plugin instance.

Raises

InvalidPluginTypeError
If the plugin cannot be instantiated.

get_plugin_versionfunction#

def get_plugin_version(plugin_class: type[MadbotPlugin]) -> str | None

Get the version of a plugin.

This function tries multiple methods to retrieve the plugin version:

  1. First tries to get version from the plugin’s init.py module (version)
  2. Falls back to using importlib.metadata.distribution() to get the installed package version
  3. Returns None if version cannot be determined

Parameters

NameTypeDescription
plugin_classType[MadbotPlugin]The plugin class to get the version for

Returns

str | None
The plugin version string, or None if version cannot be determined

get_pluginsfunction#

def get_plugins(plugin_type: type[MadbotPlugin] | None = None) -> list[type[MadbotPlugin]]

Retrieve dynamically all implementations of plugins in apps, optionally filtered by plugin type.

Parameters

NameTypeDefaultDescription
plugin_typetypeNoneThe type of plugins to filter (DataPlugin or SubmissionPlugin or MetadataFieldDefinitionPlugin).

Returns

list
A list of plugins.

is_plugin_in_dev_modefunction#

def is_plugin_in_dev_mode(plugin_class: type[MadbotPlugin]) -> bool

Check if a plugin is installed in development mode (editable install).

This function uses Python’s importlib.metadata to check the package’s direct_url.json file, which contains information about how the package was installed. For editable installs, this file contains: {“dir_info”: {“editable”: true}, “url”: “file:///path/to/source”}

Parameters

NameTypeDescription
plugin_classType[MadbotPlugin]The plugin class to check

Returns

bool
True if the plugin is installed in editable mode, False otherwise

reload_pluginsfunction#

def reload_plugins() -> None

Retrieve all available plugins.