API docs for “elisa.plugins.base.models.plugin.PluginModel”

A model that represents a plugin and its metadata.

Instance Variables	icons	a list of icons for the plugin (type: `list` of `elisa.plugins.base.models.image.ImageModel` )
	screenshots	a list of screenshot images for the plugin (type: `list` of `elisa.plugins.base.models.image.ImageModel` )
Note	this model may be enriched along the way with new metadata

Line #	Kind	Name	Docs
56	Method	__init__	Undocumented
62	Class Method	from_dict	Class method that instantiates and returns a plugin model from a
110	Class Method	from_distribution	Class method that instantiates and returns a plugin model from a
127	Method	cache_image	Return the path to the image cached on disk corresponding to the given
89	Method	_extract_resources	Undocumented

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

Inherited from Plugin:

Line #	Kind	Name	Docs
80	Method	runs_on_current_platform	Test whether the plugin is compatible with the current platform.

@classmethod
def from_dict(cls, dictionary):

Class method that instantiates and returns a plugin model from a dictionary as provided by the plugin repository.

Parameters	dictionary	a dictionary as provided by the plugin repository (type: `dict` )
Returns	a 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.

Parameters	distribution	a distribution as provided by `pkg_resources` (type: `pkg_resources.Distribution` )
Returns	a plugin model populated accordingly (type: `PluginModel` )

def cache_image(self, uri):

Return the path to the image cached on disk corresponding to the given URI.

If the uri points to a local file, just return its path without caching it. Otherwise, if the image is not cached yet, download it and cache it.

Parameters	uri	the URI to the image (type: `elisa.core.media_uri.MediaUri` )
Returns	the path to the cache file and a deferred triggered when the image is cached (type: (`str`, `elisa.core.utils.defer.Deferred`) )

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