Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

FileDownloader

Class to downloader external files. for now it only supports http(s) protocol. If a message dispatcher is provided, it will automatically log the download progress and the time it took to download the file.

Attributes
destination_folder: strmessage_dispatcher: MessageDispatcher
Functions
__INIT__

Initialize self. See help(type(self)) for accurate signature.

destination_folder : str
message_dispatcher : MessageDispatcher
DECOMPRESS_FILE

Unzip a file to a given path

file_path : str
The path to the file to unzip
destination_folder : str
Return type : str
DOWNLOAD_FILE

Download a file from a given url to a given file path

url : str
The url to download the file from
filename : str
headers : Dict
The headers to send with the request
timeout : float
The timeout for the request
destination_folder : str
The destination folder to save the file to, if None, the default destination folder is used
Return type : str
DOWNLOAD_FILE_IF_MISSING

Download a file from a given url if the file does not already exist. This class is useful for downloading a file that is required for a task. If used within a task, it automatically logs the download progress and the time it took to download the file.

url : str
url to download the file from
filename : str
name of the file once downloaded. This filename must be unique for the brick. If a file downloader tries to download a file with the same name, it considers that the file has already been downloaded and will not download it. If you want to force the download of a file (new version for example), change the filename (adding v2 for example).
headers : Dict
http header to attach to the download request
timeout : float
timeout of the download request
decompress_file : bool - False
if true the file is decompress (support .zip and .tar.gz) after the download and the zip file is deleted
Return type : str