Frame
在任何时候,页面都会通过 page.main_frame 和 frame.child_frames 方法公开其当前的框架树。
Frame 对象的生命周期由三个事件控制,这些事件在页面对象上分发
- page.on("frameattached") - 当框架附加到页面时触发。一个框架只能附加到页面一次。
- page.on("framenavigated") - 当框架提交导航到不同的 URL 时触发。
- page.on("framedetached") - 当框架从页面分离时触发。一个框架只能从页面分离一次。
框架树的示例
- 同步
- 异步
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 之前添加当脚本的 onload 事件触发或脚本内容注入到框架时,返回添加的标签。
向页面添加一个带有期望的 url 或内容的 <script>
标签。
用法
frame.add_script_tag()
frame.add_script_tag(**kwargs)
参数
-
要注入到框架中的原始 JavaScript 内容。
-
path
Union[str, pathlib.Path] (可选)#要注入到框架中的 JavaScript 文件的路径。如果
path
是相对路径,则它相对于当前工作目录解析。 -
脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关更多详细信息,请参阅 script。
-
要添加的脚本的 URL。
返回值
add_style_tag
在 v1.9 之前添加当样式表的 onload 事件触发或 CSS 内容注入到框架时,返回添加的标签。
向页面添加一个带有期望的 url 的 <link rel="stylesheet">
标签,或一个带有内容的 <style type="text/css">
标签。
用法
frame.add_style_tag()
frame.add_style_tag(**kwargs)
参数
-
要注入到框架中的原始 CSS 内容。
-
path
Union[str, pathlib.Path] (可选)#要注入到框架中的 CSS 文件的路径。如果
path
是相对路径,则它相对于当前工作目录解析。 -
<link>
标签的 URL。
返回值
content
在 v1.9 之前添加获取框架的完整 HTML 内容,包括 doctype。
用法
frame.content()
返回值
drag_and_drop
添加于:v1.13用法
frame.drag_and_drop(source, target)
frame.drag_and_drop(source, target, **kwargs)
参数
-
用于搜索要拖动元素的选择器。如果存在满足选择器的多个元素,则将使用第一个。
-
用于搜索要放置元素的元素的元素选择器。如果存在满足选择器的多个元素,则将使用第一个。
-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
source_position
Dict (可选)添加于:v1.14#在此点相对于元素内边距框的左上角点击源元素。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
target_position
Dict (可选)添加于:v1.14#在此点相对于元素内边距框的左上角放置到目标元素上。如果未指定,则使用元素的某个可见点。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。在不执行操作的情况下等待元素准备就绪时很有用。
返回值
evaluate
在 v1.9 之前添加返回 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()
参数
-
要在浏览器上下文中评估的 JavaScript 表达式。如果表达式的计算结果为函数,则会自动调用该函数。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
返回值
evaluate_handle
在 v1.9 之前添加将 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()
参数
-
要在浏览器上下文中评估的 JavaScript 表达式。如果表达式的计算结果为函数,则会自动调用该函数。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
返回值
frame_element
在 v1.9 之前添加返回与此框架对应的 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
返回值
frame_locator
添加于:v1.17当使用 iframe 时,您可以创建一个框架定位器,它将进入 iframe 并允许在 iframe 中选择元素。
用法
以下代码片段在 id 为 my-frame
的 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()
参数
返回值
get_by_alt_text
添加于:v1.27允许通过元素的 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()
参数
-
用于定位元素的文本。
-
是否查找精确匹配项:区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略。请注意,精确匹配仍然会修剪空格。
返回值
get_by_label
添加于:v1.27允许通过关联的 <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")
参数
-
用于定位元素的文本。
-
是否查找精确匹配项:区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略。请注意,精确匹配仍然会修剪空格。
返回值
get_by_placeholder
添加于:v1.27允许通过占位符文本定位输入元素。
用法
例如,考虑以下 DOM 结构。
<input type="email" placeholder="[email protected]" />
您可以在通过占位符文本定位输入后填充它
- 同步
- 异步
page.get_by_placeholder("[email protected]").fill("[email protected]")
await page.get_by_placeholder("[email protected]").fill("[email protected]")
参数
-
用于定位元素的文本。
-
是否查找精确匹配项:区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略。请注意,精确匹配仍然会修剪空格。
返回值
get_by_role
添加于:v1.27允许通过元素的 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 角色。
-
通常由
aria-checked
或原生<input type=checkbox>
控件设置的属性。了解更多关于
aria-checked
的信息。 -
通常由
aria-disabled
或disabled
设置的属性。注意与大多数其他属性不同,
disabled
是通过 DOM 层次结构继承的。了解更多关于aria-disabled
的信息。 -
是否精确匹配 name:区分大小写且全字符串匹配。默认为 false。name 是正则表达式时忽略。请注意,精确匹配仍然会修剪空格。
-
通常由
aria-expanded
设置的属性。了解更多关于
aria-expanded
的信息。 -
控制是否匹配隐藏元素的可选项。默认情况下,角色选择器仅匹配非隐藏元素,如 ARIA 定义。
了解更多关于
aria-hidden
的信息。 -
一个数字属性,通常用于角色
heading
、listitem
、row
、treeitem
,对于<h1>-<h6>
元素具有默认值。了解更多关于
aria-level
的信息。 -
匹配可访问名称的选项。默认情况下,匹配不区分大小写并搜索子字符串,使用 exact 来控制此行为。
了解更多关于 可访问名称的信息。
-
通常由
aria-pressed
设置的属性。了解更多关于
aria-pressed
的信息。 -
通常由
aria-selected
设置的属性。了解更多关于
aria-selected
的信息。
返回值
详情
角色选择器不能替代可访问性审计和一致性测试,而是提供关于 ARIA 指南的早期反馈。
许多 html 元素都有一个隐式定义的角色,角色选择器可以识别它。您可以在此处找到所有支持的角色。ARIA 指南不建议通过将 role 和/或 aria-* 属性设置为默认值来复制隐式角色和属性。
get_by_test_id
添加于:v1.27通过测试 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()
参数
返回值
详情
默认情况下,data-testid
属性用作测试 ID。如有必要,使用 selectors.set_test_id_attribute() 配置不同的测试 ID 属性。
get_by_text
添加于:v1.27允许定位包含给定文本的元素。
另请参阅 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))
参数
-
用于定位元素的文本。
-
是否查找精确匹配项:区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略。请注意,精确匹配仍然会修剪空格。
返回值
详情
按文本匹配始终会规范化空格,即使是精确匹配也是如此。例如,它将多个空格变成一个,将换行符变成空格,并忽略前导和尾随空格。
类型为 button
和 submit
的输入元素通过它们的 value
而不是文本内容进行匹配。例如,按文本 "Log in"
定位匹配 <input type=button value="Log in">
。
get_by_title
添加于:v1.27允许通过元素的 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")
参数
-
用于定位元素的文本。
-
是否查找精确匹配项:区分大小写且全字符串匹配。默认为 false。使用正则表达式定位时忽略。请注意,精确匹配仍然会修剪空格。
返回值
goto
在 v1.9 之前添加返回主资源响应。在多次重定向的情况下,导航将使用最后一次重定向的响应来解决。
如果发生以下情况,该方法将抛出错误
- 存在 SSL 错误(例如,自签名证书的情况)。
- 目标 URL 无效。
- 导航期间超过了 超时 时间。
- 远程服务器未响应或无法访问。
- 主资源加载失败。
当远程服务器返回任何有效的 HTTP 状态代码时,包括 404 “未找到” 和 500 “内部服务器错误”,此方法都不会抛出错误。可以通过调用 response.status 来检索此类响应的状态代码。
此方法要么抛出错误,要么返回主资源响应。唯一的例外是导航到 about:blank
或导航到具有不同哈希值的相同 URL,这会成功并返回 null
。
无头模式不支持导航到 PDF 文档。请参阅 上游问题。
用法
frame.goto(url)
frame.goto(url, **kwargs)
参数
-
要导航到的帧的 URL。该 URL 应包含协议方案,例如
https://
。 -
Referer 标头值。如果提供,它将优先于由 page.set_extra_http_headers() 设置的 referer 标头值。
-
最大操作时间,以毫秒为单位,默认为 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(selector)
frame.is_enabled(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
locator
添加于:v1.14该方法返回一个元素定位器,可用于在此页面/帧上执行操作。定位器在执行操作之前立即解析为元素,因此在同一定位器上执行的一系列操作实际上可以在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生了更改,则会发生这种情况。
用法
frame.locator(selector)
frame.locator(selector, **kwargs)
参数
-
解析 DOM 元素时使用的选择器。
-
将方法的结果缩小到包含与此相对定位器匹配的元素的那些结果。例如,包含
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#匹配在内部的某个位置(可能在子元素或后代元素中)不包含指定文本的元素。当传递 [字符串] 时,匹配不区分大小写并搜索子字符串。
-
匹配在内部的某个位置(可能在子元素或后代元素中)包含指定文本的元素。当传递 [字符串] 时,匹配不区分大小写并搜索子字符串。例如,
"Playwright"
匹配<article><div>Playwright</div></article>
。
返回值
set_content
在 v1.9 之前添加此方法在内部调用 document.write(),继承其所有特定特性和行为。
用法
frame.set_content(html)
frame.set_content(html, **kwargs)
参数
-
要分配给页面的 HTML 标记。
-
最大操作时间,以毫秒为单位,默认为 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()
返回值
wait_for_function
在 v1.9 之前添加当 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)
参数
-
要在浏览器上下文中评估的 JavaScript 表达式。如果表达式的计算结果为函数,则会自动调用该函数。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
-
如果 polling 为
'raf'
,则 expression 在requestAnimationFrame
回调中持续执行。如果 polling 是一个数字,则将其视为函数执行的毫秒间隔。默认为raf
。 -
最大等待时间,以毫秒为单位。默认为
30000
(30 秒)。传递0
以禁用超时。默认值可以通过使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法来更改。
返回值
wait_for_load_state
在 v1.9 之前添加等待达到所需的加载状态。
当帧达到所需的加载状态时,默认情况下为 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 断言来评估就绪状态。
-
最大操作时间,以毫秒为单位,默认为 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等待帧导航到给定的 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。
-
最大操作时间,以毫秒为单位,默认为 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
返回值
is_detached
在 v1.9 之前添加如果帧已分离,则返回 true
,否则返回 false
。
用法
frame.is_detached()
返回值
name
在 v1.9 之前添加返回在 标签中指定的帧的 name 属性。
如果 name 为空,则返回 id 属性。
此值在创建帧时计算一次,如果稍后更改属性,则不会更新。
用法
frame.name
返回值
page
在 v1.9 之前添加返回包含此帧的页面。
用法
frame.page
返回值
parent_frame
在 v1.9 之前添加父帧,如果有的话。分离的帧和主帧返回 null
。
用法
frame.parent_frame
返回值
url
在 v1.9 之前添加返回帧的 URL。
用法
frame.url
返回值
已弃用
check
在 v1.9 之前添加请改用基于定位器的 locator.check()。阅读更多关于 定位器 的信息。
此方法通过执行以下步骤来检查与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入框。如果不是,此方法将抛出错误。如果元素已被选中,则此方法立即返回。
- 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果元素在检查期间分离,则会重试整个操作。
- 如果需要,将元素滚动到视图中。
- 使用 page.mouse 在元素的中心单击。
- 确保元素现在已被选中。如果不是,此方法将抛出错误。
当所有步骤在指定的 timeout 期间未完成时,此方法将抛出 TimeoutError。传递零超时将禁用此超时。
用法
frame.check(selector)
frame.check(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。在不执行操作的情况下等待元素准备就绪时很有用。
返回值
click
在 v1.9 之前添加请改用基于定位器的 locator.click()。阅读更多关于 定位器 的信息。
此方法通过执行以下步骤来单击与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
- 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果元素在检查期间分离,则会重试整个操作。
- 如果需要,将元素滚动到视图中。
- 使用 page.mouse 在元素的中心或指定的 position 单击。
- 等待启动的导航成功或失败,除非设置了 no_wait_after 选项。
当所有步骤在指定的 timeout 期间未完成时,此方法将抛出 TimeoutError。传递零超时将禁用此超时。
用法
frame.click(selector)
frame.click(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
button
"left" | "right" | "middle" (可选)#默认为
left
。 -
默认为 1。请参阅 UIEvent.detail。
-
mousedown
和mouseup
之间等待的时间,以毫秒为单位。默认为 0。 -
是否绕过可操作性检查。默认为
false
。 -
modifiers
List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。
-
已弃用
此选项在未来将默认为
true
。启动导航的操作正在等待这些导航发生并等待页面开始加载。您可以通过设置此标志来选择不等待。您只需要在特殊情况下使用此选项,例如导航到无法访问的页面。默认为
false
。 -
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
当设置时,此方法仅执行 可操作性 检查并跳过操作。默认为
false
。用于等待元素准备好进行操作而无需执行操作。请注意,键盘modifiers
将始终按下,而与trial
无关,以允许测试仅在按下这些键时才可见的元素。
返回值
dblclick
在 v1.9 之前添加请改用基于定位器的 locator.dblclick()。阅读更多关于 定位器 的信息。
此方法通过执行以下步骤来双击与 selector 匹配的元素:
- 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
- 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果元素在检查期间分离,则会重试整个操作。
- 如果需要,将元素滚动到视图中。
- 使用 page.mouse 在元素的中心或指定的 position 双击。如果
dblclick()
的第一次单击触发了导航事件,则此方法将抛出错误。
当所有步骤在指定的 timeout 期间未完成时,此方法将抛出 TimeoutError。传递零超时将禁用此超时。
frame.dblclick()
调度两个 click
事件和一个 dblclick
事件。
用法
frame.dblclick(selector)
frame.dblclick(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
button
"left" | "right" | "middle" (可选)#默认为
left
。 -
mousedown
和mouseup
之间等待的时间,以毫秒为单位。默认为 0。 -
是否绕过可操作性检查。默认为
false
。 -
modifiers
List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。
-
已弃用
此选项无效。
此选项无效。
-
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
当设置时,此方法仅执行 可操作性 检查并跳过操作。默认为
false
。用于等待元素准备好进行操作而无需执行操作。请注意,键盘modifiers
将始终按下,而与trial
无关,以允许测试仅在按下这些键时才可见的元素。
返回值
dispatch_event
在 v1.9 之前添加请改用基于定位器的 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 是事件特定的,请参阅事件文档以获取初始属性列表
- DeviceMotionEvent
- DeviceOrientationEvent
- DragEvent
- Event
- FocusEvent
- KeyboardEvent
- MouseEvent
- PointerEvent
- TouchEvent
- WheelEvent
如果您希望将活动对象传递到事件中,您还可以将 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 })
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
DOM 事件类型:
"click"
、"dragstart"
等。 -
event_init
EvaluationArgument (可选)#可选的事件特定初始化属性。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
eval_on_selector
添加于:v1.9此方法不等待元素通过可操作性检查,因此可能导致测试不稳定。请改用 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")
参数
-
要查询的选择器。
-
要在浏览器上下文中评估的 JavaScript 表达式。如果表达式的计算结果为函数,则会自动调用该函数。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
返回值
eval_on_selector_all
添加于:v1.9在大多数情况下,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)
参数
-
要查询的选择器。
-
要在浏览器上下文中评估的 JavaScript 表达式。如果表达式的计算结果为函数,则会自动调用该函数。
-
arg
EvaluationArgument (可选)#传递给 expression 的可选参数。
返回值
expect_navigation
在 v1.9 之前添加此方法本质上是竞态的,请改用 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 被视为导航。
参数
-
最大操作时间,以毫秒为单位,默认为 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 之前添加请改用基于 locator 的 locator.fill()。阅读更多关于 locator 的信息。
此方法等待与 selector 匹配的元素,等待 actionability 检查,聚焦元素,填充它,并在填充后触发 input
事件。请注意,您可以传递空字符串来清除输入字段。
如果目标元素不是 <input>
、<textarea>
或 [contenteditable]
元素,则此方法会抛出错误。但是,如果元素位于具有关联 control 的 <label>
元素内,则将改为填充该控件。
要发送细粒度的键盘事件,请使用 locator.press_sequentially()。
用法
frame.fill(selector, value)
frame.fill(selector, value, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
要为
<input>
、<textarea>
或[contenteditable]
元素填充的值。 -
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
focus
在 v1.9 之前添加请改用基于 locator 的 locator.focus()。阅读更多关于 locator 的信息。
此方法获取带有 selector 的元素并聚焦它。如果没有与 selector 匹配的元素,该方法将等待直到 DOM 中出现匹配的元素。
用法
frame.focus(selector)
frame.focus(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
get_attribute
在 v1.9 之前添加请改用基于 locator 的 locator.get_attribute()。阅读更多关于 locator 的信息。
返回元素属性值。
用法
frame.get_attribute(selector, name)
frame.get_attribute(selector, name, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
要获取其值的属性名称。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
hover
在 v1.9 之前添加请改用基于 locator 的 locator.hover()。阅读更多关于 locator 的信息。
此方法通过执行以下步骤,悬停在与 selector 匹配的元素上
- 查找与 selector 匹配的元素。如果没有,请等待直到匹配的元素附加到 DOM。
- 除非设置了 force 选项,否则等待对匹配元素进行 actionability 检查。如果元素在检查期间分离,则会重试整个操作。
- 如果需要,将元素滚动到视图中。
- 使用 page.mouse 悬停在元素的中心,或指定的 position。
当所有组合步骤在指定的 timeout 期间未完成时,此方法将抛出 TimeoutError。传递零超时会禁用此功能。
用法
frame.hover(selector)
frame.hover(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
是否绕过可操作性检查。默认为
false
。 -
modifiers
List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。
-
no_wait_after
bool (可选)添加于:v1.28#已弃用此选项无效。
此选项无效。
-
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
当设置时,此方法仅执行 可操作性 检查并跳过操作。默认为
false
。用于等待元素准备好进行操作而无需执行操作。请注意,键盘modifiers
将始终按下,而与trial
无关,以允许测试仅在按下这些键时才可见的元素。
返回值
inner_html
在 v1.9 之前添加请改用基于 locator 的 locator.inner_html()。阅读更多关于 locator 的信息。
返回 element.innerHTML
。
用法
frame.inner_html(selector)
frame.inner_html(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
inner_text
在 v1.9 之前添加请改用基于 locator 的 locator.inner_text()。阅读更多关于 locator 的信息。
返回 element.innerText
。
用法
frame.inner_text(selector)
frame.inner_text(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
input_value
添加于:v1.13请改用基于 locator 的 locator.input_value()。阅读更多关于 locator 的信息。
返回所选 <input>
或 <textarea>
或 <select>
元素的 input.value
。
对非输入元素抛出异常。但是,如果元素位于具有关联 control 的 <label>
元素内,则返回该控件的值。
用法
frame.input_value(selector)
frame.input_value(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
is_checked
在 v1.9 之前添加请改用基于 locator 的 locator.is_checked()。阅读更多关于 locator 的信息。
返回元素是否被选中。如果元素不是复选框或单选输入框,则抛出异常。
用法
frame.is_checked(selector)
frame.is_checked(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
is_disabled
在 v1.9 之前添加请改用基于 locator 的 locator.is_disabled()。阅读更多关于 locator 的信息。
返回元素是否被禁用,与 enabled 相反。
用法
frame.is_disabled(selector)
frame.is_disabled(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
is_editable
在 v1.9 之前添加请改用基于 locator 的 locator.is_editable()。阅读更多关于 locator 的信息。
返回元素是否为 可编辑。
用法
frame.is_editable(selector)
frame.is_editable(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
is_hidden
在 v1.9 之前添加请改用基于 locator 的 locator.is_hidden()。阅读更多关于 locator 的信息。
返回元素是否隐藏,与 visible 相反。不匹配任何元素的 selector 被认为是隐藏的。
用法
frame.is_hidden(selector)
frame.is_hidden(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
已弃用
此选项被忽略。frame.is_hidden() 不会等待元素变为隐藏状态,并立即返回。
返回值
is_visible
在 v1.9 之前添加请改用基于 locator 的 locator.is_visible()。阅读更多关于 locator 的信息。
返回元素是否 可见。不匹配任何元素的 selector 被认为不可见。
用法
frame.is_visible(selector)
frame.is_visible(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
已弃用
此选项被忽略。frame.is_visible() 不会等待元素变为可见状态,并立即返回。
返回值
press
在 v1.9 之前添加请改用基于 locator 的 locator.press()。阅读更多关于 locator 的信息。
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)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
要按下的键的名称或要生成的字符,例如
ArrowLeft
或a
。 -
keydown
和keyup
之间等待的时间,以毫秒为单位。默认为 0。 -
已弃用
此选项在未来将默认为
true
。启动导航的操作正在等待这些导航发生并等待页面开始加载。您可以通过设置此标志来选择不等待。您只需要在特殊情况下使用此选项,例如导航到无法访问的页面。默认为
false
。 -
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
query_selector
添加于:v1.9请改用基于 locator 的 frame.locator()。阅读更多关于 locator 的信息。
返回指向框架元素的 ElementHandle。
不鼓励使用 ElementHandle,请改用 Locator 对象和 web-first 断言。
该方法查找框架内与指定选择器匹配的元素。如果没有元素与选择器匹配,则返回 null
。
用法
frame.query_selector(selector)
frame.query_selector(selector, **kwargs)
参数
-
要查询的选择器。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
返回值
query_selector_all
添加于:v1.9请改用基于 locator 的 frame.locator()。阅读更多关于 locator 的信息。
返回指向框架元素的 ElementHandle 数组。
不鼓励使用 ElementHandle,请改用 Locator 对象。
该方法查找框架内与指定选择器匹配的所有元素。如果没有元素与选择器匹配,则返回空数组。
用法
frame.query_selector_all(selector)
参数
返回值
select_option
在 v1.9 之前添加请改用基于 locator 的 locator.select_option()。阅读更多关于 locator 的信息。
此方法等待与 selector 匹配的元素,等待 actionability 检查,等待直到所有指定的选项都出现在 <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"])
参数
-
要查询的选择器。
-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
element
ElementHandle | List[ElementHandle] (可选)#要选择的选项元素。可选。
-
要按索引选择的选项。可选。
-
要按值选择的选项。如果
<select>
具有multiple
属性,则会选择所有给定的选项,否则仅选择与传递的选项之一匹配的第一个选项。可选。 -
要按标签选择的选项。如果
<select>
具有multiple
属性,则会选择所有给定的选项,否则仅选择与传递的选项之一匹配的第一个选项。可选。
返回值
set_checked
添加于: v1.15请使用基于定位器的 locator.set_checked() 代替。阅读更多关于 locators 的信息。
此方法通过执行以下步骤,选中或取消选中与 selector 匹配的元素
- 查找与 selector 匹配的元素。如果找不到,则等待直到匹配的元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入框。如果不是,此方法将抛出错误。
- 如果元素已经处于正确的选中状态,则此方法立即返回。
- 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果在检查期间元素被分离,则整个操作将重试。
- 如果需要,将元素滚动到视图中。
- 使用 page.mouse 在元素的中心单击。
- 确保元素现在已被选中或取消选中。如果不是,此方法将抛出错误。
当所有步骤在指定的 timeout 时间内未完成时,此方法将抛出 TimeoutError 错误。传递零超时将禁用此功能。
用法
frame.set_checked(selector, checked)
frame.set_checked(selector, checked, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
是否选中或取消选中复选框。
-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。在不执行操作的情况下等待元素准备就绪时很有用。
返回值
set_input_files
在 v1.9 之前添加请使用基于定位器的 locator.set_input_files() 代替。阅读更多关于 locators 的信息。
将文件输入的值设置为这些文件路径或文件。如果某些 filePaths
是相对路径,则它们将相对于当前工作目录解析。对于空数组,清除选定的文件。
此方法期望 selector 指向一个 input 元素。但是,如果元素位于具有关联 control 的 <label>
元素内,则会改为定位到该 control。
用法
frame.set_input_files(selector, files)
frame.set_input_files(selector, files, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
files
Union[str, pathlib.Path] | List[Union[str, pathlib.Path]] | Dict | List[Dict]# -
已弃用
此选项无效。
此选项无效。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
tap
在 v1.9 之前添加请使用基于定位器的 locator.tap() 代替。阅读更多关于 locators 的信息。
此方法通过执行以下步骤,点击与 selector 匹配的元素
- 查找与 selector 匹配的元素。如果找不到,则等待直到匹配的元素附加到 DOM。
- 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果在检查期间元素被分离,则整个操作将重试。
- 如果需要,将元素滚动到视图中。
- 使用 page.touchscreen 点击元素的中心,或指定的 position。
当所有步骤在指定的 timeout 时间内未完成时,此方法将抛出 TimeoutError 错误。传递零超时将禁用此功能。
frame.tap()
要求浏览器上下文的 hasTouch
选项设置为 true。
用法
frame.tap(selector)
frame.tap(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
是否绕过可操作性检查。默认为
false
。 -
modifiers
List["Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"] (可选)#要按下的修饰键。确保在操作期间仅按下这些修饰键,然后恢复当前的修饰键。如果未指定,则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control",在 macOS 上解析为 "Meta"。
-
已弃用
此选项无效。
此选项无效。
-
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
当设置时,此方法仅执行 可操作性 检查并跳过操作。默认为
false
。用于等待元素准备好进行操作而无需执行操作。请注意,键盘modifiers
将始终按下,而与trial
无关,以允许测试仅在按下这些键时才可见的元素。
返回值
text_content
在 v1.9 之前添加请使用基于定位器的 locator.text_content() 代替。阅读更多关于 locators 的信息。
返回 element.textContent
。
用法
frame.text_content(selector)
frame.text_content(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
type
在 v1.9 之前添加在大多数情况下,您应该使用 locator.fill() 代替。只有当页面上有特殊的键盘处理时,您才需要逐个按键 - 在这种情况下,请使用 locator.press_sequentially()。
为文本中的每个字符发送 keydown
、keypress
/input
和 keyup
事件。frame.type
可用于发送细粒度的键盘事件。要在表单字段中填充值,请使用 frame.fill()。
要按下特殊键,例如 Control
或 ArrowDown
,请使用 keyboard.press()。
用法
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
要输入到焦点元素中的文本。
-
每次按键之间等待的时间,以毫秒为单位。默认为 0。
-
已弃用
此选项无效。
此选项无效。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
uncheck
在 v1.9 之前添加请使用基于定位器的 locator.uncheck() 代替。阅读更多关于 locators 的信息。
此方法通过执行以下步骤,检查与 selector 匹配的元素
- 查找与 selector 匹配的元素。如果找不到,则等待直到匹配的元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入框。如果不是,此方法将抛出错误。如果元素已经取消选中,则此方法立即返回。
- 等待对匹配元素执行 可操作性 检查,除非设置了 force 选项。如果在检查期间元素被分离,则整个操作将重试。
- 如果需要,将元素滚动到视图中。
- 使用 page.mouse 在元素的中心单击。
- 确保元素现在已取消选中。如果不是,此方法将抛出错误。
当所有步骤在指定的 timeout 时间内未完成时,此方法将抛出 TimeoutError 错误。传递零超时将禁用此功能。
用法
frame.uncheck(selector)
frame.uncheck(selector, **kwargs)
参数
-
用于搜索元素的 CSS 选择器。如果存在多个满足选择器的元素,则将使用第一个。
-
是否绕过可操作性检查。默认为
false
。 -
已弃用
此选项无效。
此选项无效。
-
相对于元素内边距框左上角的点。如果未指定,则使用元素的某个可见点。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。 -
设置后,此方法仅执行可操作性检查并跳过操作。默认为
false
。在不执行操作的情况下等待元素准备就绪时很有用。
返回值
wait_for_selector
在 v1.9 之前添加请使用断言可见性的 Web 断言或基于定位器的 locator.wait_for() 代替。阅读更多关于 locators 的信息。
当 selector 指定的元素满足 state 选项时返回。如果等待 hidden
或 detached
,则返回 null
。
Playwright 在执行操作之前自动等待元素准备就绪。使用 Locator 对象和 Web 优先断言使代码无需使用 wait-for-selector。
等待 selector 满足 state 选项(在 DOM 中出现/消失,或变为可见/隐藏)。如果在调用方法时 selector 已经满足条件,则该方法将立即返回。如果 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())
参数
-
要查询的选择器。
-
state
"attached" | "detached" | "visible" | "hidden" (可选)#默认为
'visible'
。可以是以下之一'attached'
- 等待元素出现在 DOM 中。'detached'
- 等待元素不在 DOM 中。'visible'
- 等待元素具有非空的边界框且没有visibility:hidden
。请注意,没有任何内容或display:none
的元素具有空的边界框,并且不被视为可见。'hidden'
- 等待元素从 DOM 中分离,或具有空的边界框或visibility:hidden
。这与'visible'
选项相反。
-
如果为 true,则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素,则调用会抛出异常。
-
最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。可以使用 browser_context.set_default_timeout() 或 page.set_default_timeout() 方法更改默认值。
返回值
wait_for_timeout
在 v1.9 之前添加永远不要在生产环境中使用超时等待。等待时间的测试本质上是不稳定的。请使用 Locator 操作和自动等待的 Web 断言。
等待给定的 timeout 时间(以毫秒为单位)。
请注意,frame.waitForTimeout()
仅应用于调试。在生产环境中使用计时器的测试将是不稳定的。请改用网络事件、选择器变为可见等信号。
用法
frame.wait_for_timeout(timeout)
参数
返回值