cement.core.plugin

Cement core plugins module.

class cement.core.plugin.PluginHandler(**kw)

Bases: PluginInterface, Handler

Plugin handler implementation.

class cement.core.plugin.PluginInterface(**kw)

Bases: Interface

This class defines the Plugin Interface. Handlers that implement this interface must provide the methods and attributes defined below. In general, most implementations should sub-class from the provided PluginHandler base class as a starting point.

class Meta

Bases: object

interface = 'plugin'

String identifier of the interface.

abstract get_disabled_plugins()

Returns a list of plugins that are disabled in the config.

abstract get_enabled_plugins()

Returns a list of plugins that are enabled in the config.

abstract get_loaded_plugins()

Returns a list of plugins that have been loaded.

abstract load_plugin()

Load a plugin whose name is plugin_name.

Parameters:

plugin_name (str) – The name of the plugin to load.

abstract load_plugins(plugins)

Load all plugins from plugins.

Parameters:

plugins (list) – A list of plugin names to load.