API: aj.plugins

class aj.plugins.BinaryDependency(binary_name=None)[source]
exception Unsatisfied[source]
reason()[source]
description = 'Application binary'
is_satisfied()[source]
yaml_tag = '!BinaryDependency'
class aj.plugins.Dependency[source]
exception Unsatisfied[source]
describe()[source]
reason()[source]
build_exception()[source]
check()[source]
property value
yaml_loader

alias of SafeLoader

yaml_tag = '!Dependency'
class aj.plugins.DirectoryPluginProvider(path)[source]

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

Parameters:

path – directory to look for plugins in

provide()[source]

Should return a list of found plugin paths

Returns:

list(str)

class aj.plugins.FileDependency(file_name=None)[source]
exception Unsatisfied[source]
reason()[source]
description = 'File'
is_satisfied()[source]
yaml_tag = '!FileDependency'
class aj.plugins.ModuleDependency(module_name=None)[source]
exception Unsatisfied[source]
reason()[source]
description = 'Python module'
is_satisfied()[source]
yaml_tag = '!ModuleDependency'
class aj.plugins.OptionalPluginDependency(plugin_name=None)[source]
exception Unsatisfied[source]
reason()[source]
description = 'Plugin'
is_satisfied()[source]
yaml_tag = '!OptionalPluginDependency'
exception aj.plugins.PluginCrashed(exception)[source]
describe()[source]
class aj.plugins.PluginDependency(plugin_name=None)[source]
exception Unsatisfied[source]
reason()[source]
description = 'Plugin'
is_satisfied()[source]
yaml_tag = '!PluginDependency'
exception aj.plugins.PluginLoadError[source]
class aj.plugins.PluginManager(context)[source]

Handles plugin loading and unloading

classmethod get(context)
get_content_path(name, path)[source]
get_crash(name)[source]
get_loaded_plugins_list()[source]
load_all_from(providers)[source]

Loads all plugins provided by given providers.

Parameters:

providers (list(PluginProvider))

class aj.plugins.PluginProvider[source]

A base class for plugin locator

provide()[source]

Should return a list of found plugin paths

Returns:

list(str)

class aj.plugins.PythonPathPluginProvider[source]

A plugin provider that looks up plugins on $PYTHONPATH

provide()[source]

Should return a list of found plugin paths

Returns:

list(str)


Comments

comments powered by Disqus