跳到主要内容

Frame

在任何时间点,页面都会通过 page.main_frameframe.child_frames 方法公开其当前的帧树。

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)

方法

add_script_tag

v1.9 之前添加 frame.add_script_tag

当脚本的 onload 事件触发或脚本内容注入到 frame 中时,返回添加的标签。

向页面中添加一个 <script> 标签,其中包含所需的 url 或 content。

用法

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

参数

  • content str (可选)#

    要注入到 frame 中的原始 JavaScript 内容。

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

    要注入到 frame 中的 JavaScript 文件路径。如果 path 是相对路径,则它相对于当前工作目录解析。

  • type str (可选)#

    脚本类型。使用 'module' 以加载 JavaScript ES6 模块。 有关更多详细信息,请参阅 script

  • url str (可选)#

    要添加的脚本的 URL。

返回值


add_style_tag

v1.9 之前添加 frame.add_style_tag

当样式表的 onload 事件触发或 CSS 内容注入到 frame 中时,返回添加的标签。

向页面中添加一个 <link rel="stylesheet"> 标签,其中包含所需的 url,或一个包含 content 的 <style type="text/css"> 标签。

用法

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

参数

  • content str (可选)#

    要注入到 frame 中的原始 CSS 内容。

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

    要注入到 frame 中的 CSS 文件路径。如果 path 是相对路径,则它相对于当前工作目录解析。

  • url str (可选)#

    <link> 标签的 URL。

返回值


content

v1.9 之前添加 frame.content

获取 frame 的完整 HTML 内容,包括 doctype。

用法

frame.content()

返回值


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

    是否绕过 actionability 检查。 默认为 false

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • source_position Dict (可选)添加于: v1.14#

    在此点相对于元素填充框的左上角单击源元素。 如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • target_position Dict (可选)添加于: v1.14#

    在此点相对于元素填充框的左上角拖放到目标元素上。 如果未指定,则使用元素的某些可见点。

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后,此方法仅执行 actionability 检查并跳过该操作。 默认为 false。 用于等待元素准备好执行操作而无需执行它。

返回值


evaluate

v1.9 之前添加 frame.evaluate

返回 expression 的返回值。

如果传递给 frame.evaluate() 的函数返回 Promise,则 frame.evaluate() 将等待 promise 解析并返回其值。

如果传递给 frame.evaluate() 的函数返回非 Serializable 值,则 frame.evaluate() 返回 undefined。 Playwright 还支持传输一些 JSON 无法序列化的附加值:-0NaNInfinity-Infinity

用法

result = 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"

ElementHandle 实例可以作为参数传递给 frame.evaluate()

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

参数

  • expression str#

    要在浏览器上下文中评估的 JavaScript 表达式。 如果表达式评估为函数,则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值


evaluate_handle

v1.9 之前添加 frame.evaluate_handle

JSHandle 形式返回 expression 的返回值。

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

参数

  • expression str#

    要在浏览器上下文中评估的 JavaScript 表达式。 如果表达式评估为函数,则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值


frame_element

v1.9 之前添加 frame.frame_element

返回与此 frame 对应的 frameiframe 元素句柄。

这是 element_handle.content_frame() 的反向操作。 请注意,返回的句柄实际上属于父 frame。

如果 frame 在 frameElement() 返回之前已分离,则此方法会抛出错误。

用法

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

返回值


frame_locator

添加于: v1.17 frame.frame_locator

当使用 iframe 时,您可以创建一个 frame 定位器,它将进入 iframe 并允许在 iframe 中选择元素。

用法

以下代码片段在 id 为 my-frame 的 iframe 中查找文本为 "Submit" 的元素,例如 <iframe id="my-frame">

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

参数

  • selector str#

    用于解析 DOM 元素的选择器。

返回值


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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

    是否查找完全匹配项:区分大小写且全字符串匹配。 默认为 false。 使用正则表达式定位时忽略。 请注意,完全匹配仍然会修剪空格。

返回值


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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

    是否查找完全匹配项:区分大小写且全字符串匹配。 默认为 false。 使用正则表达式定位时忽略。 请注意,完全匹配仍然会修剪空格。

返回值


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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

    是否查找完全匹配项:区分大小写且全字符串匹配。 默认为 false。 使用正则表达式定位时忽略。 请注意,完全匹配仍然会修剪空格。

返回值


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

参数

  • 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-disableddisabled 设置的属性。

    注意

    与大多数其他属性不同,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 (可选)#

    数字属性,通常用于角色 headinglistitemrowtreeitem,对于 <h1>-<h6> 元素具有默认值。

    了解有关 aria-level 的更多信息。

  • name str | Pattern (可选)#

    用于匹配 可访问名称 的选项。 默认情况下,匹配不区分大小写并搜索子字符串,使用 exact 来控制此行为。

    了解有关 可访问名称 的更多信息。

  • pressed bool (可选)#

    通常由 aria-pressed 设置的属性。

    了解有关 aria-pressed 的更多信息。

  • selected bool (可选)#

    通常由 aria-selected 设置的属性。

    了解有关 aria-selected 的更多信息。

返回值

详情

Role 选择器不能替代可访问性审核和一致性测试,而是提供有关 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()

参数

返回值

详情

默认情况下,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))

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

    是否查找完全匹配项:区分大小写且全字符串匹配。 默认为 false。 使用正则表达式定位时忽略。 请注意,完全匹配仍然会修剪空格。

返回值

详情

按文本匹配始终会规范化空格,即使是完全匹配也是如此。 例如,它将多个空格变成一个空格,将换行符变成空格,并忽略前导和尾随空格。

类型为 buttonsubmit 的输入元素与其 value 而不是文本内容匹配。 例如,按文本 "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")

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

    是否查找完全匹配项:区分大小写且全字符串匹配。 默认为 false。 使用正则表达式定位时忽略。 请注意,完全匹配仍然会修剪空格。

返回值


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 应包含 scheme,例如 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 毫秒没有网络连接时,认为操作已完成。请勿将此方法用于测试,而是依赖 Web 断言来评估就绪状态。
    • 'commit' - 当收到网络响应并且文档开始加载时,认为操作已完成。

返回值


is_enabled

v1.9 之前添加 frame.is_enabled

返回元素是否 enabled

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


locator

添加于: v1.14 frame.locator

该方法返回一个元素定位器,可用于在此页面/框架上执行操作。定位器在执行操作之前立即解析为元素,因此对同一定位器的一系列操作实际上可以在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构已更改,则会发生这种情况。

了解更多关于定位器的信息.

了解更多关于定位器的信息.

用法

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

参数

  • selector str#

    用于解析 DOM 元素的选择器。

  • has Locator (可选)#

    将方法的搜索结果缩小到包含与此相对定位器匹配的元素的那些结果。例如,具有 text=Playwrightarticle 匹配 <article><div>Playwright</div></article>

    内部定位器必须相对于外部定位器,并且从外部定位器匹配开始查询,而不是文档根。例如,你可以在 <article><content><div>Playwright</div></content></article> 中找到具有 divcontent。但是,查找具有 article divcontent 将会失败,因为内部定位器必须是相对的,并且不应使用 content 之外的任何元素。

    请注意,外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator

  • has_not Locator (可选)添加于版本: v1.33#

    匹配不包含与内部定位器匹配的元素的元素。内部定位器是针对外部定位器查询的。例如,不具有 divarticle 匹配 <article><span>Playwright</span></article>

    请注意,外部和内部定位器必须属于同一框架。内部定位器不得包含 FrameLocator

  • has_not_text str | Pattern (可选)添加于版本: v1.33#

    匹配在内部某处(可能在子元素或后代元素中)不包含指定文本的元素。当传递 [string] 时,匹配不区分大小写并搜索子字符串。

  • has_text str | Pattern (可选)#

    匹配在内部某处(可能在子元素或后代元素中)包含指定文本的元素。当传递 [string] 时,匹配不区分大小写并搜索子字符串。例如,"Playwright" 匹配 <article><div>Playwright</div></article>

返回值


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 毫秒没有网络连接时,认为操作已完成。请勿将此方法用于测试,而是依赖 Web 断言来评估就绪状态。
    • 'commit' - 当收到网络响应并且文档开始加载时,认为操作已完成。

返回值


title

v1.9 之前添加 frame.title

返回页面标题。

用法

frame.title()

返回值


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)

要将参数传递给 frame.waitForFunction 函数的谓词

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

参数

  • expression str#

    要在浏览器上下文中评估的 JavaScript 表达式。 如果表达式评估为函数,则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • polling float | "raf" (可选)#

    如果 polling'raf',则 expressionrequestAnimationFrame 回调中持续执行。如果 polling 是一个数字,则将其视为执行该函数的间隔(以毫秒为单位)。默认为 raf

  • timeout float (可选)#

    最大等待时间(毫秒)。默认为 30000(30 秒)。传递 0 以禁用超时。可以使用 browser_context.set_default_timeout()page.set_default_timeout() 方法更改默认值。

返回值


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.

参数

  • state "load" | "domcontentloaded" | "networkidle" (可选)#

    要等待的可选加载状态,默认为 load。如果在加载当前文档时已达到该状态,则该方法会立即解析。可以是以下之一:

    • 'load' - 等待 load 事件被触发。
    • 'domcontentloaded' - 等待 DOMContentLoaded 事件被触发。
    • 'networkidle' - 不推荐使用,等待直到至少 500 毫秒没有网络连接。请勿将此方法用于测试,而是依赖 Web 断言来评估就绪状态。
  • 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_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")

参数

  • 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 毫秒没有网络连接时,认为操作已完成。请勿将此方法用于测试,而是依赖 Web 断言来评估就绪状态。
    • 'commit' - 当收到网络响应并且文档开始加载时,认为操作已完成。

返回值


属性

child_frames

v1.9 之前添加 frame.child_frames

用法

frame.child_frames

返回值


is_detached

v1.9 之前添加 frame.is_detached

如果框架已分离,则返回 true,否则返回 false

用法

frame.is_detached()

返回值


name

v1.9 之前添加 frame.name

返回框架在 标签中指定的 name 属性。

如果 name 为空,则返回 id 属性。

注意

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

用法

frame.name

返回值


page

v1.9 之前添加 frame.page

返回包含此框架的页面。

用法

frame.page

返回值


parent_frame

v1.9 之前添加 frame.parent_frame

父框架(如果有)。分离的框架和主框架返回 null

用法

frame.parent_frame

返回值


url

v1.9 之前添加 frame.url

返回框架的 URL。

用法

frame.url

返回值


已弃用

check

v1.9 之前添加 frame.check
不推荐使用

请使用基于定位器的 locator.check() 代替。阅读更多关于 定位器 的信息。

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

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

当所有步骤在指定的 timeout 期间未完成时,此方法会抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)添加于版本: v1.11#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: v1.11#

    设置后,此方法仅执行 actionability 检查并跳过该操作。 默认为 false。 用于等待元素准备好执行操作而无需执行它。

返回值


click

v1.9 之前添加 frame.click
不推荐使用

请使用基于定位器的 locator.click() 代替。阅读更多关于 定位器 的信息。

此方法通过执行以下步骤来单击与 selector 匹配的元素:

  1. 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
  2. 等待匹配元素上的 可操作性 检查,除非设置了 force 选项。如果在检查期间元素被分离,则会重试整个操作。
  3. 如果需要,将元素滚动到视图中。
  4. 使用 page.mouse 在元素的中心或指定的 position 单击。
  5. 等待启动的导航成功或失败,除非设置了 no_wait_after 选项。

当所有步骤在指定的 timeout 期间未完成时,此方法会抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • button "left" | "right" | "middle" (可选)#

    默认为 left

  • click_count int (可选)#

    默认为 1。请参阅 UIEvent.detail

  • delay float (可选)#

    mousedownmouseup 之间等待的时间(毫秒)。默认为 0。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

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

    要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

  • no_wait_after bool (可选)#

    已弃用

    此选项在未来将默认为 true

    启动导航的操作正在等待这些导航发生并等待页面开始加载。你可以通过设置此标志来选择不等待。你只需要在特殊情况下使用此选项,例如导航到无法访问的页面。默认为 false

  • position Dict (可选)#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: v1.11#

    如果设置,此方法仅执行 可操作性 检查,并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行该操作时非常有用。请注意,键盘 modifiers 将始终被按下,而与 trial 无关,以允许测试仅在按下这些键时才可见的元素。

返回值


dblclick

v1.9 之前添加 frame.dblclick
不推荐使用

请使用基于定位器的 locator.dblclick() 代替。阅读更多关于 定位器 的信息。

此方法通过执行以下步骤来双击与 selector 匹配的元素:

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

当所有步骤在指定的 timeout 期间未完成时,此方法会抛出 TimeoutError。传递零超时将禁用此功能。

注意

frame.dblclick() 调度两个 click 事件和一个 dblclick 事件。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • button "left" | "right" | "middle" (可选)#

    默认为 left

  • delay float (可选)#

    mousedownmouseup 之间等待的时间(毫秒)。默认为 0。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

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

    要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: v1.11#

    如果设置,此方法仅执行 可操作性 检查,并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行该操作时非常有用。请注意,键盘 modifiers 将始终被按下,而与 trial 无关,以允许测试仅在按下这些键时才可见的元素。

返回值


dispatch_event

v1.9 之前添加 frame.dispatch_event
不推荐使用

请使用基于定位器的 locator.dispatch_event() 代替。阅读更多关于 定位器 的信息。

以下代码段在元素上调度 click 事件。无论元素的可见性状态如何,都会调度 click 事件。这等效于调用 element.click()

用法

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

在底层,它基于给定的 type 创建事件实例,使用 event_init 属性初始化它,并在元素上调度它。默认情况下,事件是 composedcancelable 和 bubble。

由于 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 })

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

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

返回值


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

参数

  • selector str#

    要查询的选择器。

  • expression str#

    要在浏览器上下文中评估的 JavaScript 表达式。 如果表达式评估为函数,则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

返回值


eval_on_selector_all

添加于版本: v1.9 frame.eval_on_selector_all
不推荐使用

在大多数情况下,locator.evaluate_all()、其他 Locator 辅助方法和 web-first 断言能更好地完成任务。

返回 expression 的返回值。

该方法在 frame 中查找所有匹配指定选择器的元素,并将匹配元素数组作为第一个参数传递给 expression

如果 expression 返回一个 Promise,则 frame.eval_on_selector_all() 将等待 Promise resolve 并返回其值。

用法

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

参数

  • selector str#

    要查询的选择器。

  • expression str#

    要在浏览器上下文中评估的 JavaScript 表达式。 如果表达式评估为函数,则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值


expect_navigation

v1.9 之前添加 frame.expect_navigation
已弃用

此方法本质上是竞态的,请改用 frame.wait_for_url()

等待 frame 导航并返回主资源响应。如果发生多次重定向,导航将使用最后一次重定向的响应来 resolve。如果导航到不同的锚点或由于 History API 的使用而导航,导航将使用 null 来 resolve。

用法

此方法等待 frame 导航到新的 URL。当您运行的代码将间接导致 frame 导航时,此方法非常有用。考虑以下示例

with frame.expect_navigation():
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 以禁用超时。默认值可以使用 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 模式、正则表达式模式或谓词,用于在等待导航时接收 URL 以进行匹配。请注意,如果参数是不带通配符的字符串,则该方法将等待导航到与该字符串完全相同的 URL。

  • wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

    何时认为操作成功,默认为 load。事件可以是:

    • 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时,认为操作已完成。
    • 'load' - 当 load 事件被触发时,认为操作已完成。
    • 'networkidle' - 不推荐使用,当至少 500 毫秒没有网络连接时,认为操作已完成。请勿将此方法用于测试,而是依赖 Web 断言来评估就绪状态。
    • 'commit' - 当收到网络响应并且文档开始加载时,认为操作已完成。

返回值


fill

v1.9 之前添加 frame.fill
不推荐使用

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

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

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

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

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • value str#

    要为 <input><textarea>[contenteditable] 元素填充的值。

  • force bool (可选)添加于: v1.13#

    是否绕过 actionability 检查。 默认为 false

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


focus

v1.9 之前添加 frame.focus
不推荐使用

请改用基于 locator 的 locator.focus()。阅读更多关于 定位器 (locators) 的信息。

此方法获取具有 selector 的元素并聚焦它。如果没有匹配 selector 的元素,该方法将等待直到匹配的元素出现在 DOM 中。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


get_attribute

v1.9 之前添加 frame.get_attribute
不推荐使用

请改用基于 locator 的 locator.get_attribute()。阅读更多关于 定位器 (locators) 的信息。

返回元素属性值。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • name str#

    要获取其值的属性名称。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


hover

v1.9 之前添加 frame.hover
不推荐使用

请改用基于 locator 的 locator.hover()。阅读更多关于 定位器 (locators) 的信息。

此方法通过执行以下步骤悬停在匹配 selector 的元素上

  1. 查找匹配 selector 的元素。如果没有,请等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素进行 可操作性 (actionability) 检查,除非设置了 force 选项。如果元素在检查期间分离,则会重试整个操作。
  3. 如果需要,将元素滚动到视图中。
  4. 使用 page.mouse 悬停在元素的中心或指定的 position 上。

当所有步骤在指定的 timeout 期间未完成时,此方法会抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

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

    要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

  • no_wait_after bool (可选)添加于: v1.28#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: v1.11#

    如果设置,此方法仅执行 可操作性 检查,并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行该操作时非常有用。请注意,键盘 modifiers 将始终被按下,而与 trial 无关,以允许测试仅在按下这些键时才可见的元素。

返回值


inner_html

v1.9 之前添加 frame.inner_html
不推荐使用

请改用基于 locator 的 locator.inner_html()。阅读更多关于 定位器 (locators) 的信息。

返回 element.innerHTML

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


inner_text

v1.9 之前添加 frame.inner_text
不推荐使用

请改用基于 locator 的 locator.inner_text()。阅读更多关于 定位器 (locators) 的信息。

返回 element.innerText

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


input_value

添加于: v1.13 frame.input_value
不推荐使用

请改用基于 locator 的 locator.input_value()。阅读更多关于 定位器 (locators) 的信息。

返回选定的 <input><textarea><select> 元素的 input.value

为非输入元素抛出错误。但是,如果元素位于具有关联 control<label> 元素内,则返回该 control 的值。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


is_checked

v1.9 之前添加 frame.is_checked
不推荐使用

请改用基于 locator 的 locator.is_checked()。阅读更多关于 定位器 (locators) 的信息。

返回元素是否被选中。如果元素不是复选框或单选输入框,则抛出错误。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


is_disabled

v1.9 之前添加 frame.is_disabled
不推荐使用

请改用基于 locator 的 locator.is_disabled()。阅读更多关于 定位器 (locators) 的信息。

返回元素是否被禁用,与 enabled 相反。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


is_editable

v1.9 之前添加 frame.is_editable
不推荐使用

请改用基于 locator 的 locator.is_editable()。阅读更多关于 定位器 (locators) 的信息。

返回元素是否 可编辑 (editable)

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


is_hidden

v1.9 之前添加 frame.is_hidden
不推荐使用

请改用基于 locator 的 locator.is_hidden()。阅读更多关于 定位器 (locators) 的信息。

返回元素是否隐藏,与 visible 相反。不匹配任何元素的 selector 被认为是隐藏的。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

    已弃用

    此选项被忽略。frame.is_hidden() 不会等待元素变为隐藏状态,并立即返回。

返回值


is_visible

v1.9 之前添加 frame.is_visible
不推荐使用

请改用基于 locator 的 locator.is_visible()。阅读更多关于 定位器 (locators) 的信息。

返回元素是否 可见 (visible)。不匹配任何元素的 selector 被认为不可见。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

    已弃用

    此选项被忽略。frame.is_visible() 不会等待元素变为可见状态,并立即返回。

返回值


press

v1.9 之前添加 frame.press
不推荐使用

请改用基于 locator 的 locator.press()。阅读更多关于 定位器 (locators) 的信息。

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, ControlOrMetaControlOrMeta 在 Windows 和 Linux 上解析为 Control,在 macOS 上解析为 Meta

按住 Shift 键将输入与 key 对应的文本,并以大写形式显示。

如果 key 是单个字符,则它是区分大小写的,因此值 aA 将生成不同的文本。

也支持诸如 key: "Control+o"key: "Control++key: "Control+Shift+T" 之类的快捷方式。当使用修饰符指定时,在按下后续按键时,修饰符会被按下并保持按住状态。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • key str#

    要按下的键的名称或要生成的字符,例如 ArrowLefta

  • delay float (可选)#

    keydownkeyup 之间等待的时间,以毫秒为单位。默认为 0。

  • no_wait_after bool (可选)#

    已弃用

    此选项在未来将默认为 true

    启动导航的操作正在等待这些导航发生并等待页面开始加载。你可以通过设置此标志来选择不等待。你只需要在特殊情况下使用此选项,例如导航到无法访问的页面。默认为 false

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


query_selector

添加于版本: v1.9 frame.query_selector
不推荐使用

请改用基于 locator 的 frame.locator()。阅读更多关于 定位器 (locators) 的信息。

返回指向 frame 元素的 ElementHandle。

注意

不建议使用 ElementHandle,请改用 Locator 对象和 web-first 断言。

该方法在 frame 中查找匹配指定选择器的元素。如果没有元素匹配选择器,则返回 null

用法

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

参数

  • selector str#

    要查询的选择器。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

返回值


query_selector_all

添加于版本: v1.9 frame.query_selector_all
不推荐使用

请改用基于 locator 的 frame.locator()。阅读更多关于 定位器 (locators) 的信息。

返回指向 frame 元素的 ElementHandle 数组。

注意

不建议使用 ElementHandle,请改用 Locator 对象。

该方法在 frame 中查找所有匹配指定选择器的元素。如果没有元素匹配选择器,则返回空数组。

用法

frame.query_selector_all(selector)

参数

  • selector str#

    要查询的选择器。

返回值


select_option

v1.9 之前添加 frame.select_option
不推荐使用

请改用基于 locator 的 locator.select_option()。阅读更多关于 定位器 (locators) 的信息。

此方法等待匹配 selector 的元素,等待 可操作性 (actionability) 检查,等待直到所有指定的选项都出现在 <select> 元素中,并选择这些选项。

如果目标元素不是 <select> 元素,则此方法会抛出错误。但是,如果元素位于具有关联 control<label> 元素内,则将使用该 control。

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

一旦所有提供的选项都被选中,则触发 changeinput 事件。

用法

# 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"])

参数

  • selector str#

    要查询的选择器。

  • force bool (可选)添加于: v1.13#

    是否绕过 actionability 检查。 默认为 false

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • element ElementHandle | List[ElementHandle] (可选)#

    要选择的选项元素。可选。

  • index int | List[int] (可选)#

    要按索引选择的选项。可选。

  • value str | List[str] (可选)#

    要按值选择的选项。如果 <select> 具有 multiple 属性,则会选择所有给定的选项,否则仅选择与传递的选项之一匹配的第一个选项。可选。

  • label str | List[str] (可选)#

    要按标签选择的选项。如果 <select> 具有 multiple 属性,则会选择所有给定的选项,否则仅选择与传递的选项之一匹配的第一个选项。可选。

返回值


set_checked

添加于版本: v1.15 frame.set_checked
不推荐使用

请改用基于 locator 的 locator.set_checked()。阅读更多关于 定位器 (locators) 的信息。

此方法通过执行以下步骤选中或取消选中匹配 selector 的元素

  1. 查找匹配 selector 的元素。如果没有,请等待直到匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。如果不是,则此方法会抛出错误。
  3. 如果元素已处于正确的选中状态,则此方法立即返回。
  4. 等待对匹配元素进行 可操作性 (actionability) 检查,除非设置了 force 选项。如果元素在检查期间分离,则会重试整个操作。
  5. 如果需要,将元素滚动到视图中。
  6. 使用 page.mouse 在元素的中心单击。
  7. 确保元素现在已选中或未选中。如果不是,则此方法会抛出错误。

当所有步骤在指定的 timeout 期间未完成时,此方法会抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • checked bool#

    是否选中或取消选中复选框。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后,此方法仅执行 actionability 检查并跳过该操作。 默认为 false。 用于等待元素准备好执行操作而无需执行它。

返回值


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#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • files Union[str, pathlib.Path] | List[Union[str, pathlib.Path]] | Dict | List[Dict]#

    • name str

      文件名

    • mimeType str

      文件类型

    • buffer bytes

      文件内容

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


tap

v1.9 之前添加 frame.tap
不推荐使用

使用基于定位器的 locator.tap() 代替。阅读更多关于 定位器 的信息。

此方法通过执行以下步骤,点击与 selector 匹配的元素

  1. 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果在检查期间元素被分离,则会重试整个操作。
  3. 如果需要,将元素滚动到视图中。
  4. 使用 page.touchscreen 点击元素中心,或指定的 position

当所有步骤组合起来在指定的 timeout 期间未完成时,此方法将抛出 TimeoutError。传递零超时将禁用此功能。

注意

frame.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

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

    要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: v1.11#

    如果设置,此方法仅执行 可操作性 检查,并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行该操作时非常有用。请注意,键盘 modifiers 将始终被按下,而与 trial 无关,以允许测试仅在按下这些键时才可见的元素。

返回值


text_content

v1.9 之前添加 frame.text_content
不推荐使用

使用基于定位器的 locator.text_content() 代替。阅读更多关于 定位器 的信息。

返回 element.textContent

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


type

v1.9 之前添加 frame.type
已弃用

在大多数情况下,您应该使用 locator.fill() 代替。只有当页面上有特殊的键盘处理时,才需要逐个按键 - 在这种情况下,请使用 locator.press_sequentially()

为文本中的每个字符发送 keydownkeypress/inputkeyup 事件。frame.type 可用于发送细粒度的键盘事件。要填写表单字段中的值,请使用 frame.fill()

要按下特殊键,例如 ControlArrowDown,请使用 keyboard.press()

用法

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • text str#

    要输入到焦点元素中的文本。

  • delay float (可选)#

    按键之间等待的时间,以毫秒为单位。默认为 0。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


uncheck

v1.9 之前添加 frame.uncheck
不推荐使用

使用基于定位器的 locator.uncheck() 代替。阅读更多关于 定位器 的信息。

此方法通过执行以下步骤,取消选中与 selector 匹配的元素

  1. 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。如果不是,此方法将抛出错误。如果元素已取消选中,则此方法立即返回。
  3. 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果在检查期间元素被分离,则会重试整个操作。
  4. 如果需要,将元素滚动到视图中。
  5. 使用 page.mouse 在元素的中心单击。
  6. 确保元素现在已取消选中。如果不是,此方法将抛出错误。

当所有步骤组合起来在指定的 timeout 期间未完成时,此方法将抛出 TimeoutError。传递零超时将禁用此功能。

用法

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

参数

  • selector str#

    用于搜索元素的 selector。如果存在多个满足选择器的元素,则将使用第一个元素。

  • force bool (可选)#

    是否绕过 actionability 检查。 默认为 false

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)添加于版本: v1.11#

    相对于元素内边距框左上角的点。如果未指定,则使用元素的某些可见点。

  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

  • trial bool (可选)添加于版本: v1.11#

    设置后,此方法仅执行 actionability 检查并跳过该操作。 默认为 false。 用于等待元素准备好执行操作而无需执行它。

返回值


wait_for_selector

v1.9 之前添加 frame.wait_for_selector
不推荐使用

使用断言可见性的 Web 断言或基于定位器的 locator.wait_for() 代替。阅读更多关于 定位器 的信息。

当选择器指定的元素满足 state 选项时返回。如果等待 hiddendetached,则返回 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)

参数

  • selector str#

    要查询的选择器。

  • state "attached" | "detached" | "visible" | "hidden" (可选)#

    默认为 'visible'。可以是以下之一

    • 'attached' - 等待元素出现在 DOM 中。
    • 'detached' - 等待元素不在 DOM 中。
    • 'visible' - 等待元素具有非空边界框且没有 visibility:hidden。请注意,没有任何内容或 display:none 的元素具有空边界框,并且不被视为可见。
    • 'hidden' - 等待元素从 DOM 中分离,或具有空边界框或 visibility:hidden。这与 'visible' 选项相反。
  • strict bool (可选)添加于: v1.14#

    如果为 true,则调用需要选择器解析为单个元素。 如果给定的选择器解析为多个元素,则调用将抛出异常。

  • timeout float (可选)#

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

返回值


wait_for_timeout

v1.9 之前添加 frame.wait_for_timeout
不推荐使用

永远不要在生产环境中使用等待超时。等待时间的测试本质上是不稳定的。使用 Locator 操作和自动等待的 Web 断言。

等待给定的 timeout 毫秒数。

请注意,frame.waitForTimeout() 仅应用于调试。在生产环境中使用计时器的测试将是不稳定的。请改用网络事件、选择器变为可见等信号。

用法

frame.wait_for_timeout(timeout)

参数

  • timeout float#

    要等待的超时时间

返回值