Frame

ページは、page.main_frame および frame.child_frames メソッドを介して、現在のフレームツリーを公開しています。

Frame オブジェクトのライフサイクルは、ページオブジェクトでディスパッチされる3つのイベントによって制御されます

page.on("frameattached") - フレームがページにアタッチされたときに発火します。Frame はページに一度だけアタッチできます。
page.on("framenavigated") - フレームが異なる URL へのナビゲーションをコミットしたときに発火します。
page.on("framedetached") - フレームがページからデタッチされたときに発火します。Frame はページから一度だけデタッチできます。

フレームツリーのダンプの例

同期
非同期

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    firefox = playwright.firefox
    browser = firefox.launch()
    page = browser.new_page()
    page.goto("https://www.theverge.com")
    dump_frame_tree(page.main_frame, "")
    browser.close()

def dump_frame_tree(frame, indent):
    print(indent + frame.name + '@' + frame.url)
    for child in frame.child_frames:
        dump_frame_tree(child, indent + "    ")

with sync_playwright() as playwright:
    run(playwright)

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    firefox = playwright.firefox
    browser = await firefox.launch()
    page = await browser.new_page()
    await page.goto("https://www.theverge.com")
    dump_frame_tree(page.main_frame, "")
    await browser.close()

def dump_frame_tree(frame, indent):
    print(indent + frame.name + '@' + frame.url)
    for child in frame.child_frames:
        dump_frame_tree(child, indent + "    ")

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

メソッド

add_script_tag

v1.9より前に追加

frame.add_script_tag

スクリプトの onload が発火したとき、またはスクリプトコンテンツがフレームに挿入されたときに、追加されたタグを返します。

目的の URL またはコンテンツを持つ <script> タグをページに追加します。

使用法

frame.add_script_tag()
frame.add_script_tag(**kwargs)

引数

content str (オプション)#

フレームに挿入される生の JavaScript コンテンツ。
path Union[str, pathlib.Path] (オプション)#

フレームに挿入される JavaScript ファイルへのパス。path が相対パスの場合、現在の作業ディレクトリに対して相対的に解決されます。
type str (オプション)#

スクリプトタイプ。JavaScript ES6 モジュールをロードするには 'module' を使用します。詳細については、script を参照してください。
url str (オプション)#

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

戻り値

ElementHandle #

add_style_tag

v1.9より前に追加

frame.add_style_tag

スタイルシートの onload が発火したとき、または CSS コンテンツがフレームに挿入されたときに、追加されたタグを返します。

目的の URL を持つ <link rel="stylesheet"> タグ、またはコンテンツを持つ <style type="text/css"> タグをページに追加します。

使用法

frame.add_style_tag()
frame.add_style_tag(**kwargs)

引数

content str (オプション)#

フレームに挿入される生の CSS コンテンツ。
path Union[str, pathlib.Path] (オプション)#

フレームに挿入される CSS ファイルへのパス。path が相対パスの場合、現在の作業ディレクトリに対して相対的に解決されます。
url str (オプション)#

<link> タグの URL。

戻り値

ElementHandle #

content

v1.9より前に追加

frame.content

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

使用法

frame.content()

戻り値

str #

drag_and_drop

追加: v1.13

frame.drag_and_drop

使用法

frame.drag_and_drop(source, target)
frame.drag_and_drop(source, target, **kwargs)

引数

source str #

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

ドロップ先の要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合、最初の要素が使用されます。
force bool (オプション)#

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

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

このオプションは効果がありません。
source_position Dict (オプション)追加: v1.14#
- x float
- y float
要素のパディングボックスの左上隅を基準としたこの点で、ソース要素をクリックします。指定されていない場合、要素の可視点が使用されます。
strict bool (オプション)追加: v1.14#

true の場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
target_position Dict (オプション)追加: v1.14#
- x float
- y float
要素のパディングボックスの左上隅を基準としたこの点で、ターゲット要素にドロップします。指定されていない場合、要素の可視点が使用されます。
timeout float (オプション)#

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

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

戻り値

NoneType #

evaluate

v1.9より前に追加

frame.evaluate

expression の戻り値を返します。

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

frame.evaluate() に渡された関数が非 Serializable 値を返す場合、frame.evaluate() は undefined を返します。Playwright は、JSON でシリアライズ可能でない追加の値（-0、NaN、Infinity、-Infinity）の転送もサポートしています。

使用法

同期
非同期

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

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

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

同期
非同期

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

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

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

同期
非同期

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

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

引数

expression str #

ブラウザコンテキストで評価される JavaScript 式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument (オプション)#

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

戻り値

Dict #

evaluate_handle

v1.9より前に追加

frame.evaluate_handle

expression の戻り値を JSHandle として返します。

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

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

使用法

同期
非同期

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

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

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

同期
非同期

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

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

JSHandle インスタンスは、frame.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()

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

引数

expression str #

ブラウザコンテキストで評価される JavaScript 式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument (オプション)#

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

戻り値

JSHandle #

frame_element

v1.9より前に追加

frame.frame_element

このフレームに対応する frame または iframe 要素ハンドルを返します。

これは element_handle.content_frame() の逆です。返されるハンドルは実際には親フレームに属していることに注意してください。

フレームが frameElement() が返される前にデタッチされた場合、このメソッドはエラーをスローします。

使用法

同期
非同期

frame_element = frame.frame_element()
content_frame = frame_element.content_frame()
assert frame == content_frame

frame_element = await frame.frame_element()
content_frame = await frame_element.content_frame()
assert frame == content_frame

戻り値

ElementHandle #

frame_locator

追加: v1.17

frame.frame_locator

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

使用法

次のスニペットは、my-frame という ID を持つ iframe 内で「Submit」というテキストを持つ要素を特定します (<iframe id="my-frame"> など)。

同期
非同期

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

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

引数

selector str #

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

戻り値

FrameLocator #

get_by_alt_text

追加: v1.27

frame.get_by_alt_text

要素を alt テキストで特定できるようにします。

使用法

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

<img alt='Playwright logo'>

同期
非同期

page.get_by_alt_text("Playwright logo").click()

await page.get_by_alt_text("Playwright logo").click()

引数

text str | Pattern #

要素を特定するためのテキスト。
exact bool (オプション)#

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

戻り値

Locator #

get_by_label

追加: v1.27

frame.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")

await page.get_by_label("Username").fill("john")
await page.get_by_label("Password").fill("secret")

引数

text str | Pattern #

要素を特定するためのテキスト。
exact bool (オプション)#

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

戻り値

Locator #

get_by_placeholder

追加: v1.27

frame.get_by_placeholder

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

使用法

たとえば、次の DOM 構造を考えてみましょう。

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

プレースホルダーテキストで特定した後、入力を入力できます

同期
非同期

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

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

引数

text str | Pattern #

要素を特定するためのテキスト。
exact bool (オプション)#

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

戻り値

Locator #

get_by_role

追加: v1.27

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

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

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

await 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 の詳細はこちら。

戻り値

Locator #

詳細

ロールセレクターは、アクセシビリティ監査と適合性テストに取って代わるものではありませんが、ARIA ガイドラインに関する早期フィードバックを提供します。

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

get_by_test_id

追加: v1.27

frame.get_by_test_id

テスト ID で要素を特定します。

使用法

次の DOM 構造を検討してください。

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

要素をテスト ID で特定できます

同期
非同期

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

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

引数

test_id str | Pattern #

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

戻り値

Locator #

詳細

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

get_by_text

追加: v1.27

frame.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))

# 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 です。正規表現で検索する場合は無視されます。完全一致でも空白はトリムされることに注意してください。

戻り値

Locator #

詳細

テキストによるマッチングは、完全一致でも常に空白を正規化します。たとえば、複数のスペースを 1 つに変換し、改行をスペースに変換し、先頭と末尾の空白を無視します。

タイプ button および submit の入力要素は、テキストコンテンツではなく、その値によって一致します。たとえば、テキスト「Log in」で検索すると、<input type=button value="Log in"> と一致します。

get_by_title

追加: v1.27

frame.get_by_title

要素を title 属性で特定できるようにします。

使用法

次の DOM 構造を検討してください。

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

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

同期
非同期

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

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

引数

text str | Pattern #

要素を特定するためのテキスト。
exact bool (オプション)#

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

戻り値

Locator #

goto

v1.9より前に追加

frame.goto

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

メソッドは、次の場合にエラーをスローします

SSL エラーがある場合 (自己署名証明書の場合など)。
ターゲット URL が無効です。
ナビゲーション中にタイムアウトが超過した場合。
リモートサーバーが応答しないか、到達不能な場合。
メインリソースのロードに失敗した場合。

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

注

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

注

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

使用法

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

引数

url str #

フレームをナビゲートする URL。URL にはスキームを含める必要があります (例: https://)。
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 ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。このメソッドはテストには使用しないでください。代わりに、準備状態を評価するためにウェブアサーションに依存してください。
- 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

NoneType | Response #

is_enabled

v1.9より前に追加

frame.is_enabled

要素が有効かどうかを返します。

使用法

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

戻り値

bool #

locator

追加: v1.14

frame.locator

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

ロケーターの詳細はこちら.

使用法

frame.locator(selector)
frame.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 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> に一致します。

戻り値

Locator #

set_content

v1.9より前に追加

frame.set_content

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

使用法

frame.set_content(html)
frame.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 ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。このメソッドはテストには使用しないでください。代わりに、準備状態を評価するためにウェブアサーションに依存してください。
- 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

NoneType #

title

v1.9より前に追加

frame.title

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

使用法

frame.title()

戻り値

str #

wait_for_function

v1.9より前に追加

frame.wait_for_function

expression が truthy な値を返すと、その値を返します。

使用法

frame.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.main_frame.wait_for_function("() => window.x > 0")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

import asyncio
from playwright.async_api import async_playwright, Playwright

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

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

frame.waitForFunction 関数の述語に引数を渡すには

同期
非同期

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

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

引数

expression str #

ブラウザコンテキストで評価される JavaScript 式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument (オプション)#

expression に渡すオプションの引数。
polling float | "raf" (オプション)#

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

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

戻り値

JSHandle #

wait_for_load_state

v1.9より前に追加

frame.wait_for_load_state

必要なロード状態に達するまで待機します。

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

注

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

使用法

同期
非同期

frame.click("button") # click triggers navigation.
frame.wait_for_load_state() # the promise resolves after "load" event.

await frame.click("button") # click triggers navigation.
await frame.wait_for_load_state() # the promise resolves after "load" event.

引数

state "load" | "domcontentloaded" | "networkidle" (オプション)#

待機するオプションのロード状態。デフォルトは load です。現在のドキュメントのロード中に状態がすでに到達している場合、メソッドはすぐに解決されます。次のいずれかになります。
- 'load' - load イベントが発行されるのを待ちます。
- 'domcontentloaded' - DOMContentLoaded イベントが発行されるのを待ちます。
- 'networkidle' - 非推奨 少なくとも 500 ミリ秒間ネットワーク接続がなくなるまで待ちます。このメソッドはテストには使用しないでください。代わりに、準備状態を評価するためにウェブアサーションに依存してください。
timeout float (オプション)#

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

戻り値

NoneType #

wait_for_url

追加バージョン: v1.11

frame.wait_for_url

フレームが指定された URL にナビゲートするまで待機します。

使用法

同期
非同期

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

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

引数

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

ナビゲーションを待機中に一致させるための glob パターン、正規表現パターン、または述語 (URL を受信)。パラメーターがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に一致する URL へのナビゲーションを待機することに注意してください。
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 ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。このメソッドはテストには使用しないでください。代わりに、準備状態を評価するためにウェブアサーションに依存してください。
- 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

NoneType #

プロパティ

child_frames

v1.9より前に追加

frame.child_frames

使用法

frame.child_frames

戻り値

List[Frame]#

is_detached

v1.9より前に追加

frame.is_detached

フレームがデタッチされている場合は true、それ以外の場合は false を返します。

使用法

frame.is_detached()

戻り値

bool #

name

v1.9より前に追加

frame.name

フレームの <frame> タグで指定された name 属性を返します。

name が空の場合、代わりに id 属性を返します。

注

この値はフレームが作成されたときに一度計算され、後で属性が変更されても更新されません。

使用法

frame.name

戻り値

str #

page

v1.9より前に追加

frame.page

このフレームを含むページを返します。

使用法

frame.page

戻り値

Page #

parent_frame

v1.9より前に追加

frame.parent_frame

親フレーム（存在する場合）。デタッチされたフレームとメインフレームは null を返します。

使用法

frame.parent_frame

戻り値

NoneType | Frame #

url

v1.9より前に追加

frame.url

フレームの URL を返します。

使用法

frame.url

戻り値

str #

非推奨

check

v1.9より前に追加

frame.check

非推奨

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

このメソッドは、selector に一致する要素を次の手順でチェックします

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素がすでにチェックされている場合、このメソッドはすぐに返ります。
force オプションが設定されていない限り、一致する要素のアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央をクリックします。
要素がチェックされていることを確認します。そうでない場合、このメソッドは例外をスローします。

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

使用法

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

引数

selector str #

要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
force bool (オプション)#

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

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

このオプションは効果がありません。
position Dict (オプション)追加バージョン: v1.11#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
strict bool (オプション)追加: v1.14#

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

最大時間（ミリ秒単位）。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は、browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。
trial bool (オプション)追加バージョン: v1.11#

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

戻り値

NoneType #

click

v1.9より前に追加

frame.click

非推奨

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

このメソッドは、selector に一致する要素を次の手順でクリックします

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

使用法

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

引数

selector str #

要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
button "left" | "right" | "middle" (オプション)#

デフォルトは left です。
click_count int (オプション)#

デフォルトは 1 です。UIEvent.detail を参照してください。
delay float (オプション)#

mousedown と mouseup の間の待機時間（ミリ秒単位）。デフォルトは 0 です。
force bool (オプション)#

アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (オプション)#

押す修飾キー。操作中にこれらの修飾キーのみが押されていることを確認し、その後、現在の修飾キーを復元します。指定しない場合は、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows および Linux では "Control" に、macOS では "Meta" に解決されます。
no_wait_after bool (オプション)#

非推奨
このオプションは将来、デフォルトで true になります。

ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページがロードを開始するのを待機しています。このフラグを設定することで、待機をオプトアウトできます。このオプションが必要になるのは、アクセスできないページにナビゲートする場合などの例外的なケースのみです。デフォルトは false です。
position Dict (オプション)#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
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 に関係なく押されることに注意してください。

戻り値

NoneType #

dblclick

v1.9より前に追加

frame.dblclick

非推奨

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

このメソッドは、selector に一致する要素を次の手順でダブルクリックします

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
force オプションが設定されていない限り、一致する要素のアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央、または指定された position をダブルクリックします。dblclick() の最初のクリックがナビゲーションイベントをトリガーした場合、このメソッドは例外をスローします。

注

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

使用法

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

引数

selector str #

要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
button "left" | "right" | "middle" (オプション)#

デフォルトは left です。
delay float (オプション)#

mousedown と mouseup の間の待機時間（ミリ秒単位）。デフォルトは 0 です。
force bool (オプション)#

アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (オプション)#

押す修飾キー。操作中にこれらの修飾キーのみが押されていることを確認し、その後、現在の修飾キーを復元します。指定しない場合は、現在押されている修飾キーが使用されます。"ControlOrMeta" は、Windows および Linux では "Control" に、macOS では "Meta" に解決されます。
no_wait_after bool (オプション)#

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

このオプションは効果がありません。
position Dict (オプション)#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
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 に関係なく押されることに注意してください。

戻り値

NoneType #

dispatch_event

v1.9より前に追加

frame.dispatch_event

非推奨

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

以下のスニペットは、要素に対して click イベントをディスパッチします。要素の可視状態に関係なく、click がディスパッチされます。これは、element.click() を呼び出すことと同じです。

使用法

同期
非同期

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

await frame.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 = frame.evaluate_handle("new DataTransfer()")
frame.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })

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

引数

selector str #

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

DOM イベントタイプ: "click"、"dragstart" など。
event_init EvaluationArgument (オプション)#

オプションのイベント固有の初期化プロパティ。
strict bool (オプション)追加: v1.14#

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

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

戻り値

NoneType #

eval_on_selector

追加バージョン: v1.9

frame.eval_on_selector

非推奨

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

expression の戻り値を返します。

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

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

使用法

同期
非同期

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

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

引数

selector str #

クエリ対象のセレクター。
expression str #

ブラウザコンテキストで評価される JavaScript 式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument (optional)#

expressionに渡すオプションの引数。
strict bool (オプション)追加: v1.14#

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

戻り値

Dict #

eval_on_selector_all

追加バージョン: v1.9

frame.eval_on_selector_all

非推奨

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

expressionの戻り値を返します。

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

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

使用法

同期
非同期

divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)

divs_counts = await frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)

引数

selector str #

クエリ対象のセレクター。
expression str #

ブラウザコンテキストで評価される JavaScript 式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument (optional)#

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

戻り値

Dict #

v1.9より前に追加

frame.expect_navigation

非推奨

このメソッドは本質的に競合状態が発生しやすいため、代わりにframe.wait_for_url()を使用してください。

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

使用法

このメソッドは、フレームが新しいURLにナビゲートするのを待ちます。フレームを間接的にナビゲートさせるコードを実行する場合に役立ちます。次の例を考えてください。

同期
非同期

with frame.expect_navigation():
    frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
# Resolves after navigation has finished

async with frame.expect_navigation():
    await frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
# 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)#

ナビゲーションを待機中に一致させるための glob パターン、正規表現パターン、または述語 (URL を受信)。パラメーターがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に一致する URL へのナビゲーションを待機することに注意してください。
wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (optional)#

操作が成功したと見なすタイミング。デフォルトは load です。イベントは次のいずれかになります。
- 'domcontentloaded' - DOMContentLoaded イベントが発行されたときに操作が完了したと見なします。
- 'load' - load イベントが発行されたときに操作が完了したと見なします。
- 'networkidle' - 非推奨 少なくとも 500 ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。このメソッドはテストには使用しないでください。代わりに、準備状態を評価するためにウェブアサーションに依存してください。
- 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

EventContextManager[Response]#

fill

v1.9より前に追加

frame.fill

非推奨

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

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

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

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

使用法

frame.fill(selector, value)
frame.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() メソッドを使用して変更できます。

戻り値

NoneType #

focus

v1.9より前に追加

frame.focus

非推奨

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

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

使用法

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

戻り値

NoneType #

get_attribute

v1.9より前に追加

frame.get_attribute

非推奨

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

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

使用法

frame.get_attribute(selector, name)
frame.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() メソッドを使用して変更できます。

戻り値

NoneType | str #

hover

v1.9より前に追加

frame.hover

非推奨

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

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

selectorに一致する要素を見つけます。存在しない場合は、一致する要素がDOMにアタッチされるまで待機します。
forceオプションが設定されていない限り、一致する要素に対する操作可能性チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouseを使用して、要素の中央、または指定されたpositionにマウスカーソルを合わせます。

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

使用法

frame.hover(selector)
frame.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 (optional)追加: v1.28#

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

このオプションは効果がありません。
position Dict (optional)#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
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 に関係なく押されることに注意してください。

戻り値

NoneType #

inner_html

v1.9より前に追加

frame.inner_html

非推奨

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

element.innerHTMLを返します。

使用法

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

戻り値

str #

inner_text

v1.9より前に追加

frame.inner_text

非推奨

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

element.innerTextを返します。

使用法

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

戻り値

str #

input_value

追加: v1.13

frame.input_value

非推奨

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

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

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

使用法

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

戻り値

str #

is_checked

v1.9より前に追加

frame.is_checked

非推奨

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

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

使用法

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

戻り値

bool #

is_disabled

v1.9より前に追加

frame.is_disabled

非推奨

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

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

使用法

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

戻り値

bool #

is_editable

v1.9より前に追加

frame.is_editable

非推奨

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

要素が編集可能かどうかを返します。

使用法

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

戻り値

bool #

is_hidden

v1.9より前に追加

frame.is_hidden

非推奨

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

要素が非表示かどうかを返します。visibleの反対です。selectorがどの要素にも一致しない場合、非表示とみなされます。

使用法

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

引数

selector str #

要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
strict bool (オプション)追加: v1.14#

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

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

戻り値

bool #

is_visible

v1.9より前に追加

frame.is_visible

非推奨

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

要素が表示されているかどうかを返します。selectorがどの要素にも一致しない場合、表示されていないとみなされます。

使用法

frame.is_visible(selector)
frame.is_visible(selector, **kwargs)

引数

selector str #

要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
strict bool (オプション)追加: v1.14#

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

非推奨
このオプションは無視されます。frame.is_visible()は、要素が表示されるのを待たずにすぐに返します。

戻り値

bool #

press

v1.9より前に追加

frame.press

非推奨

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

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"などのショートカットもサポートされています。修飾子付きで指定すると、後続のキーが押されている間、修飾子が押されたままになります。

使用法

frame.press(selector, key)
frame.press(selector, key, **kwargs)

引数

selector str #

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

押すキーの名前または生成する文字（ArrowLeftやaなど）。
delay float (optional)#

keydownとkeyupの間で待機する時間（ミリ秒単位）。デフォルトは0です。
no_wait_after bool (optional)#

非推奨
このオプションは将来、デフォルトで true になります。

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

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

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

戻り値

NoneType #

query_selector

追加バージョン: v1.9

frame.query_selector

非推奨

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

フレーム要素を指すElementHandleを返します。

注意

ElementHandleの使用は推奨されません。代わりにLocatorオブジェクトとウェブファーストアサーションを使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を見つけます。セレクターに一致する要素がない場合、nullを返します。

使用法

frame.query_selector(selector)
frame.query_selector(selector, **kwargs)

引数

selector str #

クエリ対象のセレクター。
strict bool (オプション)追加: v1.14#

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

戻り値

NoneType | ElementHandle #

query_selector_all

追加バージョン: v1.9

frame.query_selector_all

非推奨

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

フレーム要素を指すElementHandleを返します。

注意

ElementHandleの使用は推奨されません。代わりにLocatorオブジェクトを使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を見つけます。セレクターに一致する要素がない場合、空の配列を返します。

使用法

frame.query_selector_all(selector)

引数

selector str #

クエリ対象のセレクター。

戻り値

List[ElementHandle]#

select_option

v1.9より前に追加

frame.select_option

非推奨

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

このメソッドは、selectorに一致する要素を待機し、操作可能性チェックを待機し、指定されたすべてのオプションが<select>要素に存在することを確認し、これらのオプションを選択します。

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

正常に選択されたオプション値の配列を返します。

指定されたすべてのオプションが選択されると、changeイベントとinputイベントをトリガーします。

使用法

同期
非同期

# Single selection matching the value or label
frame.select_option("select#colors", "blue")
# single selection matching both the label
frame.select_option("select#colors", label="blue")
# multiple selection
frame.select_option("select#colors", value=["red", "green", "blue"])

# Single selection matching the value or label
await frame.select_option("select#colors", "blue")
# single selection matching the label
await frame.select_option("select#colors", label="blue")
# multiple selection
await frame.select_option("select#colors", value=["red", "green", "blue"])

引数

selector str #

クエリ対象のセレクター。
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() メソッドを使用して変更できます。
element ElementHandle | List[ElementHandle] (optional)#

選択するオプション要素。オプション。
index int | List[int] (optional)#

インデックスで選択するオプション。オプション。
value str | List[str] (optional)#

値で選択するオプション。<select> が multiple 属性を持つ場合、指定されたすべてのオプションが選択されます。それ以外の場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。オプション。
label str | List[str] (オプション)#

ラベルで選択するオプション。<select> が multiple 属性を持つ場合、指定されたすべてのオプションが選択されます。それ以外の場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。オプション。

戻り値

List[str]#

set_checked

追加バージョン: v1.15

frame.set_checked

非推奨

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

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

selector に一致する要素を検索します。一致する要素がない場合は、一致する要素が DOM にアタッチされるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。
要素がすでに正しいチェック状態になっている場合、このメソッドはすぐに戻ります。
操作性チェックが force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央をクリックします。
要素がチェックまたはチェック解除されたことを確認します。そうでない場合、このメソッドは例外をスローします。

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

使用法

frame.set_checked(selector, checked)
frame.set_checked(selector, checked, **kwargs)

引数

selector str #

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

チェックボックスをチェックまたはチェック解除するかどうか。
force bool (オプション)#

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

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

このオプションは効果がありません。
position Dict (オプション)#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
strict bool (オプション)#

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

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

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

戻り値

NoneType #

set_input_files

v1.9より前に追加

frame.set_input_files

非推奨

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

ファイル入力の値を、これらのファイルパスまたはファイルに設定します。filePaths の一部が相対パスである場合、それらは現在の作業ディレクトリに対する相対パスとして解決されます。空の配列の場合、選択されたファイルをクリアします。

このメソッドは、selector が input 要素を指していることを期待します。ただし、要素が関連付けられた control を持つ <label> 要素内にある場合、代わりにコントロールをターゲットにします。

使用法

frame.set_input_files(selector, files)
frame.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() メソッドを使用して変更できます。

戻り値

NoneType #

tap

v1.9より前に追加

frame.tap

非推奨

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

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

selector に一致する要素を検索します。一致する要素がない場合は、一致する要素が DOM にアタッチされるまで待機します。
操作性チェックが force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
要素の中央、または指定された position をタップするには、page.touchscreen を使用します。

注

frame.tap() は、ブラウザーコンテキストの hasTouch オプションが true に設定されている必要があります。

使用法

frame.tap(selector)
frame.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 (オプション)#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
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 に関係なく押されることに注意してください。

戻り値

NoneType #

text_content

v1.9より前に追加

frame.text_content

非推奨

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

element.textContent を返します。

使用法

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

戻り値

NoneType | str #

type

v1.9より前に追加

frame.type

非推奨

ほとんどの場合、代わりに locator.fill() を使用する必要があります。ページ上に特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。この場合は、locator.press_sequentially() を使用してください。

テキスト内の各文字に対して、keydown、keypress/input、および keyup イベントを送信します。frame.type は、きめ細かいキーボードイベントを送信するために使用できます。フォームフィールドに値を入力するには、frame.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() メソッドを使用して変更できます。

戻り値

NoneType #

uncheck

v1.9より前に追加

frame.uncheck

非推奨

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

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

selector に一致する要素を検索します。一致する要素がない場合は、一致する要素が DOM にアタッチされるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素がすでにチェック解除されている場合、このメソッドはすぐに戻ります。
操作性チェックが force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央をクリックします。
要素がチェック解除されたことを確認します。そうでない場合、このメソッドは例外をスローします。

使用法

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

引数

selector str #

要素を検索するためのセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
force bool (オプション)#

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

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

このオプションは効果がありません。
position Dict (オプション)追加バージョン: v1.11#
- x float
- y float
要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視ポイントを使用します。
strict bool (オプション)追加: v1.14#

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

最大時間（ミリ秒単位）。デフォルトは 30000 (30 秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は、browser_context.set_default_timeout() または page.set_default_timeout() メソッドを使用して変更できます。
trial bool (オプション)追加バージョン: v1.11#

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

戻り値

NoneType #

wait_for_selector

v1.9より前に追加

frame.wait_for_selector

非推奨

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

selector で指定された要素が state オプションを満たすと戻ります。hidden または detached を待機している場合は null を返します。

注

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

selector が state オプション (DOM に表示/非表示になるか、可視/非可視になるか) を満たすのを待ちます。メソッドを呼び出した時点で selector がすでに条件を満たしている場合、メソッドはすぐに戻ります。セレクターが 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.main_frame.wait_for_selector("img")
        print("Loaded image: " + str(element.get_attribute("src")))
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = await chromium.launch()
    page = await browser.new_page()
    for current_url in ["https://google.com", "https://bbc.com"]:
        await page.goto(current_url, wait_until="domcontentloaded")
        element = await page.main_frame.wait_for_selector("img")
        print("Loaded image: " + str(await element.get_attribute("src")))
    await browser.close()

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

引数

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

戻り値

NoneType | ElementHandle #

wait_for_timeout

v1.9より前に追加

frame.wait_for_timeout

非推奨

本番環境でタイムアウトを待つことは絶対にしないでください。時間を待つテストは本質的に不安定です。自動的に待機する Locator アクションとウェブアサーションを使用してください。

指定された timeout （ミリ秒単位）の間、待機します。

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

使用法

frame.wait_for_timeout(timeout)

引数

timeout float #

待機するタイムアウト

戻り値

NoneType #

メソッド​

add_script_tag​

add_style_tag​

content​

drag_and_drop​

evaluate​

evaluate_handle​

frame_element​

frame_locator​

get_by_alt_text​

get_by_label​

get_by_placeholder​

get_by_role​

get_by_test_id​

get_by_text​

get_by_title​

goto​

is_enabled​

locator​

set_content​

title​

wait_for_function​

wait_for_load_state​

wait_for_url​

プロパティ​

child_frames​

is_detached​

name​

page​

parent_frame​

url​

非推奨​

check​

click​

dblclick​

dispatch_event​

eval_on_selector​

eval_on_selector_all​

expect_navigation​

fill​

focus​

get_attribute​

hover​

inner_html​

inner_text​

input_value​

is_checked​

is_disabled​

is_editable​

is_hidden​

is_visible​

press​

query_selector​

query_selector_all​

select_option​

set_checked​

set_input_files​

tap​

text_content​

type​

uncheck​

wait_for_selector​

wait_for_timeout​

メソッド

add_script_tag

add_style_tag

content

drag_and_drop

evaluate

evaluate_handle

frame_element

frame_locator

get_by_alt_text

get_by_label

get_by_placeholder

get_by_role

get_by_test_id

get_by_text

get_by_title

goto

is_enabled

locator

set_content

title

wait_for_function

wait_for_load_state

wait_for_url

プロパティ

child_frames

is_detached

name

page

parent_frame

url

非推奨

check

click

dblclick

dispatch_event

eval_on_selector

eval_on_selector_all

expect_navigation

fill

focus

get_attribute

hover

inner_html

inner_text

input_value

is_checked

is_disabled

is_editable

is_hidden

is_visible

press

query_selector

query_selector_all

select_option

set_checked

set_input_files

tap

text_content

type

uncheck

wait_for_selector

wait_for_timeout