跳到主要内容

Download

Download 对象通过 page.on("download") 事件由页面分发。

当浏览器上下文关闭时,属于该浏览器上下文的所有已下载文件都将被删除。

下载事件在下载开始时发出。下载路径在下载完成后可用。

# 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)

方法

cancel

添加于: v1.13 download.cancel

取消下载。如果下载已完成或已取消,则不会失败。成功取消后,download.failure() 将解析为 'canceled'

用法

download.cancel()

返回值


delete

添加于 v1.9 之前 download.delete

删除下载的文件。如有必要,将等待下载完成。

用法

download.delete()

返回值


failure

添加于 v1.9 之前 download.failure

返回下载错误(如果有)。如有必要,将等待下载完成。

用法

download.failure()

返回值


path

添加于 v1.9 之前 download.path

返回成功下载的文件的路径,或者在下载失败/取消时抛出异常。该方法如有必要将等待下载完成。当远程连接时,该方法会抛出异常。

请注意,下载的文件名是随机 GUID,使用 download.suggested_filename 获取建议的文件名。

用法

download.path()

返回值


save_as

添加于 v1.9 之前 download.save_as

将下载复制到用户指定的路径。在下载仍在进行中时调用此方法是安全的。如有必要,将等待下载完成。

用法

download.save_as("/path/to/save/at/" + download.suggested_filename)

参数

返回值


属性

page

添加于: v1.12 download.page

获取下载所属的页面。

用法

download.page

返回值


suggested_filename

添加于 v1.9 之前 download.suggested_filename

返回此下载的建议文件名。它通常由浏览器根据 Content-Disposition 响应头或 download 属性计算得出。请参阅 whatwg 上的规范。不同的浏览器可以使用不同的逻辑来计算它。

用法

download.suggested_filename

返回值


url

添加于 v1.9 之前 download.url

返回下载的 URL。

用法

download.url

返回值