ape.plugins.dummyplugin.CrashTestDummyConfiguration

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

Translates the configobj configuration to a CrashTestDummy

CrashTestDummyConfiguration

Param:
  • section_name: name in the configuration with settings
  • configuration: dict of configuration values
__init__(*args, **kwargs)

CrashTestDummyConfiguration

Param:
  • section_name: name in the configuration with settings
  • configuration: dict of configuration values

Methods

__init__(*args, **kwargs) CrashTestDummyConfiguration

Attributes

configspec A configspec built from configspec_source for validation
configuration validates and sets the configuration using the source configuration
check_extra_values(warn_user=True)

checks the configuration for values not in the configspec

Returns:True if extra values, false otherwise
check_rep()

Calls process_errors

Raise:ConfigurationError if errors are found (or there are unknown options and not allow_extras)
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)
process_errors()

processes configuration, validation_outcome and logs the errors

Returns:True if there were errors (same as not self.validation_outcome)
update(section)

Uses ‘updates_section’ to build configuration from other section

Param:
  • section: plugin-section to update
Returns:

section merged with this section or original if appropriate

configspec

A configspec built from configspec_source for validation

configspec_source

the configuration specification source

configuration

validates and sets the configuration using the source configuration

Precondition:self.configspec has full configspec including section name
Returns:validated configuration for this section
constants

object with string constants (see SubConfigurationConstants)

logger
Returns:A logging object.
plugin_name

Gets the plugin name from the section

Returns:plugin-name if found or ‘<non-plugin>’
product

A crash test dummy

validation_outcome

Outcome of validating the configuration

validator

validator for the configuration

Navigation