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

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

戻り値