Package yapsy :: Module AutoInstallPluginManager :: Class AutoInstallPluginManager
[hide private]

Class AutoInstallPluginManager

source code

                          object --+    
                                   |    
PluginManager.PluginManagerDecorator --+
                                       |
                                      AutoInstallPluginManager

A plugin manager that also manages the installation of the plugin files into the appropriate directory.

Instance Methods [hide private]
 
__init__(self, plugin_install_dir=None, decorated_manager=None, categories_filter={'Default': <class 'yapsy.IPlugin.IPlugin'>}, directories_list=None, plugin_info_ext='yapsy-plugin')
Create the plugin manager and set up the directory where to install new plugins.
source code
 
setInstallDir(self, plugin_install_dir)
Set the directory where to install new plugins.
source code
 
getInstallDir(self)
Return the directory where new plugins should be installed.
source code
 
install(self, directory, plugin_info_filename)
Giving the plugin's info file (e.g.
source code

Inherited from PluginManager.PluginManagerDecorator: __getattr__, collectPlugins

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, plugin_install_dir=None, decorated_manager=None, categories_filter={'Default': <class 'yapsy.IPlugin.IPlugin'>}, directories_list=None, plugin_info_ext='yapsy-plugin')
(Constructor)

source code 

Create the plugin manager and set up the directory where to install new plugins.

Arguments

plugin_install_dir
The directory where new plugins to be installed will be copied.

Warning

If plugin_install_dir does not correspond to an element of the directories_list, it is appended to the later.

Overrides: PluginManager.PluginManagerDecorator.__init__

install(self, directory, plugin_info_filename)

source code 

Giving the plugin's info file (e.g. myplugin.yapsy-plugin), and the directory where it is located, get all the files that define the plugin and copy them into the correct directory.

Return True if the installation is a success, False if it is a failure.