eric6.PluginManager.PluginManager

Module implementing the Plugin Manager.

Global Attributes

Classes

Functions

PluginManager

Class implementing the Plugin Manager.

Signals

allPlugginsActivated()

emitted at startup after all plugins have been activated

pluginAboutToBeActivated(modulName, pluginObject)

emitted just before a plugin is activated

pluginAboutToBeDeactivated(moduleName, pluginObject)

emitted just before a plugin is deactivated

pluginActivated(moduleName, pluginObject)

emitted just after a plugin was activated

pluginDeactivated(moduleName, pluginObject)

emitted just after a plugin was deactivated

shutdown()

emitted at shutdown of the IDE

Derived from

Class Attributes

Class Methods

Methods

Static Methods

PluginManager (Constructor)

Constructor

The Plugin Manager deals with three different plugin directories. The first is the one, that is part of eric6 (eric6/Plugins). The second one is the global plugin directory called 'eric6plugins', which is located inside the site-packages directory. The last one is the user plugin directory located inside the .eric6 directory of the users home directory.

parent (QObject)

reference to the parent object

disabledPlugins (list of str)

list of plug-ins that have been disabled via the command line parameters '--disable-plugin='

doLoadPlugins (bool)

flag indicating, that plug-ins should be loaded

develPlugin (str)

filename of a plug-in to be loaded for development

Raises PluginModulesError:

raised to indicate the absence of plug-in modules

Raises PluginPathError:

raised to indicate an invalid plug-in path

PluginManager.__canActivatePlugin

Private method to check, if a plugin can be activated.

module

reference to the module to be activated

Returns:

flag indicating, if the module satisfies all requirements for being activated (boolean)

Raises PluginClassFormatError:

raised to indicate an invalid plug-in class format

Raises PluginModuleFormatError:

raised to indicate an invalid plug-in module format

PluginManager.__canDeactivatePlugin

Private method to check, if a plugin can be deactivated.

module

reference to the module to be deactivated

Returns:

flag indicating, if the module satisfies all requirements for being deactivated (boolean)

PluginManager.__checkPluginsDownloadDirectory

Private slot to check for the existence of the plugins download directory.

PluginManager.__downloadRepositoryFileDone

Private method called after the repository file was downloaded.

reply (QNetworkReply)

reference to the reply object of the download

PluginManager.__getShortInfo

Private method to extract the short info from a module.

module

module to extract short info from

Returns:

dictionay containing plug-in data

Return Type:

dict ("plugin_name": str, "version": str, "short_desc": str, "error": bool)

PluginManager.__insertPluginsPaths

Private method to insert the valid plugin paths intos the search path.

PluginManager.__loadPlugins

Private method to load the plugins found.

PluginManager.__onlineStateChanged

Private slot handling changes in online state.

online (bool)

flag indicating the online state

PluginManager.__pluginDirectoriesExist

Private method to check, if the plugin folders exist.

If the plugin folders don't exist, they are created (if possible).

Returns:

tuple of a flag indicating existence of any of the plugin directories (boolean) and a message (string)

PluginManager.__pluginModulesExist

Private method to check, if there are plugins available.

Returns:

flag indicating the availability of plugins (boolean)

PluginManager.__sslErrors

Private slot to handle SSL errors.

reply

reference to the reply object (QNetworkReply)

errors

list of SSL errors (list of QSslError)

PluginManager.activatePlugin

Public method to activate a plugin.

name

name of the module to be activated

onDemand=

flag indicating activation of an on demand plugin (boolean)

Returns:

reference to the initialized plugin object

Raises PluginActivationError:

raised to indicate an issue during the plug-in activation

PluginManager.activatePlugins

Public method to activate all plugins having the "autoactivate" attribute set to True.

PluginManager.checkPluginEntry

Public method to check a plug-in's data for an update.

name

data for the name field (string)

short

data for the short field (string)

description

data for the description field (list of strings)

url

data for the url field (string)

author

data for the author field (string)

version

data for the version field (string)

filename

data for the filename field (string)

status

status of the plugin (string [stable, unstable, unknown])

PluginManager.checkPluginUpdatesAvailable

Public method to check the availability of updates of plug-ins.

PluginManager.clearPluginsPrivateData

Public method to clear the private data of plug-ins of a specified type.

Plugins supporting this functionality must support the module function clearPrivateData() and have the module level attribute pluginType.

type_

type of the plugin to clear private data for (string)

PluginManager.deactivatePlugin

Public method to deactivate a plugin.

name

name of the module to be deactivated

onDemand=

flag indicating deactivation of an on demand plugin (boolean)

PluginManager.deactivateVcsPlugins

Public method to deactivated all activated VCS plugins.

PluginManager.doShutdown

Public method called to perform actions upon shutdown of the IDE.

PluginManager.finalizeSetup

Public method to finalize the setup of the plugin manager.

PluginManager.getPluginApiFiles

Public method to get the list of API files installed by a plugin.

language

language of the requested API files (string)

Returns:

list of API filenames (list of string)

PluginManager.getPluginConfigData

Public method to get the config data of all active, non on-demand plugins used by the configuration dialog.

Plugins supporting this functionality must provide the plugin module function 'getConfigData' returning a dictionary with unique keys of lists with the following list contents:

display string

string shown in the selection area of the configuration page. This should be a localized string

pixmap name

filename of the pixmap to be shown next to the display string

page creation function

plugin module function to be called to create the configuration page. The page must be subclasses from Preferences.ConfigurationPages.ConfigurationPageBase and must implement a method called 'save' to save the settings. A parent entry will be created in the selection list, if this value is None.

parent key

dictionary key of the parent entry or None, if this defines a toplevel entry.

reference to configuration page

This will be used by the configuration dialog and must always be None

Returns:

plug-in configuration data

PluginManager.getPluginDetails

Public method to get detailed information about a plugin.

name

name of the module to get detailed infos about (string)

Returns:

details of the plugin as a dictionary

PluginManager.getPluginDir

Public method to get the path of a plugin directory.

key

key of the plug-in directory (string)

Returns:

path of the requested plugin directory (string)

PluginManager.getPluginDisplayStrings

Public method to get the display strings of all plugins of a specific type.

type_

type of the plugins (string)

Returns:

dictionary with name as key and display string as value (dictionary of string)

PluginManager.getPluginExeDisplayData

Public method to get data to display information about a plugins external tool.

Returns:

list of dictionaries containing the data. Each dictionary must either contain data for the determination or the data to be displayed.
A dictionary of the first form must have the following entries:

• programEntry - indicator for this dictionary form (boolean), always True
• header - string to be diplayed as a header (string)
• exe - the executable (string)
• versionCommand - commandline parameter for the exe (string)
• versionStartsWith - indicator for the output line containing the version (string)
• versionPosition - number of element containing the version (integer)
• version - version to be used as default (string)
• versionCleanup - tuple of two integers giving string positions start and stop for the version string (tuple of integers)

A dictionary of the second form must have the following entries:

• programEntry - indicator for this dictionary form (boolean), always False
• header - string to be diplayed as a header (string)
• text - entry text to be shown (string)
• version - version text to be shown (string)

PluginManager.getPluginInfos

Public method to get infos about all loaded plug-ins.

Returns:

list of dictionaries with keys "module_name", "plugin_name", "version", "auto_activate", "active", "short_desc", "error"

Return Type:

list of dict ("module_name": str, "plugin_name": str, "version": str, "auto_activate": bool, "active": bool, "short_desc": str, "error": bool)

PluginManager.getPluginModules

Public method to get a list of plugin modules.

pluginPath

name of the path to search (string)

Returns:

list of plugin module names (list of string)

PluginManager.getPluginObject

Public method to activate an ondemand plugin given by type and typename.

type_

type of the plugin to be activated (string)

typename

name of the plugin within the type category (string)

maybeActive=

flag indicating, that the plugin may be active already (boolean)

Returns:

reference to the initialized plugin object

PluginManager.getPluginPreviewPixmap

Public method to get a preview pixmap of a plugin of a specific type.

type_

type of the plugin (string)

name

name of the plugin type (string)

Returns:

preview pixmap (QPixmap)

PluginManager.getPluginQtHelpFiles

Public method to get the list of QtHelp documentation files provided by a plug-in.

Returns:

dictionary with documentation type as key and list of files as value

Return Type:

dict (key: str, value: list of str)

PluginManager.getVcsSystemIndicators

Public method to get the Vcs System indicators.

Plugins supporting this functionality must support the module function getVcsSystemIndicator returning a dictionary with indicator as key and a tuple with the vcs name (string) and vcs display string (string).

Returns:

dictionary with indicator as key and a list of tuples as values. Each tuple contains the vcs name (string) and vcs display string (string).

PluginManager.initOnDemandPlugin

Public method to create a plugin object for the named on demand plugin.

Note: The plug-in is not activated.

name

name of the plug-in (string)

Raises PluginActivationError:

raised to indicate an issue during the plug-in activation

PluginManager.initOnDemandPlugins

Public method to create plugin objects for all on demand plugins.

Note: The plugins are not activated.

PluginManager.initPluginToolbars

Public method to initialize plug-in toolbars.

toolbarManager

reference to the toolbar manager object (E5ToolBarManager)

PluginManager.isPluginActive

Public method to check, if a certain plugin is active.

pluginName

name of the plugin to check for (string)

Returns:

flag indicating, if the plugin is active (boolean)

PluginManager.isPluginLoaded

Public method to check, if a certain plugin is loaded.

pluginName

name of the plugin to check for (string)

Returns:

flag indicating, if the plugin is loaded (boolean)

PluginManager.isValidPluginName

Public methode to check, if a file name is a valid plugin name.

Plugin modules must start with "Plugin" and have the extension ".py".

pluginName

name of the file to be checked (string)

Returns:

flag indicating a valid plugin name (boolean)

PluginManager.loadDocumentationSetPlugins

Public method to load just the documentation sets plugins.

Raises PluginModulesError:

raised to indicate the absence of plug-in modules

PluginManager.loadPlugin

Public method to load a plugin module.

Initially all modules are inactive. Modules that are requested on demand are sorted out and are added to the on demand list. Some basic validity checks are performed as well. Modules failing these checks are added to the failed modules list.

name

name of the module to be loaded (string)

directory

name of the plugin directory (string)

reload_

flag indicating to reload the module (boolean)

Raises PluginLoadError:

raised to indicate an issue loading the plug-in

PluginManager.preferencesChanged

Public slot to react to changes in configuration.

PluginManager.removePluginFromSysModules

Public method to remove a plugin and all related modules from sys.modules.

pluginName

name of the plugin module (string)

package

name of the plugin package (string)

internalPackages

list of intenal packages (list of string)

Returns:

flag indicating the plugin module was found in sys.modules (boolean)

PluginManager.unloadPlugin

Public method to unload a plugin module.

name

name of the module to be unloaded (string)

Returns:

flag indicating success (boolean)