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

Page

Page は、Browser 内の単一のタブ、または Chromium の拡張機能のバックグラウンドページとやり取りするためのメソッドを提供します。1つのBrowser インスタンスには、複数のPage インスタンスが存在する場合があります。

この例では、ページを作成し、URLにナビゲートしてから、スクリーンショットを保存します。

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch()
    context = browser.new_context()
    page = context.new_page()
    page.goto("https://example.com")
    page.screenshot(path="screenshot.png")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

Pageクラスは、on、once、removeListenerなどのNodeのネイティブなEventEmitterメソッドを使用して処理できるさまざまなイベント（以下に説明）を発行します。

この例では、単一ページのloadイベントのメッセージをログに記録します。

page.once("load", lambda: print("page loaded!"))

イベントの登録を解除するには、removeListenerメソッドを使用します。

def log_request(intercepted_request):
    print("a request was made:", intercepted_request.url)
page.on("request", log_request)
# sometime later...
page.remove_listener("request", log_request)

メソッド​

add_init_script​

v1.9より前に追加 page.add_init_script

以下のいずれかのシナリオで評価されるスクリプトを追加します。

  • ページがナビゲートされるたびに。
  • 子フレームがアタッチまたはナビゲートされるたびに。この場合、スクリプトは新しくアタッチされたフレームのコンテキストで評価されます。

スクリプトは、ドキュメントが作成された後、そのスクリプトが実行される前に評価されます。これは、JavaScript 環境を修正する場合に役立ちます (例: Math.random をシードする場合)。

使用法

ページが読み込まれる前に Math.random をオーバーライドする例

// preload.js
Math.random = () => 42;
# in your playwright script, assuming the preload.js file is in same directory
page.add_init_script(path="./preload.js")
注

browser_context.add_init_script() と page.add_init_script() を介してインストールされた複数のスクリプトの評価順序は定義されていません。

引数

  • path Union[str, pathlib.Path] (オプション)#

    JavaScriptファイルへのパス。path が相対パスの場合、現在の作業ディレクトリを基準に解決されます。オプションです。

  • script str (オプション)#

    ブラウザコンテキストのすべてのページで評価されるスクリプト。オプション。

戻り値

add_locator_handler​

追加バージョン: v1.42 page.add_locator_handler

ウェブページをテストしていると、「サインアップ」ダイアログのような予期しないオーバーレイが表示され、ボタンのクリックなどの自動化したいアクションがブロックされることがあります。これらのオーバーレイは常に同じように、または同じ時間に表示されるわけではないため、自動テストで処理するのが難しいです。

このメソッドを使用すると、オーバーレイが表示されていることを検出したときにアクティブになる、ハンドラーと呼ばれる特別な関数を設定できます。ハンドラーの役割はオーバーレイを削除し、オーバーレイがないかのようにテストを続行できるようにすることです。

留意すべき点

  • オーバーレイが予測可能に表示される場合、page.add_locator_handler() を使用する代わりに、テストで明示的にオーバーレイを待機し、通常のテストフローの一部として閉じることを推奨します。
  • Playwright は、アクション可能性チェックを必要とするアクションを実行または再試行する前、または自動待機アサーションチェックを実行する前に、オーバーレイを毎回チェックします。オーバーレイが表示されている場合、Playwright は最初にハンドラを呼び出し、その後アクション/アサーションに進みます。ハンドラはアクション/アサーションを実行した場合にのみ呼び出されることに注意してください。オーバーレイが表示されてもアクションを実行しない場合、ハンドラはトリガーされません。
  • ハンドラを実行した後、Playwright はハンドラをトリガーしたオーバーレイがもう表示されていないことを確認します。no_wait_after を使用してこの動作をオプトアウトできます。
  • ハンドラーの実行時間は、ハンドラーを実行したアクション/アサーションのタイムアウトにカウントされます。ハンドラーの実行時間が長すぎると、タイムアウトが発生する可能性があります。
  • 複数のハンドラーを登録できます。ただし、一度に実行されるハンドラーは1つだけです。ハンドラー内のアクションが他のハンドラーに依存しないようにしてください。
警告

ハンドラーを実行すると、テスト中にページのステートが変更されます。たとえば、現在フォーカスされている要素が変更され、マウスが移動します。ハンドラーの後に実行されるアクションが自己完結型であり、フォーカスとマウスのステートが変更されていないことに依存しないことを確認してください。

たとえば、locator.focus() の後に keyboard.press() を呼び出すテストを考えてみましょう。もしこの2つのアクションの間にハンドラがボタンをクリックすると、フォーカスされた要素は間違っている可能性が高く、キー押下は予期せぬ要素で発生します。この問題を回避するには、代わりに locator.press() を使用してください。

もう1つの例は、mouse.move() の後に mouse.down() が続く一連のマウスアクションです。ここでも、これら2つのアクションの間にハンドラが実行されると、マウスダウン中にマウスの位置が間違っています。ハンドラによって状態が変更されないことに依存しない、locator.click() のような自己完結型のアクションを優先してください。

使用法

「ニュースレターに登録する」ダイアログが表示されたときに閉じる例

# Setup the handler.
def handler():
  page.get_by_role("button", name="No thanks").click()
page.add_locator_handler(page.get_by_text("Sign up to the newsletter"), handler)

# Write the test as usual.
page.goto("https://example.com")
page.get_by_role("button", name="Start here").click()

「セキュリティ詳細の確認」ページが表示されたときにスキップする例

# Setup the handler.
def handler():
  page.get_by_role("button", name="Remind me later").click()
page.add_locator_handler(page.get_by_text("Confirm your security details"), handler)

# Write the test as usual.
page.goto("https://example.com")
page.get_by_role("button", name="Start here").click()

すべてのアクション可能性チェックでカスタムコールバックを使用する例。常に表示される ロケーターを使用しているため、ハンドラはすべてのアクション可能性チェックの前に呼び出されます。ハンドラが 要素を非表示にしないため、no_wait_after を指定することが重要です。

# Setup the handler.
def handler():
  page.evaluate("window.removeObstructionsForTestIfNeeded()")
page.add_locator_handler(page.locator("body"), handler, no_wait_after=True)

# Write the test as usual.
page.goto("https://example.com")
page.get_by_role("button", name="Start here").click()

ハンドラは元のロケーターを引数として受け取ります。times を設定することで、呼び出し回数後にハンドラを自動的に削除することもできます。

def handler(locator):
  locator.click()
page.add_locator_handler(page.get_by_label("Close"), handler, times=1)

引数

  • locator Locator#

    ハンドラーをトリガーするロケーター。

  • handler Callable[Locator]:Promise[Any]#

    locator が表示されたときに実行される関数。この関数は、クリックなどのアクションをブロックする要素を削除する必要があります。

  • no_wait_after bool (オプション)追加バージョン: v1.44#

    デフォルトでは、ハンドラーを呼び出した後、Playwrightはオーバーレイが非表示になるまで待機し、その後、ハンドラーをトリガーしたアクション/アサーションを続行します。このオプションを使用すると、この動作をオプトアウトできるため、ハンドラーの実行後もオーバーレイを表示したままにすることができます。

  • times int (オプション)追加バージョン: v1.44#

    このハンドラーが呼び出される最大回数を指定します。デフォルトは無制限です。

戻り値

add_script_tag​

v1.9より前に追加 page.add_script_tag

目的のURLまたはコンテンツを持つ<script>タグをページに追加します。スクリプトのonloadが発火したとき、またはスクリプトコンテンツがフレームに挿入されたときに、追加されたタグを返します。

使用法

page.add_script_tag()
page.add_script_tag(**kwargs)

引数

  • content str (オプション)#

    フレームに挿入される生のJavaScriptコンテンツ。

  • path Union[str, pathlib.Path] (オプション)#

    フレームに挿入されるJavaScriptファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。

  • type str (オプション)#

    スクリプトの種類。JavaScript ES6モジュールをロードするには、「module」を使用します。詳細については、scriptを参照してください。

  • url str (オプション)#

    追加するスクリプトのURL。

戻り値

add_style_tag​

v1.9より前に追加 page.add_style_tag

目的のURLを持つ<link rel="stylesheet">タグ、またはコンテンツを持つ<style type="text/css">タグをページに追加します。スタイルシートのonloadが発火したとき、またはCSSコンテンツがフレームに挿入されたときに、追加されたタグを返します。

使用法

page.add_style_tag()
page.add_style_tag(**kwargs)

引数

  • content str (オプション)#

    フレームに挿入される生のCSSコンテンツ。

  • path Union[str, pathlib.Path] (オプション)#

    フレームに挿入されるCSSファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。

  • url str (オプション)#

    <link>タグのURL。

戻り値

bring_to_front​

v1.9より前に追加 page.bring_to_front

ページを前面に表示します（タブをアクティブにします）。

使用法

page.bring_to_front()

戻り値

close​

v1.9より前に追加 page.close

run_before_unload が false の場合、アンロードハンドラは実行されず、ページが閉じるのを待機します。run_before_unload が true の場合、メソッドはアンロードハンドラを実行しますが、ページが閉じるのを待機は**しません**。

デフォルトでは、page.close()はbeforeunloadハンドラーを実行しません。

注

run_before_unload が true として渡された場合、beforeunload ダイアログが表示される可能性があり、page.on("dialog") イベントを介して手動で処理する必要があります。

使用法

page.close()
page.close(**kwargs)

引数

  • reason str (オプション)追加されたバージョン: v1.40#

    ページの閉鎖によって中断された操作に報告される理由。

  • run_before_unload bool (オプション)#

    デフォルトはfalseです。before unloadページハンドラーを実行するかどうか。

戻り値

content​

v1.9より前に追加 page.content

doctypeを含む、ページの完全なHTMLコンテンツを取得します。

使用法

page.content()

戻り値

drag_and_drop​

追加バージョン: v1.13 page.drag_and_drop

このメソッドは、ソース要素をターゲット要素にドラッグします。まずソース要素に移動し、mousedownを実行し、次にターゲット要素に移動してmouseupを実行します。

使用法

page.drag_and_drop("#source", "#target")
# or specify exact positions relative to the top-left corners of the elements:
page.drag_and_drop(
  "#source",
  "#target",
  source_position={"x": 34, "y": 7},
  target_position={"x": 10, "y": 20}
)

引数

  • source str#

    ドラッグする要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合、最初のものが使用されます。

  • target str#

    ドロップする要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合、最初のものが使用されます。

  • force bool (オプション)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • source_position Dict (オプション)追加されたバージョン: v1.14#

    要素のパディングボックスの左上隅を基準としたこの点でソース要素をクリックします。指定しない場合、要素のいくつかの可視点が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • target_position Dict (オプション)追加されたバージョン: v1.14#

    要素のパディングボックスの左上隅を基準としたこの点でターゲット要素にドロップします。指定しない場合、要素のいくつかの可視点が使用されます。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

emulate_media​

v1.9より前に追加 page.emulate_media

このメソッドは、media引数によってCSS media typeを、および/またはcolorScheme引数を使用して'prefers-colors-scheme'メディア機能を変更します。

使用法

page.evaluate("matchMedia('screen').matches")
# → True
page.evaluate("matchMedia('print').matches")
# → False

page.emulate_media(media="print")
page.evaluate("matchMedia('screen').matches")
# → False
page.evaluate("matchMedia('print').matches")
# → True

page.emulate_media()
page.evaluate("matchMedia('screen').matches")
# → True
page.evaluate("matchMedia('print').matches")
# → False
page.emulate_media(color_scheme="dark")
page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches")
# → True
page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
# → False

引数

  • color_scheme "light" | "dark" | "no-preference" | "null" (オプション)追加バージョン: v1.9#

    prefers-colors-scheme メディア機能をエミュレートします。サポートされている値は 'light' と 'dark' です。'Null' を渡すと配色エミュレーションが無効になります。'no-preference' は非推奨です。

  • contrast "no-preference" | "more" | "null" (オプション)追加バージョン: v1.51#

  • forced_colors "active" | "none" | "null" (オプション)追加されたバージョン: v1.15#

  • media "screen" | "print" | "null" (オプション)追加バージョン: v1.9#

    ページの CSS メディアタイプを変更します。許可される値は 'Screen'、'Print'、'Null' のみです。'Null' を渡すと CSS メディアエミュレーションが無効になります。

  • reduced_motion "reduce" | "no-preference" | "null" (オプション)追加日: v1.12#

    'prefers-reduced-motion'メディア機能をエミュレートします。サポートされる値は'reduce'、'no-preference'です。nullを渡すと、モーション削減エミュレーションが無効になります。

戻り値

evaluate​

v1.9より前に追加 page.evaluate

expression の呼び出しの値を返します。

page.evaluate() に渡された関数が Promise を返す場合、page.evaluate() は Promise が解決されるのを待機し、その値を返します。

page.evaluate() に渡された関数が Serializable ではない値を返す場合、page.evaluate() は undefined に解決されます。Playwright は、JSON によってシリアライズできないいくつかの追加の値も転送することをサポートしています: -0、NaN、Infinity、-Infinity。

使用法

expression に引数を渡す

result = page.evaluate("([x, y]) => Promise.resolve(x * y)", [7, 8])
print(result) # prints "56"

関数ではなく文字列を渡すこともできます。

print(page.evaluate("1 + 2")) # prints "3"
x = 10
print(page.evaluate(f"1 + {x}")) # prints "11"

ElementHandle インスタンスは、page.evaluate() の引数として渡すことができます。

body_handle = page.evaluate("document.body")
html = page.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
body_handle.dispose()

引数

  • expression str#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (オプション)#

    expression に渡すオプションの引数。

戻り値

evaluate_handle​

v1.9より前に追加 page.evaluate_handle

expression の呼び出しの値を JSHandle として返します。

page.evaluate() と page.evaluate_handle() の唯一の違いは、page.evaluate_handle() が JSHandle を返すことです。

page.evaluate_handle() に渡された関数が Promise を返す場合、page.evaluate_handle() は Promise が解決されるのを待機し、その値を返します。

使用法

a_window_handle = page.evaluate_handle("Promise.resolve(window)")
a_window_handle # handle for the window object.

関数ではなく文字列を渡すこともできます。

a_handle = page.evaluate_handle("document") # handle for the "document"

JSHandle インスタンスは、page.evaluate_handle() の引数として渡すことができます。

a_handle = page.evaluate_handle("document.body")
result_handle = page.evaluate_handle("body => body.innerHTML", a_handle)
print(result_handle.json_value())
result_handle.dispose()

引数

  • expression str#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (オプション)#

    expression に渡すオプションの引数。

戻り値

expect_console_message​

追加バージョン: v1.9 page.expect_console_message

アクションを実行し、ページで記録される ConsoleMessage を待機します。述語が指定されている場合、ConsoleMessage の値を predicate 関数に渡し、predicate(message) が真の値を返すのを待ちます。page.on("console") イベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_console_message()
page.expect_console_message(**kwargs)

引数

  • predicate Callable[ConsoleMessage]:bool (オプション)#

    ConsoleMessage オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_download​

追加バージョン: v1.9 page.expect_download

アクションを実行し、新しい Download を待機します。述語が指定されている場合、Download の値を predicate 関数に渡し、predicate(download) が真の値を返すのを待ちます。ダウンロードイベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_download()
page.expect_download(**kwargs)

引数

  • predicate Callable[Download]:bool (オプション)#

    Download オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_event​

v1.9より前に追加 page.expect_event

イベントが発生するのを待ち、その値を述語関数に渡します。述語が真の値を返すと戻ります。イベントが発生する前にページが閉じられた場合、エラーがスローされます。イベントデータ値を返します。

使用法

with page.expect_event("framenavigated") as event_info:
    page.get_by_role("button")
frame = event_info.value

引数

  • event str#

    イベント名。通常、*.on(event) に渡されるものと同じです。

  • predicate Callable (オプション)#

    イベントデータを受け取り、待機が解決されるべき場合にtruthyな値に解決されます。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_file_chooser​

追加バージョン: v1.9 page.expect_file_chooser

アクションを実行し、新しい FileChooser が作成されるのを待機します。述語が指定されている場合、FileChooser の値を predicate 関数に渡し、predicate(fileChooser) が真の値を返すのを待ちます。ファイルチューザーが開く前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_file_chooser()
page.expect_file_chooser(**kwargs)

引数

  • predicate Callable[FileChooser]:bool (オプション)#

    FileChooser オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_popup​

追加バージョン: v1.9 page.expect_popup

アクションを実行し、ポップアップ Page を待機します。述語が指定されている場合、[Popup] の値を predicate 関数に渡し、predicate(page) が真の値を返すのを待ちます。ポップアップイベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_popup()
page.expect_popup(**kwargs)

引数

  • predicate Callable[Page]:bool (オプション)#

    Page オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_request​

v1.9より前に追加 page.expect_request

一致するリクエストを待機し、それを返します。イベントの詳細については、waiting for event を参照してください。

使用法

with page.expect_request("http://example.com/resource") as first:
    page.get_by_text("trigger request").click()
first_request = first.value

# or with a lambda
with page.expect_request(lambda request: request.url == "http://example.com" and request.method == "get") as second:
    page.get_by_text("trigger request").click()
second_request = second.value

引数

  • url_or_predicate str | Pattern | Callable[Request]:bool#

    リクエスト URL 文字列、正規表現、または Request オブジェクトを受け取る述語。コンテキストオプションを介して base_url が提供され、渡された URL がパスである場合、new URL() コンストラクタを介して結合されます。

  • timeout float (オプション)#

    最大待機時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は page.set_default_timeout() メソッドを使用して変更できます。

戻り値

expect_request_finished​

追加日: v1.12 page.expect_request_finished

アクションを実行し、Request の読み込みが完了するのを待ちます。述語が指定されている場合、Request の値を predicate 関数に渡し、predicate(request) が真の値を返すのを待ちます。page.on("requestfinished") イベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_request_finished()
page.expect_request_finished(**kwargs)

引数

  • predicate Callable[Request]:bool (オプション)#

    Request オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_response​

v1.9より前に追加 page.expect_response

一致するレスポンスを返します。イベントの詳細については、waiting for event を参照してください。

使用法

with page.expect_response("https://example.com/resource") as response_info:
    page.get_by_text("trigger response").click()
response = response_info.value
return response.ok

# or with a lambda
with page.expect_response(lambda response: response.url == "https://example.com" and response.status == 200 and response.request.method == "get") as response_info:
    page.get_by_text("trigger response").click()
response = response_info.value
return response.ok

引数

  • url_or_predicate str | Pattern | Callable[Response]:bool#

    リクエスト URL 文字列、正規表現、または Response オブジェクトを受け取る述語。コンテキストオプションを介して base_url が提供され、渡された URL がパスである場合、new URL() コンストラクタを介して結合されます。

  • timeout float (オプション)#

    最大待機時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

expect_websocket​

追加バージョン: v1.9 page.expect_websocket

アクションを実行し、新しい WebSocket を待機します。述語が提供されている場合、WebSocket の値を predicate 関数に渡し、predicate(webSocket) が真の値を返すのを待ちます。WebSocket イベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_websocket()
page.expect_websocket(**kwargs)

引数

  • predicate Callable[WebSocket]:bool (オプション)#

    WebSocket オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expect_worker​

追加バージョン: v1.9 page.expect_worker

アクションを実行し、新しい Worker を待機します。述語が提供されている場合、Worker の値を predicate 関数に渡し、predicate(worker) が真の値を返すのを待ちます。Worker イベントが発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.expect_worker()
page.expect_worker(**kwargs)

引数

  • predicate Callable[Worker]:bool (オプション)#

    Worker オブジェクトを受け取り、待機が解決されるときに真の値を返します。

  • timeout float (オプション)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

expose_binding​

v1.9より前に追加 page.expose_binding

このメソッドは、このページのすべてのフレームの window オブジェクトに name と呼ばれる関数を追加します。呼び出されると、関数は callback を実行し、Promise を返します。これは callback の戻り値に解決されます。callback が Promise を返す場合、それは待機されます。

callback 関数の最初の引数には、呼び出し元に関する情報が含まれます: { browserContext: BrowserContext, page: Page, frame: Frame }。

コンテキスト全体版については、browser_context.expose_binding() を参照してください。

注

page.expose_binding() を介してインストールされた関数はナビゲーション後も存続します。

使用法

ページURLをページのすべてのフレームに公開する例

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch(headless=False)
    context = browser.new_context()
    page = context.new_page()
    page.expose_binding("pageURL", lambda source: source["page"].url)
    page.set_content("""
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.pageURL();
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
    """)
    page.click("button")

with sync_playwright() as playwright:
    run(playwright)

引数

  • name str#

    ウィンドウオブジェクト上の関数の名前。

  • callback Callable#

    Playwright のコンテキストで呼び出されるコールバック関数。

  • handle bool (オプション)#

    非推奨

    このオプションは将来削除されます。

    引数を値で渡す代わりに、ハンドルとして渡すかどうか。ハンドルとして渡す場合、引数は1つのみサポートされます。値で渡す場合、複数の引数がサポートされます。

戻り値

expose_function​

v1.9より前に追加 page.expose_function

このメソッドは、ページのすべてのフレームの window オブジェクトに name という名前の関数を追加します。呼び出されると、関数は callback を実行し、callback の戻り値に解決される Promise を返します。

callback が Promise を返す場合、それが待機されます。

コンテキスト全体に公開される関数については、browser_context.expose_function() を参照してください。

注

page.expose_function() を介してインストールされた関数はナビゲーション後も存続します。

使用法

ページにsha256関数を追加する例

import hashlib
from playwright.sync_api import sync_playwright, Playwright

def sha256(text):
    m = hashlib.sha256()
    m.update(bytes(text, "utf8"))
    return m.hexdigest()


def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch(headless=False)
    page = browser.new_page()
    page.expose_function("sha256", sha256)
    page.set_content("""
        <script>
          async function onClick() {
            document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
          }
        </script>
        <button onclick="onClick()">Click me</button>
        <div></div>
    """)
    page.click("button")

with sync_playwright() as playwright:
    run(playwright)

引数

  • name str#

    windowオブジェクト上の関数の名前。

  • callback Callable#

    Playwrightのコンテキストで呼び出されるコールバック関数。

戻り値

frame​

v1.9より前に追加 page.frame

指定された条件に一致するフレームを返します。nameまたはurlのいずれかを指定する必要があります。

使用法

frame = page.frame(name="frame-name")
frame = page.frame(url=r".*domain.*")

引数

  • name str (オプション)#

    iframe の name 属性で指定されたフレーム名。オプション。

  • url str | Pattern | Callable[URL]:bool (オプション)#

    フレームの url を URL オブジェクトとして受け取るグロブパターン、正規表現パターン、または述語。オプション。

戻り値

frame_locator​

追加バージョン: v1.17 page.frame_locator

iframeを操作する場合、iframeに入り、そのiframe内の要素を選択できるフレームロケーターを作成できます。

使用法

次のスニペットは、IDがmy-frameのiframeにあるテキスト「Submit」を持つ要素を検索します（例: <iframe id="my-frame">）。

locator = page.frame_locator("#my-iframe").get_by_text("Submit")
locator.click()

引数

  • selector str#

    DOM要素を解決するときに使用するセレクター。

戻り値

get_by_alt_text​

追加バージョン: v1.27 page.get_by_alt_text

要素をそのaltテキストで特定できます。

使用法

例えば、このメソッドはaltテキスト「Playwright logo」で画像を見つけます。

<img alt='Playwright logo'>
page.get_by_alt_text("Playwright logo").click()

引数

  • text str | Pattern#

    要素を特定するためのテキスト。

  • exact bool (オプション)#

    完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

get_by_label​

追加バージョン: v1.27 page.get_by_label

関連する<label>またはaria-labelledby要素のテキスト、またはaria-label属性によって入力要素を特定できます。

使用法

例えば、このメソッドは以下のDOMでラベル「Username」と「Password」を持つ入力を見つけます。

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.get_by_label("Username").fill("john")
page.get_by_label("Password").fill("secret")

引数

  • text str | Pattern#

    要素を特定するためのテキスト。

  • exact bool (オプション)#

    完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

get_by_placeholder​

追加バージョン: v1.27 page.get_by_placeholder

プレースホルダーテキストによって入力要素を特定できます。

使用法

例えば、以下のDOM構造を考えてみましょう。

<input type="email" placeholder="name@example.com" />

プレースホルダーテキストで入力を見つけてから、入力できます。

page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")

引数

  • text str | Pattern#

    要素を特定するためのテキスト。

  • exact bool (オプション)#

    完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

get_by_role​

追加バージョン: v1.27 page.get_by_role

要素をそのARIAロール、ARIA属性、およびアクセシブルネームで特定できます。

使用法

以下のDOM構造を考えてみましょう。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

各要素をその暗黙的なロールで特定できます。

expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

page.get_by_role("checkbox", name="Subscribe").check()

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

引数

  • role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"#

    必須のariaロール。

  • checked bool (オプション)#

    通常、aria-checkedまたはネイティブの<input type=checkbox>コントロールによって設定される属性。

    aria-checkedの詳細。

  • disabled bool (オプション)#

    通常、aria-disabledまたはdisabledによって設定される属性。

    注

    他のほとんどの属性とは異なり、disabledはDOM階層を介して継承されます。aria-disabledの詳細。

  • exact bool (オプション)追加バージョン: v1.28#

    name が完全に一致するかどうか: 大文字小文字を区別し、文字列全体を一致させます。デフォルトは false です。name が正規表現の場合、無視されます。厳密な一致でも空白はトリムされます。

  • expanded bool (オプション)#

    通常、aria-expandedによって設定される属性。

    aria-expandedの詳細。

  • include_hidden bool (オプション)#

    非表示要素が一致するかどうかを制御するオプション。デフォルトでは、ARIAで定義されているように、非表示でない要素のみがロールセレクターによって一致します。

    aria-hiddenの詳細。

  • level int (オプション)#

    通常、heading、listitem、row、treeitemのロールに存在する数値属性で、<h1>-<h6>要素のデフォルト値があります。

    aria-levelの詳細。

  • name str | Pattern (オプション)#

    アクセシブルネームに一致するオプション。デフォルトでは、大文字小文字を区別せず、部分文字列を検索します。この動作を制御するには exact を使用します。

    アクセシブルネームの詳細。

  • pressed bool (オプション)#

    通常、aria-pressedによって設定される属性。

    aria-pressedの詳細。

  • selected bool (オプション)#

    通常、aria-selectedによって設定される属性。

    aria-selectedの詳細。

戻り値

詳細

ロールセレクターは、アクセシビリティ監査や適合性テストを**置き換えるものではなく**、ARIAガイドラインに関する早期のフィードバックを提供します。

多くのHTML要素には、ロールセレクターによって認識される暗黙的に定義されたロールがあります。サポートされているすべてのロールはこちらで確認できます。ARIAガイドラインは、roleおよび/またはaria-*属性をデフォルト値に設定して暗黙的なロールと属性を重複させることを**推奨しません**。

get_by_test_id​

追加バージョン: v1.27 page.get_by_test_id

テストIDによって要素を特定します。

使用法

以下のDOM構造を考えてみましょう。

<button data-testid="directions">Itinéraire</button>

テストIDによって要素を特定できます。

page.get_by_test_id("directions").click()

引数

戻り値

詳細

デフォルトでは、data-testid 属性がテスト ID として使用されます。必要に応じて異なるテスト ID 属性を設定するには、selectors.set_test_id_attribute() を使用します。

get_by_text​

追加バージョン: v1.27 page.get_by_text

指定されたテキストを含む要素を特定できます。

アクセス可能なロールなどの別の基準で一致させ、その後テキストコンテンツでフィルタリングできる locator.filter() メソッドも参照してください。

使用法

以下のDOM構造を考えてみましょう。

<div>Hello <span>world</span></div>
<div>Hello</div>

テキストの部分文字列、完全な文字列、または正規表現で特定できます。

# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))

引数

  • text str | Pattern#

    要素を特定するためのテキスト。

  • exact bool (オプション)#

    完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

詳細

テキストによる一致は、厳密な一致であっても常に空白を正規化します。例えば、複数のスペースを1つにまとめ、改行をスペースに変換し、先頭と末尾の空白を無視します。

buttonおよびsubmit型の入力要素は、テキストコンテンツの代わりにそのvalueによって一致します。例えば、テキスト"Log in"で特定すると、<input type=button value="Log in">が一致します。

get_by_title​

追加バージョン: v1.27 page.get_by_title

要素をそのタイトル属性で特定できます。

使用法

以下のDOM構造を考えてみましょう。

<span title='Issues count'>25 issues</span>

タイトルテキストで問題数を特定した後、確認できます。

expect(page.get_by_title("Issues count")).to_have_text("25 issues")

引数

  • text str | Pattern#

    要素を特定するためのテキスト。

  • exact bool (オプション)#

    完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

go_back​

v1.9より前に追加 page.go_back

メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトの応答で解決されます。戻ることができない場合、nullを返します。

履歴の前のページに移動します。

使用法

page.go_back()
page.go_back(**kwargs)

引数

  • timeout float (オプション)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

go_forward​

v1.9より前に追加 page.go_forward

メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトの応答で解決されます。進むことができない場合、nullを返します。

履歴の次のページに移動します。

使用法

page.go_forward()
page.go_forward(**kwargs)

引数

  • timeout float (オプション)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

goto​

v1.9より前に追加 page.goto

メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最初の非リダイレクト応答で解決されます。

このメソッドは、以下の場合にエラーをスローします。

  • SSLエラーがある場合（例: 自己署名証明書の場合）。
  • ターゲットURLが無効な場合。
  • timeout がナビゲーション中に超過した場合。
  • リモートサーバーが応答しないか、アクセスできない場合。
  • メインリソースの読み込みに失敗した場合。

このメソッドは、404 "Not Found" や 500 "Internal Server Error" など、リモートサーバーから有効な HTTP ステータスコードが返された場合でもエラーをスローしません。このようなレスポンスのステータスコードは、response.status を呼び出すことで取得できます。

注

このメソッドは、エラーをスローするか、メインリソース応答を返します。唯一の例外は、about:blankへのナビゲーション、または異なるハッシュを持つ同じURLへのナビゲーションであり、これらは成功しnullを返します。

注

ヘッドレスモードはPDFドキュメントへのナビゲーションをサポートしていません。上流の問題を参照してください。

使用法

page.goto(url)
page.goto(url, **kwargs)

引数

  • url str#

    ページをナビゲートする URL。URL はスキーム (例: https://) を含める必要があります。コンテキストオプションを介して base_url が提供され、渡された URL がパスである場合、new URL() コンストラクタを介して結合されます。

  • referer str (オプション)#

    Referer ヘッダー値。提供されている場合、page.set_extra_http_headers() によって設定された referer ヘッダー値よりも優先されます。

  • timeout float (オプション)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

locator​

追加されたバージョン: v1.14 page.locator

このメソッドは、このページ/フレームでアクションを実行するために使用できる要素ロケーターを返します。ロケーターはアクションを実行する直前に要素に解決されるため、同じロケーターに対する一連のアクションは、実際には異なるDOM要素に対して実行される可能性があります。これは、それらのアクション間でDOM構造が変更された場合に発生します。

ロケーターの詳細.

使用法

page.locator(selector)
page.locator(selector, **kwargs)

引数

  • selector str#

    DOM要素を解決するときに使用するセレクター。

  • has Locator (オプション)#

    この相対ロケーターに一致する要素を含む結果にメソッドの結果を絞り込みます。例えば、text=Playwrightを持つarticleは<article><div>Playwright</div></article>に一致します。

    内部ロケーターは**外部ロケーターに対して相対的**でなければならず、ドキュメントルートではなく外部ロケーターの一致からクエリが開始されます。例えば、<article><content><div>Playwright</div></content></article>でdivを持つcontentを見つけることができます。しかし、article divを持つcontentを探すと、内部ロケーターは相対的でなければならず、contentの外部の要素を使用すべきではないため、失敗します。

    外側のロケーターと内側のロケーターは同じフレームに属している必要があります。内側のロケーターには FrameLocator を含めることはできません。

  • has_not ロケーター (オプション)追加バージョン: v1.33#

    内部ロケーターに一致する要素を含まない要素に一致します。内部ロケーターは外部ロケーターに対してクエリされます。例えば、divを持たないarticleは<article><span>Playwright</span></article>に一致します。

    外側のロケーターと内側のロケーターは同じフレームに属している必要があります。内側のロケーターには FrameLocator を含めることはできません。

  • has_not_text str | Pattern (オプション)追加バージョン: v1.33#

    指定されたテキストを、おそらく子または子孫要素内にどこかに含まない要素と一致します。 [string] が渡された場合、大文字と小文字を区別せず、部分文字列を検索します。

  • has_text str | Pattern (オプション)#

    指定されたテキストを、おそらく子または子孫要素内にどこかに含む要素と一致します。 [string] が渡された場合、大文字と小文字を区別せず、部分文字列を検索します。たとえば、"Playwright" は <article><div>Playwright</div></article> と一致します。

戻り値

opener​

v1.9より前に追加 page.opener

ポップアップページの場合にオープナーを返し、その他の場合はnullを返します。オープナーがすでに閉じられている場合、nullを返します。

使用法

page.opener()

戻り値

pause​

追加バージョン: v1.9 page.pause

スクリプトの実行を一時停止します。Playwrightはスクリプトの実行を停止し、ユーザーがページオーバーレイの「Resume」ボタンを押すか、DevToolsコンソールでplaywright.resume()を呼び出すのを待ちます。

ユーザーは一時停止中にセレクターを検査したり、手動のステップを実行したりできます。再開すると、元のスクリプトは一時停止した場所から実行を続けます。

注

このメソッドを使用するには、Playwright をヘッドレスオプションが偽であるヘッドモードで起動する必要があります。

使用法

page.pause()

戻り値

pdf​

v1.9より前に追加 page.pdf

PDFバッファを返します。

page.pdf() は print CSS メディアでページの PDF を生成します。screen メディアで PDF を生成するには、page.pdf() を呼び出す前に page.emulate_media() を呼び出してください。

注

デフォルトでは、page.pdf()は印刷用に色が変更されたPDFを生成します。正確な色のレンダリングを強制するには、-webkit-print-color-adjustプロパティを使用します。

使用法

# generates a pdf with "screen" media type.
page.emulate_media(media="screen")
page.pdf(path="page.pdf")

width、height、margin オプションは、単位付きの値を受け入れます。単位なしの値はピクセルとして扱われます。

いくつかの例

  • page.pdf({width: 100}) - 幅を100ピクセルに設定して印刷
  • page.pdf({width: '100px'}) - 幅を100ピクセルに設定して印刷
  • page.pdf({width: '10cm'}) - 幅を10センチメートルに設定して印刷。

すべての可能な単位は

  • px - ピクセル
  • in - インチ
  • cm - センチメートル
  • mm - ミリメートル

format オプションは次のとおりです。

  • Letter: 8.5インチ x 11インチ
  • Legal: 8.5インチ x 14インチ
  • Tabloid: 11インチ x 17インチ
  • Ledger: 17インチ x 11インチ
  • A0: 33.1インチ x 46.8インチ
  • A1: 23.4インチ x 33.1インチ
  • A2: 16.54インチ x 23.4インチ
  • A3: 11.7インチ x 16.54インチ
  • A4: 8.27インチ x 11.7インチ
  • A5: 5.83インチ x 8.27インチ
  • A6: 4.13インチ x 5.83インチ
注

header_template と footer_template のマークアップには以下の制限があります: > 1. テンプレート内のスクリプトタグは評価されません。 > 2. ページスタイルはテンプレート内では表示されません。

引数

  • display_header_footer bool (オプション)#

    ヘッダーとフッターを表示します。デフォルトはfalseです。

  • footer_template str (オプション)#

    印刷フッター用の HTML テンプレート。header_template と同じ形式を使用する必要があります。

  • format str (オプション)#

    用紙フォーマット。設定されている場合、width または height オプションよりも優先されます。デフォルトは「Letter」です。

  • header_template str (オプション)#

    印刷ヘッダーのHTMLテンプレート。印刷値を挿入するために次のクラスが使用される有効なHTMLマークアップである必要があります。

    • 'date' 形式化された印刷日付
    • 'title' ドキュメントタイトル
    • 'url' ドキュメントの場所
    • 'pageNumber' 現在のページ番号
    • 'totalPages' ドキュメントの総ページ数

  • height str | float (オプション)#

    用紙の高さ。単位付きの値を受け入れます。

  • landscape bool (オプション)#

    用紙の向き。デフォルトはfalseです。

  • margin Dict (オプション)#

    • top str | float (オプション)

      上余白。単位付きの値を受け入れます。デフォルトは0です。

    • right str | float (オプション)

      右余白。単位付きの値を受け入れます。デフォルトは0です。

    • bottom str | float (オプション)

      下余白。単位付きの値を受け入れます。デフォルトは0です。

    • left str | float (オプション)

      左余白。単位付きの値を受け入れます。デフォルトは0です。

    用紙の余白。デフォルトはなし。

  • outline bool (オプション)追加バージョン: v1.42#

    ドキュメントのアウトラインをPDFに埋め込むかどうか。デフォルトはfalseです。

  • page_ranges str (オプション)#

    印刷するページの範囲。例: '1-5, 8, 11-13'。デフォルトは空文字列で、すべてのページを印刷することを意味します。

  • path Union[str, pathlib.Path] (オプション)#

    PDF を保存するファイルパス。path が相対パスの場合、現在の作業ディレクトリを基準に解決されます。パスが指定されていない場合、PDF はディスクに保存されません。

  • prefer_css_page_size bool (オプション)#

    ページで宣言された CSS @page サイズを、width、height、または format オプションで宣言されたものよりも優先します。デフォルトは false で、コンテンツは用紙サイズに合わせて拡大縮小されます。

  • print_background bool (オプション)#

    背景グラフィックを印刷します。デフォルトはfalseです。

  • scale float (オプション)#

    ウェブページのレンダリングのスケール。デフォルトは1です。スケール量は0.1から2の間である必要があります。

  • tagged bool (オプション)追加バージョン: v1.42#

    タグ付けされた（アクセシブルな）PDFを生成するかどうか。デフォルトはfalseです。

  • width str | float (オプション)#

    用紙の幅。単位付きの値を受け入れます。

戻り値

reload​

v1.9より前に追加 page.reload

このメソッドは、ユーザーがブラウザの更新をトリガーしたかのように、現在のページをリロードします。メインリソース応答を返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトの応答で解決されます。

使用法

page.reload()
page.reload(**kwargs)

引数

  • timeout float (オプション)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

remove_locator_handler​

追加バージョン: v1.44 page.remove_locator_handler

特定のロケーターについて page.add_locator_handler() で追加されたすべてのロケーターハンドラを削除します。

使用法

page.remove_locator_handler(locator)

引数

戻り値

request_gc​

追加日: v1.48 page.request_gc

ページにガベージコレクションを実行するように要求します。到達不能なすべてのオブジェクトが収集される保証はありません。

これはメモリリークを検出するのに役立ちます。たとえば、ページにリークする可能性のある大きなオブジェクト 'suspect' がある場合、WeakRef を使用してリークしないことを確認できます。

# 1. In your page, save a WeakRef for the "suspect".
page.evaluate("globalThis.suspectWeakRef = new WeakRef(suspect)")
# 2. Request garbage collection.
page.request_gc()
# 3. Check that weak ref does not deref to the original object.
assert page.evaluate("!globalThis.suspectWeakRef.deref()")

使用法

page.request_gc()

戻り値

route​

v1.9より前に追加 page.route

ルーティングは、ページによって行われるネットワークリクエストを変更する機能を提供します。

ルーティングが有効になると、URLパターンに一致するすべてのリクエストは、続行、完了、または中止されない限り停止します。

注

レスポンスがリダイレクトの場合、ハンドラーは最初のURLに対してのみ呼び出されます。

注

page.route() はサービスワーカーによって傍受されたリクエストを傍受しません。この問題については、こちらを参照してください。リクエスト傍受を使用する場合は、service_workers を 'block' に設定してサービスワーカーを無効にすることをお勧めします。

注

page.route() はポップアップページの最初のリクエストを傍受しません。代わりに browser_context.route() を使用してください。

使用法

すべての画像リクエストを中止する素朴なハンドラの例

page = browser.new_page()
page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
page.goto("https://example.com")
browser.close()

または、代わりに正規表現パターンを使用する同じスニペット

page = browser.new_page()
page.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
page.goto("https://example.com")
browser.close()

リクエストを調べてルートアクションを決定することができます。たとえば、一部の POST データを含むすべてのリクエストをモックし、その他のすべてのリクエストをそのままにするなどです。

def handle_route(route: Route):
  if ("my-string" in route.request.post_data):
    route.fulfill(body="mocked-data")
  else:
    route.continue_()
page.route("/api/**", handle_route)

ページルートは、リクエストが両方のハンドラに一致する場合、ブラウザコンテキストルート (browser_context.route() で設定) よりも優先されます。

ハンドラ付きのルートを削除するには、page.unroute() を使用できます。

注

ルーティングを有効にすると、HTTP キャッシュが無効になります。

引数

  • url str | Pattern | Callable[URL]:bool#

    ルーティング中に一致する URL を受け取るグロブパターン、正規表現パターン、または述語。コンテキストオプションで base_url が設定されており、指定された URL が * で始まらない文字列の場合、new URL() コンストラクタを使用して解決されます。

  • handler Callable[Route, Request]:Promise[Any] | Any#

    リクエストをルーティングするハンドラ関数。

  • times int (オプション)追加されたバージョン: v1.15#

    ルートが使用される頻度。デフォルトでは毎回使用されます。

戻り値

route_from_har​

追加日: v1.23 page.route_from_har

指定された場合、ページで行われたネットワークリクエストは HAR ファイルから提供されます。HAR からのリプレイについて詳しくは、こちらをご覧ください。

Playwright はサービスワーカーによって傍受されたリクエストを HAR ファイルから提供しません。この問題については、こちらを参照してください。リクエスト傍受を使用する場合は、service_workers を 'block' に設定してサービスワーカーを無効にすることをお勧めします。

使用法

page.route_from_har(har)
page.route_from_har(har, **kwargs)

引数

  • har Union[str, pathlib.Path]#

    事前に記録されたネットワークデータを含む HAR ファイルへのパス。path が相対パスの場合、現在の作業ディレクトリに対して解決されます。

  • not_found "abort" | "fallback" (オプション)#

    • 'abort' に設定されている場合、HAR ファイルに見つからないリクエストは中止されます。
    • 'fallback' に設定すると、見つからないリクエストはネットワークに送信されます。

    デフォルトは abort です。

  • update bool (オプション)#

    指定された場合、ファイルから提供する代わりに、実際のネットワーク情報で指定された HAR を更新します。browser_context.close() が呼び出されたときにファイルがディスクに書き込まれます。

  • update_content "embed" | "attach" (オプション)追加日: v1.32#

    リソースコンテンツ管理を制御するためのオプション設定。attach が指定されている場合、リソースは個別のファイルまたは ZIP アーカイブ内のエントリとして永続化されます。embed が指定されている場合、コンテンツは HAR ファイル内にインラインで格納されます。

  • update_mode "full" | "minimal" (オプション)追加日: v1.32#

    minimal に設定すると、HAR からルーティングするために必要な情報のみが記録されます。これにより、HAR からリプレイするときに使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、およびその他の種類の HAR 情報が省略されます。デフォルトは minimal です。

  • url str | Pattern (オプション)#

    リクエスト URL に一致するグロブパターン、正規表現、または述語。パターンに一致する URL を持つリクエストのみが HAR ファイルから提供されます。指定されていない場合、すべてのリクエストが HAR ファイルから提供されます。

戻り値

route_web_socket​

追加日: v1.48 page.route_web_socket

このメソッドを使用すると、ページによって行われるwebsocket接続を変更できます。

このメソッドが呼び出された後に作成された WebSocket のみがルーティングされることに注意してください。ページをナビゲートする前にこのメソッドを呼び出すことをお勧めします。

使用法

以下は、単一のメッセージに応答するシンプルなモックの例です。WebSocketRoute には、より詳細な情報と例があります。

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "request":
    ws.send("response")

def handler(ws: WebSocketRoute):
  ws.on_message(lambda message: message_handler(ws, message))

page.route_web_socket("/ws", handler)

引数

  • url str | Pattern | Callable[URL]:bool#

    このパターンに一致するURLを持つWebSocketのみがルーティングされます。文字列パターンは、base_urlコンテキストオプションに対する相対パスで指定できます。

  • handler Callable[WebSocketRoute]:Promise[Any] | Any#

    WebSocket をルーティングするハンドラ関数。

戻り値

screenshot​

v1.9より前に追加 page.screenshot

キャプチャされたスクリーンショットを含むバッファを返します。

使用法

page.screenshot()
page.screenshot(**kwargs)

引数

  • animations "disabled" | "allow" (optional)#

    "disabled"に設定すると、CSSアニメーション、CSSトランジション、Webアニメーションが停止します。アニメーションは期間によって異なる扱いを受けます。

    • 有限のアニメーションは完了まで早送りされ、transitionendイベントが発生します。
    • 無限のアニメーションは初期状態にキャンセルされ、スクリーンショットの後に再生されます。

    デフォルトは"allow"で、アニメーションはそのまま残されます。

  • caret "hide" | "initial" (optional)#

    "hide"に設定すると、スクリーンショットはテキストキャレットを非表示にします。"initial"に設定すると、テキストキャレットの動作は変更されません。デフォルトは"hide"です。

  • clip Dict (optional)#

    • x float

      クリップ領域の左上隅のx座標

    • y float

      クリップ領域の左上隅のy座標

    • width float

      クリッピング領域の幅

    • height float

      クリッピング領域の高さ

    結果の画像のクリッピングを指定するオブジェクト。

  • full_page bool (optional)#

    trueの場合、現在表示されているビューポートではなく、スクロール可能なページ全体のスクリーンショットを撮ります。デフォルトは false です。

  • mask List[Locator] (optional)#

    スクリーンショットを撮る際にマスクする必要があるロケーターを指定します。マスクされた要素は、バウンディングボックスを完全に覆うピンク色のボックス #FF00FF ( mask_color でカスタマイズ) で重ねられます。マスクは不可視要素にも適用されます。これを無効にするには 可視要素のみを照合する を参照してください。

  • mask_color str (オプション)追加されたバージョン: v1.35#

    CSSカラー形式で、マスクされた要素のオーバーレイボックスの色を指定します。デフォルトの色はピンク#FF00FFです。

  • omit_background bool (optional)#

    デフォルトの白い背景を非表示にし、透過性のあるスクリーンショットをキャプチャできるようにします。jpeg画像には適用されません。デフォルトはfalseです。

  • path Union[str, pathlib.Path] (optional)#

    画像を保存するファイルパス。スクリーンショットのタイプはファイル拡張子から推測されます。path が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。パスが指定されていない場合、画像はディスクに保存されません。

  • quality int (optional)#

    画像の品質（0～100）。png画像には適用されません。

  • scale "css" | "device" (optional)#

    "css"に設定すると、スクリーンショットはページ上の各CSSピクセルにつき1ピクセルになります。高DPIデバイスの場合、これによりスクリーンショットが小さく保たれます。"device"オプションを使用すると、各デバイスピクセルにつき1ピクセルが生成されるため、高DPIデバイスのスクリーンショットは2倍以上大きくなります。

    デフォルトは"device"です。

  • style str (オプション)追加日: v1.41#

    スクリーンショット作成時に適用するスタイルシートのテキスト。これにより、動的な要素を非表示にしたり、要素を見えなくしたり、プロパティを変更したりして、再現性のあるスクリーンショットを作成するのに役立ちます。このスタイルシートはShadow DOMを貫通し、内部フレームにも適用されます。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • type "png" | "jpeg" (optional)#

    スクリーンショットの種類を指定します。デフォルトはpngです。

戻り値

set_content​

v1.9より前に追加 page.set_content

このメソッドは内部的に document.write() を呼び出し、そのすべての特定の特性と動作を継承します。

使用法

page.set_content(html)
page.set_content(html, **kwargs)

引数

  • html str#

    ページに割り当てる HTML マークアップ。

  • timeout float (optional)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (optional)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

set_default_navigation_timeout​

v1.9より前に追加 page.set_default_navigation_timeout

この設定は、以下のメソッドと関連するショートカットのデフォルトの最大ナビゲーション時間を変更します。

注

page.set_default_navigation_timeout() は、page.set_default_timeout()、browser_context.set_default_timeout()、および browser_context.set_default_navigation_timeout() よりも優先されます。

使用法

page.set_default_navigation_timeout(timeout)

引数

  • timeout float#

    最大ナビゲーション時間 (ミリ秒)

set_default_timeout​

v1.9より前に追加 page.set_default_timeout

この設定は、timeoutオプションを受け入れるすべてのメソッドのデフォルトの最大時間を変更します。

注

page.set_default_navigation_timeout() は、page.set_default_timeout() よりも優先されます。

使用法

page.set_default_timeout(timeout)

引数

  • timeout float#

    最大時間 (ミリ秒)。タイムアウトを無効にするには 0 を渡します。

set_extra_http_headers​

v1.9より前に追加 page.set_extra_http_headers

追加のHTTPヘッダーは、ページが開始するすべてのリクエストとともに送信されます。

注

page.set_extra_http_headers() は、送信リクエストのヘッダーの順序を保証しません。

使用法

page.set_extra_http_headers(headers)

引数

  • headers Dict[str, str]#

    すべてのリクエストとともに送信される追加の HTTP ヘッダーを含むオブジェクト。すべてのヘッダー値は文字列である必要があります。

戻り値

set_viewport_size​

v1.9より前に追加 page.set_viewport_size

単一のブラウザに複数のページがある場合、各ページは独自のビューポートサイズを持つことができます。ただし、browser.new_context() を使用すると、コンテキスト内のすべてのページに対してビューポートサイズ (およびその他) を一度に設定できます。

page.set_viewport_size() はページのサイズを変更します。多くのウェブサイトは電話がサイズを変更することを想定していないため、ページに移動する前にビューポートサイズを設定する必要があります。page.set_viewport_size() は screen サイズもリセットします。これらのプロパティをより細かく制御する必要がある場合は、screen と viewport パラメータを指定して browser.new_context() を使用してください。

使用法

page = browser.new_page()
page.set_viewport_size({"width": 640, "height": 480})
page.goto("https://example.com")

引数

  • viewport_size Dict#

    • width int

      ページ幅（ピクセル単位）。

    • height int

      ページ高さ（ピクセル単位）。

戻り値

title​

v1.9より前に追加 page.title

ページのタイトルを返します。

使用法

page.title()

戻り値

unroute​

v1.9より前に追加 page.unroute

page.route() で作成されたルートを削除します。handler が指定されていない場合、url のすべてのルートを削除します。

使用法

page.unroute(url)
page.unroute(url, **kwargs)

引数

  • url str | Pattern | Callable[URL]:bool#

    ルーティング中に一致する URL を受け取る glob パターン、正規表現パターン、または述語。

  • handler Callable[Route, Request]:Promise[Any] | Any (optional)#

    リクエストをルーティングするためのオプションのハンドラー関数。

戻り値

unroute_all​

追加日: v1.41 page.unroute_all

page.route() および page.route_from_har() で作成されたすべてのルートを削除します。

使用法

page.unroute_all()
page.unroute_all(**kwargs)

引数

  • behavior "wait" | "ignoreErrors" | "default" (optional)#

    既に実行中のハンドラを待機するかどうか、およびエラーがスローされた場合の対処方法を指定します。

    • 'default' - 現在のハンドラ呼び出し (もしあれば) の完了を待たず、アンルートされたハンドラがエラーをスローした場合、未処理のエラーが発生する可能性があります。
    • 'wait' - 現在のハンドラ呼び出し (もしあれば) の完了を待ちます。
    • 'ignoreErrors' - 現在のハンドラ呼び出し (もしあれば) の完了を待たず、アンルーティング後にハンドラによってスローされたすべてのエラーは静かにキャッチされます。

戻り値

wait_for_event​

v1.9より前に追加 page.wait_for_event
注

ほとんどの場合、page.expect_event() を使用する必要があります。

指定された event が発生するまで待ちます。述語が指定されている場合、イベントの値を predicate 関数に渡し、predicate(event) が真値を返すまで待ちます。event が発生する前にページが閉じられた場合、エラーがスローされます。

使用法

page.wait_for_event(event)
page.wait_for_event(event, **kwargs)

引数

  • event str#

    イベント名。通常、*.on(event) に渡されるものと同じです。

  • predicate Callable (optional)#

    イベントデータを受け取り、待機が解決されるべき場合にtruthyな値に解決されます。

  • timeout float (optional)#

    待機する最大時間（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。デフォルト値はbrowser_context.set_default_timeout()で変更できます。

戻り値

wait_for_function​

v1.9より前に追加 page.wait_for_function

expression が真値を返すと解決されます。真値の JSHandle に解決されます。

使用法

page.wait_for_function() はビューポートサイズの変更を監視するために使用できます

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    webkit = playwright.webkit
    browser = webkit.launch()
    page = browser.new_page()
    page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
    page.wait_for_function("() => window.x > 0")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

page.wait_for_function() 関数の述語に引数を渡すには

selector = ".foo"
page.wait_for_function("selector => !!document.querySelector(selector)", selector)

引数

  • expression str#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (optional)#

    expression に渡すオプションの引数。

  • polling float | "raf" (optional)#

    polling が 'raf' の場合、expression は requestAnimationFrame コールバックで継続的に実行されます。polling が数値の場合、関数が実行されるミリ秒単位の間隔として扱われます。デフォルトは raf です。

  • timeout float (optional)#

    待機する最大時間（ミリ秒単位）。デフォルトは 30000（30秒）です。タイムアウトを無効にするには 0 を渡します。デフォルト値は、browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

wait_for_load_state​

v1.9より前に追加 page.wait_for_load_state

必要な読み込み状態に到達すると解決されます。

これは、ページがデフォルトで load という必要な読み込み状態に達したときに解決します。このメソッドが呼び出されたときにナビゲーションがコミットされている必要があります。現在のドキュメントがすでに必要な状態に達している場合は、すぐに解決されます。

注

ほとんどの場合、Playwright は すべてのアクションの前に自動的に待機する ため、このメソッドは必要ありません。

使用法

page.get_by_role("button").click() # click triggers navigation.
page.wait_for_load_state() # the promise resolves after "load" event.
with page.expect_popup() as page_info:
    page.get_by_role("button").click() # click triggers a popup.
popup = page_info.value
# Wait for the "DOMContentLoaded" event.
popup.wait_for_load_state("domcontentloaded")
print(popup.title()) # popup is ready to use.

引数

  • state "load" | "domcontentloaded" | "networkidle" (optional)#

    待機するオプションの読み込み状態。デフォルトは load です。現在のドキュメントの読み込み中にすでに状態に達している場合、メソッドはすぐに解決します。次のいずれかです。

    • 'load' - load イベントが発火するまで待ちます。
    • 'domcontentloaded' - DOMContentLoaded イベントが発火するまで待ちます。
    • 'networkidle' - 推奨されません 少なくとも 500 ミリ秒間ネットワーク接続がないまで待ちます。テストにはこのメソッドを使用せず、代わりにウェブアサーションに頼って準備状況を評価してください。

  • timeout float (optional)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

wait_for_url​

追加されたバージョン: v1.11 page.wait_for_url

メインフレームが指定されたURLにナビゲートするのを待ちます。

使用法

page.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
page.wait_for_url("**/target.html")

引数

  • url str | Pattern | Callable[URL]:bool#

    ナビゲーションを待っている間、一致する URL を受け取る glob パターン、正規表現パターン、または述語。パラメータがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に一致する URL へのナビゲーションを待機することに注意してください。

  • timeout float (optional)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (optional)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

プロパティ​

clock​

追加されたバージョン: v1.45 page.clock

Playwright には、クロックと時間の経過をモックする機能があります。

使用法

page.clock

タイプ

context​

v1.9より前に追加 page.context

ページが属するブラウザコンテキストを取得します。

使用法

page.context

戻り値

frames​

v1.9より前に追加 page.frames

ページにアタッチされたすべてのフレームの配列。

使用法

page.frames

戻り値

is_closed​

v1.9より前に追加 page.is_closed

ページが閉じられたことを示します。

使用法

page.is_closed()

戻り値

keyboard​

v1.9より前に追加 page.keyboard

使用法

page.keyboard

タイプ

main_frame​

v1.9より前に追加 page.main_frame

ページのメインフレーム。ページにはナビゲーション中に持続するメインフレームがあることが保証されます。

使用法

page.main_frame

戻り値

mouse​

v1.9より前に追加 page.mouse

使用法

page.mouse

タイプ

request​

追加バージョン: v1.16 page.request

このページに関連付けられた API テスト ヘルパー。このメソッドは、ページのコンテキストにある browser_context.request と同じインスタンスを返します。詳細については browser_context.request を参照してください。

使用法

page.request

タイプ

touchscreen​

v1.9より前に追加 page.touchscreen

使用法

page.touchscreen

タイプ

url​

v1.9より前に追加 page.url

使用法

page.url

戻り値

video​

v1.9より前に追加 page.video

このページに関連付けられたビデオオブジェクト。

使用法

page.video

戻り値

viewport_size​

v1.9より前に追加 page.viewport_size

使用法

page.viewport_size

戻り値

  • NoneType | Dict#

    • width int

      ページ幅（ピクセル単位）。

    • height int

      ページ高さ（ピクセル単位）。

workers​

v1.9より前に追加 page.workers

このメソッドは、ページに関連付けられたすべての専用 WebWorkers を返します。

注

これにはサービスワーカーは含まれません

使用法

page.workers

戻り値

イベント​

on("close")​

v1.9より前に追加 page.on("close")

ページが閉じられたときに発行されます。

使用法

page.on("close", handler)

イベントデータ

on("console")​

v1.9より前に追加 page.on("console")

ページ内の JavaScript が console.log や console.dir などのコンソール API メソッドのいずれかを呼び出したときに発生します。

console.log に渡された引数は、ConsoleMessage イベントハンドラ引数で利用できます。

使用法

def print_args(msg):
    for arg in msg.args:
        print(arg.json_value())

page.on("console", print_args)
page.evaluate("console.log('hello', 5, { foo: 'bar' })")

イベントデータ

on("crash")​

v1.9より前に追加 page.on("crash")

ページがクラッシュしたときに発行されます。ブラウザページは、あまりにも多くのメモリを割り当てようとするとクラッシュする可能性があります。ページがクラッシュすると、進行中およびその後の操作は例外をスローします。

クラッシュに対処する最も一般的な方法は、例外をキャッチすることです。

try:
    # crash might happen during a click.
    page.click("button")
    # or while waiting for an event.
    page.wait_for_event("popup")
except Error as e:
    pass
    # when the page crashes, exception message contains "crash".

使用法

page.on("crash", handler)

イベントデータ

on("dialog")​

v1.9より前に追加 page.on("dialog")

alert、prompt、confirm、beforeunload などのJavaScriptダイアログが表示されたときに発行されます。リスナーは、ダイアログを dialog.accept() または dialog.dismiss() する必要があります。そうしないと、ページがダイアログを待機して フリーズ し、クリックなどのアクションが完了しなくなります。

使用法

page.on("dialog", lambda dialog: dialog.accept())
注

page.on("dialog") または browser_context.on("dialog") リスナーがない場合、すべてのダイアログは自動的に閉じられます。

イベントデータ

on("domcontentloaded")​

追加バージョン: v1.9 page.on("domcontentloaded")

JavaScript DOMContentLoaded イベントがディスパッチされたときに発行されます。

使用法

page.on("domcontentloaded", handler)

イベントデータ

on("download")​

v1.9より前に追加 page.on("download")

添付ファイルのダウンロードが開始されたときに発行されます。ユーザーは、渡された Download インスタンスを介して、ダウンロードされたコンテンツに対する基本的なファイル操作にアクセスできます。

使用法

page.on("download", handler)

イベントデータ

on("filechooser")​

追加バージョン: v1.9 page.on("filechooser")

<input type=file> をクリックした後など、ファイル選択が表示されるときに発行されます。Playwright は、file_chooser.set_files() を使用して入力ファイルをその後アップロードできるように設定することで、これに応答できます。

page.on("filechooser", lambda file_chooser: file_chooser.set_files("/tmp/myfile.pdf"))

使用法

page.on("filechooser", handler)

イベントデータ

on("frameattached")​

追加バージョン: v1.9 page.on("frameattached")

フレームがアタッチされたときに発行されます。

使用法

page.on("frameattached", handler)

イベントデータ

on("framedetached")​

追加バージョン: v1.9 page.on("framedetached")

フレームがデタッチされたときに発行されます。

使用法

page.on("framedetached", handler)

イベントデータ

on("framenavigated")​

追加バージョン: v1.9 page.on("framenavigated")

フレームが新しいURLにナビゲートされたときに発行されます。

使用法

page.on("framenavigated", handler)

イベントデータ

on("load")​

v1.9より前に追加 page.on("load")

JavaScript load イベントがディスパッチされたときに発行されます。

使用法

page.on("load", handler)

イベントデータ

on("pageerror")​

追加バージョン: v1.9 page.on("pageerror")

ページ内でキャッチされない例外が発生したときに発行されます。

# Log all uncaught errors to the terminal
page.on("pageerror", lambda exc: print(f"uncaught exception: {exc}"))

# Navigate to a page with an exception.
page.goto("data:text/html,<script>throw new Error('test')</script>")

使用法

page.on("pageerror", handler)

イベントデータ

on("popup")​

v1.9より前に追加 page.on("popup")

ページが新しいタブまたはウィンドウを開いたときに発行されます。このイベントは browser_context.on("page") に加えて発行されますが、このページに関連するポップアップのみが対象です。

ページが利用可能になる最も早いタイミングは、初期URLに移動したときです。たとえば、window.open('http://example.com') でポップアップを開く場合、このイベントは「http://example.com」へのネットワークリクエストが完了し、その応答がポップアップでロードを開始したときに発生します。このネットワークリクエストをルーティング/リッスンしたい場合は、Page の同様のメソッドの代わりに、それぞれ browser_context.route() と browser_context.on("request") を使用してください。

with page.expect_event("popup") as page_info:
    page.get_by_text("open the popup").click()
popup = page_info.value
print(popup.evaluate("location.href"))
注

ページが特定の状態になるまで待機するには、page.wait_for_load_state() を使用します (ほとんどの場合、必要ありません)。

使用法

page.on("popup", handler)

イベントデータ

on("request")​

v1.9より前に追加 page.on("request")

ページがリクエストを発行したときに発行されます。request オブジェクトは読み取り専用です。リクエストを傍受して変更するには、page.route() または browser_context.route() を参照してください。

使用法

page.on("request", handler)

イベントデータ

on("requestfailed")​

追加バージョン: v1.9 page.on("requestfailed")

リクエストがタイムアウトなどで失敗したときに発行されます。

page.on("requestfailed", lambda request: print(request.url + " " + request.failure.error_text))
注

404や503などのHTTPエラー応答は、HTTPの観点からは依然として成功した応答であるため、リクエストはpage.on("requestfinished")イベントで完了し、page.on("requestfailed")では完了しません。リクエストは、クライアントがサーバーからHTTP応答を取得できない場合（例: ネットワークエラー net::ERR_FAILED のため）にのみ失敗と見なされます。

使用法

page.on("requestfailed", handler)

イベントデータ

on("requestfinished")​

追加バージョン: v1.9 page.on("requestfinished")

レスポンスボディのダウンロード後にリクエストが正常に完了したときに発行されます。成功したレスポンスの場合、イベントのシーケンスは request、response、requestfinished です。

使用法

page.on("requestfinished", handler)

イベントデータ

on("response")​

v1.9より前に追加 page.on("response")

リクエストの response ステータスとヘッダーが受信されたときに発行されます。成功したレスポンスの場合、イベントの順序は request、response、requestfinished です。

使用法

page.on("response", handler)

イベントデータ

on("websocket")​

追加バージョン: v1.9 page.on("websocket")

WebSocket リクエストが送信されたときに発行されます。

使用法

page.on("websocket", handler)

イベントデータ

on("worker")​

v1.9より前に追加 page.on("worker")

専用の WebWorker がページによって生成されたときに発行されます。

使用法

page.on("worker", handler)

イベントデータ

非推奨​

accessibility​

v1.9より前に追加 page.accessibility
非推奨

このプロパティは非推奨です。ページのアクセシビリティをテストする必要がある場合は、Axe などの他のライブラリを使用してください。Axe との統合については、Node.js の ガイド を参照してください。

使用法

page.accessibility

タイプ

check​

v1.9より前に追加 page.check
推奨されません

代わりにロケーターベースのlocator.check()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selector に一致する要素をチェックします。

  1. selector に一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. 一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはスローします。要素がすでにチェックされている場合、このメソッドはすぐに戻ります。
  3. force オプションが設定されていない限り、一致する要素に対する actionability チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  4. 必要に応じて要素を表示するためにスクロールします。
  5. page.mouse を使用して要素の中央をクリックします。
  6. 要素が現在チェックされていることを確認します。そうでない場合、このメソッドはスローします。

指定された timeout の間にすべての手順が完了しない場合、このメソッドは TimeoutError をスローします。タイムアウトをゼロにすると、これを無効にします。

使用法

page.check(selector)
page.check(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • force bool (optional)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • no_wait_after bool (optional)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • position Dict (オプション)追加されたバージョン: v1.11#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)追加されたバージョン: v1.11#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

click​

v1.9より前に追加 page.click
推奨されません

代わりにロケーターベースのlocator.click()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selector に一致する要素をクリックします。

  1. selector に一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. force オプションが設定されていない限り、一致する要素に対する actionability チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. 要素の中央または指定された position でクリックするには page.mouse を使用します。
  5. no_wait_after オプションが設定されていない限り、開始されたナビゲーションが成功または失敗するまで待ちます。

指定された timeout の間にすべての手順が完了しない場合、このメソッドは TimeoutError をスローします。タイムアウトをゼロにすると、これを無効にします。

使用法

page.click(selector)
page.click(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • button "left" | "right" | "middle" (optional)#

    デフォルトは left です。

  • click_count int (optional)#

    デフォルトは 1 です。UIEvent.detail を参照してください。

  • delay float (optional)#

    mousedown と mouseup の間の待機時間 (ミリ秒単位)。デフォルトは 0 です。

  • force bool (optional)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (optional)#

    押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

  • no_wait_after bool (optional)#

    非推奨

    このオプションは将来 true になります。

    ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページがロードを開始するのを待機します。このフラグを設定することで、待機をオプトアウトできます。これは、アクセスできないページにナビゲートするなどの例外的な場合にのみ必要です。デフォルトは false です。

  • position Dict (optional)#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)追加されたバージョン: v1.11#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。キーボードの modifiers は、それらのキーが押されているときにのみ表示される要素をテストするために、trial に関係なく押されます。

戻り値

dblclick​

v1.9より前に追加 page.dblclick
推奨されません

代わりにロケーターベースのlocator.dblclick()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selector に一致する要素をダブルクリックします。

  1. selector に一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. force オプションが設定されていない限り、一致する要素に対する actionability チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. 要素の中央または指定された position でダブルクリックするには page.mouse を使用します。

指定された timeout の間にすべての手順が完了しない場合、このメソッドは TimeoutError をスローします。タイムアウトをゼロにすると、これを無効にします。

注

page.dblclick()は、2つのclickイベントと1つのdblclickイベントをディスパッチします。

使用法

page.dblclick(selector)
page.dblclick(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • button "left" | "right" | "middle" (optional)#

    デフォルトは left です。

  • delay float (optional)#

    mousedown と mouseup の間の待機時間 (ミリ秒単位)。デフォルトは 0 です。

  • force bool (optional)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (optional)#

    押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

  • no_wait_after bool (optional)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • position Dict (optional)#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)追加されたバージョン: v1.11#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。キーボードの modifiers は、それらのキーが押されているときにのみ表示される要素をテストするために、trial に関係なく押されます。

戻り値

dispatch_event​

v1.9より前に追加 page.dispatch_event
推奨されません

代わりにロケーターベースのlocator.dispatch_event()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

以下のスニペットは、要素に対して click イベントをディスパッチします。要素の表示状態にかかわらず、click がディスパッチされます。これは element.click() を呼び出すことと同等です。

使用法

page.dispatch_event("button#submit", "click")

内部では、指定された type に基づいてイベントのインスタンスを作成し、event_init プロパティで初期化し、要素にディスパッチします。イベントはデフォルトで composed、cancelable、バブルします。

event_init はイベント固有であるため、初期プロパティのリストについてはイベントドキュメントを参照してください。

ライブオブジェクトをイベントに渡したい場合は、JSHandle をプロパティ値として指定することもできます。

# note you can only create data_transfer in chromium and firefox
data_transfer = page.evaluate_handle("new DataTransfer()")
page.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • type str#

    DOM イベントタイプ: "click"、"dragstart" など。

  • event_init EvaluationArgument (optional)#

    オプションのイベント固有の初期化プロパティ。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

eval_on_selector​

追加バージョン: v1.9 page.eval_on_selector
推奨されません

このメソッドは、要素がアクション性チェックに合格するのを待たないため、不安定なテストにつながる可能性があります。locator.evaluate()、その他の Locator ヘルパーメソッド、またはウェブファーストアサーションを使用してください。

このメソッドは、ページ内で指定されたセレクタに一致する要素を見つけ、それを expression の最初の引数として渡します。要素がセレクタに一致しない場合、このメソッドはエラーをスローします。expression の値を返します。

expression が Promise を返す場合、page.eval_on_selector() は Promise が解決されるまで待機し、その値を返します。

使用法

search_value = page.eval_on_selector("#search", "el => el.value")
preload_href = page.eval_on_selector("link[rel=preload]", "el => el.href")
html = page.eval_on_selector(".main-container", "(e, suffix) => e.outer_html + suffix", "hello")

引数

  • selector str#

    クエリするセレクター。

  • expression str#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (optional)#

    expression に渡すオプションの引数。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

戻り値

eval_on_selector_all​

追加バージョン: v1.9 page.eval_on_selector_all
推奨されません

ほとんどの場合、locator.evaluate_all()、その他のLocatorヘルパーメソッド、およびウェブ優先のアサーションの方が優れています。

このメソッドは、ページ内で指定されたセレクタに一致するすべての要素を見つけ、一致する要素の配列を expression の最初の引数として渡します。expression の呼び出し結果を返します。

expression が Promise を返す場合、page.eval_on_selector_all() は Promise が解決されるまで待機し、その値を返します。

使用法

div_counts = page.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)

引数

  • selector str#

    クエリするセレクター。

  • expression str#

    ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

  • arg EvaluationArgument (optional)#

    expression に渡すオプションの引数。

戻り値

expect_navigation​

v1.9より前に追加 page.expect_navigation
非推奨

このメソッドは本質的に競合状態になりやすいので、代わりに page.wait_for_url() を使用してください。

メインフレームのナビゲーションを待機し、メインリソースのレスポンスを返します。複数のリダイレクトが発生した場合、ナビゲーションは最後のRリダイレクトのレスポンスで解決されます。異なるアンカーへのナビゲーションやHistory APIの使用によるナビゲーションの場合、ナビゲーションはnullで解決されます。

使用法

これは、ページが新しいURLにナビゲートするか、再読み込みされるときに解決されます。ページが間接的にナビゲーションを引き起こすコードを実行する場合に便利です。例えば、クリックターゲットにsetTimeoutからナビゲーションをトリガーするonclickハンドラーがある場合などです。この例を考えてみてください。

with page.expect_navigation():
    # This action triggers the navigation after a timeout.
    page.get_by_text("Navigate after timeout").click()
# Resolves after navigation has finished
注

URL を変更するために History API を使用することは、ナビゲーションと見なされます。

引数

  • timeout float (optional)#

    最大操作時間 (ミリ秒単位)。デフォルトは 30 秒です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout()、または page.set_default_timeout() メソッドを使用して変更できます。

  • url str | Pattern | Callable[URL]:bool (optional)#

    ナビゲーションを待っている間、一致する URL を受け取る glob パターン、正規表現パターン、または述語。パラメータがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に一致する URL へのナビゲーションを待機することに注意してください。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (optional)#

    操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかです。

    • 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したと見なします。
    • 'load' - loadイベントが発火したときに操作が終了したと見なします。
    • 'networkidle' - 推奨されません 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
    • 'commit' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が終了したと見なします。

戻り値

fill​

v1.9より前に追加 page.fill
推奨されません

代わりにロケーターベースのlocator.fill()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、selector に一致する要素を待ち、actionability チェックを待ち、要素にフォーカスし、入力し、入力後に input イベントをトリガーします。入力フィールドをクリアするために空の文字列を渡すことができることに注意してください。

ターゲット要素が <input>、<textarea>、または [contenteditable] 要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連付けられた コントロール を持つ <label> 要素内にある場合、代わりにコントロールが入力されます。

きめ細かなキーボードイベントを送信するには、locator.press_sequentially() を使用します。

使用法

page.fill(selector, value)
page.fill(selector, value, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • value str#

    <input>、<textarea> または [contenteditable] 要素に入力する値。

  • force bool (オプション)追加バージョン: v1.13#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • no_wait_after bool (optional)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

focus​

v1.9より前に追加 page.focus
推奨されません

代わりにロケーターベースのlocator.focus()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、selector に一致する要素を取得し、それにフォーカスします。selector に一致する要素がない場合、メソッドは一致する要素がDOMに表示されるまで待機します。

使用法

page.focus(selector)
page.focus(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

get_attribute​

v1.9より前に追加 page.get_attribute
推奨されません

代わりにロケーターベースのlocator.get_attribute()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素の属性値を返します。

使用法

page.get_attribute(selector, name)
page.get_attribute(selector, name, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • name str#

    値を取得する属性名。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

hover​

v1.9より前に追加 page.hover
推奨されません

代わりにロケーターベースのlocator.hover()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、以下の手順を実行して、selector に一致する要素にカーソルを合わせます。

  1. selector に一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. force オプションが設定されていない限り、一致する要素に対する actionability チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. 要素の中央または指定された position にカーソルを合わせるには page.mouse を使用します。

指定された timeout の間にすべての手順が完了しない場合、このメソッドは TimeoutError をスローします。タイムアウトをゼロにすると、これを無効にします。

使用法

page.hover(selector)
page.hover(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • force bool (optional)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (optional)#

    押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

  • no_wait_after bool (オプション)追加バージョン: v1.28#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • position Dict (optional)#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)追加されたバージョン: v1.11#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。キーボードの modifiers は、それらのキーが押されているときにのみ表示される要素をテストするために、trial に関係なく押されます。

戻り値

inner_html​

v1.9より前に追加 page.inner_html
推奨されません

代わりにロケーターベースのlocator.inner_html()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

element.innerHTML を返します。

使用法

page.inner_html(selector)
page.inner_html(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

inner_text​

v1.9より前に追加 page.inner_text
推奨されません

代わりにロケーターベースのlocator.inner_text()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

element.innerText を返します。

使用法

page.inner_text(selector)
page.inner_text(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

input_value​

追加バージョン: v1.13 page.input_value
推奨されません

代わりにロケーターベースのlocator.input_value()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

選択した <input>、<textarea>、または <select> 要素の input.value を返します。

非入力要素の場合はスローされます。ただし、要素が関連する コントロールを持つ <label> 要素内にある場合は、コントロールの値を返します。

使用法

page.input_value(selector)
page.input_value(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

is_checked​

v1.9より前に追加 page.is_checked
推奨されません

代わりにロケーターベースのlocator.is_checked()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素がチェックされているかどうかを返します。要素がチェックボックスまたはラジオ入力でない場合、スローします。

使用法

page.is_checked(selector)
page.is_checked(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

is_disabled​

v1.9より前に追加 page.is_disabled
推奨されません

代わりにロケーターベースのlocator.is_disabled()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が無効になっているかどうか (つまり、有効の反対) を返します。

使用法

page.is_disabled(selector)
page.is_disabled(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

is_editable​

v1.9より前に追加 page.is_editable
推奨されません

代わりにロケーターベースのlocator.is_editable()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が編集可能であるかどうかを返します。

使用法

page.is_editable(selector)
page.is_editable(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

is_enabled​

v1.9より前に追加 page.is_enabled
推奨されません

代わりにロケータベースの locator.is_enabled() を使用してください。ロケータ の詳細については、こちらをご覧ください。

要素が 有効 かどうかを返します。

使用法

page.is_enabled(selector)
page.is_enabled(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

is_hidden​

v1.9より前に追加 page.is_hidden
推奨されません

代わりにロケーターベースのlocator.is_hidden()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が非表示かどうかを返します。visible の反対です。どの要素にも一致しない selector は非表示と見なされます。

使用法

page.is_hidden(selector)
page.is_hidden(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (optional)#

    非推奨

    このオプションは無視されます。page.is_hidden() は要素が非表示になるのを待たずにすぐに戻ります。

戻り値

is_visible​

v1.9より前に追加 page.is_visible
推奨されません

代わりにロケーターベースのlocator.is_visible()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素が visible かどうかを返します。どの要素にも一致しない selector は非表示と見なされます。

使用法

page.is_visible(selector)
page.is_visible(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    非推奨

    このオプションは無視されます。page.is_visible() は要素が可視になるのを待たずに即座に返します。

戻り値

press​

v1.9より前に追加 page.press
推奨されません

代わりにロケーターベースのlocator.press()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

要素にフォーカスを当て、keyboard.down() と keyboard.up() を使用します。

key には、目的の keyboardEvent.key の値、またはテキストを生成するための単一の文字を指定できます。key の値のスーパーセットはこちらで確認できます。キーの例は次のとおりです。

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUpなど。

以下の修飾ショートカットもサポートされています：Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta。 ControlOrMetaはWindowsおよびLinuxではControlに、macOSではMetaに解決されます。

Shift を押し続けると、key に対応するテキストが大文字で入力されます。

key が単一の文字である場合、大文字と小文字が区別されるため、値 a と A はそれぞれ異なるテキストを生成します。

key: "Control+o"、key: "Control++、key: "Control+Shift+T"のようなショートカットもサポートされています。修飾キーを指定した場合、修飾キーは押し続けられ、その後に続くキーが押されます。

使用法

page = browser.new_page()
page.goto("https://keycode.info")
page.press("body", "A")
page.screenshot(path="a.png")
page.press("body", "ArrowLeft")
page.screenshot(path="arrow_left.png")
page.press("body", "Shift+O")
page.screenshot(path="o.png")
browser.close()

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • key str#

    押すキーの名前、または ArrowLeft や a などの生成する文字。

  • delay float (オプション)#

    keydown と keyup の間の待機時間 (ミリ秒)。デフォルトは 0 です。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは将来 true になります。

    ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページがロードを開始するのを待機します。このフラグを設定することで、待機をオプトアウトできます。これは、アクセスできないページにナビゲートするなどの例外的な場合にのみ必要です。デフォルトは false です。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

query_selector​

追加バージョン: v1.9 page.query_selector
推奨されません

代わりにロケータベースの page.locator() を使用してください。ロケータの詳細をご覧ください。

このメソッドは、指定されたセレクターに一致する要素をページ内で見つけます。セレクターに一致する要素がない場合、戻り値は null に解決されます。ページ上の要素を待機するには、locator.wait_for() を使用します。

使用法

page.query_selector(selector)
page.query_selector(selector, **kwargs)

引数

  • selector str#

    クエリするセレクター。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

戻り値

query_selector_all​

追加バージョン: v1.9 page.query_selector_all
推奨されません

代わりにロケータベースの page.locator() を使用してください。ロケータの詳細をご覧ください。

このメソッドは、ページ内で指定されたセレクターに一致するすべての要素を検索します。セレクターに一致する要素がない場合、戻り値は [] に解決されます。

使用法

page.query_selector_all(selector)

引数

  • selector str#

    クエリするセレクター。

戻り値

select_option​

v1.9より前に追加 page.select_option
推奨されません

代わりにロケーターベースのlocator.select_option()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、セレクターに一致する要素を待機し、アクション可能性のチェックを待機し、すべての指定されたオプションが <select> 要素内に存在するまで待機して、それらのオプションを選択します。

ターゲット要素が<select>要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連するコントロールを持つ<label>要素内にある場合、代わりにそのコントロールが使用されます。

正常に選択されたオプション値の配列を返します。

提供されたすべてのオプションが選択されると、changeおよびinputイベントをトリガーします。

使用法

# Single selection matching the value or label
page.select_option("select#colors", "blue")
# single selection matching both the label
page.select_option("select#colors", label="blue")
# multiple selection
page.select_option("select#colors", value=["red", "green", "blue"])

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • force bool (オプション)追加バージョン: v1.13#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • element ElementHandle | List[ElementHandle] (オプション)#

    選択するオプション要素。オプション。

  • index int | List[int] (オプション)#

    インデックスで選択するオプション。オプション。

  • value str | List[str] (オプション)#

    値で選択するオプション。<select>にmultiple属性がある場合、指定されたすべてのオプションが選択され、そうでない場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。オプション。

  • label str | List[str] (オプション)#

    ラベルで選択するオプション。<select>にmultiple属性がある場合、指定されたすべてのオプションが選択され、そうでない場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。オプション。

戻り値

set_checked​

追加されたバージョン: v1.15 page.set_checked
推奨されません

代わりにロケーターベースのlocator.set_checked()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、セレクターに一致する要素を、次の手順を実行してチェックまたはチェック解除します。

  1. セレクターに一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. 一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはエラーをスローします。
  3. 要素がすでに正しいチェック状態である場合、このメソッドはすぐに戻ります。
  4. force オプションが設定されていない限り、一致する要素に対してアクション可能性のチェックを待機します。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
  5. 必要に応じて要素を表示するためにスクロールします。
  6. page.mouse を使用して要素の中央をクリックします。
  7. 要素がチェックまたはチェック解除されたことを確認します。そうでない場合、このメソッドはエラーをスローします。

すべての手順を合わせて指定されたtimeout内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロに設定すると、この機能は無効になります。

使用法

page.set_checked(selector, checked)
page.set_checked(selector, checked, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • checked bool#

    チェックボックスをチェックするか、チェックを外すか。

  • force bool (オプション)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • position Dict (オプション)#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

set_input_files​

v1.9より前に追加 page.set_input_files
推奨されません

代わりにロケーターベースのlocator.set_input_files()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

ファイル入力の値を、これらのファイルパスまたはファイルに設定します。filePaths の一部が相対パスである場合、現在の作業ディレクトリを基準に解決されます。空の配列の場合、選択されたファイルをクリアします。[webkitdirectory] 属性を持つ入力の場合、単一のディレクトリパスのみがサポートされます。

このメソッドは、セレクターが input 要素を指していることを想定しています。ただし、要素が関連付けられた コントロールを持つ <label> 要素内にある場合、代わりにコントロールを対象とします。

使用法

page.set_input_files(selector, files)
page.set_input_files(selector, files, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • files Union[str, pathlib.Path] | List[Union[str, pathlib.Path]] | Dict | List[Dict]#

    • name str

      ファイル名

    • mimeType str

      ファイルタイプ

    • buffer bytes

      ファイル内容

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

tap​

v1.9より前に追加 page.tap
推奨されません

代わりにロケーターベースのlocator.tap()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、セレクターに一致する要素を、次の手順を実行してタップします。

  1. セレクターに一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. force オプションが設定されていない限り、一致する要素に対してアクション可能性のチェックを待機します。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
  3. 必要に応じて要素を表示するためにスクロールします。
  4. page.touchscreen を使用して、要素の中央または指定された 位置をタップします。

すべての手順を合わせて指定されたtimeout内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロに設定すると、この機能は無効になります。

注

page.tap() メソッドは、ブラウザコンテキストの has_touch オプションが false の場合、例外をスローします。

使用法

page.tap(selector)
page.tap(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • force bool (オプション)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (オプション)#

    押す修飾キー。操作中にこれらの修飾キーのみが押されていることを保証し、現在の修飾キーを元に戻します。指定しない場合、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows と Linux では "Control" に、macOS では "Meta" に解決されます。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • position Dict (オプション)#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)追加されたバージョン: v1.11#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。キーボードの modifiers は、それらのキーが押されているときにのみ表示される要素をテストするために、trial に関係なく押されます。

戻り値

text_content​

v1.9より前に追加 page.text_content
推奨されません

代わりにロケーターベースのlocator.text_content()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

element.textContent を返します。

使用法

page.text_content(selector)
page.text_content(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

type​

v1.9より前に追加 page.type
非推奨

ほとんどの場合、代わりにlocator.fill()を使用してください。ページで特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。この場合はlocator.press_sequentially()を使用してください。

テキスト内の各文字に対して、keydown、keypress/input、および keyup イベントを送信します。page.type を使用して、詳細なキーボードイベントを送信できます。フォームフィールドに値を入力するには、page.fill() を使用します。

ControlやArrowDownのような特殊なキーを押すには、keyboard.press()を使用します。

使用法

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • text str#

    フォーカスされた要素に入力するテキスト。

  • delay float (オプション)#

    キー押下間の待機時間（ミリ秒）。デフォルトは0です。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

uncheck​

v1.9より前に追加 page.uncheck
推奨されません

代わりにロケーターベースのlocator.uncheck()を使用してください。ロケーターについて詳しくはこちらをご覧ください。

このメソッドは、セレクターに一致する要素を、次の手順を実行してチェック解除します。

  1. セレクターに一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. 一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはスローされます。要素がすでにチェック解除されている場合、このメソッドは即座に返します。
  3. force オプションが設定されていない限り、一致する要素に対してアクション可能性のチェックを待機します。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
  4. 必要に応じて要素を表示するためにスクロールします。
  5. page.mouse を使用して要素の中央をクリックします。
  6. 要素がチェックされていないことを確認します。そうでない場合、このメソッドはエラーをスローします。

すべての手順を合わせて指定されたtimeout内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロに設定すると、この機能は無効になります。

使用法

page.uncheck(selector)
page.uncheck(selector, **kwargs)

引数

  • selector str#

    要素を検索するセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。

  • force bool (オプション)#

    アクション性チェックをバイパスするかどうか。デフォルトは false です。

  • no_wait_after bool (オプション)#

    非推奨

    このオプションは効果がありません。

    このオプションは効果がありません。

  • position Dict (オプション)追加されたバージョン: v1.11#

    要素のパディングボックスの左上隅を基準に使用する点。指定しない場合は、要素の可視点の一部が使用されます。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

  • trial bool (オプション)追加されたバージョン: v1.11#

    設定すると、このメソッドは アクション性 チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

wait_for_selector​

v1.9より前に追加 page.wait_for_selector
推奨されません

可視性をアサートするウェブアサーション、またはロケータベースの locator.wait_for() を代わりに使用してください。ロケータの詳細をご覧ください。

セレクターで指定された要素が state オプションを満たした場合に返します。hidden または detached を待機している場合、null を返します。

注

Playwrightは、アクションを実行する前に要素が準備完了になるまで自動的に待機します。Locator オブジェクトとWebファーストのアサーションを使用すると、コードでセレクターの待機が不要になります。

セレクターが state オプション（DOMからの出現/消失、または可視/非表示）を満たすまで待機します。メソッド呼び出し時に セレクターがすでに条件を満たしている場合、メソッドは即座に返ります。セレクターが timeout ミリ秒間条件を満たさない場合、関数は例外をスローします。

使用法

このメソッドはナビゲーションをまたいで動作します

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = chromium.launch()
    page = browser.new_page()
    for current_url in ["https://google.com", "https://bbc.com"]:
        page.goto(current_url, wait_until="domcontentloaded")
        element = page.wait_for_selector("img")
        print("Loaded image: " + str(element.get_attribute("src")))
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

引数

  • selector str#

    クエリするセレクター。

  • state "attached" | "detached" | "visible" | "hidden" (オプション)#

    デフォルトは'visible'です。以下のいずれかになります。

    • 'attached' - 要素がDOMに存在することを待ちます。
    • 'detached' - 要素がDOMに存在しないことを待ちます。
    • 'visible' - 要素が空でない境界ボックスを持ち、visibility:hiddenがないことを待ちます。コンテンツがない要素やdisplay:noneの要素は空の境界ボックスを持つため、可視とはみなされないことに注意してください。
    • 'hidden' - 要素がDOMからデタッチされているか、空の境界ボックスを持つか、またはvisibility:hiddenを持つことを待ちます。これは'visible'オプションとは逆です。

  • strict bool (オプション)追加されたバージョン: v1.14#

    trueの場合、呼び出しはセレクターが単一の要素に解決されることを必要とします。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

  • timeout float (オプション)#

    最大時間 (ミリ秒)。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。

戻り値

wait_for_timeout​

v1.9より前に追加 page.wait_for_timeout
推奨されません

本番環境ではタイムアウトを待たないでください。時間を待つテストは本質的に不安定です。自動的に待機するLocatorアクションとWebアサーションを使用してください。

指定された timeout (ミリ秒) だけ待機します。

page.waitForTimeout()はデバッグ目的でのみ使用されるべきであることに注意してください。本番環境でタイマーを使用するテストは不安定になる可能性があります。代わりに、ネットワークイベント、セレクターの表示など、他のシグナルを使用してください。

使用法

# wait for 1 second
page.wait_for_timeout(1000)

引数

  • timeout float#

    待機するタイムアウト

戻り値