check_music_download¶
Summary¶
- check_music_download(descriptor: MapDescriptor = None, gdrive_api_key: str = '', skip: bool = False, skip_warnings: bool = False)¶
This test downloads the file from each download mirror, and both compares their sizes and hashes them to ensure the archives are actually the same.
- Parameters:
descriptor (MapDescriptor) – A MapDescriptor object representing a board.
gdrive_api_key (str, optional) – A valid Google Drive API key, which will be used to download the music file stored on that service. If not supplied, the Music Download check will be skipped.
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:
Importing¶
from cs_board_tools.validation.music import check_music_download