build_results_object

Summary

build_results_object(errors: list[str] = [], messages: list[str] = [], warnings: list[str] = [], data: Any = None, success: bool = False, skip: bool = False) → CheckResult

This function builds a Results object and returns it fully populated with the details of the most recent check.

Parameters:

• errors (list[str]) – A list of error messages.

• messages (list[str]) – A list of informational messages.

• warnings (list[str]) – A list of warning messages.

• data (Any) – This parameter could hold any meaningful data. It will be returned embedded in the CheckResult object.

• success (bool) – If set to True, “OK” will be set as the check status.

• skip (bool) – If set to True, “SKIPPED” will be set as the check status.

Returns:

A CheckResult object containing the check status as well as any messages and additional data.

Return type:

CheckResult

Importing

from cs_board_tools.validation.results import build_results_object