Frame

在任何时间点，页面都会通过 page.main_frame 和 frame.child_frames 方法暴露其当前的框架树。

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

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

倾倒框架树的示例

同步
异步

from playwright.sync_api import sync_playwright, Playwright

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

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

with sync_playwright() as playwright:
    run(playwright)

import asyncio
from playwright.async_api import async_playwright, Playwright

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

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

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

方法

add_script_tag

v1.9 版本前添加

frame.add_script_tag

脚本加载或脚本内容注入框架后触发 onload 时返回添加的标签。

向页面添加一个带有指定 URL 或内容的 <script> 标签。

用法

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

参数

content str (可选)#

注入框架的原始 JavaScript 内容。
path Union[str, pathlib.Path] (可选)#

注入框架的 JavaScript 文件路径。如果 path 是相对路径，则会相对于当前工作目录解析。
type str (可选)#

脚本类型。使用 'module' 以加载 JavaScript ES6 模块。更多详情请参见 script。
url str (可选)#

要添加的脚本的 URL。

返回值

ElementHandle #

add_style_tag

v1.9 版本前添加

frame.add_style_tag

样式表加载或 CSS 内容注入框架后触发 onload 时返回添加的标签。

向页面添加一个带有指定 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
相对于元素内边距框左上角，在此点上点击源元素。如果未指定，则使用元素的某个可见点。
strict bool (可选)v1.14 版本添加#

如果为 true，则要求定位符解析为单个元素。如果给定的定位符解析为多个元素，则调用将抛出异常。
target_position Dict (可选)v1.14 版本添加#
- x float
- y float
相对于元素内边距框左上角，在此点上释放到目标元素。如果未指定，则使用元素的某个可见点。
timeout float (可选)#

最大毫秒数。默认为 30000 (30 秒)。传入 0 以禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需实际执行。

返回值

NoneType #

evaluate

v1.9 版本前添加

frame.evaluate

返回 expression 的返回值。

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

如果传递给 frame.evaluate() 的函数返回一个非可序列化的值，则 frame.evaluate() 返回 undefined。Playwright 还支持传输一些 JSON 不可序列化的额外值：-0, NaN, Infinity, -Infinity。

用法

同步
异步

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

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

也可以传入字符串而不是函数。

同步
异步

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

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

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

同步
异步

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

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

参数

expression str #

在浏览器上下文要评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。
arg EvaluationArgument (可选)#

传递给 expression 的可选参数。

返回值

Dict #

evaluate_handle

v1.9 版本前添加

frame.evaluate_handle

将 expression 的返回值作为 JSHandle 返回。

frame.evaluate() 和 frame.evaluate_handle() 唯一的区别在于 frame.evaluate_handle() 返回 JSHandle。

如果传递给 frame.evaluate_handle() 的函数返回一个 Promise，则 frame.evaluate_handle() 将等待该 Promise 解析并返回其值。

用法

同步
异步

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

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

也可以传入字符串而不是函数。

同步
异步

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

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

JSHandle 实例可以作为参数传递给 frame.evaluate_handle()。

同步
异步

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

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

参数

expression str #

在浏览器上下文要评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。
arg EvaluationArgument (可选)#

传递给 expression 的可选参数。

返回值

JSHandle #

frame_element

v1.9 版本前添加

frame.frame_element

返回与此框架对应的 frame 或 iframe 元素句柄。

这是 element_handle.content_frame() 的逆操作。注意，返回的句柄实际上属于父框架。

如果在 frameElement() 返回之前框架已分离，此方法会抛出错误。

用法

同步
异步

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

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

返回值

ElementHandle #

frame_locator

v1.17 版本添加

frame.frame_locator

处理 iframe 时，您可以创建一个框架定位符，该定位符将进入 iframe 并允许在该 iframe 中选择元素。

用法

以下片段查找 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()

参数

selector str #

解析 DOM 元素时使用的定位符。

返回值

FrameLocator #

get_by_alt_text

v1.27 版本添加

frame.get_by_alt_text

允许按元素的 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本 "Playwright logo" 查找图像

<img alt='Playwright logo'>

同步
异步

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

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

参数

text str | Pattern #

用于定位元素的文本。
exact bool (可选)#

是否查找精确匹配项：区分大小写和整个字符串匹配。默认为 false。按正则表达式定位时忽略。注意，精确匹配仍然会修剪空格。

返回值

Locator #

get_by_label

v1.27 版本添加

frame.get_by_label

允许通过关联的 <label> 或 aria-labelledby 元素的文本或通过 aria-label 属性定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签 "Username" 和 "Password" 查找输入框

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

同步
异步

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

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

参数

text str | Pattern #

用于定位元素的文本。
exact bool (可选)#

是否查找精确匹配项：区分大小写和整个字符串匹配。默认为 false。按正则表达式定位时忽略。注意，精确匹配仍然会修剪空格。

返回值

Locator #

get_by_placeholder

v1.27 版本添加

frame.get_by_placeholder

允许通过占位符文本定位输入元素。

用法

例如，考虑以下 DOM 结构。

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

通过占位符文本定位输入框后，您可以填充它

同步
异步

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

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

参数

text str | Pattern #

用于定位元素的文本。
exact bool (可选)#

是否查找精确匹配项：区分大小写和整个字符串匹配。默认为 false。按正则表达式定位时忽略。注意，精确匹配仍然会修剪空格。

返回值

Locator #

get_by_role

v1.27 版本添加

frame.get_by_role

允许通过元素的 ARIA role、ARIA 属性和 accessible name 定位元素。

用法

考虑以下 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 role。
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 (可选)#

匹配 accessible name 的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 exact 控制此行为。

了解有关 accessible name 的更多信息。
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 而非文本内容匹配的。例如，按文本 "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>

通过 title 文本定位后，您可以检查 issue 数量

同步
异步

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 可禁用超时。默认值可通过使用 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

bool #

locator

v1.14 版本添加

frame.locator

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

了解有关定位符的更多信息.

用法

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

参数

selector str #

解析 DOM 元素时使用的定位符。
has Locator (可选)#

将方法结果缩小到包含与此相对定位符匹配的元素的范围。例如，具有 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。

内部定位符必须相对于外部定位符，并且查询是从外部定位符匹配开始的，而不是文档根目录。例如，您可以在 <article><content><div>Playwright</div></content></article> 中找到包含 div 的 content。但是，查找包含 article div 的 content 将失败，因为内部定位符必须是相对的，并且不应使用 content 外部的任何元素。

请注意，外部和内部定位符必须属于同一框架。内部定位符不得包含 FrameLocator。
has_not Locator (可选)新增于: v1.33#

匹配不包含与内部定位符匹配的元素的元素。内部定位符针对外部定位符进行查询。例如，不包含 div 的 article 匹配 <article><span>Playwright</span></article>。

请注意，外部和内部定位符必须属于同一框架。内部定位符不得包含 FrameLocator。
has_not_text str | Pattern (可选)新增于: v1.33#

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

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

返回值

Locator #

set_content

v1.9 版本前添加

frame.set_content

此方法内部调用 document.write()，并继承其所有特定特性和行为。

用法

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

参数

html str #

要分配给页面的 HTML 标记。
timeout float (可选)#

最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。
wait_until "load" | "domcontentloaded" | "networkidle" | "commit" (可选)#

何时认为操作成功，默认为 load。事件可以是以下之一：
- 'domcontentloaded' - 当触发 DOMContentLoaded 事件时认为操作完成。
- 'load' - 当触发 load 事件时认为操作完成。
- 'networkidle' - 不建议使用 当至少 500 毫秒内没有网络连接时认为操作完成。不要将此方法用于测试，而是依赖 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 函数的 predicate

同步
异步

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

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

参数

expression str #

在浏览器上下文要评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。
arg EvaluationArgument (可选)#

要传递给 expression 的可选参数。
polling float | "raf" (可选)#

如果 polling 为 'raf'，则 expression 会在 requestAnimationFrame 回调中持续执行。如果 polling 为数字，则视为函数执行的间隔（以毫秒为单位）。默认为 raf。
timeout float (可选)#

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

返回值

JSHandle #

wait_for_load_state

v1.9 版本前添加

frame.wait_for_load_state

等待达到所需的加载状态。

当框架达到所需的加载状态时（默认为 load），此方法返回。调用此方法时，导航必须已经提交。如果当前文档已达到所需状态，则立即解析。

注意

大多数情况下，无需使用此方法，因为 Playwright 在每次操作前都会自动等待。

用法

同步
异步

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

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

参数

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

要等待的可选加载状态，默认为 load。如果在加载当前文档时已达到该状态，则方法立即解析。可以是以下任一值：
- 'load' - 等待 load 事件触发。
- 'domcontentloaded' - 等待 DOMContentLoaded 事件触发。
- 'networkidle' - 不推荐使用 等待直到至少 500 毫秒内没有网络连接。请勿将此方法用于测试，而应依赖 web assertions 来评估准备状态。
timeout float (可选)#

最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout()、browser_context.set_default_timeout()、page.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType #

wait_for_url

新增于: v1.11

frame.wait_for_url

等待框架导航到指定的 URL。

用法

同步
异步

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

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

参数

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

等待导航时用于匹配 URL 的 glob 模式、regex 模式或 predicate。请注意，如果参数是不含通配符的字符串，则该方法将等待导航到与该字符串完全相等的 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' - 当收到网络响应且文档开始加载时认为操作完成。

返回值

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

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

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

注意

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

用法

frame.name

返回值

str #

page

v1.9 版本前添加

frame.page

返回包含此框架的页面。

用法

frame.page

返回值

Page #

parent_frame

v1.9 版本前添加

frame.parent_frame

父框架（如果有）。已分离的框架和主框架返回 null。

用法

frame.parent_frame

返回值

NoneType | Frame #

url

v1.9 版本前添加

frame.url

返回框架的 url。

用法

frame.url

返回值

str #

已弃用

check

v1.9 版本前添加

frame.check

不推荐使用

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

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

查找匹配 selector 的元素。如果不存在，则等待匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选输入。如果不是，则此方法抛出异常。如果元素已被选中，则此方法立即返回。
等待对匹配的元素执行 actionability 检查，除非设置了 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)新增于: v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需实际执行。

返回值

NoneType #

click

v1.9 版本前添加

frame.click

不推荐使用

请改用基于定位符的 locator.click()。了解有关定位符的更多信息。

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

查找匹配 selector 的元素。如果不存在，则等待匹配的元素附加到 DOM。
等待对匹配的元素执行 actionability 检查，除非设置了 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)新增于: v1.11#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需执行操作本身。请注意，无论是否设置了 trial，都会按下键盘 modifiers 以允许测试只有在按下这些键时才可见的元素。

返回值

NoneType #

dblclick

v1.9 版本前添加

frame.dblclick

不推荐使用

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

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

查找匹配 selector 的元素。如果不存在，则等待匹配的元素附加到 DOM。
等待对匹配的元素执行 actionability 检查，除非设置了 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)新增于: v1.11#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需执行操作本身。请注意，无论是否设置了 trial，都会按下键盘 modifiers 以允许测试只有在按下这些键时才可见的元素。

返回值

NoneType #

dispatch_event

v1.9 版本前添加

frame.dispatch_event

不推荐使用

请改用基于定位符的 locator.dispatch_event()。了解有关定位符的更多信息。

下面的代码片段在元素上分发 click 事件。无论元素的可见性状态如何，click 事件都会被分发。

用法

同步
异步

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

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

这等同于调用 element.click()。

底层实现是，根据给定的 type 创建一个事件实例，使用 event_init 属性对其进行初始化，并在元素上分发该事件。事件默认是 composed、cancelable 和冒泡的。

由于 event_init 是事件特定的，请参考事件文档获取初始属性列表
DeviceMotionEvent
DeviceOrientationEvent
DragEvent
Event
FocusEvent
KeyboardEvent
MouseEvent
PointerEvent
TouchEvent

WheelEvent

同步
异步

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

参数

如果希望将活动对象传递到事件中，也可以将 JSHandle 指定为属性值

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
selector str #

type str #
DOM 事件类型："click"、"dragstart" 等。

event_init EvaluationArgument (可选)#
strict bool (可选)v1.14 版本添加#

如果为 true，则要求定位符解析为单个元素。如果给定的定位符解析为多个元素，则调用将抛出异常。
可选的事件特定初始化属性。

最大毫秒数。默认为 30000 (30 秒)。传入 0 以禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

timeout float (可选)#

NoneType #

eval_on_selector

新增于: v1.9

不推荐使用

frame.eval_on_selector

此方法不等待元素通过 actionability 检查，因此可能导致测试不稳定。请改用 locator.evaluate()、其他 Locator 辅助方法或 web-first assertions。

返回 expression 的返回值。

该方法在框架内查找匹配指定 selector 的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配该 selector，该方法将抛出错误。

用法

同步
异步

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

参数

如果 expression 返回一个 Promise，则 frame.eval_on_selector() 将等待 Promise 解析并返回其值。

selector str #
要查询的定位符。

在浏览器上下文要评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。
expression str #

arg EvaluationArgument (可选)#
strict bool (可选)v1.14 版本添加#

如果为 true，则要求定位符解析为单个元素。如果给定的定位符解析为多个元素，则调用将抛出异常。

返回值

要传递给 expression 的可选参数。

Dict #

eval_on_selector

eval_on_selector_all

不推荐使用

frame.eval_on_selector_all

在大多数情况下，locator.evaluate_all()、其他 Locator 辅助方法和 web-first assertions 的效果更好。

返回 expression 的返回值。

该方法在框架内查找匹配指定 selector 的所有元素，并将匹配元素的数组作为第一个参数传递给 expression。

用法

同步
异步

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)

参数

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

selector str #
selector str #

在浏览器上下文要评估的 JavaScript 表达式。如果表达式评估为一个函数，该函数将自动调用。
expression str #

arg EvaluationArgument (可选)#

返回值

要传递给 expression 的可选参数。

v1.9 版本前添加

expect_navigation

已废弃

frame.expect_navigation

此方法存在固有的竞态条件，请改用 frame.wait_for_url()。

用法

此方法等待 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

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 可禁用超时。默认值可通过使用 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 (可选)#

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

何时认为操作成功，默认为 load。事件可以是以下之一：
- 'domcontentloaded' - 当触发 DOMContentLoaded 事件时认为操作完成。
- 'load' - 当触发 load 事件时认为操作完成。
- 'networkidle' - 不建议使用 当至少 500 毫秒内没有网络连接时认为操作完成。不要将此方法用于测试，而是依赖 Web 断言来评估就绪状态。
- 'commit' - 当收到网络响应且文档开始加载时认为操作完成。

返回值

EventContextManager[Response]#

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType #

focus

v1.9 版本前添加

frame.focus

不推荐使用

改用基于 locator 的 locator.focus() 方法。了解更多关于 locators 的信息。

此方法获取与 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType #

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
name str #

要获取值的属性名称。
strict bool (可选)v1.14 版本添加#

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

最大毫秒数。默认为 30000 (30 秒)。传入 0 以禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType | str #

hover

v1.9 版本前添加

frame.hover

不推荐使用

改用基于 locator 的 locator.hover() 方法。了解更多关于 locators 的信息。

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

查找与 selector 匹配的元素。如果没有找到，则等待，直到匹配的元素附加到 DOM。
等待对匹配元素执行 actionability 检查，除非设置了 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)新增于: v1.11#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需执行操作本身。请注意，无论是否设置了 trial，都会按下键盘 modifiers 以允许测试只有在按下这些键时才可见的元素。

返回值

NoneType #

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
strict bool (可选)v1.14 版本添加#

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

最大毫秒数。默认为 30000 (30 秒)。传入 0 以禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

str #

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
strict bool (可选)v1.14 版本添加#

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

最大毫秒数。默认为 30000 (30 秒)。传入 0 以禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

str #

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
strict bool (可选)v1.14 版本添加#

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

最大毫秒数。默认为 30000 (30 秒)。传入 0 以禁用超时。默认值可通过使用 browser_context.set_default_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

str #

is_checked

v1.9 版本前添加

frame.is_checked

不推荐使用

改用基于 locator 的 locator.is_checked() 方法。了解更多关于 locators 的信息。

返回元素是否被选中（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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

bool #

is_disabled

v1.9 版本前添加

frame.is_disabled

不推荐使用

改用基于 locator 的 locator.is_disabled() 方法。了解更多关于 locators 的信息。

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

用法

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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

bool #

is_editable

v1.9 版本前添加

frame.is_editable

不推荐使用

改用基于 locator 的 locator.is_editable() 方法。了解更多关于 locators 的信息。

返回元素是否可编辑 (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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

bool #

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
strict bool (可选)v1.14 版本添加#

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

已废弃
此选项会被忽略。frame.is_hidden() 不会等待元素变为隐藏状态，而是立即返回。

返回值

bool #

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 #

用于搜索元素的定位符。如果存在多个满足该定位符的元素，则使用第一个。
strict bool (可选)v1.14 版本添加#

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

已废弃
此选项会被忽略。frame.is_visible() 不会等待元素变为可见状态，而是立即返回。

返回值

bool #

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, 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType #

query_selector

eval_on_selector

frame.query_selector

不推荐使用

改用基于 locator 的 frame.locator() 方法。了解更多关于 locators 的信息。

返回指向 frame 元素的 ElementHandle。

注意

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

此方法在 frame 内查找与指定 selector 匹配的元素。如果没有元素匹配 selector，则返回 null。

用法

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

参数

selector str #

selector str #
strict bool (可选)v1.14 版本添加#

如果为 true，则要求定位符解析为单个元素。如果给定的定位符解析为多个元素，则调用将抛出异常。

返回值

NoneType | ElementHandle #

query_selector_all

eval_on_selector

frame.query_selector_all

不推荐使用

改用基于 locator 的 frame.locator() 方法。了解更多关于 locators 的信息。

返回指向 frame 元素的 ElementHandle 列表。

注意

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

此方法在 frame 内查找所有与指定 selector 匹配的元素。如果没有元素匹配 selector，则返回空数组。

用法

frame.query_selector_all(selector)

参数

selector str #

selector str #

返回值

List[ElementHandle]#

select_option

v1.9 版本前添加

frame.select_option

不推荐使用

改用基于 locator 的 locator.select_option() 方法。了解更多关于 locators 的信息。

此方法等待与 selector 匹配的元素出现，等待 actionability 检查，等待直到 <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 #

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_navigation_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 的 locator.set_checked() 方法。了解更多关于 locators 的信息。

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

查找与 selector 匹配的元素。如果没有找到，则等待，直到匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选输入框。如果不是，此方法会抛出错误。
如果元素已经处于正确的选中状态，此方法会立即返回。
等待对匹配元素执行 actionability 检查，除非设置了 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需实际执行。

返回值

NoneType #

set_input_files

v1.9 版本前添加

frame.set_input_files

不推荐使用

改用基于 locator 的 locator.set_input_files() 方法。了解更多关于 locators 的信息。

将文件输入的值设置为这些文件路径或文件。如果某些 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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType #

tap

v1.9 版本前添加

frame.tap

不推荐使用

请改用基于 locator 的 locator.tap()。了解更多关于 locators 的信息。

此方法通过执行以下步骤来轻触与 selector 匹配的元素：

查找与 selector 匹配的元素。如果找不到，等待匹配的元素附加到 DOM。
等待对匹配的元素进行可操作性检查，除非设置了 force 选项。如果在检查期间元素被分离，将重试整个操作。
如果需要，将元素滚动到视图中。
使用 page.touchscreen 轻触元素的中心，或指定的 position。

如果在指定的 timeout 内所有步骤未能完成，此方法将抛出 TimeoutError。传递零 timeout 将禁用此功能。

注意

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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)新增于: v1.11#

设置后，此方法仅执行 actionability 检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需执行操作本身。请注意，无论是否设置了 trial，都会按下键盘 modifiers 以允许测试只有在按下这些键时才可见的元素。

返回值

NoneType #

text_content

v1.9 版本前添加

frame.text_content

不推荐使用

请改用基于 locator 的 locator.text_content()。了解更多关于 locators 的信息。

返回 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_navigation_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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType #

uncheck

v1.9 版本前添加

frame.uncheck

不推荐使用

请改用基于 locator 的 locator.uncheck()。了解更多关于 locators 的信息。

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

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

如果在指定的 timeout 内所有步骤未能完成，此方法将抛出 TimeoutError。传递零 timeout 将禁用此功能。

用法

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_navigation_timeout() 或 page.set_default_timeout() 方法更改。
trial bool (可选)新增于: v1.11#

设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。可用于等待元素准备好执行操作，而无需实际执行。

返回值

NoneType #

wait_for_selector

v1.9 版本前添加

frame.wait_for_selector

不推荐使用

请改用断言可见性的 Web 断言或基于 locator 的 locator.wait_for()。了解更多关于 locators 的信息。

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

注意

Playwright 在执行操作前会自动等待元素就绪。使用 Locator 对象和 Web 优先断言可以使代码无需使用 wait-for-selector。

等待 selector 满足 state 选项（从 DOM 出现/消失，或变为可见/隐藏）。如果在调用方法时 selector 已经满足条件，该方法将立即返回。如果在 timeout 毫秒内 selector 不满足条件，函数将抛出错误。

用法

此方法在导航期间也有效。

同步
异步

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 #

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_navigation_timeout() 或 page.set_default_timeout() 方法更改。

返回值

NoneType | ElementHandle #

wait_for_timeout

v1.9 版本前添加

frame.wait_for_timeout

不推荐使用

切勿在生产环境中使用 wait_for_timeout。依赖时间的测试本身就是不稳定的。请使用会自动等待的 Locator 操作和 Web 断言。

等待给定的 timeout（毫秒）。

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

用法

frame.wait_for_timeout(timeout)

参数

timeout float #

要等待的 timeout 值。

返回值

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​

NoneType#

Dict#

Dict#

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

NoneType #

Dict #

Dict #

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