跳转到主要内容

Locator

定位器是 Playwright 自动等待和重试能力的核心部分。简而言之，定位器代表一种在任何时刻查找页面上元素的方式。可以使用 page.locator() 方法创建定位器。

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

方法​

all​

添加于: v1.29 locator.all

当定位器指向元素列表时，这将返回一个定位器数组，指向它们各自的元素。

注意

locator.all() 不会等待元素与定位器匹配，而是立即返回页面上存在的任何内容。

当元素列表动态变化时，locator.all() 将产生不可预测且不稳定的结果。

当元素列表稳定但动态加载时，请在调用 locator.all() 之前等待完整列表加载完成。

用法

for li in page.get_by_role('listitem').all():
  li.click();

返回值

all_inner_texts​

添加于: v1.14 locator.all_inner_texts

返回所有匹配节点的 node.innerText 值数组。

断言文本

如果需要在页面上断言文本，请优先使用带有 use_inner_text 选项的 expect(locator).to_have_text() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

texts = page.get_by_role("link").all_inner_texts()

返回值

all_text_contents​

添加于: v1.14 locator.all_text_contents

返回所有匹配节点的 node.textContent 值数组。

断言文本

如果需要在页面上断言文本，请优先使用 expect(locator).to_have_text() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

texts = page.get_by_role("link").all_text_contents()

返回值

and_​

添加于: v1.34 locator.and_

创建一个定位器，它同时匹配当前定位器和参数定位器。

用法

以下示例查找具有特定标题的按钮。

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

参数

  • locator Locator#

    要匹配的附加定位器。

返回值

aria_snapshot​

添加于: v1.49 locator.aria_snapshot

捕获给定元素的 aria 快照。阅读更多关于 aria 快照和 expect(locator).to_match_aria_snapshot() 以了解相应的断言。

用法

page.get_by_role("link").aria_snapshot()

参数

返回值

详细信息

此方法捕获给定元素的 aria 快照。快照是一个字符串，表示元素及其子元素的状态。快照可用于在测试中断言元素的状态，或将其与未来的状态进行比较。

ARIA 快照使用 YAML 标记语言表示

  • 对象的键是元素的角色和可选的可访问名称。
  • 值可以是文本内容或子元素数组。
  • 通用静态文本可以使用 text 键表示。

以下是 HTML 标记和相应的 ARIA 快照

<ul aria-label="Links">
  <li><a href="/">Home</a></li>
  <li><a href="/about">About</a></li>
<ul>
- list "Links":
  - listitem:
    - link "Home"
  - listitem:
    - link "About"

blur​

添加于: v1.28 locator.blur

在元素上调用 blur。

用法

locator.blur()
locator.blur(**kwargs)

参数

返回值

bounding_box​

添加于: v1.14 locator.bounding_box

此方法返回与定位器匹配的元素的边界框，如果元素不可见，则返回 null。边界框是相对于主框架视口计算的 - 这通常与浏览器窗口相同。

用法

box = page.get_by_role("button").bounding_box()
page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)

参数

返回值

  • NoneType | Dict#

    • x float

      元素的 x 坐标，单位为像素。

    • y float

      元素的 y 坐标，单位为像素。

    • width float

      元素的宽度，单位为像素。

    • height float

      元素的高度，单位为像素。

详细信息

滚动会影响返回的边界框，类似于 Element.getBoundingClientRect。这意味着 x 和/或 y 可能是负数。

来自子框架的元素返回相对于主框架的边界框，这与 Element.getBoundingClientRect 不同。

假设页面是静态的，使用边界框坐标执行输入是安全的。例如，以下代码片段应点击元素的中心。

check​

添加于: v1.14 locator.check

确保复选框或单选按钮元素已选中。

用法

page.get_by_role("checkbox").check()

参数

  • force bool (可选)#

    是否绕过可操作性检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • timeout float (可选)#

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

  • trial bool (可选)#

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

返回值

详细信息

执行以下步骤

  1. 确保元素是复选框或单选按钮输入。如果不是，此方法会抛出异常。如果元素已选中，此方法立即返回。
  2. 等待元素的可操作性检查，除非设置了 force 选项。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 在元素的中心点击。
  5. 确保元素现在已选中。如果不是，此方法会抛出异常。

如果在操作期间的任何时刻元素从 DOM 中分离，此方法会抛出异常。

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

clear​

添加于: v1.28 locator.clear

清除输入字段。

用法

page.get_by_role("textbox").clear()

参数

返回值

详细信息

此方法等待可操作性检查，聚焦元素，清除它，并在清除后触发一个 input 事件。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法会抛出错误。但是，如果元素在具有关联 control 的 <label> 元素内，则将清除该控件。

click​

添加于: v1.14 locator.click

点击一个元素。

用法

点击按钮

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

在画布上的特定位置按住 Shift 键并右键单击

page.locator("canvas").click(
    button="right", modifiers=["Shift"], position={"x": 23, "y": 32}
)

参数

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

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

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，无论 trial 的值如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

详细信息

此方法通过执行以下步骤点击元素

  1. 等待元素的可操作性检查，除非设置了 force 选项。
  2. 如果需要，将元素滚动到视图中。
  3. 使用 page.mouse 在元素的中心或指定的 position 点击。
  4. 等待启动的导航成功或失败，除非设置了 no_wait_after 选项。

如果在操作期间的任何时刻元素从 DOM 中分离，此方法会抛出异常。

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

count​

添加于: v1.14 locator.count

返回与定位器匹配的元素数量。

断言数量

如果需要在页面上断言元素数量，请优先使用 expect(locator).to_have_count() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

count = page.get_by_role("listitem").count()

返回值

dblclick​

添加于: v1.14 locator.dblclick

双击一个元素。

用法

locator.dblclick()
locator.dblclick(**kwargs)

参数

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

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

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，无论 trial 的值如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

详细信息

此方法通过执行以下步骤双击元素

  1. 等待元素的可操作性检查，除非设置了 force 选项。
  2. 如果需要，将元素滚动到视图中。
  3. 使用 page.mouse 在元素的中心或指定的 position 双击。

如果在操作期间的任何时刻元素从 DOM 中分离，此方法会抛出异常。

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

注意

element.dblclick() 会分发两个 click 事件和一个 dblclick 事件。

dispatch_event​

添加于: v1.14 locator.dispatch_event

以编程方式在匹配元素上分发事件。

用法

locator.dispatch_event("click")

参数

返回值

详细信息

上面的代码片段在元素上分发 click 事件。无论元素的可见性状态如何，都会分发 click 事件。这相当于调用 element.click()。

在底层，它基于给定的 type 创建一个事件实例，使用 event_init 属性初始化它，并在元素上分发它。默认情况下，事件是 composed、cancelable 和 bubble 的。

由于 event_init 是事件特定的，请参阅事件文档以获取初始属性列表

如果您希望将实时对象传递到事件中，您还可以将 JSHandle 指定为属性值

data_transfer = page.evaluate_handle("new DataTransfer()")
locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

drag_to​

添加于: v1.18 locator.drag_to

将源元素拖动到目标元素并放下它。

用法

source = page.locator("#source")
target = page.locator("#target")

source.drag_to(target)
# or specify exact positions relative to the top-left corners of the elements:
source.drag_to(
  target,
  source_position={"x": 34, "y": 7},
  target_position={"x": 10, "y": 20}
)

参数

  • target Locator#

    要拖动到的元素的定位器。

  • force bool (可选)#

    是否绕过可操作性检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • source_position Dict (可选)#

    在此点相对于元素内边距框左上角点击源元素。如果未指定，则使用元素的某个可见点。

  • target_position Dict (可选)#

    在此点相对于元素内边距框左上角在目标元素上放下。如果未指定，则使用元素的某个可见点。

  • timeout float (可选)#

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

  • trial bool (可选)#

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

返回值

详细信息

此方法将定位器拖动到另一个目标定位器或目标位置。它将首先移动到源元素，执行 mousedown，然后移动到目标元素或位置并执行 mouseup。

evaluate​

添加于: v1.14 locator.evaluate

在页面中执行 JavaScript 代码，并将匹配的元素作为参数。

用法

参数

返回值

详细信息

返回使用匹配的元素作为第一个参数，以及 arg 作为第二个参数调用的 expression 的返回值。

如果 expression 返回 Promise，此方法将等待 promise resolve 并返回其值。

如果 expression 抛出错误或 rejected，此方法也会抛出错误。

evaluate_all​

添加于: v1.14 locator.evaluate_all

在页面中执行 JavaScript 代码，并将所有匹配的元素作为参数。

用法

locator = page.locator("div")
more_than_ten = locator.evaluate_all("(divs, min) => divs.length > min", 10)

参数

  • expression str#

    要在浏览器上下文中求值的 JavaScript 表达式。如果表达式求值为一个函数，则会自动调用该函数。

  • arg EvaluationArgument (可选)#

    传递给 expression 的可选参数。

返回值

详细信息

返回使用所有匹配元素的数组作为第一个参数，以及 arg 作为第二个参数调用的 expression 的返回值。

如果 expression 返回 Promise，此方法将等待 promise resolve 并返回其值。

如果 expression 抛出错误或 rejected，此方法也会抛出错误。

evaluate_handle​

添加于: v1.14 locator.evaluate_handle

在页面中执行 JavaScript 代码，将匹配的元素作为参数，并返回带有结果的 JSHandle。

用法

locator.evaluate_handle(expression)
locator.evaluate_handle(expression, **kwargs)

参数

返回值

详细信息

返回 expression 的返回值，类型为 JSHandle，调用时使用匹配的元素作为第一个参数，以及 arg 作为第二个参数。

locator.evaluate() 和 locator.evaluate_handle() 之间的唯一区别是 locator.evaluate_handle() 返回 JSHandle。

如果 expression 返回 Promise，此方法将等待 promise resolve 并返回其值。

如果 expression 抛出错误或 rejected，此方法也会抛出错误。

有关更多详细信息，请参阅 page.evaluate_handle()。

fill​

添加于: v1.14 locator.fill

为输入字段设置值。

用法

page.get_by_role("textbox").fill("example value")

参数

返回值

详细信息

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

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

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

filter​

添加于版本: v1.22 locator.filter

此方法根据选项缩小现有定位器的范围，例如按文本过滤。 它可以链式调用以进行多次过滤。

用法

row_locator = page.locator("tr")
# ...
row_locator.filter(has_text="text in column 1").filter(
    has=page.get_by_role("button", name="column 2 button")
).screenshot()

参数

  • has Locator (可选)#

    将方法的返回结果缩小到包含与此相对定位器匹配的元素的那些结果。 例如，包含 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。

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

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

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

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

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

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

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

  • has_text str | Pattern (可选)#

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

  • visible bool (可选)添加于版本: v1.51#

    仅匹配可见或不可见的元素。

返回值

focus​

添加于: v1.14 locator.focus

在匹配的元素上调用 focus。

用法

locator.focus()
locator.focus(**kwargs)

参数

返回值

frame_locator​

添加于版本: v1.17 locator.frame_locator

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

用法

locator = page.frame_locator("iframe").get_by_text("Submit")
locator.click()

参数

  • selector str#

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

返回值

get_attribute​

添加于: v1.14 locator.get_attribute

返回匹配元素的属性值。

断言属性

如果您需要断言元素的属性，请优先使用 expect(locator).to_have_attribute() 以避免不稳定性。 有关更多详细信息，请参阅断言指南。

用法

locator.get_attribute(name)
locator.get_attribute(name, **kwargs)

参数

返回值

get_by_alt_text​

添加于版本: v1.27 locator.get_by_alt_text

允许通过元素的 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本 “Playwright logo” 找到图像

<img alt='Playwright logo'>
page.get_by_alt_text("Playwright logo").click()

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

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

返回值

get_by_label​

添加于版本: v1.27 locator.get_by_label

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

用法

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

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.get_by_label("Username").fill("john")
page.get_by_label("Password").fill("secret")

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

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

返回值

get_by_placeholder​

添加于版本: v1.27 locator.get_by_placeholder

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

用法

例如，考虑以下 DOM 结构。

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

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

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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

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

返回值

get_by_role​

添加于版本: v1.27 locator.get_by_role

允许通过元素的 ARIA role、ARIA 属性和 辅助功能名称定位元素。

用法

考虑以下 DOM 结构。

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

您可以按其隐式 role 定位每个元素

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

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

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

参数

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

    必需的 aria 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 定义，才会被 role 选择器匹配。

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

  • level int (可选)#

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

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

  • name str | Pattern (可选)#

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

    了解更多关于 辅助功能名称 的信息。

  • pressed bool (可选)#

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

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

  • selected bool (可选)#

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

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

返回值

详细信息

Role 选择器**不能替代**辅助功能审核和一致性测试，而是提供关于 ARIA 指南的早期反馈。

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

get_by_test_id​

添加于版本: v1.27 locator.get_by_test_id

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

<button data-testid="directions">Itinéraire</button>

您可以通过元素的测试 ID 定位它

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

参数

返回值

详细信息

默认情况下，data-testid 属性用作测试 ID。 如果需要配置不同的测试 ID 属性，请使用 selectors.set_test_id_attribute()。

get_by_text​

添加于版本: v1.27 locator.get_by_text

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

另请参阅 locator.filter()，它允许按其他条件（例如辅助功能 role）进行匹配，然后按文本内容进行过滤。

用法

考虑以下 DOM 结构

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

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

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

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

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

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

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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

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

返回值

详细信息

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

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

get_by_title​

添加于版本: v1.27 locator.get_by_title

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

用法

考虑以下 DOM 结构。

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

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

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

参数

  • text str | Pattern#

    用于定位元素的文本。

  • exact bool (可选)#

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

返回值

highlight​

添加于版本: v1.20 locator.highlight

在屏幕上高亮显示相应的元素。 用于调试，请勿提交使用 locator.highlight() 的代码。

用法

locator.highlight()

返回值

hover​

添加于: v1.14 locator.hover

悬停在匹配的元素之上。

用法

page.get_by_role("link").hover()

参数

  • force bool (可选)#

    是否绕过可操作性检查。默认为 false。

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

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

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

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (可选)#

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

  • timeout float (可选)#

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

  • trial bool (可选)#

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，无论 trial 的值如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

详细信息

此方法通过执行以下步骤悬停在元素之上

  1. 等待元素上的 可操作性 检查，除非设置了 force 选项。
  2. 如果需要，将元素滚动到视图中。
  3. 使用 page.mouse 悬停在元素的中心，或指定的 position。

如果在操作期间的任何时刻元素从 DOM 中分离，此方法会抛出异常。

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

inner_html​

添加于: v1.14 locator.inner_html

返回 element.innerHTML。

用法

locator.inner_html()
locator.inner_html(**kwargs)

参数

返回值

inner_text​

添加于: v1.14 locator.inner_text

返回 element.innerText。

断言文本

如果需要在页面上断言文本，请优先使用带有 use_inner_text 选项的 expect(locator).to_have_text() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

locator.inner_text()
locator.inner_text(**kwargs)

参数

返回值

input_value​

添加于: v1.14 locator.input_value

返回匹配的 <input>、<textarea> 或 <select> 元素的值。

断言值

如果您需要断言输入值，请优先使用 expect(locator).to_have_value() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

value = page.get_by_role("textbox").input_value()

参数

返回值

详细信息

如果元素不是 input、textarea 或 select，则会抛出错误。 然而，如果元素位于关联了 control 的 <label> 元素内，则返回该 control 的值。

is_checked​

添加于: v1.14 locator.is_checked

返回元素是否被选中。 如果元素不是复选框或单选按钮，则会抛出错误。

断言选中状态

如果您需要断言复选框已被选中，请优先使用 expect(locator).to_be_checked() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

checked = page.get_by_role("checkbox").is_checked()

参数

返回值

is_disabled​

添加于: v1.14 locator.is_disabled

返回元素是否被禁用，与 启用 状态相反。

断言禁用状态

如果您需要断言元素已被禁用，请优先使用 expect(locator).to_be_disabled() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

disabled = page.get_by_role("button").is_disabled()

参数

返回值

is_editable​

添加于: v1.14 locator.is_editable

返回元素是否 可编辑。 如果目标元素不是 <input>、<textarea>、<select>、[contenteditable] 且没有允许 [aria-readonly] 的 role 属性，则此方法会抛出错误。

断言可编辑状态

如果您需要断言元素是可编辑的，请优先使用 expect(locator).to_be_editable() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

editable = page.get_by_role("textbox").is_editable()

参数

返回值

is_enabled​

添加于: v1.14 locator.is_enabled

返回元素是否 启用。

断言启用状态

如果您需要断言元素已被启用，请优先使用 expect(locator).to_be_enabled() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

enabled = page.get_by_role("button").is_enabled()

参数

返回值

is_hidden​

添加于: v1.14 locator.is_hidden

返回元素是否隐藏，与 visible 相反。

断言可见性

如果您需要断言元素已被隐藏，请优先使用 expect(locator).to_be_hidden() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

hidden = page.get_by_role("button").is_hidden()

参数

  • timeout float (可选)#

    已弃用

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

返回值

is_visible​

添加于: v1.14 locator.is_visible

返回元素是否 可见。

断言可见性

如果您需要断言元素是可见的，请优先使用 expect(locator).to_be_visible() 以避免不稳定性。 详见 断言指南 获取更多细节。

用法

visible = page.get_by_role("button").is_visible()

参数

  • timeout float (可选)#

    已弃用

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

返回值

locator​

添加于: v1.14 locator.locator

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

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

用法

locator.locator(selector_or_locator)
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 外部的任何元素。

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

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

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

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

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

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

  • has_text str | Pattern (可选)#

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

返回值

nth​

添加于: v1.14 locator.nth

返回指向第 n 个匹配元素的定位器。 它是从零开始的，nth(0) 选择第一个元素。

用法

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

参数

返回值

or_​

添加于版本: v1.33 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()

参数

  • locator Locator#

    要匹配的备用定位器。

返回值

press​

添加于: v1.14 locator.press

聚焦匹配的元素并按下组合键。

用法

page.get_by_role("textbox").press("Backspace")

参数

  • key str#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

  • delay float (可选)#

    keydown 和 keyup 之间等待的时间，以毫秒为单位。 默认为 0。

  • no_wait_after bool (可选)#

    已弃用

    此选项将来会默认为 true。

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

  • timeout float (可选)#

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

返回值

详细信息

聚焦元素，然后使用 keyboard.down() 和 keyboard.up()。

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" 之类的快捷键。 当使用修饰符指定时，在按下后续键时，修饰符会被按下并保持按住状态。

press_sequentially​

新增于: v1.38 locator.press_sequentially
提示

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

聚焦元素，然后为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。

要按下特殊键，例如 Control 或 ArrowDown，请使用 locator.press()。

用法

locator.press_sequentially("hello") # types instantly
locator.press_sequentially("world", delay=100) # types slower, like a user

输入文本字段然后提交表单的示例

locator = page.get_by_label("Password")
locator.press_sequentially("my password")
locator.press("Enter")

参数

  • text str#

    要顺序按下到聚焦元素中的字符的字符串。

  • delay float (可选)#

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

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • timeout float (可选)#

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

返回值

screenshot​

添加于: v1.14 locator.screenshot

截取与定位器匹配的元素的屏幕截图。

用法

page.get_by_role("link").screenshot()

禁用动画并将屏幕截图保存到文件

page.get_by_role("link").screenshot(animations="disabled", path="link.png")

参数

  • animations "disabled" | "allow" (可选)#

    当设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。 动画根据其持续时间获得不同的处理

    • 有限动画会快进到完成，因此它们将触发 transitionend 事件。
    • 无限动画将被取消到初始状态，然后在屏幕截图后重新播放。

    默认为 "allow"，保持动画不变。

  • caret "hide" | "initial" (可选)#

    当设置为 "hide" 时，屏幕截图将隐藏文本光标。 当设置为 "initial" 时，文本光标行为将不会更改。 默认为 "hide"。

  • mask List[Locator] (可选)#

    指定在截取屏幕截图时应遮罩的定位器。 遮罩元素将被粉红色框 #FF00FF (可通过 mask_color 自定义) 覆盖，该框完全覆盖其边界框。 遮罩也适用于不可见元素，请参阅 仅匹配可见元素 以禁用此功能。

  • mask_color str (可选)新增于: v1.35#

    指定遮罩元素的覆盖框颜色，以 CSS 颜色格式 表示。 默认颜色为粉红色 #FF00FF。

  • omit_background bool (可选)#

    隐藏默认白色背景并允许捕获具有透明度的屏幕截图。 不适用于 jpeg 图像。 默认为 false。

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

    保存图像的文件路径。 屏幕截图类型将从文件扩展名推断。 如果 path 是相对路径，则它相对于当前工作目录解析。 如果未提供路径，则图像不会保存到磁盘。

  • quality int (可选)#

    图像质量，介于 0-100 之间。 不适用于 png 图像。

  • scale "css" | "device" (可选)#

    当设置为 "css" 时，屏幕截图将为页面上的每个 css 像素设置一个像素。 对于高 dpi 设备，这将使屏幕截图保持较小尺寸。 使用 "device" 选项将为每个设备像素生成一个像素，因此高 dpi 设备的屏幕截图将是两倍大甚至更大。

    默认为 "device"。

  • style str (可选)新增于: v1.41#

    在制作屏幕截图时应用的样式表的文本。 在这里你可以隐藏动态元素、使元素不可见或更改其属性，以帮助你创建可重复的屏幕截图。 此样式表穿透 Shadow DOM 并应用于内部框架。

  • timeout float (可选)#

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

  • type "png" | "jpeg" (可选)#

    指定屏幕截图类型，默认为 png。

返回值

详细信息

此方法捕获页面的屏幕截图，裁剪为与定位器匹配的特定元素的大小和位置。 如果元素被其他元素覆盖，则它实际上不会在屏幕截图中可见。 如果元素是可滚动容器，则只有当前滚动的内容将在屏幕截图中可见。

此方法等待 可操作性 检查，然后在截取屏幕截图之前将元素滚动到视图中。 如果元素从 DOM 中分离，则此方法会抛出错误。

返回包含捕获的屏幕截图的缓冲区。

scroll_into_view_if_needed​

添加于: v1.14 locator.scroll_into_view_if_needed

此方法等待 可操作性 检查，然后尝试将元素滚动到视图中，除非它根据 IntersectionObserver 的 ratio 定义完全可见。

有关滚动的替代方法，请参阅 滚动。

用法

locator.scroll_into_view_if_needed()
locator.scroll_into_view_if_needed(**kwargs)

参数

返回值

select_option​

添加于: v1.14 locator.select_option

在 <select> 中选择一个或多个选项。

用法

<select multiple>
  <option value="red">Red</option>
  <option value="green">Green</option>
  <option value="blue">Blue</option>
</select>
# single selection matching the value or label
element.select_option("blue")
# single selection matching the label
element.select_option(label="blue")
# multiple selection for blue, red and second option
element.select_option(value=["red", "green", "blue"])

参数

  • force bool (可选)#

    是否绕过可操作性检查。默认为 false。

  • no_wait_after bool (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • timeout float (可选)#

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

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

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

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

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

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

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

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

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

返回值

详细信息

此方法等待 可操作性 检查，等待直到所有指定的选项都出现在 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，则此方法会抛出错误。 然而，如果元素位于关联了 control 的 <label> 元素内，则将使用该 control。

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

一旦所有提供的选项都被选中，就会触发 change 和 input 事件。

select_text​

添加于: v1.14 locator.select_text

此方法等待 可操作性 检查，然后聚焦元素并选择其所有文本内容。

如果元素位于关联了 control 的 <label> 元素内，则会聚焦并选择 control 中的文本。

用法

locator.select_text()
locator.select_text(**kwargs)

参数

返回值

set_checked​

Added in: v1.15 locator.set_checked

Set the state of a checkbox or a radio element.

用法

page.get_by_role("checkbox").set_checked(True)

参数

  • checked bool#

    Whether to check or uncheck the checkbox.

  • force bool (optional)#

    是否绕过可操作性检查。默认为 false。

  • no_wait_after bool (optional)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (optional)#

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

  • timeout float (optional)#

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

  • trial bool (optional)#

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

返回值

详细信息

This method checks or unchecks an element by performing the following steps

  1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
  2. If the element already has the right checked state, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  4. 如果需要，将元素滚动到视图中。
  5. 使用 page.mouse 在元素的中心点击。
  6. Ensure that the element is now checked or unchecked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

set_input_files​

添加于: v1.14 locator.set_input_files

Upload file or multiple files into <input type=file>. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.

用法

# Select one file
page.get_by_label("Upload file").set_input_files('myfile.pdf')

# Select multiple files
page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])

# Select a directory
page.get_by_label("Upload directory").set_input_files('mydir')

# Remove all the selected files
page.get_by_label("Upload file").set_input_files([])

# Upload buffer from memory
page.get_by_label("Upload file").set_input_files(
    files=[
        {"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
    ],
)

参数

返回值

详细信息

Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

This method expects Locator to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

tap​

添加于: v1.14 locator.tap

Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually dispatching touch events, see the emulating legacy touch events page.

用法

locator.tap()
locator.tap(**kwargs)

参数

  • force bool (optional)#

    是否绕过可操作性检查。默认为 false。

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

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

  • no_wait_after bool (optional)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (optional)#

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

  • timeout float (optional)#

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

  • trial bool (optional)#

    设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好进行操作，而无需执行操作。请注意，无论 trial 的值如何，键盘 modifiers 都将被按下，以允许测试仅在按下这些键时才可见的元素。

返回值

详细信息

This method taps the element by performing the following steps

  1. Wait for actionability checks on the element, unless force option is set.
  2. 如果需要，将元素滚动到视图中。
  3. Use page.touchscreen to tap the center of the element, or the specified position.

如果在操作期间的任何时刻元素从 DOM 中分离，此方法会抛出异常。

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

注意

element.tap() requires that the hasTouch option of the browser context be set to true.

text_content​

添加于: v1.14 locator.text_content

Returns the node.textContent.

断言文本

如果需要在页面上断言文本，请优先使用 expect(locator).to_have_text() 以避免不稳定性。有关更多详细信息，请参阅断言指南。

用法

locator.text_content()
locator.text_content(**kwargs)

参数

返回值

uncheck​

添加于: v1.14 locator.uncheck

Ensure that checkbox or radio element is unchecked.

用法

page.get_by_role("checkbox").uncheck()

参数

  • force bool (optional)#

    是否绕过可操作性检查。默认为 false。

  • no_wait_after bool (optional)#

    已弃用

    此选项无效。

    此选项无效。

  • position Dict (optional)#

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

  • timeout float (optional)#

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

  • trial bool (optional)#

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

返回值

详细信息

This method unchecks the element by performing the following steps

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. 如果需要，将元素滚动到视图中。
  4. 使用 page.mouse 在元素的中心点击。
  5. Ensure that the element is now unchecked. If not, this method throws.

如果在操作期间的任何时刻元素从 DOM 中分离，此方法会抛出异常。

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

wait_for​

Added in: v1.16 locator.wait_for

Returns when element specified by locator satisfies the state option.

If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to timeout milliseconds until the condition is met.

用法

order_sent = page.locator("#order-sent")
order_sent.wait_for()

参数

  • state "attached" | "detached" | "visible" | "hidden" (optional)#

    Defaults to 'visible'. Can be either

    • 'attached' - wait for element to be present in DOM.
    • 'detached' - wait for element to not be present in DOM.
    • 'visible' - wait for element to have non-empty bounding box and no visibility:hidden. Note that element without any content or with display:none has an empty bounding box and is not considered visible.
    • 'hidden' - wait for element to be either detached from DOM, or have an empty bounding box or visibility:hidden. This is opposite to the 'visible' option.

  • timeout float (optional)#

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

返回值

Properties​

content_frame​

Added in: v1.43 locator.content_frame

Returns a FrameLocator object pointing to the same iframe as this locator.

Useful when you have a Locator object obtained somewhere, and later on would like to interact with the content inside the frame.

For a reverse operation, use frame_locator.owner.

用法

locator = page.locator("iframe[name=\"embedded\"]")
# ...
frame_locator = locator.content_frame
frame_locator.get_by_role("button").click()

返回值

first​

添加于: v1.14 locator.first

Returns locator to the first matching element.

用法

locator.first

返回值

last​

添加于: v1.14 locator.last

Returns locator to the last matching element.

用法

banana = page.get_by_role("listitem").last

返回值

page​

Added in: v1.19 locator.page

A page this locator belongs to.

用法

locator.page

返回值

Deprecated​

element_handle​

添加于: v1.14 locator.element_handle
Discouraged

Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.

Resolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If multiple elements match the locator, throws.

用法

locator.element_handle()
locator.element_handle(**kwargs)

参数

返回值

element_handles​

添加于: v1.14 locator.element_handles
Discouraged

Always prefer using Locators and web assertions over ElementHandles because latter are inherently racy.

Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.

用法

locator.element_handles()

返回值

type​

添加于: v1.14 locator.type
已弃用

In most cases, you should use locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use locator.press_sequentially().

聚焦元素，然后为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。

要按下特殊键，例如 Control 或 ArrowDown，请使用 locator.press()。

用法

参数

  • text str#

    A text to type into a focused element.

  • delay float (optional)#

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

  • no_wait_after bool (optional)#

    已弃用

    此选项无效。

    此选项无效。

  • timeout float (optional)#

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

返回值