Class e.p.b.m.p.PluginModel(Model):

Part of elisa.plugins.base.models.plugin View In Hierarchy

A model that represents a plugin and its metadata as understood by Elisa.
Instance Variablesnamethe name of the plugin (type: unicode )
versionthe version number of the plugin (type: distutils.version.LooseVersion )
author_namethe name of the author of the plugin (type: unicode )
author_emailthe e-mail address of the author of the plugin (type: unicode )
platformsa list of compatible platforms (typical values are: linux, win32, macosx) (type: list of unicode )
licensethe license of the plugin (type: unicode )
websitethe home page of the plugin (type: unicode )
categorya unique category the plugin belongs to (type: unicode )
tagsa list of tags that define the plugin (type: list of unicode )
egg_namethe egg name (type: unicode )
urithe URI where the egg can be downloaded from (type: unicode )
summarya short text describing the plugin (type: unicode )
descriptiona detailed description of what the plugin does (type: unicode )
iconsa list of icons for the plugin (type: list of elisa.plugins.base.models.image.ImageModel )
screenshotsa list of screenshot images for the plugin (type: list of elisa.plugins.base.models.image.ImageModel )
enabledwhether the plugin is currently enabled (this attribute is not part of the plugin metadata) (type: bool )
Notethis model may be enriched along the way with new metadata
Line # Kind Name Docs
85 Method __init__ Undocumented
105 Class Method from_dict Class method that instantiates and returns a plugin model from a
147 Class Method from_distribution Class method that instantiates and returns a plugin model from a
168 Method printable_name Return a human-friendly name for the plugin.
181 Method cache_image Return the path to the image cached on disk corresponding to the given

Inherited from Bindable (via Model):

Line # Kind Name Docs
34 Method bind Bind a local attribute to destination_attribute of
73 Method unbind Remove the binding of attribute to destination_attribute of
104 Method unbind_object Remove all the bindings you have for a certain destination_object.
118 Method __setattr__ Undocumented
136 Method __delattr__ Undocumented
def __init__(self):
Undocumented
@classmethod
def from_dict(cls, dictionary):
Class method that instantiates and returns a plugin model from a dictionary as provided by the plugin repository.
Parametersdictionarya dictionary as provided by the plugin repository (type: dict )
Returnsa plugin model populated accordingly (type: PluginModel )
@classmethod
def from_distribution(cls, distribution):
Class method that instantiates and returns a plugin model from a distribution as provided by pkg_resources.
Parametersdistributiona distribution as provided by pkg_resources (type: pkg_resources.Distribution )
Returnsa plugin model populated accordingly (type: PluginModel )
def printable_name(self):
Return a human-friendly name for the plugin.
Returns (type: unicode )
def cache_image(self, uri):
Return the path to the image cached on disk corresponding to the given URI.

If the image is not cached yet, download it and cache it.

Parametersurithe URI to the image (type: elisa.core.media_uri.MediaUri )
Returnsthe path to the cache file and a deferred triggered when the image is cached (type: (str, elisa.core.utils.defer.Deferred) )
API Documentation for Elisa Media Center, generated by pydoctor at 2008-12-01 12:03:30.