download_file#
- Client.download_file(remote_filename, local_filename, chunk_size=65536, compute_sha1_checksum=True)#
Download a file from the server.
- Parameters:
remote_filename (
str) – Name of the remote file to download.local_filename (
str) – Name of the local file to create.chunk_size (
int, default:65536) – Maximum size in bytes of a chunk of data to transfer per request.compute_sha1_checksum (
bool, default:True) – Whether to compute the SHA1-checksum of the file to be downloaded on the server-side.
- Raises:
RuntimeError : – If a response indicates an error on the server-side.
ValueError : – If the checksums between the downloaded file and remote file do not match.
- Return type: