ape.plugins.dummyplugin.Dummy

class ape.plugins.dummyplugin.Dummy(*args, **kwargs)

A plugin to test the infrastructure (a no-op)

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
fetch_config() prints a sample configuration
help([width]) Prints a help-string for the plugin
log_error(error[, message]) Logs the error in bold red

Attributes

help_page A HelpPage to use if self.sections has been defined
logger
return:A logging object.
product builds and returns a DummyClass
sections An ordered dict for the help page
fetch_config()

prints a sample configuration

help(width=80)

Prints a help-string for the plugin

Param:
  • width: number of characters wide to print help
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)
help_page

A HelpPage to use if self.sections has been defined

logger
Returns:A logging object.
product

builds and returns a DummyClass

Precondition:self.configuration map has been set
sections

An ordered dict for the help page

Navigation