Class e.c.e.e.EggPlugin(Loggable):

Part of elisa.core.epm.egg_plugin View In Hierarchy

An Elisa plugin.

Can represent:

  1. a plugin coming from a remote repository
  2. a local .elisa (egg) file.
  3. an already installed plugin

For now the property list is freely settable.

Line # Kind Name Docs
77 Method __init__ Fill the plugin data.
132 Method get_plugin_deps Get the list of deps with version information.
145 Method pre_install Run the pre-installation script.
153 Method post_install Run the post-installation script.
161 Method pre_remove Run the pre-disinstallation script.
169 Method post_remove Run the post-disinstallation script.
177 Method is_installed_systemwide Tell whether the plugin is installed system wide.
242 Method custom_install Undocumented
299 Method uninstall Undocumented
302 Method download Retrieve the plugin data.
363 Method __repr__ Undocumented
191 Method _install_py_deps Undocumented
201 Method _blocking_custom_install Put the plugin in the right directory and run the needed scripts.
245 Method _blocking_uninstall Remove the plugin and run the needed scripts.
def __init__(self, repository=None, local_file=None, plugin_class=None, **kwargs):
Fill the plugin data.
Parametersrepositorythe repository where the plugin is coming from, if it doesn't represent a single .elisa file (type: epm.egg_repository.EggRepository )
local_filea single, local .elisa file's path (type: string )
plugin_classthe class of an installed plugin (type: elisa.core.plugin.Plugin )
kwargsproperties of the plugin (type: dictionary )
def get_plugin_deps(self):
Get the list of deps with version information.
def pre_install(self):
Run the pre-installation script.
RaisesInstallationErrorwhen the script doesn't return 0
def post_install(self):
Run the post-installation script.
RaisesInstallationErrorwhen the script doesn't return 0
def pre_remove(self):
Run the pre-disinstallation script.
RaisesInstallationErrorwhen the script doesn't return 0
def post_remove(self):
Run the post-disinstallation script.
RaisesInstallationErrorwhen the script doesn't return 0
def is_installed_systemwide(self):
Tell whether the plugin is installed system wide.
Returnsthe answer (type: bool )
def _install_py_deps(self):
Undocumented
def _blocking_custom_install(self, force=False):
Put the plugin in the right directory and run the needed scripts.
RaisesInstallationErrorwhen something goes wrong.
def custom_install(self, force=False):
Undocumented
def _blocking_uninstall(self, force=False):
Remove the plugin and run the needed scripts.
Parametersforceuninstall even if there are plugins dipending on this one (type: bool )
RaisesUninstallationErrorwhen cannot uninstall the plugin

Block the installation if there are plugins depending on this (unless 'force' is True) or if the plugin is installed system-wide.

def uninstall(self, force=False):
Undocumented
def download(self, directory=None):
Retrieve the plugin data.

If the plugin is not a local .elisa file, ask the repository for the data: if download is ok, set the instance variable "download_path" to the absolute path of the downloaded file, to None otherwise.

Parametersdirectorythe absolute path of the directory where to store the downloaded file. Needs to exist and to be writeable (type: string )
Returnsa deferred triggered when the download has finished (type: twisted.internet.defer.Defer )
def __repr__(self):
Undocumented
API Documentation for Elisa Media Center, generated by pydoctor at 2009-02-16 19:15:05.