bootils.plugins package

Package and namespace for plugin implementations.

Built-in plugins live in bootils.plugins.core, and custome plugins are loaded from the file system into the bootils.plugins.custom namespace.

Subpackages

• bootils.plugins.core package
  • Submodules
  • bootils.plugins.core.demon module
  • bootils.plugins.core.filesystem module
  • bootils.plugins.core.host module
  • bootils.plugins.core.jsw module
• bootils.plugins.custom package

Submodules

bootils.plugins.loader module

Plugin management.

class bootils.plugins.loader.PluginBase(context)

Bases: object

Base class for plugins.

This class defines the plugin interface (callbacks), and provides sensible default implementations so that a plugin only has to define those callbacks it needs to override.

cfg_list(key, section=None)

Get a config value as a list.

configure(config)

Store plugin-specific configuration.

control(command, *args, **options)

Control a service / process.

This delegates to a control_‹command› method of a subclass, if one is found.

Returns:True if the command was handled successfully. Return type:bool

name

Name of the plugin (e.g. for reporting).

post_check()

Perform post-launch checks and generate results.

pre_check()

Perform pre-launch checks and generate results.

result(ok, name, comment, diagnostics=None)

Create checks.CheckResult with a qualified name.

class bootils.plugins.loader.PluginContext

Bases: object

State held by plugins.

class bootils.plugins.loader.PluginExecutor(loader)

Bases: object

Call plugin hooks in different life-cycle phases.

configure()

Assemble configuration for each plugin and pass it on.

control(command, *args, **options)

Delegates execution of the given command to all plugins, until one of them indicates it handled the task.

post_checks()

Perform post-launch checks.

pre_checks()

Perform pre-launch checks.

class bootils.plugins.loader.PluginLoader(cfg, appname)

Bases: object

Load and manage plugins, both core and custom ones.

See also Package Discovery and Resource Access using pkg_resources.

DEFAULT_PLUGIN_PATH = [u'/etc/{appname}/plugin.d', u'{appdir}/plugin.d']

discover()

Inspect the given search path and import any plugins found.

Returns the list of plugin classes.

classmethod load_into_context(ctx, project=None)

Discovers plugins and places a PluginLoader instance in ctx.obj.plugins.