5.3.1.11. install_plugin

mfutil.plugins.install_plugin(plugin_filepath, plugins_base_dir=None, ignore_errors=False, quiet=False)

Install a plugin from a .plugin file.

Parameters

• plugin_filepath (string) – the plugin file path.

• plugins_base_dir (string) – (optional) the plugin base directory path. If not set, the default plugins base directory path is used.

• ignore_errors (boolean) – If True, errors are ignored,

• otherwise fails on errors. Default value is False.

• quiet (boolean) – quiet mode to reduce output printing. Default value is False.

Raises

• MFUtilPluginBaseNotInitialized – if the plugins base is not initialized.

• MFUtilPluginFileNotFound – if the .plugin file is not found.

• MFUtilPluginAlreadyInstalled – if the plugin is already installed.

• MFUtilPluginCantInstall – if the plugin can’t be installed.