Module PluginManager :: Class Plugin
[hide private]
[frames] | no frames]

Class Plugin

source code

object --+
         |
        Plugin

Class encapsulating the Storage Connect plugin

Instance Methods [hide private]
 
__init__(self, plugin_name, plugin_module)
Construstor for the Plugin encapsulation class.
source code
str
getName(self)
Get the plugin's fully qualified name.
source code
str
getPath(self)
Get the plugin's path.
source code
str
getModuleName(self)
Get the plugin's module name.
source code
list
getClass(self, auto_import=True)
Get the plugin's list of classes.
source code
 
importPlugin(self)
Import the IPlugin class.
source code
bool
isImported(self)
Check if the Plugin is already imported.
source code
dict
getInfo(self)
Get the information for the plugin.
source code
Plugin proxy instance
getProxy(self)
Get a proxy instance for the plugin class.
source code
str
__repr__(self)
Allow displaying of the plugin names.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, plugin_name, plugin_module)
(Constructor)

source code 

Construstor for the Plugin encapsulation class.

Parameters:
  • plugin_name (str) - Name of the plugin.
  • plugin_module (object) - Plugin module.
Overrides: object.__init__

getName(self)

source code 

Get the plugin's fully qualified name.

Returns: str
Fully Qualified name of the plugin.

getPath(self)

source code 

Get the plugin's path.

Returns: str
Path to the plugin.

getModuleName(self)

source code 

Get the plugin's module name.

Returns: str
Module name of the plugin.

getClass(self, auto_import=True)

source code 

Get the plugin's list of classes.

Returns: list
Class objects for the plugin (if it is already imported).

isImported(self)

source code 

Check if the Plugin is already imported.

Returns: bool
True if the Plugin is already imported.

getInfo(self)

source code 

Get the information for the plugin.

Returns: dict
information on and about the Storage Connect plug-in.

getProxy(self)

source code 

Get a proxy instance for the plugin class.

Returns: Plugin proxy instance
Plugin proxy instance.

__repr__(self)
(Representation operator)

source code 

Allow displaying of the plugin names.

Returns: str
Plugin name.
Overrides: object.__repr__