BaseCheck#

class BaseCheck[source]#

Base class for check.

__init__(**kwargs)[source]#
__new__(*args, **kwargs)#

Methods

BaseCheck.add_condition(name, ...)

Add new condition function to the check.

BaseCheck.clean_conditions()

Remove all conditions from this check instance.

BaseCheck.conditions_decision(result)

Run conditions on given result.

BaseCheck.config([include_version, ...])

Return check configuration (conditions' configuration not yet supported).

BaseCheck.from_config(conf[, version_unmatch])

Return check object from a CheckConfig object.

BaseCheck.from_json(conf[, version_unmatch])

Deserialize check instance from JSON string.

BaseCheck.metadata([with_doc_link])

Return check metadata.

BaseCheck.name()

Name of class in split camel case.

BaseCheck.params([show_defaults])

Return parameters to show when printing the check.

BaseCheck.remove_condition(index)

Remove given condition by index.

BaseCheck.run(*args, **kwargs)

Run Check.

BaseCheck.to_json([indent, include_version, ...])

Serialize check instance to JSON string.