メインコンテンツへスキップ

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

戻り値