BaseCheck#

class compliance_checker.base.BaseCheck(options=None)[source]#

Methods

`get_test_ctx`(severity, name[, variable])	Creates an existing TestCtx object in _defined_results dict if it does not exist for the current checker instance, or an returns the existing TestCtx for modification.
`setup`(ds)	Common setup method for a Checker.

Attributes Summary

`HIGH`
`LOW`
`MEDIUM`
`supported_ds`

Methods Summary

`__init__`([options])
`get_test_ctx`(severity, name[, variable])	Creates an existing TestCtx object in _defined_results dict if it does not exist for the current checker instance, or an returns the existing TestCtx for modification.
`setup`(ds)	Common setup method for a Checker.

Attributes Documentation

HIGH = 3#

LOW = 1#

MEDIUM = 2#

supported_ds = []#

Methods Documentation

__init__(options=None)[source]#

get_test_ctx(severity, name, variable=None)[source]#

Creates an existing TestCtx object in _defined_results dict if it does not exist for the current checker instance, or an returns the existing TestCtx for modification. Takes a severity level and name and uses the two element tuple formed by the arguments as a key into the dict.

Parameters:

severity (int) – A BaseCheck severity level
name (str) – The name of the check

Rtype compliance_checker.base.TestCtx:

Returns:

A new or or existing TestCtx instance taken from this instance’s _defined_results dict

setup(ds)[source]#

Common setup method for a Checker.

Automatically run when running a CheckSuite. Define this method in your Checker class.