Part of elisa.core.epm.egg_plugin View In Hierarchy
An Elisa plugin.
Can represent:| 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. |
| Parameters | repository | the repository where the plugin is coming from, if it doesn't represent
a single .elisa file
(type: epm.egg_repository.EggRepository
) |
| local_file | a single, local .elisa file's path (type: string ) | |
| plugin_class | the class of an installed plugin
(type: elisa.core.plugin.Plugin
) | |
| kwargs | properties of the plugin (type: dictionary ) |
| Raises | InstallationError | when the script doesn't return 0 |
| Raises | InstallationError | when the script doesn't return 0 |
| Raises | InstallationError | when the script doesn't return 0 |
| Raises | InstallationError | when the script doesn't return 0 |
| Returns | the answer (type: bool ) | |
| Raises | InstallationError | when something goes wrong. |
| Parameters | force | uninstall even if there are plugins dipending on this one (type: bool ) |
| Raises | UninstallationError | when 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. |
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.| Parameters | directory | the absolute path of the directory where to store the downloaded file. Needs to exist and to be writeable (type: string ) |
| Returns | a deferred triggered when the download has finished
(type: twisted.internet.defer.Defer
) | |