Get#

Description#

Download a file or folder from the given URL to the specified local path.

If the URL points to a file, downloads that single file. If the URL points to a folder, downloads the folder and its contents recursively.

For CLI options, run wrapp get --help.

Python API Reference#

async wrapp.get(
url: str,
filename: str | None,
overwrite: bool = False,
context: CommandParameters = CommandParameters(debug=False, verbose=False, dry_run=False, log_file=None, hash_cache_file=None),
*,
scheduler: SchedulerContext | None = None,
) → None#

Download a file or folder from the given URL to the specified local path.

If the URL points to a folder, downloads the folder and its contents recursively.

Parameters:

  • url – URL to download (file or folder)

  • filename – Optional alternate local path to download to. If not given, uses the same name as in the source URL

  • overwrite – Specify to allow overwriting the target if it already exists

  • context – Global configuration parameters

  • scheduler – Optionally pre-constructed SchedulerContext. When calling many functions in a row make sure to pre-construct the scheduler.

Raises:

  • FailedCommand – When prerequisites not matched

  • StorageOperationError – Raised when network or file operations fail