validate_board_file¶

Summary¶

validate_board_file(frbs: list[BoardFile], skip_board_configuration_tests=False, skip_max_paths_test=False) → ValidationResultBundle¶

The entry-point for validating Fortune Avenue-compatible .frb files.

Parameters:

frbs (list[BoardFile]) – A list of BoardFile objects representing your .frb(s).
skip_board_configuration_tests (bool, optional) – If set to True, the Board Configuration checks will be skipped. Defaults to False.
skip_max_paths_test (bool, optional) – If set to True, the Max Paths Check will be skipped. Defaults to False.

Returns:

A bundle containing the overall results, as well as a list containing objects that represent each of the individual results.

Return type:

ValidationResultBundle

from cs_board_tools.validation.main import validate_board_file