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.
- Sync
- Async
# Start waiting for the download
with page.expect_download() as download_info:
# Perform the action that initiates download
page.get_by_text("Download file").click()
download = download_info.value
# Wait for the download process to complete and save the downloaded file somewhere
download.save_as("/path/to/save/at/" + download.suggested_filename)
# Start waiting for the download
async with page.expect_download() as download_info:
# Perform the action that initiates download
await page.get_by_text("Download file").click()
download = await download_info.value
# Wait for the download process to complete and save the downloaded file somewhere
await download.save_as("/path/to/save/at/" + download.suggested_filename)
方法 (Methods)
cancel
Added in: v1.13Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, download.failure()
would resolve to 'canceled'
.
使用方式
download.cancel()
傳回值
delete
Added before v1.9Deletes the downloaded file. Will wait for the download to finish if necessary.
使用方式
download.delete()
傳回值
failure
Added before v1.9Returns download error if any. Will wait for the download to finish if necessary.
使用方式
download.failure()
傳回值
path
Added before v1.9Returns path to the downloaded file for a successful download, or throws for a failed/canceled 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.
使用方式
download.path()
傳回值
save_as
Added before v1.9Copy 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.
使用方式
- Sync
- Async
download.save_as("/path/to/save/at/" + download.suggested_filename)
await download.save_as("/path/to/save/at/" + download.suggested_filename)
參數
-
path
Union[str, pathlib.Path]#Path where the download should be copied.
傳回值
屬性 (Properties)
page
Added in: v1.12Get the page that the download belongs to.
使用方式
download.page
傳回值
suggested_filename
Added before v1.9Returns 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.
使用方式
download.suggested_filename
傳回值
url
Added before v1.9Returns downloaded url.
使用方式
download.url
傳回值