跳到主要内容

定位器

介绍​

定位器是 Playwright 自动等待和重试能力的核心部分。简而言之，定位器代表了一种在任何时刻在页面上查找元素的方法。

快速指南​

以下是推荐的内置定位器。

page.get_by_label("User Name").fill("John")

page.get_by_label("Password").fill("secret-password")

page.get_by_role("button", name="Sign in").click()

expect(page.get_by_text("Welcome, John!")).to_be_visible()

定位元素​

Playwright 提供了多种内置定位器。为了使测试更具弹性，我们建议优先使用面向用户的属性和显式约定，例如 page.get_by_role()。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
<button>Sign in</button>

通过角色 'button' 和名称 "Sign in" 定位元素。

page.get_by_role("button", name="Sign in").click()
注意

使用 代码生成器 生成定位器，然后根据需要进行编辑。

每次定位器用于操作时，都会在页面中定位最新的 DOM 元素。在下面的代码片段中，底层的 DOM 元素将被定位两次，每次操作之前定位一次。这意味着，如果在调用之间 DOM 由于重新渲染而发生变化，则将使用与定位器对应的新元素。

locator = page.get_by_role("button", name="Sign in")

locator.hover()
locator.click()

请注意，所有创建定位器的方法，例如 page.get_by_label()，在 定位器 和 Frame定位器 类上也是可用的，因此您可以将它们链接起来并迭代地缩小定位器的范围。

locator = page.frame_locator("my-frame").get_by_role("button", name="Sign in")

locator.click()

按角色定位​

page.get_by_role() 定位器反映了用户和辅助技术如何感知页面，例如某个元素是按钮还是复选框。按角色定位时，通常还应传递可访问的名称，以便定位器精确定位元素。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000

注册

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

角色定位器包括 按钮、复选框、标题、链接、列表、表格等等，并遵循 W3C 关于 ARIA 角色、ARIA 属性 和 可访问名称 的规范。请注意，许多 html 元素（如 <button>）都具有 隐式定义的角色，该角色可被角色定位器识别。

请注意，角色定位器不能取代可访问性审核和一致性测试，而是提供关于 ARIA 指南的早期反馈。

何时使用角色定位器

我们建议优先使用角色定位器来定位元素，因为这是最接近用户和辅助技术感知页面的方式。

按标签定位​

大多数表单控件通常都有专用的标签，可以方便地用于与表单交互。在这种情况下，您可以使用 page.get_by_label() 通过其关联的标签定位控件。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
<label>Password <input type="password" /></label>

您可以在通过标签文本定位输入框后填写内容

page.get_by_label("Password").fill("secret")
何时使用标签定位器

在定位表单字段时使用此定位器。

按占位符定位​

输入框可能具有 placeholder 属性，以提示用户应输入的值。您可以使用 page.get_by_placeholder() 定位此类输入框。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
<input type="email" placeholder="[email protected]" />

您可以在通过占位符文本定位输入框后填写内容

page.get_by_placeholder("[email protected]").fill("[email protected]")
何时使用占位符定位器

在定位没有标签但有占位符文本的表单元素时使用此定位器。

按文本定位​

通过元素包含的文本查找元素。使用 page.get_by_text() 时，您可以按子字符串、确切字符串或正则表达式匹配。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
欢迎，John
<span>Welcome, John</span>

您可以按元素包含的文本定位元素

expect(page.get_by_text("Welcome, John")).to_be_visible()

设置精确匹配

expect(page.get_by_text("Welcome, John", exact=True)).to_be_visible()

使用正则表达式匹配

expect(page.get_by_text(re.compile("welcome, john", re.IGNORECASE))).to_be_visible()
注意

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

何时使用文本定位器

我们建议使用文本定位器来查找非交互元素，如 div、span、p 等。对于按钮、a、input 等交互元素，请使用 角色定位器。

您还可以 按文本过滤，这在尝试在列表中查找特定项时非常有用。

按 alt 文本定位​

所有图像都应具有描述图像的 alt 属性。您可以使用 page.get_by_alt_text() 根据文本替代方案定位图像。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
playwright logo
<img alt="playwright logo" src="/img/playwright-logo.svg" width="100" />

您可以在通过文本替代方案定位图像后单击它

page.get_by_alt_text("playwright logo").click()
何时使用 alt 定位器

当您的元素支持 alt 文本（如 img 和 area 元素）时，请使用此定位器。

按标题定位​

使用 page.get_by_title() 定位具有匹配 title 属性的元素。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
25 个问题
<span title='Issues count'>25 issues</span>

您可以在通过标题文本定位后检查问题计数

expect(page.get_by_title("Issues count")).to_have_text("25 issues")
何时使用标题定位器

当您的元素具有 title 属性时，请使用此定位器。

按测试 ID 定位​

按测试 ID 进行测试是最具弹性的测试方式，即使属性的文本或角色发生更改，测试仍然会通过。QA 和开发人员应定义显式的测试 ID，并使用 page.get_by_test_id() 查询它们。但是，按测试 ID 进行测试不是面向用户的。如果角色或文本值对您很重要，请考虑使用面向用户的定位器，例如 角色 和 文本定位器。

例如，考虑以下 DOM 结构。

https://127.0.0.1:3000
<button data-testid="directions">Itinéraire</button>

您可以按其测试 ID 定位元素

page.get_by_test_id("directions").click()
何时使用测试 ID 定位器

当您选择使用测试 ID 方法或无法按 角色 或 文本 定位时，也可以使用测试 ID。

设置自定义测试 ID 属性​

默认情况下，page.get_by_test_id() 将基于 data-testid 属性定位元素，但您可以在测试配置中或通过调用 selectors.set_test_id_attribute() 进行配置。

设置测试 ID 以使用自定义数据属性进行测试。

playwright.selectors.set_test_id_attribute("data-pw")

在您的 html 中，您现在可以使用 data-pw 作为您的测试 ID，而不是默认的 data-testid。

https://127.0.0.1:3000
<button data-pw="directions">Itinéraire</button>

然后像往常一样定位元素

page.get_by_test_id("directions").click()

按 CSS 或 XPath 定位​

如果您绝对必须使用 CSS 或 XPath 定位器，则可以使用 page.locator() 创建一个定位器，该定位器接受一个选择器，描述如何在页面中查找元素。Playwright 支持 CSS 和 XPath 选择器，如果您省略 css= 或 xpath= 前缀，它会自动检测它们。

page.locator("css=button").click()
page.locator("xpath=//button").click()

page.locator("button").click()
page.locator("//button").click()

XPath 和 CSS 选择器可能与 DOM 结构或实现相关联。当 DOM 结构更改时，这些选择器可能会中断。以下长 CSS 或 XPath 链是不稳定测试的不良做法示例

page.locator(
    "#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input"
).click()

page.locator('//*[@id="tsf"]/div[2]/div[1]/div[1]/div/div[2]/input').click()
何时使用此方法

不建议使用 CSS 和 XPath，因为 DOM 经常更改，导致测试不具有弹性。相反，请尝试提出一个接近用户感知页面的定位器，例如 角色定位器，或使用测试 ID 定义显式测试约定。

在 Shadow DOM 中定位​

默认情况下，Playwright 中的所有定位器都适用于 Shadow DOM 中的元素。例外情况是

考虑以下使用自定义 Web 组件的示例

<x-details role=button aria-expanded=true aria-controls=inner-details>
  <div>Title</div>
  #shadow-root
    <div id=inner-details>Details</div>
</x-details>

您可以像 shadow root 根本不存在一样进行定位。

要单击 <div>Details</div>

page.get_by_text("Details").click()
<x-details role=button aria-expanded=true aria-controls=inner-details>
  <div>Title</div>
  #shadow-root
    <div id=inner-details>Details</div>
</x-details>

要单击 <x-details>

page.locator("x-details", has_text="Details" ).click()
<x-details role=button aria-expanded=true aria-controls=inner-details>
  <div>Title</div>
  #shadow-root
    <div id=inner-details>Details</div>
</x-details>

确保 <x-details> 包含文本 “Details”

expect(page.locator("x-details")).to_contain_text("Details")

过滤定位器​

考虑以下 DOM 结构，我们想单击第二个产品卡的购买按钮。我们有几个选项可以过滤定位器以获得正确的定位器。

https://127.0.0.1:3000

  • 产品 1

  • 产品 2

<ul>
  <li>
    <h3>Product 1</h3>
    <button>Add to cart</button>
  </li>
  <li>
    <h3>Product 2</h3>
    <button>Add to cart</button>
  </li>
</ul>

按文本过滤​

定位器可以使用 locator.filter() 方法按文本过滤。它将在元素内部的某个位置（可能在后代元素中）搜索特定的字符串，不区分大小写。您也可以传递正则表达式。

page.get_by_role("listitem").filter(has_text="Product 2").get_by_role(
    "button", name="Add to cart"
).click()

使用正则表达式

page.get_by_role("listitem").filter(has_text=re.compile("Product 2")).get_by_role(
    "button", name="Add to cart"
).click()

按不包含文本过滤​

或者，按不包含文本过滤

# 5 in-stock items
expect(page.get_by_role("listitem").filter(has_not_text="Out of stock")).to_have_count(5)

按子/后代过滤​

定位器支持一个选项，仅选择具有或不具有与另一个定位器匹配的后代的元素。因此，您可以通过任何其他定位器进行过滤，例如 locator.get_by_role()、locator.get_by_test_id()、locator.get_by_text() 等。

https://127.0.0.1:3000

  • 产品 1

  • 产品 2

<ul>
  <li>
    <h3>Product 1</h3>
    <button>Add to cart</button>
  </li>
  <li>
    <h3>Product 2</h3>
    <button>Add to cart</button>
  </li>
</ul>
page.get_by_role("listitem").filter(
    has=page.get_by_role("heading", name="Product 2")
).get_by_role("button", name="Add to cart").click()

我们还可以断言产品卡，以确保只有一个

expect(
    page.get_by_role("listitem").filter(
        has=page.get_by_role("heading", name="Product 2")
    )
).to_have_count(1)

过滤定位器必须相对于原始定位器，并且从原始定位器匹配开始查询，而不是从文档根开始查询。因此，以下方法将不起作用，因为过滤定位器从 <ul> 列表元素开始匹配，该元素位于原始定位器匹配的 <li> 列表项之外

# ✖ WRONG
expect(
    page.get_by_role("listitem").filter(
        has=page.get_by_role("list").get_by_role("heading", name="Product 2")
    )
).to_have_count(1)

按不包含子/后代过滤​

我们还可以按不包含内部匹配元素进行过滤。

expect(
    page.get_by_role("listitem").filter(
        has_not=page.get_by_role("heading", name="Product 2")
    )
).to_have_count(1)

请注意，内部定位器从外部定位器开始匹配，而不是从文档根开始匹配。

定位器运算符​

在定位器内部匹配​

您可以链接创建定位器的方法，例如 page.get_by_text() 或 locator.get_by_role()，以将搜索范围缩小到页面的特定部分。

在此示例中，我们首先通过定位其角色 listitem 创建一个名为 product 的定位器。然后我们按文本过滤。我们可以再次使用 product 定位器按角色按钮获取并单击它，然后使用断言来确保只有一个文本为 “产品 2” 的产品。

product = page.get_by_role("listitem").filter(has_text="Product 2")

product.get_by_role("button", name="Add to cart").click()

您还可以将两个定位器链接在一起，例如在特定对话框内查找 “保存” 按钮

save_button = page.get_by_role("button", name="Save")
# ...
dialog = page.get_by_test_id("settings-dialog")
dialog.locator(save_button).click()

同时匹配两个定位器​

方法 locator.and_() 通过匹配额外的定位器来缩小现有定位器的范围。例如，您可以组合 page.get_by_role() 和 page.get_by_title() 以按角色和标题进行匹配。

button = page.get_by_role("button").and_(page.getByTitle("Subscribe"))

匹配两个备选定位器之一​

如果您想定位两个或多个元素之一，并且您不知道是哪一个，请使用 locator.or_() 创建一个定位器，该定位器匹配任何一个或两个备选方案。

例如，考虑这样一种情况，您想单击 “新邮件” 按钮，但有时会弹出安全设置对话框。在这种情况下，您可以等待 “新邮件” 按钮或对话框，并采取相应的操作。

注意

如果 “新邮件” 按钮和安全对话框都出现在屏幕上，“or” 定位器将同时匹配它们，可能会抛出 “严格模式违规” 错误。在这种情况下，您可以使用 locator.first 仅匹配其中一个。

new_email = page.get_by_role("button", name="New")
dialog = page.get_by_text("Confirm security settings")
expect(new_email.or_(dialog).first).to_be_visible()
if (dialog.is_visible()):
  page.get_by_role("button", name="Dismiss").click()
new_email.click()

仅匹配可见元素​

注意

通常，最好找到一种 更可靠的方法 来唯一标识元素，而不是检查可见性。

考虑一个页面，其中包含两个按钮，第一个按钮不可见，第二个按钮 可见。

<button style='display: none'>Invisible</button>
<button>Visible</button>

  • 这将找到两个按钮并抛出 严格模式 违规错误

    page.locator("button").click()

  • 这将仅找到第二个按钮，因为它可见，然后单击它。

    page.locator("button").locator("visible=true").click()

列表​

计算列表中的项目数​

您可以断言定位器以计算列表中的项目数。

例如，考虑以下 DOM 结构

https://127.0.0.1:3000
  • 苹果
  • 香蕉
  • 橙子
<ul>
  <li>apple</li>
  <li>banana</li>
  <li>orange</li>
</ul>

使用 count 断言来确保列表包含 3 个项目。

expect(page.get_by_role("listitem")).to_have_count(3)

断言列表中的所有文本​

您可以断言定位器以查找列表中的所有文本。

例如，考虑以下 DOM 结构

https://127.0.0.1:3000
  • 苹果
  • 香蕉
  • 橙子
<ul>
  <li>apple</li>
  <li>banana</li>
  <li>orange</li>
</ul>

使用 expect(locator).to_have_text() 确保列表包含文本 “苹果”、“香蕉” 和 “橙子”。

expect(page.get_by_role("listitem")).to_have_text(["apple", "banana", "orange"])

获取特定项目​

有很多方法可以获取列表中的特定项目。

按文本获取​

使用 page.get_by_text() 方法按其文本内容定位列表中的元素，然后单击它。

例如，考虑以下 DOM 结构

https://127.0.0.1:3000
  • 苹果
  • 香蕉
  • 橙子
<ul>
  <li>apple</li>
  <li>banana</li>
  <li>orange</li>
</ul>

按其文本内容定位项目并单击它。

page.get_by_text("orange").click()

按文本过滤​

使用 locator.filter() 定位列表中的特定项目。

例如，考虑以下 DOM 结构

https://127.0.0.1:3000
  • 苹果
  • 香蕉
  • 橙子
<ul>
  <li>apple</li>
  <li>banana</li>
  <li>orange</li>
</ul>

按 “listitem” 角色定位项目，然后按文本 “橙子” 过滤，然后单击它。

page.get_by_role("listitem").filter(has_text="orange").click()

按测试 ID 获取​

使用 page.get_by_test_id() 方法定位列表中的元素。如果还没有测试 ID，您可能需要修改 html 并添加测试 ID。

例如，考虑以下 DOM 结构

https://127.0.0.1:3000
  • 苹果
  • 香蕉
  • 橙子
<ul>
  <li data-testid='apple'>apple</li>
  <li data-testid='banana'>banana</li>
  <li data-testid='orange'>orange</li>
</ul>

按其测试 ID “orange” 定位项目，然后单击它。

page.get_by_test_id("orange").click()

按第 n 项获取​

如果您有一个相同的元素列表，并且区分它们的唯一方法是顺序，则可以使用 locator.first、locator.last 或 locator.nth() 从列表中选择特定元素。

banana = page.get_by_role("listitem").nth(1)

但是，请谨慎使用此方法。通常，页面可能会更改，并且定位器将指向与您期望的元素完全不同的元素。相反，请尝试提出一个唯一的定位器，该定位器将通过 严格模式标准。

链接过滤器​

当您有各种相似之处的元素时，可以使用 locator.filter() 方法选择正确的元素。您还可以链接多个过滤器以缩小选择范围。

例如，考虑以下 DOM 结构

https://127.0.0.1:3000
  • John
  • Mary
  • John
  • Mary
<ul>
  <li>
    <div>John</div>
    <div><button>Say hello</button></div>
  </li>
  <li>
    <div>Mary</div>
    <div><button>Say hello</button></div>
  </li>
  <li>
    <div>John</div>
    <div><button>Say goodbye</button></div>
  </li>
  <li>
    <div>Mary</div>
    <div><button>Say goodbye</button></div>
  </li>
</ul>

要截取包含 “Mary” 和 “说再见” 的行的屏幕截图

row_locator = page.get_by_role("listitem")

row_locator.filter(has_text="Mary").filter(
    has=page.get_by_role("button", name="Say goodbye")
).screenshot(path="screenshot.png")

您现在应该在项目的根目录中有一个 “screenshot.png” 文件。

罕见用例​

对列表中的每个元素执行某些操作​

迭代元素

for row in page.get_by_role("listitem").all():
    print(row.text_content())

使用常规 for 循环迭代

rows = page.get_by_role("listitem")
count = rows.count()
for i in range(count):
    print(rows.nth(i).text_content())

在页面中评估​

locator.evaluate_all() 中的代码在页面中运行，您可以在那里调用任何 DOM API。

rows = page.get_by_role("listitem")
texts = rows.evaluate_all("list => list.map(element => element.textContent)")

严格模式​

定位器是严格的。这意味着，如果多个元素匹配，则对定位器执行的所有暗示某些目标 DOM 元素的操作都将抛出异常。例如，如果 DOM 中有多个按钮，则以下调用将抛出异常

如果多于一个则抛出错误​

page.get_by_role("button").click()

另一方面，Playwright 了解您何时执行多元素操作，因此当定位器解析为多个元素时，以下调用可以完美地工作。

多个元素时工作正常​

page.get_by_role("button").count()

您可以通过 locator.first、locator.last 和 locator.nth() 显式选择退出严格模式检查，方法是告诉 Playwright 在多个元素匹配时使用哪个元素。不建议使用这些方法，因为当您的页面更改时，Playwright 可能会单击您不打算单击的元素。相反，请遵循上述最佳实践来创建一个唯一标识目标元素的定位器。

更多定位器​

对于不太常用的定位器，请查看其他定位器指南。