Home | Trees | Indices | Help |
---|
|
Plugin Base Class
This class acts as a elisa.core.component.Component factory. All the Plugin's class variables can be stored in a plugin.conf file which has the following syntax:[general] name="base" version="0.1" plugin_dependencies=["foo"] external_dependencies=["pgm"] description="base elisa components" # that's a component! [media_providers.local_media:LocalMedia] description="To access file:// media" platforms=["linux", "posix"] external_dependencies=["gnomevfs",] component_dependencies = ["base:coherence_service"]Each option of the "general" section will be mapped to it's corresponding class variable in the Plugin.
|
|||
__metaclass__ |
|
|||
|
|||
Inherited from Inherited from |
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
string |
|
|
|||
|
|
|||
elisa.core.config.Config |
config =
Config generated by reading config_file |
||
string |
config_file =
Plugin's directory relative path to plugin.conf |
||
string |
directory =
absolute path to the directory storing the Plugin's source code file (or Egg) |
||
dict mapping elisa.core.component.Component names to elisa.core.component.Component instances |
components =
Component implementations provided by the Plugin |
||
string |
name =
plugin's name. |
||
list |
plugin_dependencies =
Elisa plugins dependencies specified using colon-syntax |
||
list |
external_dependencies =
external Python dependencies specified using dot-syntax |
||
string |
version =
Plugin's version as a dot-syntax string |
||
string |
description =
one line Plugin's description |
||
checked = True
|
|||
deps_error =
|
|||
Inherited from |
|
|||
Inherited from |
|
|
|
Check plugin's python dependencies This check is performed at most once. |
Check the supported platforms and external dependencies of the Component identified by its name. This check is performed at most once. |
Load the config_file if defined Fill config class variable if config_file points to a valid config filename. Also fill name, version, description, plugin_dependencies, external_dependencies and components. |
|
Retrieve a data file stored and managed by the plugin. If the plugin is stored in a flat directory we build an absolute filesystem path of the data file relative to the plugin's directory. If the plugin is an egg (most of the time zipped), we use pkg_resources which extract the file to a temporary directory and use that temporary file.
|
|
nameplugin's name. Should be unique
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0beta1 on Wed Jan 16 19:08:58 2008 | http://epydoc.sourceforge.net |