check_for_screenshots

Summary

check_for_screenshots(bundle: Bundle, skip: bool, skip_warnings: bool = False) → CheckResult

Checks to see if all present .frb files have associated .webp screenshot files.

Parameters:

• bundle (Bundle) – A Bundle object representing a board.

• skip (bool) – If set to True, the check will be skipped, but a valid resultobject with no messages and SKIPPED as its status will still be returned.

• skip_warnings (bool, optional) – If set, skips tests resulting in “Warning” messages.

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.filesystem import check_for_screenshots