FrameLocator

FrameLocator 表示页面上 `iframe` 的一个视图。它捕获了足够的逻辑来检索 `iframe` 并在该 iframe 中定位元素。FrameLocator 可以通过 locator.content_frame、page.frame_locator() 或 locator.frame_locator() 方法创建。

同步
异步

locator = page.locator("my-frame").content_frame.get_by_text("Submit")
locator.click()

locator = page.locator("#my-frame").content_frame.get_by_text("Submit")
await locator.click()

严格性

帧定位器是严格的。这意味着如果一个给定的选择器匹配多个元素，所有对帧定位器的操作都将抛出错误。

同步
异步

# Throws if there are several frames in DOM:
page.locator('.result-frame').content_frame.get_by_role('button').click()

# Works because we explicitly tell locator to pick the first frame:
page.locator('.result-frame').first.content_frame.get_by_role('button').click()

# Throws if there are several frames in DOM:
await page.locator('.result-frame').content_frame.get_by_role('button').click()

# Works because we explicitly tell locator to pick the first frame:
await page.locator('.result-frame').first.content_frame.get_by_role('button').click()

将 Locator 转换为 FrameLocator

如果您有一个指向 `iframe` 的 Locator 对象，可以使用 locator.content_frame 将其转换为 FrameLocator。

将 FrameLocator 转换为 Locator

如果您有一个 FrameLocator 对象，可以使用 frame_locator.owner 将其转换为指向同一 `iframe` 的 Locator。

方法

frame_locator

新增于: v1.17

frameLocator.frame_locator

使用 iframe 时，您可以创建一个框架定位器，它将进入 iframe 并允许选择 iframe 中的元素。

用法

frame_locator.frame_locator(selector)

参数

selector str #

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

FrameLocator #

get_by_alt_text

新增于：v1.27

frameLocator.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

frameLocator.get_by_label

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

用法

例如，此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入

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

同步
异步

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

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

参数

text str | Pattern #

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

是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

get_by_placeholder

新增于：v1.27

frameLocator.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

frameLocator.get_by_role

允许通过元素的 ARIA 角色、ARIA 属性和可访问名称进行定位。

用法

考虑以下 DOM 结构。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

您可以通过其隐式角色定位每个元素

同步
异步

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

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

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

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

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

await page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).click()

参数

role "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"#

所需的 aria 角色。
checked bool (可选)#

通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。

了解更多关于 aria-checked 的信息。
disabled bool (可选)#

通常由 aria-disabled 或 disabled 设置的属性。

注意
与大多数其他属性不同，disabled 在 DOM 层次结构中是继承的。了解更多关于 aria-disabled 的信息。
exact bool (可选)新增于: v1.28#

name 是否精确匹配：区分大小写且是完整字符串。默认为 false。当 name 为正则表达式时，此参数被忽略。请注意，精确匹配仍会去除空白字符。
expanded bool (可选)#

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

了解更多关于 aria-expanded 的信息。
include_hidden bool (可选)#

控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。

了解更多关于 aria-hidden 的信息。
level int (可选)#

通常用于角色 heading、listitem、row、treeitem 的数字属性，<h1>-<h6> 元素具有默认值。

了解更多关于 aria-level 的信息。
name str | Pattern (可选)#

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

了解更多关于可访问名称的信息。
pressed bool (可选)#

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

了解更多关于 aria-pressed 的信息。
selected bool (可选)#

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

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

Locator #

详情

角色选择器 不替代 可访问性审计和合规性测试，而是提供有关 ARIA 指南的早期反馈。

许多 HTML 元素都具有隐式定义的角色，该角色由角色选择器识别。您可以在此处找到所有支持的角色。ARIA 指南不建议通过将 `role` 和/或 `aria-*` 属性设置为默认值来重复隐式角色和属性。

get_by_test_id

新增于：v1.27

frameLocator.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

frameLocator.get_by_text

允许定位包含给定文本的元素。

另请参阅 locator.filter()，它允许按其他条件（例如可访问角色）进行匹配，然后按文本内容进行过滤。

用法

考虑以下 DOM 结构

<div>Hello <span>world</span></div>
<div>Hello</div>

您可以通过文本子字符串、精确字符串或正则表达式进行定位

同步
异步

# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))

# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))

参数

text str | Pattern #

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

是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

详情

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

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

get_by_title

新增于：v1.27

frameLocator.get_by_title

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

用法

考虑以下 DOM 结构。

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

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

同步
异步

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

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

参数

text str | Pattern #

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

是否查找完全匹配：区分大小写和全字符串。默认为 false。通过正则表达式定位时忽略。请注意，精确匹配仍会去除空白。

Locator #

locator

新增于: v1.17

frameLocator.locator

该方法在定位器的子树中查找与指定选择器匹配的元素。它还接受过滤选项，类似于 locator.filter() 方法。

了解更多关于定位器.

用法

frame_locator.locator(selector_or_locator)
frame_locator.locator(selector_or_locator, **kwargs)

参数

selector_or_locator str | Locator #

用于解析 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 #

属性

owner

新增于: v1.43

frameLocator.owner

返回一个 Locator 对象，指向与此帧定位器相同的 `iframe`。

当您在某处获得一个 FrameLocator 对象，并且以后希望与 `iframe` 元素进行交互时很有用。

要进行反向操作，请使用 locator.content_frame。

用法

同步
异步

frame_locator = page.locator("iframe[name=\"embedded\"]").content_frame
# ...
locator = frame_locator.owner
expect(locator).to_be_visible()

frame_locator = page.locator("iframe[name=\"embedded\"]").content_frame
# ...
locator = frame_locator.owner
await expect(locator).to_be_visible()

Locator #

已弃用

first

新增于: v1.17

frameLocator.first

已弃用

请改用 locator.first，然后是 locator.content_frame。

返回第一个匹配帧的定位器。

用法

frame_locator.first

FrameLocator #

last

新增于: v1.17

frameLocator.last

已弃用

请改用 locator.last，然后是 locator.content_frame。

返回最后一个匹配帧的定位器。

用法

frame_locator.last

FrameLocator #

nth

新增于: v1.17

frameLocator.nth

已弃用

请改用 locator.nth()，然后是 locator.content_frame。

返回第 n 个匹配帧的定位器。它是基于零的，`nth(0)` 选择第一个帧。

用法

frame_locator.nth(index)

参数

index int #

FrameLocator #

方法​

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​

locator​

属性​

owner​

已弃用​

first​

last​

nth​

方法

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

locator

属性

owner

已弃用

first

last

nth