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

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 クラスは、NodeのネイティブEventEmitterメソッド(on、once、removeListenerなど)のいずれかを使用して処理できる様々なイベント(以下に説明)を発行します。

この例では、単一ページの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

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

このメソッドを使用すると、オーバーレイが表示されていることを検出したときに起動する特殊な関数（ハンドラ）を設定できます。ハンドラの役割はオーバーレイを削除することであり、これによりテストはオーバーレイが存在しなかったかのように続行できます。

留意事項

  • オーバーレイが予測可能に表示される場合、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()

すべてのアクション可能性チェックでカスタムコールバックを使用する例です。常に表示される<body>ロケーターを使用しているため、ハンドラはすべてのアクション可能性チェックの前に呼び出されます。ハンドラが<body>要素を非表示にしないため、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 (オプション)#

    イベントデータを受け取り、待機が解決されるべきときに真の値を返します。

  • 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

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

使用法

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

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

使用法

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)が真の値を返すのを待ちます。ワーカーイベントが発火する前にページが閉じられた場合、エラーをスローします。

使用法

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を返します。この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を実行し、Promiseを返します。このPromiseはcallbackの戻り値に解決されます。

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#

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

  • 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オブジェクトとして受け取るglobパターン、正規表現パターン、または述語。オプション。

戻り値

frame_locator​

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

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

使用法

次のスニペットは、<iframe id="my-frame">のようなID my-frameを持つiframe内で、テキスト「Submit」を持つ要素を見つけます。

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

引数

  • test_id str | Pattern#

    要素を特定するためのID。

戻り値

詳細

デフォルトでは、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

要素をそのtitle属性で特定できます。

使用法

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

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

タイトルテキストで特定した後、Issueの数をチェックできます。

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が無効な場合。
  • ナビゲーション中にタイムアウトを超過した場合。
  • リモートサーバーが応答しないか、到達不能な場合。
  • メインリソースの読み込みに失敗した場合。

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

注意

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

注意

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

使用法

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を見つけることができます。ただし、内部ロケーターは相対的であり、content外の要素を使用すべきではないため、article divを持つcontentを探すことは失敗します。

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

  • has_not Locator (オプション)追加日: v1.33#

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

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

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

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

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

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

戻り値

opener​

v1.9以前に追加 page.opener

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

使用法

page.opener()

戻り値

pause​

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

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

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

注意

このメソッドは、Playwrightがヘッドモードで、偽のheadlessオプションを付けて起動されている必要があります。

使用法

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.5in x 11in
  • Legal: 8.5in x 14in
  • Tabloid: 11in x 17in
  • Ledger: 17in x 11in
  • A0: 33.1in x 46.8in
  • A1: 23.4in x 33.1in
  • A2: 16.54in x 23.4in
  • A3: 11.7in x 16.54in
  • A4: 8.27in x 11.7in
  • A5: 5.83in x 8.27in
  • A6: 4.13in x 5.83in
注意

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 Workerによって傍受されたリクエストを傍受しません。このIssueを参照してください。リクエスト傍受を使用する際は、service_workersを'block'に設定してService Workerを無効にすることをお勧めします。

注意

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は、Service Workerによって傍受されたリクエストをHARファイルから提供しません。このIssueを参照してください。リクエスト傍受を使用する際は、service_workersを'block'に設定してService Workerを無効にすることをお勧めします。

使用法

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'に設定した場合、不足しているリクエストはネットワークに送信されます。

    デフォルトは中止です。

  • 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" (オプション)#

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

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

    デフォルトは、アニメーションに手を加えない"allow"です。

  • caret "hide" | "initial" (オプション)#

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

  • clip Dict (オプション)#

    • x float

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

    • y float

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

    • width float

      クリップ領域の幅

    • height float

      クリップ領域の高さ

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

  • full_page bool (オプション)#

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

  • mask List[Locator] (オプション)#

    スクリーンショット撮影時にマスクされるべきロケーターを指定します。マスクされた要素は、そのバウンディングボックスを完全に覆うピンクのボックス#FF00FF（mask_colorでカスタマイズ可能）で重ねられます。このマスクは不可視要素にも適用されます。それを無効にするには、可視要素のみに一致を参照してください。

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

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

  • omit_background bool (オプション)#

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

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

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

  • quality int (オプション)#

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

  • scale "css" | "device" (オプション)#

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

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

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

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

  • timeout float (オプション)#

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

  • type "png" | "jpeg" (オプション)#

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

戻り値

set_content​

v1.9以前に追加 page.set_content

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

使用法

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

引数

  • html str#

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

  • 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' - ネットワーク応答が受信され、ドキュメントの読み込みが開始されたときに操作が完了したとみなします。

戻り値

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を受け取る述語。

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

    イベントデータを受け取り、待機が解決されるべきときに真の値を返します。

  • 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を受け取る述語。パラメータがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に一致する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

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

注意

これにはServiceWorkerは含まれません

使用法

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などのconsole 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オプションが設定されていない限り、一致した要素に対するアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  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 (optional)追加バージョン: v1.11#

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

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

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

  • timeout float (optional)#

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

  • trial bool (optional)追加バージョン: v1.11#

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

戻り値

click​

v1.9以前に追加 page.click
非推奨

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

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

  1. selectorに一致する要素を見つけます。一致する要素がない場合、一致する要素がDOMにアタッチされるまで待機します。
  2. forceオプションが設定されていない限り、一致した要素に対するアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素をビューにスクロールします。
  4. page.mouseを使用して要素の中心、または指定されたpositionをクリックします。
  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 (optional)追加バージョン: v1.11#

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

戻り値

dblclick​

v1.9以前に追加 page.dblclick
非推奨

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

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

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

すべてのステップを合わせても指定された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 (optional)追加バージョン: 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()を使用してください。

メインフレームのナビゲーションを待機し、メインリソース応答を返します。複数のリダイレクトがある場合、ナビゲーションは最後のリダイレクトの応答で解決されます。異なるアンカーへのナビゲーションや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
注意

History APIを使用して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()メソッドを使用して変更できます。

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

    ナビゲーションを待機中に一致させるための、グロブパターン、正規表現パターン、またはURLを受け取る述語。パラメータがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に一致する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に一致する要素を待ち、アクション可能性チェックを待ち、要素にフォーカスし、値を入力し、入力後にinputイベントをトリガーします。入力フィールドをクリアするために空の文字列を渡すことも可能です。

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

細粒なキーボードイベントを送信するには、locator.press_sequentially()を使用してください。

使用法

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

引数

  • selector str#

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

  • value str#

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

  • force bool (optional)追加されたバージョン: 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オプションが設定されていない限り、一致した要素に対するアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
  3. 必要に応じて要素をビューにスクロールします。
  4. page.mouseを使用して要素の中心、または指定されたpositionにホバーします。

すべてのステップを合わせても指定された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 (optional)追加バージョン: 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を返します。

非入力要素に対しては例外をスローします。ただし、要素が関連付けられたcontrolを持つ<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 (オプション)#

    最大時間（ミリ秒）。デフォルトは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 (オプション)#

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

戻り値

is_hidden​

v1.9以前に追加 page.is_hidden
非推奨

代わりにロケーターベースの locator.is_hidden() を使用してください。 ロケーターの詳細についてはこちらをお読みください。

要素が非表示かどうかを返します。visibleの反対です。一致する要素がないセレクターは非表示とみなされます。

使用法

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

引数

  • selector str#

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

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

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

  • timeout float (オプション)#

    非推奨

    このオプションは無視されます。page.is_hidden() は要素が非表示になるのを待たず、直ちに返します。

戻り値

is_visible​

v1.9以前に追加 page.is_visible
非推奨

代わりにロケーターベースの locator.is_visible() を使用してください。 ロケーターの詳細についてはこちらをお読みください。

要素が可視かどうかを返します。一致する要素がないセレクターは可視とみなされません。

使用法

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 が単一文字の場合、大文字と小文字が区別されるため、値 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 (optional)追加されたバージョン: 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. 要素が現在チェックまたはアンチェックされていることを確認します。そうでない場合、このメソッドはエラーをスローします。

指定されたタイムアウト内にすべてのステップが完了しなかった場合、このメソッドは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 を使用して、要素の中心、または指定された位置をタップします。

指定されたタイムアウト内にすべてのステップが完了しなかった場合、このメソッドは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 (optional)追加バージョン: 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. 要素が現在アンチェックされていることを確認します。そうでない場合、このメソッドはエラーをスローします。

指定されたタイムアウト内にすべてのステップが完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロに設定すると、この機能は無効になります。

使用法

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

引数

  • selector str#

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

  • force bool (オプション)#

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

  • no_wait_after bool (オプション)#

    非推奨

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

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

  • position Dict (optional)追加バージョン: v1.11#

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

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

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

  • timeout float (オプション)#

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

  • trial bool (optional)追加バージョン: v1.11#

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

戻り値

wait_for_selector​

v1.9以前に追加 page.wait_for_selector
非推奨

可視性をアサートするウェブアサーション、またはロケーターベースの locator.wait_for() を使用してください。 ロケーターの詳細についてはこちらをお読みください。

セレクターで指定された要素がstateオプションを満たすときに返します。hiddenまたはdetachedを待つ場合、nullを返します。

注意

Playwrightは、アクションを実行する前に要素が準備完了になるのを自動的に待ちます。Locatorオブジェクトとウェブファーストアサーションを使用すると、コードがwait-for-selectorフリーになります。

セレクターがstateオプション（DOMに表示/非表示になるか、可視/非可視になるか）を満たすのを待ちます。メソッド呼び出し時にセレクターがすでに条件を満たしている場合、メソッドは直ちに返します。指定されたタイムアウトミリ秒間、セレクターが条件を満たさない場合、関数はエラーをスローします。

使用法

このメソッドはナビゲーションをまたいで動作します。

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アクションとウェブアサーションを使用してください。

指定されたタイムアウトミリ秒間待ちます。

page.waitForTimeout()はデバッグ目的でのみ使用すべきであることに注意してください。本番環境でタイマーを使用するテストは不安定になります。代わりにネットワークイベントやセレクターの可視化などのシグナルを使用してください。

使用法

# wait for 1 second
page.wait_for_timeout(1000)

引数

  • timeout float#

    待機するタイムアウト

戻り値