Skip to main content

Download

Download objects are dispatched by page via the page.on("download") event.

All the downloaded files belonging to the browser context are deleted when the browser context is closed.

Download event is emitted once the download starts. Download path becomes available once download completes:

with page.expect_download() as download_info:
    page.get_by_text("Download file").click()
download = download_info.value
# wait for download to complete
path = download.path()

Methods​

cancel​

Added in: v1.13download.cancel

Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, download.failure() would resolve to 'canceled'.

Usage

download.cancel()

delete​

Added in: v1.8download.delete

Deletes the downloaded file. Will wait for the download to finish if necessary.

Usage

download.delete()

failure​

Added in: v1.8download.failure

Returns download error if any. Will wait for the download to finish if necessary.

Usage

download.failure()

Returns

page​

Added in: v1.12download.page

Get the page that the download belongs to.

Usage

download.page

Returns

path​

Added in: v1.8download.path

Returns path to the downloaded file in case of successful download. The method will wait for the download to finish if necessary. The method throws when connected remotely.

Note that the download's file name is a random GUID, use download.suggested_filename to get suggested file name.

Usage

download.path()

Returns

save_as​

Added in: v1.8download.save_as

Copy the download to a user-specified path. It is safe to call this method while the download is still in progress. Will wait for the download to finish if necessary.

Usage

download.save_as(path)

Arguments

suggested_filename​

Added in: v1.8download.suggested_filename

Returns suggested filename for this download. It is typically computed by the browser from the Content-Disposition response header or the download attribute. See the spec on whatwg. Different browsers can use different logic for computing it.

Usage

download.suggested_filename

Returns

url​

Added in: v1.8download.url

Returns downloaded url.

Usage

download.url

Returns