funcdownload

download(

resources: Resource | Iterable[Resource],

*,

session: Session | None = None,

max_workers: int = 8,

progress: Callable[[Progress], None] | None = None,

cancel: CancelToken | None = None,

task: str = 'download',

) → None

Download resources in parallel, skipping files that are already valid.

Interrupted files resume from their .part file. All files are attempted even if some fail. Resources with the same path are downloaded once.

Parameters:

• resources (Resource | Iterable[Resource]) – One resource, or several.

• session (Session | None) – The session to use. A temporary one is created if omitted.

• max_workers (int) – How many files to download at once.

• progress (Callable[[Progress], None] | None) – Called with byte counts if every size is known, otherwise with file counts. It may be called from worker threads, one at a time.

• cancel (CancelToken | None) – Stops the downloads and keeps partial files for later.

• task (str) – The task name reported to progress.

Raises:

• DownloadError – A file failed. DownloadError.failures lists every failure.

• Cancelled – cancel was triggered.