API: aj.plugins

class aj.plugins.PluginProvider

A base class for plugin locator

provide()

Should return a list of found plugin paths

Returns:list(str)

class aj.plugins.DirectoryPluginProvider(path)

A plugin provider that looks up plugins in a given directory.

Parameters:path – directory to look for plugins in

provide()

Should return a list of found plugin paths

Returns:list(str)

class aj.plugins.PythonPathPluginProvider

A plugin provider that looks up plugins on $PYTHONPATH

provide()

Should return a list of found plugin paths

Returns:list(str)

exception aj.plugins.PluginLoadError

exception aj.plugins.PluginCrashed(exception)

describe()

class aj.plugins.Dependency

exception Unsatisfied

describe()

reason()

build_exception()

check()

value

yaml_loader

alias of yaml.loader.SafeLoader

yaml_tag = '!Dependency'

class aj.plugins.ModuleDependency(module_name=None)

exception Unsatisfied

reason()

description = 'Python module'

is_satisfied()

yaml_tag = '!ModuleDependency'

class aj.plugins.PluginDependency(plugin_name=None)

exception Unsatisfied

reason()

description = 'Plugin'

is_satisfied()

yaml_tag = '!PluginDependency'

class aj.plugins.OptionalPluginDependency(plugin_name=None)

exception Unsatisfied

reason()

description = 'Plugin'

is_satisfied()

yaml_tag = '!OptionalPluginDependency'

class aj.plugins.BinaryDependency(binary_name=None)

exception Unsatisfied

reason()

description = 'Application binary'

is_satisfied()

yaml_tag = '!BinaryDependency'

class aj.plugins.FileDependency(file_name=None)

exception Unsatisfied

reason()

description = 'File'

is_satisfied()

yaml_tag = '!FileDependency'

class aj.plugins.PluginManager(context)

Handles plugin loading and unloading

classmethod get(context)

get_content_path(name, path)

get_crash(name)

get_loaded_plugins_list()

load_all_from(providers)

Loads all plugins provided by given providers.

Parameters:providers (list(PluginProvider)) –

---

Comments

comments powered by Disqus