plugins API reference

Plugins mechanism to load user defined method

class biomajmanager.plugins.BMPlugin

Base plugin class for BioMAJ manager

get_config()

Get the BioMAJ manager config as object

Returns:configparser instance Return type::class:’configparser`

get_manager()

Get the BioMAJ manager instance

Returns:Manager Return type:biomaj.manager.Manager

get_name()

Get the name of the plugin. Based on the class name

set_config(config)

Set BioMAJ manager config object

set_manager(manager)

Set BioMAJ manager config object

class biomajmanager.plugins.Plugins(manager=None, name=None)

Plugin class for BioMAJ Manager

__init__(manager=None, name=None)

Create the plugin object

Parameters:

• manager (biomajmanager.manager.Manager) – Manager instance
• name (String) – Name of the plugin to load. [DEFAULT: load all plugins]

Raises:

• SystemExit – If ‘manager’ arg is not given
• SystemExit – If ‘PLUGINS’ section not found in manager.properties
• SystemExit – If ‘plugins.dir’ not set in manager.properties
• SystemExit – If ‘plugins.list’ not set in manager.properties
• SystemExit – If ‘plugins.dir’ does not exist

__weakref__

list of weak references to the object (if defined)