CheckResult

class CheckResult(data: Any = '', status: str = 'SKIPPED', error_messages: list[str] = <factory>, informational_messages: list[str] = <factory>, warning_messages: list[str] = <factory>)

Bases: object

A dataclass representing results from a single validation check on a single board.

This object is normally attached to a ValidationResult object, to live alongside other result sets from other checks, representing a single board. This object contains a status, which will be either ERROR, OK, WARNING, or SKIPPED; data, a field designed to allow any sort of data to be passed back; and three lists of strings to hold error, informational, and warning messages, respectively.

Methods

Attributes

data

status

error_messages

informational_messages

warning_messages