ape.plugins.apeplugin.OperationConfiguration

class ape.plugins.apeplugin.OperationConfiguration(plugins_section, plugin_subsections, operation_name, quartermaster, countdown_timer=None)

a builder of plugins for operations

OperationConfiguration builder

Param:
  • plugins_section: dict with configuration (PLUGINS section)
  • operation_name: option in the identifier for the operation
  • plugin_subsections: list of sub-section-names for the plugins
  • quartermaster: QuarterMaster to retrieve plugins
  • countdown_timer: CountdownTimer for the operation composite
__init__(plugins_section, plugin_subsections, operation_name, quartermaster, countdown_timer=None)

OperationConfiguration builder

Param:
  • plugins_section: dict with configuration (PLUGINS section)
  • operation_name: option in the identifier for the operation
  • plugin_subsections: list of sub-section-names for the plugins
  • quartermaster: QuarterMaster to retrieve plugins
  • countdown_timer: CountdownTimer for the operation composite

Methods

__init__(plugins_section, ...[, countdown_timer]) OperationConfiguration builder

Attributes

operation A composite of plugins
plugin_sections_names creates a dict of plugin section-name:plugin-name pairs
log_error(error, message='')

Logs the error in bold red

Param:
  • error: error type (prefix in red and bold)
  • message: descriptive message (red but not bold)
logger
Returns:A logging object.
operation

A composite of plugins

plugin_sections_names

creates a dict of plugin section-name:plugin-name pairs

Navigation