Frame

在任何时刻，page都会通过 page.main_frame 和 frame.child_frames 方法暴露其当前的 frame 树。

Frame 对象由三个在 page 对象上分派的事件控制其生命周期：

page.on("frameattached") - 当 frame 附加到 page 时触发。一个 Frame 只能附加到 page 一次。
page.on("framenavigated") - 当 frame 提交导航到另一个 URL 时触发。
page.on("framedetached") - 当 frame 从 page 分离时触发。一个 Frame 只能从 page 分离一次。

转储框架树的示例

同步
异步

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 (可选)#

脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关详细信息，请参阅 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

获取框架的完整 HTML 内容，包括 doctype。

用法

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
在此点（相对于元素内边距框的左上角）点击源元素。如果未指定，则使用元素的某个可见点。
steps int (可选)Added in: v1.57#

默认为 1。发送 n 个插值的 mousemove 事件以表示从 mousedown 到 mouseup 的拖动过程。当设置为 1 时，在目标位置发出单个 mousemove 事件。
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() 的逆操作。请注意，返回的 handle 实际上属于父 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 中的元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中查找文本为“提交”的元素，例如 <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 中通过标签“用户名”和“密码”找到输入

<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。如有必要，使用 selectors.set_test_id_attribute() 配置不同的测试 ID 属性。

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 #

详情

按文本匹配始终会规范化空格，即使是精确匹配也是如此。例如，它会将多个空格转换为一个空格，将换行符转换为空格，并忽略前导和尾随空格。

类型为 button 和 submit 的输入元素通过其 value 而不是文本内容进行匹配。例如，通过文本 "登录" 定位匹配 <input type=button value="登录">。

get_by_title

新增于：v1.27

frame.get_by_title

允许通过元素的 title 属性定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过 title 文本定位它后检查问题数量

同步
异步

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 无效。
导航过程中 timeout 超时。
远程服务器无响应或无法访问。
主资源加载失败。

当远程服务器返回任何有效的 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 表示禁用 timeout。默认值可以通过使用 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' - 当收到网络响应且文档开始加载时，认为操作完成。

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

此方法返回一个定位器（Locator），可用于在此页面/框架上执行操作。定位器在执行操作之前解析为元素，因此对同一定位器的一系列操作实际上可能在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生变化，就会发生这种情况。

了解更多关于定位器.

用法

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

参数

selector str #

用于解析 DOM 元素的选取器。
has Locator (可选)#

将方法的返回结果缩小到包含匹配此相对定位器的元素的结果。例如，article 包含 text=Playwright 匹配 <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 (optional)新增于：v1.33#

匹配不包含指定文本的元素，可能在子元素或后代元素中。当传入 [字符串] 时，匹配不区分大小写并搜索子字符串。
has_text str | Pattern (可选)#

匹配包含指定文本的元素，可能在子元素或后代元素中。当传入 [string] 时，匹配不区分大小写并搜索子字符串。例如，"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 表示禁用 timeout。默认值可以通过使用 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' - 当收到网络响应且文档开始加载时，认为操作完成。

NoneType #

title

v1.9 之前添加

frame.title

返回页面标题。

用法

frame.title()

str #

wait_for_function

v1.9 之前添加

frame.wait_for_function

当 expression 返回一个真值时返回，并返回该值。

用法

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 表示禁用 timeout。默认值可以通过使用 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 毫秒内没有网络连接。不要将此方法用于测试，而是依赖 Web 断言来评估准备情况。
timeout float (可选)#

最大操作时间（以毫秒为单位），默认为 30 秒，传入 0 表示禁用 timeout。默认值可以通过使用 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 模式、regex 模式或接收 URL 进行匹配的谓词。请注意，如果参数是不带通配符的字符串，该方法将等待导航到与该字符串完全相同的 URL。
timeout float (可选)#

最大操作时间（以毫秒为单位），默认为 30 秒，传入 0 表示禁用 timeout。默认值可以通过使用 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' - 当收到网络响应且文档开始加载时，认为操作完成。

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

返回标签中指定的框架名称属性。

如果名称为空，则返回 id 属性。

注意

此值在框架创建时计算一次，如果属性稍后更改，则不会更新。

用法

frame.name

str #

page

v1.9 之前添加

frame.page

返回包含此框架的页面。

用法

frame.page

页面 #

parent_frame

v1.9 之前添加

frame.parent_frame

父框架，如果有的话。分离的框架和主框架返回 null。

用法

frame.parent_frame

NoneType | 帧 #

url

v1.9 之前添加

frame.url

返回框架的 url。

用法

frame.url

str #

已弃用

check

v1.9 之前添加

frame.check

不推荐

请改用基于定位符的 locator.check()。阅读有关定位符的更多信息。

此方法通过执行以下步骤检查与 selector 匹配的元素

查找与 selector 匹配的元素。如果没有找到，则等待匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出。如果元素已被选中，此方法将立即返回。
等待匹配元素上的可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，则重试整个操作。
如果需要，将元素滚动到视图中。
使用 page.mouse 点击元素中心。
确保元素现在已选中。如果不是，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此项。

用法

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 选项。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此项。

用法

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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。用于在不执行操作的情况下等待元素准备好。请注意，键盘 modifiers 将被按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

NoneType #

dblclick

v1.9 之前添加

frame.dblclick

不推荐

请改用基于定位符的 locator.dblclick()。阅读有关定位符的更多信息。

此方法双击与 selector 匹配的元素，方法如下：

查找与 selector 匹配的元素。如果没有找到，则等待匹配的元素附加到 DOM。
等待匹配元素上的可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，则重试整个操作。
如果需要，将元素滚动到视图中。
使用 page.mouse 双击元素中心，或指定的 position。如果 dblclick() 的第一次点击触发了导航事件，此方法将抛出异常。

当所有步骤组合在指定的 timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此项。

注意

frame.dblclick() 会分派两个 click 事件和一个 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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 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 优先断言。

返回 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 (可选)#

要传递给 expression 的可选参数。
strict bool (可选)新增于：v1.14#

如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。

Dict #

eval_on_selector_all

添加于：v1.9

frame.eval_on_selector_all

不推荐

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 web-first 断言会做得更好。

返回 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 (可选)#

要传递给 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 (可选)#

最大操作时间（以毫秒为单位），默认为 30 秒，传入 0 表示禁用 timeout。默认值可以通过使用 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 (可选)#

用于等待导航的 glob 模式、regex 模式或接收 URL 进行匹配的谓词。请注意，如果参数是不带通配符的字符串，该方法将等待导航到与该字符串完全相同的 URL。
wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

何时认为操作成功，默认为 load。事件可以是以下之一
- 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
- 'load' - 当 load 事件触发时，认为操作完成。
- 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。
- 'commit' - 当收到网络响应且文档开始加载时，认为操作完成。

事件上下文管理器[Response]#

fill

v1.9 之前添加

frame.fill

不推荐

请改用基于定位符的 locator.fill()。阅读有关定位符的更多信息。

此方法等待与 selector 匹配的元素，等待可操作性检查，聚焦元素，填充它，并在填充后触发 input 事件。注意，您可以传递一个空字符串来清除输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内部，则会填充该 control。

要发送细粒度键盘事件，请使用 locator.press_sequentially()。

用法

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

参数

selector str #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
value str #

要填充 <input>、<textarea> 或 [contenteditable] 元素的值。
force bool (可选)添加于：v1.13#

是否绕过可操作性检查。默认为 false。
no_wait_after bool (可选)#

已弃用
此选项无效。

此选项无效。
strict bool (可选)新增于：v1.14#

如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 30000（30秒）。传入 0 可禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改。

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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

是否绕过可操作性检查。默认为 false。
modifiers List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#

要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
no_wait_after bool (可选)新增于: v1.28#

已弃用
此选项无效。

此选项无效。
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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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> 元素内部，则返回 control 的值。

用法

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

参数

selector str #

用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
strict bool (可选)新增于：v1.14#

如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
timeout float (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

最大等待时间（以毫秒为单位）。默认为 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 (可选)#

已弃用
忽略此选项。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 (可选)#

已弃用
忽略此选项。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 (可选)#

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() 方法更改。

NoneType #

query_selector

添加于：v1.9

frame.query_selector

不推荐

建议使用基于定位器的 frame.locator()。阅读有关定位器的更多信息。

返回指向框架元素的 ElementHandle。

注意

不推荐使用 ElementHandle，请使用 Locator 对象和面向 Web 的断言。

该方法在框架中查找与指定选取器匹配的元素。如果没有元素匹配选取器，则返回 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()。阅读有关定位器的更多信息。

返回指向框架元素的 ElementHandles。

注意

不推荐使用 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> 元素内，则将使用该 control。

返回已成功选择的选项值数组。

一旦所有提供的选项都已选中，将触发 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 (可选)添加于：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 属性，则选择所有给定的选项，否则只选择与传入选项之一匹配的第一个选项。可选。

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> 元素内部，则改为定位该 control。

用法

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 选项，否则等待对匹配元素执行可操作性检查。如果在检查过程中元素被分离，则重试整个操作。
如果需要，将元素滚动到视图中。
使用 page.touchscreen 点击元素的中心，或指定的 position。

如果所有步骤组合在指定的 timeout 内未完成，此方法将抛出 TimeoutError。传递零超时禁用此行为。

注意

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#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 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()。只有当页面上有特殊的键盘处理时，才需要一个接一个地按下按键——在这种情况下，使用 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 点击元素中心。
确保元素现在未选中。如果不是，此方法将抛出异常。

如果所有步骤组合在指定的 timeout 内未完成，此方法将抛出 TimeoutError。传递零超时禁用此行为。

用法

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()。阅读有关定位器的更多信息。

当由选择器指定的元素满足 state 选项时返回。如果等待 hidden 或 detached，则返回 null。

注意

Playwright 会自动等待元素准备就绪，然后再执行操作。使用 Locator 操作和面向 Web 的断言可以使代码无需 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