LocatorAssertions

LocatorAssertions 类提供了断言方法，可用于在测试中对 Locator 状态进行断言。

🌐 The LocatorAssertions class provides assertion methods that can be used to make assertions about the Locator state in the tests.

Sync
Async

from playwright.sync_api import Page, expect

def test_status_becomes_submitted(page: Page) -> None:
    # ..
    page.get_by_role("button").click()
    expect(page.locator(".status")).to_have_text("Submitted")

from playwright.async_api import Page, expect

async def test_status_becomes_submitted(page: Page) -> None:
    # ..
    await page.get_by_role("button").click()
    await expect(page.locator(".status")).to_have_text("Submitted")

方法

🌐 Methods

not_to_be_attached

Added in: v1.33

locatorAssertions.not_to_be_attached

expect(locator).to_be_attached() 的相反。

🌐 The opposite of expect(locator).to_be_attached().

用法

expect(locator).not_to_be_attached()
expect(locator).not_to_be_attached(**kwargs)

参数

attached bool (optional)#
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_checked

Added in: v1.20

locatorAssertions.not_to_be_checked

expect(locator).to_be_checked() 的相反情况。

🌐 The opposite of expect(locator).to_be_checked().

用法

expect(locator).not_to_be_checked()
expect(locator).not_to_be_checked(**kwargs)

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_disabled

Added in: v1.20

locatorAssertions.not_to_be_disabled

expect(locator).to_be_disabled() 的相反情况。

🌐 The opposite of expect(locator).to_be_disabled().

用法

expect(locator).not_to_be_disabled()
expect(locator).not_to_be_disabled(**kwargs)

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_editable

Added in: v1.20

locatorAssertions.not_to_be_editable

expect(locator).to_be_editable() 的相反。

🌐 The opposite of expect(locator).to_be_editable().

用法

expect(locator).not_to_be_editable()
expect(locator).not_to_be_editable(**kwargs)

参数

editable bool (optional) Added in: v1.26#
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_empty

Added in: v1.20

locatorAssertions.not_to_be_empty

expect(locator).to_be_empty() 的相反情况。

🌐 The opposite of expect(locator).to_be_empty().

用法

expect(locator).not_to_be_empty()
expect(locator).not_to_be_empty(**kwargs)

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_enabled

Added in: v1.20

locatorAssertions.not_to_be_enabled

expect(locator).to_be_enabled() 的相反情况。

🌐 The opposite of expect(locator).to_be_enabled().

用法

expect(locator).not_to_be_enabled()
expect(locator).not_to_be_enabled(**kwargs)

参数

enabled bool (optional) Added in: v1.26#
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_focused

Added in: v1.20

locatorAssertions.not_to_be_focused

expect(locator).to_be_focused() 的相反。

🌐 The opposite of expect(locator).to_be_focused().

用法

expect(locator).not_to_be_focused()
expect(locator).not_to_be_focused(**kwargs)

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_hidden

Added in: v1.20

locatorAssertions.not_to_be_hidden

expect(locator).to_be_hidden() 的相反情况。

🌐 The opposite of expect(locator).to_be_hidden().

用法

expect(locator).not_to_be_hidden()
expect(locator).not_to_be_hidden(**kwargs)

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_in_viewport

Added in: v1.31

locatorAssertions.not_to_be_in_viewport

expect(locator).to_be_in_viewport() 的反义操作。

🌐 The opposite of expect(locator).to_be_in_viewport().

用法

expect(locator).not_to_be_in_viewport()
expect(locator).not_to_be_in_viewport(**kwargs)

参数

ratio float (optional)#
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_be_visible

Added in: v1.20

locatorAssertions.not_to_be_visible

expect(locator).to_be_visible() 的相反情况。

🌐 The opposite of expect(locator).to_be_visible().

用法

expect(locator).not_to_be_visible()
expect(locator).not_to_be_visible(**kwargs)

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。
visible bool (optional) Added in: v1.26#

NoneType #

not_to_contain_class

Added in: v1.52

locatorAssertions.not_to_contain_class

expect(locator).to_contain_class() 的相反。

🌐 The opposite of expect(locator).to_contain_class().

用法

expect(locator).not_to_contain_class(expected)
expect(locator).not_to_contain_class(expected, **kwargs)

参数

expected str | List[str]#

预期的类或 RegExp 或这些的列表。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_contain_text

Added in: v1.20

locatorAssertions.not_to_contain_text

expect(locator).to_contain_text() 的相反。

🌐 The opposite of expect(locator).to_contain_text().

用法

expect(locator).not_to_contain_text(expected)
expect(locator).not_to_contain_text(expected, **kwargs)

参数

expected str | Pattern | List[str] | List[Pattern] | List[str | Pattern] Added in: v1.18#

预期的子字符串或正则表达式或这些的列表。
ignore_case bool (optional) Added in: v1.23#

是否执行大小写不相关的匹配。[ignore_case]如果指定，（/api/class-locatorassertions.mdx#locator-assertions-not-to-contain-text-option-ignore-case）选项优先于对应的正则表达式标志。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。
use_inner_text bool (optional) Added in: v1.18#

在获取 DOM 节点文本时，是使用 element.innerText 还是 element.textContent。

NoneType #

not_to_have_accessible_description

Added in: v1.44

locatorAssertions.not_to_have_accessible_description

expect(locator).to_have_accessible_description() 的反义操作。

🌐 The opposite of expect(locator).to_have_accessible_description().

用法

expect(locator).not_to_have_accessible_description(name)
expect(locator).not_to_have_accessible_description(name, **kwargs)

参数

description str | Pattern #

预期可访问描述。
ignore_case bool (optional)#

是否执行大小写不相关的匹配。[ignore_case]如果指定，（/api/class-locatorassertions.mdx#locator-assertions-not-to-have-accessible-description-option-ignore-case）选项优先于对应的正则表达式标志。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_accessible_error_message

Added in: v1.50

locatorAssertions.not_to_have_accessible_error_message

expect(locator).to_have_accessible_error_message() 的相反情况。

🌐 The opposite of expect(locator).to_have_accessible_error_message().

用法

expect(locator).not_to_have_accessible_error_message(error_message)
expect(locator).not_to_have_accessible_error_message(error_message, **kwargs)

参数

error_message str | Pattern #

预期可访问的错误消息。
ignore_case bool (optional)#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_accessible_name

Added in: v1.44

locatorAssertions.not_to_have_accessible_name

expect(locator).to_have_accessible_name() 的反义操作。

🌐 The opposite of expect(locator).to_have_accessible_name().

用法

expect(locator).not_to_have_accessible_name(name)
expect(locator).not_to_have_accessible_name(name, **kwargs)

参数

name str | Pattern #

预期可访问名称。
ignore_case bool (optional)#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_attribute

Added in: v1.20

locatorAssertions.not_to_have_attribute

expect(locator).to_have_attribute() 的相反。

🌐 The opposite of expect(locator).to_have_attribute().

用法

expect(locator).not_to_have_attribute(name, value)
expect(locator).not_to_have_attribute(name, value, **kwargs)

参数

name str Added in: v1.18#

属性名称。
value str | Pattern Added in: v1.18#

期望的属性值。
ignore_case bool (optional) Added in: v1.40#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_class

Added in: v1.20

locatorAssertions.not_to_have_class

expect(locator).to_have_class() 的相反。

🌐 The opposite of expect(locator).to_have_class().

用法

expect(locator).not_to_have_class(expected)
expect(locator).not_to_have_class(expected, **kwargs)

参数

expected str | Pattern | List[str] | List[Pattern] | List[str | Pattern] Added in: v1.18#

预期的类或 RegExp 或这些的列表。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_count

Added in: v1.20

locatorAssertions.not_to_have_count

expect(locator).to_have_count() 的相反操作。

🌐 The opposite of expect(locator).to_have_count().

用法

expect(locator).not_to_have_count(count)
expect(locator).not_to_have_count(count, **kwargs)

参数

count int Added in: v1.18#

预期计数。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_css

Added in: v1.20

locatorAssertions.not_to_have_css

expect(locator).to_have_css() 的相反。

🌐 The opposite of expect(locator).to_have_css().

用法

expect(locator).not_to_have_css(name, value)
expect(locator).not_to_have_css(name, value, **kwargs)

参数

name str Added in: v1.18#

CSS 属性名称。
value str | Pattern Added in: v1.18#

CSS 属性值。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_id

Added in: v1.20

locatorAssertions.not_to_have_id

expect(locator).to_have_id() 的相反操作。

🌐 The opposite of expect(locator).to_have_id().

用法

expect(locator).not_to_have_id(id)
expect(locator).not_to_have_id(id, **kwargs)

参数

id str | Pattern Added in: v1.18#

元素 ID。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_js_property

Added in: v1.20

locatorAssertions.not_to_have_js_property

expect(locator).to_have_js_property() 的相反。

🌐 The opposite of expect(locator).to_have_js_property().

用法

expect(locator).not_to_have_js_property(name, value)
expect(locator).not_to_have_js_property(name, value, **kwargs)

参数

name str Added in: v1.18#

属性名称。
value Any Added in: v1.18#

属性值
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_role

Added in: v1.44

locatorAssertions.not_to_have_role

expect(locator).to_have_role() 的相反。

🌐 The opposite of expect(locator).to_have_role().

用法

expect(locator).not_to_have_role(role)
expect(locator).not_to_have_role(role, **kwargs)

参数

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

所需的咏叹调角色。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_text

Added in: v1.20

locatorAssertions.not_to_have_text

expect(locator).to_have_text() 的相反操作。

🌐 The opposite of expect(locator).to_have_text().

用法

expect(locator).not_to_have_text(expected)
expect(locator).not_to_have_text(expected, **kwargs)

参数

expected str | Pattern | List[str] | List[Pattern] | List[str | Pattern] Added in: v1.18#

预期的字符串或正则表达式或它们的列表。
ignore_case bool (optional) Added in: v1.23#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。
use_inner_text bool (optional) Added in: v1.18#

在获取 DOM 节点文本时，是使用 element.innerText 还是 element.textContent。

NoneType #

not_to_have_value

Added in: v1.20

locatorAssertions.not_to_have_value

expect(locator).to_have_value() 的相反操作。

🌐 The opposite of expect(locator).to_have_value().

用法

expect(locator).not_to_have_value(value)
expect(locator).not_to_have_value(value, **kwargs)

参数

value str | Pattern Added in: v1.18#

期望值。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_have_values

Added in: v1.23

locatorAssertions.not_to_have_values

expect(locator).to_have_values() 的相反情况。

🌐 The opposite of expect(locator).to_have_values().

用法

expect(locator).not_to_have_values(values)
expect(locator).not_to_have_values(values, **kwargs)

参数

values List[str] | List[Pattern] | List[str | Pattern]#

当前选择的预期选项。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

not_to_match_aria_snapshot

Added in: v1.49

locatorAssertions.not_to_match_aria_snapshot

expect(locator).to_match_aria_snapshot() 的反义操作。

🌐 The opposite of expect(locator).to_match_aria_snapshot().

用法

expect(locator).not_to_match_aria_snapshot(expected)
expect(locator).not_to_match_aria_snapshot(expected, **kwargs)

参数

expected str #
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_attached

Added in: v1.33

locatorAssertions.to_be_attached

确保 Locator 指向一个已连接到文档或 ShadowRoot 的元素。

🌐 Ensures that Locator points to an element that is connected to a Document or a ShadowRoot.

用法

Sync
Async

expect(page.get_by_text("Hidden text")).to_be_attached()

await expect(page.get_by_text("Hidden text")).to_be_attached()

参数

attached bool (optional)#
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_checked

Added in: v1.20

locatorAssertions.to_be_checked

确保 Locator 指向已选中的输入项。

🌐 Ensures the Locator points to a checked input.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.get_by_label("Subscribe to newsletter")
expect(locator).to_be_checked()

from playwright.async_api import expect

locator = page.get_by_label("Subscribe to newsletter")
await expect(locator).to_be_checked()

参数

checked bool (optional) Added in: v1.18#

提供要断言的状态。默认情况下断言输入进行检查。当 indeterminate 设置为 true 时，无法使用此选项。
indeterminate bool (optional) Added in: v1.50#

断言元素处于不确定（混合）状态。仅支持复选框和单选按钮。当提供了 checked 时，此选项不能为 true。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_disabled

Added in: v1.20

locatorAssertions.to_be_disabled

确保 Locator 指向一个已禁用的元素。如果元素具有“disabled”属性或通过 'aria-disabled' 被禁用，则该元素被视为已禁用。请注意，只有像 HTML button、input、select、textarea、option、optgroup 这样的原生控件元素可以通过设置“disabled”属性来禁用。浏览器会忽略其他元素上的“disabled”属性。

🌐 Ensures the Locator points to a disabled element. Element is disabled if it has "disabled" attribute or is disabled via 'aria-disabled'. Note that only native control elements such as HTML button, input, select, textarea, option, optgroup can be disabled by setting "disabled" attribute. "disabled" attribute on other elements is ignored by the browser.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator("button.submit")
expect(locator).to_be_disabled()

from playwright.async_api import expect

locator = page.locator("button.submit")
await expect(locator).to_be_disabled()

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_editable

Added in: v1.20

locatorAssertions.to_be_editable

确保 Locator 指向可编辑的元素。

🌐 Ensures the Locator points to an editable element.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.get_by_role("textbox")
expect(locator).to_be_editable()

from playwright.async_api import expect

locator = page.get_by_role("textbox")
await expect(locator).to_be_editable()

参数

editable bool (optional) Added in: v1.26#
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_empty

Added in: v1.20

locatorAssertions.to_be_empty

确保 Locator 指向一个空的可编辑元素或没有文本的 DOM 节点。

🌐 Ensures the Locator points to an empty editable element or to a DOM node that has no text.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator("div.warning")
expect(locator).to_be_empty()

from playwright.async_api import expect

locator = page.locator("div.warning")
await expect(locator).to_be_empty()

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_enabled

Added in: v1.20

locatorAssertions.to_be_enabled

确保 Locator 指向一个已启用的元素。

🌐 Ensures the Locator points to an enabled element.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator("button.submit")
expect(locator).to_be_enabled()

from playwright.async_api import expect

locator = page.locator("button.submit")
await expect(locator).to_be_enabled()

参数

enabled bool (optional) Added in: v1.26#
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_focused

Added in: v1.20

locatorAssertions.to_be_focused

确保 Locator 指向一个已聚焦的 DOM 节点。

🌐 Ensures the Locator points to a focused DOM node.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.get_by_role("textbox")
expect(locator).to_be_focused()

from playwright.async_api import expect

locator = page.get_by_role("textbox")
await expect(locator).to_be_focused()

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_hidden

Added in: v1.20

locatorAssertions.to_be_hidden

确保 Locator 要么无法解析到任何 DOM 节点，要么解析到一个不可见的节点。

🌐 Ensures that Locator either does not resolve to any DOM node, or resolves to a non-visible one.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator('.my-element')
expect(locator).to_be_hidden()

from playwright.async_api import expect

locator = page.locator('.my-element')
await expect(locator).to_be_hidden()

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_in_viewport

Added in: v1.31

locatorAssertions.to_be_in_viewport

确保 Locator 指向根据 intersection observer API 与视口相交的元素。

🌐 Ensures the Locator points to an element that intersects viewport, according to the intersection observer API.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.get_by_role("button")
# Make sure at least some part of element intersects viewport.
expect(locator).to_be_in_viewport()
# Make sure element is fully outside of viewport.
expect(locator).not_to_be_in_viewport()
# Make sure that at least half of the element intersects viewport.
expect(locator).to_be_in_viewport(ratio=0.5)

from playwright.async_api import expect

locator = page.get_by_role("button")
# Make sure at least some part of element intersects viewport.
await expect(locator).to_be_in_viewport()
# Make sure element is fully outside of viewport.
await expect(locator).not_to_be_in_viewport()
# Make sure that at least half of the element intersects viewport.
await expect(locator).to_be_in_viewport(ratio=0.5)

参数

ratio float (optional)#

元素与视口相交的最小比例。如果等于 0，则元素应与视口相交的比例为任意正数。默认值为 0。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_be_visible

Added in: v1.20

locatorAssertions.to_be_visible

确保 Locator 指向一个已附加且可见的 DOM 节点。

🌐 Ensures that Locator points to an attached and visible DOM node.

要检查列表中至少有一个元素可见，请使用 locator.first。

🌐 To check that at least one element from the list is visible, use locator.first.

用法

Sync
Async

# A specific element is visible.
expect(page.get_by_text("Welcome")).to_be_visible()

# At least one item in the list is visible.
expect(page.get_by_test_id("todo-item").first).to_be_visible()

# At least one of the two elements is visible, possibly both.
expect(
    page.get_by_role("button", name="Sign in")
    .or_(page.get_by_role("button", name="Sign up"))
    .first
).to_be_visible()

# A specific element is visible.
await expect(page.get_by_text("Welcome")).to_be_visible()

# At least one item in the list is visible.
await expect(page.get_by_test_id("todo-item").first).to_be_visible()

# At least one of the two elements is visible, possibly both.
await expect(
    page.get_by_role("button", name="Sign in")
    .or_(page.get_by_role("button", name="Sign up"))
    .first
).to_be_visible()

参数

timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。
visible bool (optional) Added in: v1.26#

NoneType #

to_contain_class

Added in: v1.52

locatorAssertions.to_contain_class

确保 Locator 指向具有指定 CSS 类的元素。断言值中的所有类（以空格分隔）都必须出现在 Element.classList 中，顺序可以任意。

🌐 Ensures the Locator points to an element with given CSS classes. All classes from the asserted value, separated by spaces, must be present in the Element.classList in any order.

用法

<div class='middle selected row' id='component'></div>

Sync
Async

from playwright.sync_api import expect

locator = page.locator("#component")
expect(locator).to_contain_class("middle selected row")
expect(locator).to_contain_class("selected")
expect(locator).to_contain_class("row middle")

from playwright.async_api import expect

locator = page.locator("#component")
await expect(locator).to_contain_class("middle selected row")
await expect(locator).to_contain_class("selected")
await expect(locator).to_contain_class("row middle")

当传递数组时，方法断言所在元素列表与预期类列表匹配。每个元素的类属性与数组中对应的类进行匹配：

🌐 When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class lists. Each element's class attribute is matched against the corresponding class in the array:

<div class='list'>
  <div class='component inactive'></div>
  <div class='component active'></div>
  <div class='component inactive'></div>
</div>

Sync
Async

from playwright.sync_api import expect

locator = page.locator(".list > .component")
await expect(locator).to_contain_class(["inactive", "active", "inactive"])

from playwright.async_api import expect

locator = page.locator(".list > .component")
await expect(locator).to_contain_class(["inactive", "active", "inactive"])

参数

expected str | List[str]#

包含预期类名的字符串（以空格分隔），或用于断言多个元素的此类字符串列表。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_contain_text

Added in: v1.20

locatorAssertions.to_contain_text

确保 Locator 指向包含给定文本的元素。在计算元素的文本内容时，将考虑所有嵌套元素。你也可以对该值使用正则表达式。

🌐 Ensures the Locator points to an element that contains the given text. All nested elements will be considered when computing the text content of the element. You can use regular expressions for the value as well.

用法

Sync
Async

import re
from playwright.sync_api import expect

locator = page.locator('.title')
expect(locator).to_contain_text("substring")
expect(locator).to_contain_text(re.compile(r"\d messages"))

import re
from playwright.async_api import expect

locator = page.locator('.title')
await expect(locator).to_contain_text("substring")
await expect(locator).to_contain_text(re.compile(r"\d messages"))

如果你传递一个数组作为期望值，则期望为：

🌐 If you pass an array as an expected value, the expectations are:

定位器解析为元素列表。
此列表的子集中的元素分别包含预期数组中的文本。
匹配的元素子集与预期数组具有相同的顺序。
预期数组中的每个文本值都与列表中的某个元素匹配。

例如，考虑以下列表：

🌐 For example, consider the following list:

<ul>
  <li>Item Text 1</li>
  <li>Item Text 2</li>
  <li>Item Text 3</li>
</ul>

让我们看看如何使用断言：

🌐 Let's see how we can use the assertion:

Sync
Async

from playwright.sync_api import expect

# ✓ Contains the right items in the right order
expect(page.locator("ul > li")).to_contain_text(["Text 1", "Text 3"])

# ✖ Wrong order
expect(page.locator("ul > li")).to_contain_text(["Text 3", "Text 2"])

# ✖ No item contains this text
expect(page.locator("ul > li")).to_contain_text(["Some 33"])

# ✖ Locator points to the outer list element, not to the list items
expect(page.locator("ul")).to_contain_text(["Text 3"])

from playwright.async_api import expect

# ✓ Contains the right items in the right order
await expect(page.locator("ul > li")).to_contain_text(["Text 1", "Text 3"])

# ✖ Wrong order
await expect(page.locator("ul > li")).to_contain_text(["Text 3", "Text 2"])

# ✖ No item contains this text
await expect(page.locator("ul > li")).to_contain_text(["Some 33"])

# ✖ Locator points to the outer list element, not to the list items
await expect(page.locator("ul")).to_contain_text(["Text 3"])

参数

expected str | Pattern | List[str] | List[Pattern] | List[str | Pattern] Added in: v1.18#

预期的子字符串或正则表达式或这些的列表。
ignore_case bool (optional) Added in: v1.23#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。
use_inner_text bool (optional) Added in: v1.18#

在获取 DOM 节点文本时，是使用 element.innerText 还是 element.textContent。

NoneType #

详情

当 expected 参数是字符串时，Playwright 会在匹配前对实际文本和预期字符串中的空格和换行进行规范化。当使用正则表达式时，实际文本将按原样进行匹配。

🌐 When expected parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual text and in the expected string before matching. When regular expression is used, the actual text is matched as is.

to_have_accessible_description

Added in: v1.44

locatorAssertions.to_have_accessible_description

确保 Locator 指向具有给定可访问描述的元素。

🌐 Ensures the Locator points to an element with a given accessible description.

用法

Sync
Async

locator = page.get_by_test_id("save-button")
expect(locator).to_have_accessible_description("Save results to disk")

locator = page.get_by_test_id("save-button")
await expect(locator).to_have_accessible_description("Save results to disk")

参数

description str | Pattern #

预期可访问描述。
ignore_case bool (optional)#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_accessible_error_message

Added in: v1.50

locatorAssertions.to_have_accessible_error_message

确保 Locator 指向具有指定 aria errormessage 的元素。

🌐 Ensures the Locator points to an element with a given aria errormessage.

用法

Sync
Async

locator = page.get_by_test_id("username-input")
expect(locator).to_have_accessible_error_message("Username is required.")

locator = page.get_by_test_id("username-input")
await expect(locator).to_have_accessible_error_message("Username is required.")

参数

error_message str | Pattern #

预期可访问的错误消息。
ignore_case bool (optional)#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_accessible_name

Added in: v1.44

locatorAssertions.to_have_accessible_name

确保 Locator 指向具有给定可访问名称的元素。

🌐 Ensures the Locator points to an element with a given accessible name.

用法

Sync
Async

locator = page.get_by_test_id("save-button")
expect(locator).to_have_accessible_name("Save to disk")

locator = page.get_by_test_id("save-button")
await expect(locator).to_have_accessible_name("Save to disk")

参数

name str | Pattern #

预期可访问名称。
ignore_case bool (optional)#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_attribute

Added in: v1.20

locatorAssertions.to_have_attribute

确保 Locator 指向具有指定属性的元素。

🌐 Ensures the Locator points to an element with given attribute.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator("input")
expect(locator).to_have_attribute("type", "text")

from playwright.async_api import expect

locator = page.locator("input")
await expect(locator).to_have_attribute("type", "text")

参数

name str Added in: v1.18#

属性名称。
value str | Pattern Added in: v1.18#

期望的属性值。
ignore_case bool (optional) Added in: v1.40#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_class

Added in: v1.20

locatorAssertions.to_have_class

确保 Locator 指向具有给定 CSS 类的元素。当提供字符串时，它必须与元素的 class 属性完全匹配。要匹配单个类，请使用 expect(locator).to_contain_class()。

🌐 Ensures the Locator points to an element with given CSS classes. When a string is provided, it must fully match the element's class attribute. To match individual classes use expect(locator).to_contain_class().

用法

<div class='middle selected row' id='component'></div>

Sync
Async

from playwright.sync_api import expect

locator = page.locator("#component")
expect(locator).to_have_class("middle selected row")
expect(locator).to_have_class(re.compile(r"(^|\\s)selected(\\s|$)"))

from playwright.async_api import expect

locator = page.locator("#component")
await expect(locator).to_have_class("middle selected row")
await expect(locator).to_have_class(re.compile(r"(^|\\s)selected(\\s|$)"))

当传入一个数组时，该方法会断言定位到的元素列表与相应的预期类值列表匹配。每个元素的类属性都会与数组中的相应字符串或正则表达式进行匹配：

🌐 When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class values. Each element's class attribute is matched against the corresponding string or regular expression in the array:

Sync
Async

from playwright.sync_api import expect

locator = page.locator(".list > .component")
expect(locator).to_have_class(["component", "component selected", "component"])

from playwright.async_api import expect

locator = page.locator(".list > .component")
await expect(locator).to_have_class(["component", "component selected", "component"])

参数

expected str | Pattern | List[str] | List[Pattern] | List[str | Pattern] Added in: v1.18#

预期的类或 RegExp 或这些的列表。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_count

Added in: v1.20

locatorAssertions.to_have_count

确保 Locator 解析为确切数量的 DOM 节点。

🌐 Ensures the Locator resolves to an exact number of DOM nodes.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator("list > .component")
expect(locator).to_have_count(3)

from playwright.async_api import expect

locator = page.locator("list > .component")
await expect(locator).to_have_count(3)

参数

count int Added in: v1.18#

预期计数。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_css

Added in: v1.20

locatorAssertions.to_have_css

确保 Locator 解析为具有给定计算 CSS 样式的元素。

🌐 Ensures the Locator resolves to an element with the given computed CSS style.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.get_by_role("button")
expect(locator).to_have_css("display", "flex")

from playwright.async_api import expect

locator = page.get_by_role("button")
await expect(locator).to_have_css("display", "flex")

参数

name str Added in: v1.18#

CSS 属性名称。
value str | Pattern Added in: v1.18#

CSS 属性值。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_id

Added in: v1.20

locatorAssertions.to_have_id

确保 Locator 指向具有指定 DOM 节点 ID 的元素。

🌐 Ensures the Locator points to an element with the given DOM Node ID.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.get_by_role("textbox")
expect(locator).to_have_id("lastname")

from playwright.async_api import expect

locator = page.get_by_role("textbox")
await expect(locator).to_have_id("lastname")

参数

id str | Pattern Added in: v1.18#

元素 ID。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_js_property

Added in: v1.20

locatorAssertions.to_have_js_property

确保 Locator 指向具有指定 JavaScript 属性的元素。请注意，该属性可以是原始类型，也可以是普通可序列化的 JavaScript 对象。

🌐 Ensures the Locator points to an element with given JavaScript property. Note that this property can be of a primitive type as well as a plain serializable JavaScript object.

用法

Sync
Async

from playwright.sync_api import expect

locator = page.locator(".component")
expect(locator).to_have_js_property("loaded", True)

from playwright.async_api import expect

locator = page.locator(".component")
await expect(locator).to_have_js_property("loaded", True)

参数

name str Added in: v1.18#

属性名称。
value Any Added in: v1.18#

属性值
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_role

Added in: v1.44

locatorAssertions.to_have_role

确保 Locator 指向具有指定 ARIA 角色的元素。

🌐 Ensures the Locator points to an element with a given ARIA role.

请注意，角色是作为字符串匹配的，不考虑 ARIA 角色层次。例如，在具有子类角色 "switch" 的元素上断言超类角色 "checkbox" 将会失败。

🌐 Note that role is matched as a string, disregarding the ARIA role hierarchy. For example, asserting a superclass role "checkbox" on an element with a subclass role "switch" will fail.

用法

Sync
Async

locator = page.get_by_test_id("save-button")
expect(locator).to_have_role("button")

locator = page.get_by_test_id("save-button")
await expect(locator).to_have_role("button")

参数

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

所需的咏叹调角色。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_text

Added in: v1.20

locatorAssertions.to_have_text

确保 Locator 指向具有给定文本的元素。在计算元素的文本内容时，会考虑所有嵌套的元素。你也可以对该值使用正则表达式。

🌐 Ensures the Locator points to an element with the given text. All nested elements will be considered when computing the text content of the element. You can use regular expressions for the value as well.

用法

Sync
Async

import re
from playwright.sync_api import expect

locator = page.locator(".title")
expect(locator).to_have_text(re.compile(r"Welcome, Test User"))
expect(locator).to_have_text(re.compile(r"Welcome, .*"))

import re
from playwright.async_api import expect

locator = page.locator(".title")
await expect(locator).to_have_text(re.compile(r"Welcome, Test User"))
await expect(locator).to_have_text(re.compile(r"Welcome, .*"))

如果你传递一个数组作为期望值，则期望为：

🌐 If you pass an array as an expected value, the expectations are:

定位器解析为元素列表。
元素的数量等于数组中期望值的数量。
列表中的元素具有按顺序一一匹配预期数组值的文本。

例如，考虑以下列表：

🌐 For example, consider the following list:

<ul>
  <li>Text 1</li>
  <li>Text 2</li>
  <li>Text 3</li>
</ul>

让我们看看如何使用断言：

🌐 Let's see how we can use the assertion:

Sync
Async

from playwright.sync_api import expect

# ✓ Has the right items in the right order
expect(page.locator("ul > li")).to_have_text(["Text 1", "Text 2", "Text 3"])

# ✖ Wrong order
expect(page.locator("ul > li")).to_have_text(["Text 3", "Text 2", "Text 1"])

# ✖ Last item does not match
expect(page.locator("ul > li")).to_have_text(["Text 1", "Text 2", "Text"])

# ✖ Locator points to the outer list element, not to the list items
expect(page.locator("ul")).to_have_text(["Text 1", "Text 2", "Text 3"])

from playwright.async_api import expect

# ✓ Has the right items in the right order
await expect(page.locator("ul > li")).to_have_text(["Text 1", "Text 2", "Text 3"])

# ✖ Wrong order
await expect(page.locator("ul > li")).to_have_text(["Text 3", "Text 2", "Text 1"])

# ✖ Last item does not match
await expect(page.locator("ul > li")).to_have_text(["Text 1", "Text 2", "Text"])

# ✖ Locator points to the outer list element, not to the list items
await expect(page.locator("ul")).to_have_text(["Text 1", "Text 2", "Text 3"])

参数

expected str | Pattern | List[str] | List[Pattern] | List[str | Pattern] Added in: v1.18#

预期的字符串或正则表达式或它们的列表。
ignore_case bool (optional) Added in: v1.23#

是否执行不区分大小写的匹配。如果指定，ignore_case 选项优先于相应的正则表达式标志。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。
use_inner_text bool (optional) Added in: v1.18#

在获取 DOM 节点文本时，是使用 element.innerText 还是 element.textContent。

NoneType #

详情

to_have_value

Added in: v1.20

locatorAssertions.to_have_value

确保 Locator 指向具有给定输入值的元素。你也可以为该值使用正则表达式。

🌐 Ensures the Locator points to an element with the given input value. You can use regular expressions for the value as well.

用法

Sync
Async

import re
from playwright.sync_api import expect

locator = page.locator("input[type=number]")
expect(locator).to_have_value(re.compile(r"[0-9]"))

import re
from playwright.async_api import expect

locator = page.locator("input[type=number]")
await expect(locator).to_have_value(re.compile(r"[0-9]"))

参数

value str | Pattern Added in: v1.18#

期望值。
timeout float (optional) Added in: v1.18#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_have_values

Added in: v1.23

locatorAssertions.to_have_values

确保 Locator 指向多选/组合框（即带有 multiple 属性的 select），并且选择了指定的值。

🌐 Ensures the Locator points to multi-select/combobox (i.e. a select with the multiple attribute) and the specified values are selected.

用法

例如，给定以下元素：

🌐 For example, given the following element:

<select id="favorite-colors" multiple>
  <option value="R">Red</option>
  <option value="G">Green</option>
  <option value="B">Blue</option>
</select>

Sync
Async

import re
from playwright.sync_api import expect

locator = page.locator("id=favorite-colors")
locator.select_option(["R", "G"])
expect(locator).to_have_values([re.compile(r"R"), re.compile(r"G")])

import re
from playwright.async_api import expect

locator = page.locator("id=favorite-colors")
await locator.select_option(["R", "G"])
await expect(locator).to_have_values([re.compile(r"R"), re.compile(r"G")])

参数

values List[str] | List[Pattern] | List[str | Pattern]#

当前选择的预期选项。
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

to_match_aria_snapshot

Added in: v1.49

locatorAssertions.to_match_aria_snapshot

断言目标元素与给定的辅助功能快照匹配。

🌐 Asserts that the target element matches the given accessibility snapshot.

用法

Sync
Async

page.goto("https://demo.playwright.dev/todomvc/")
expect(page.locator('body')).to_match_aria_snapshot('''
  - heading "todos"
  - textbox "What needs to be done?"
''')

await page.goto("https://demo.playwright.dev/todomvc/")
await expect(page.locator('body')).to_match_aria_snapshot('''
  - heading "todos"
  - textbox "What needs to be done?"
''')

参数

expected str #
timeout float (optional)#

重试断言的时间（以毫秒为单位）。默认值为 5000。

NoneType #

方法​

not_to_be_attached​

not_to_be_checked​

not_to_be_disabled​

not_to_be_editable​

not_to_be_empty​

not_to_be_enabled​

not_to_be_focused​

not_to_be_hidden​

not_to_be_in_viewport​

not_to_be_visible​

not_to_contain_class​

not_to_contain_text​

not_to_have_accessible_description​

not_to_have_accessible_error_message​

not_to_have_accessible_name​

not_to_have_attribute​

not_to_have_class​

not_to_have_count​

not_to_have_css​

not_to_have_id​

not_to_have_js_property​

not_to_have_role​

not_to_have_text​

not_to_have_value​

not_to_have_values​

not_to_match_aria_snapshot​

to_be_attached​

to_be_checked​

to_be_disabled​

to_be_editable​

to_be_empty​

to_be_enabled​

to_be_focused​

to_be_hidden​

to_be_in_viewport​

to_be_visible​

to_contain_class​

to_contain_text​

to_have_accessible_description​

to_have_accessible_error_message​

to_have_accessible_name​

to_have_attribute​

to_have_class​

to_have_count​

to_have_css​

to_have_id​

to_have_js_property​

to_have_role​

to_have_text​

to_have_value​

to_have_values​

to_match_aria_snapshot​

方法

not_to_be_attached

not_to_be_checked

not_to_be_disabled

not_to_be_editable

not_to_be_empty

not_to_be_enabled

not_to_be_focused

not_to_be_hidden

not_to_be_in_viewport

not_to_be_visible

not_to_contain_class

not_to_contain_text

not_to_have_accessible_description

not_to_have_accessible_error_message

not_to_have_accessible_name

not_to_have_attribute

not_to_have_class

not_to_have_count

not_to_have_css

not_to_have_id

not_to_have_js_property

not_to_have_role

not_to_have_text

not_to_have_value

not_to_have_values

not_to_match_aria_snapshot

to_be_attached

to_be_checked

to_be_disabled

to_be_editable

to_be_empty

to_be_enabled

to_be_focused

to_be_hidden

to_be_in_viewport

to_be_visible

to_contain_class

to_contain_text

to_have_accessible_description

to_have_accessible_error_message

to_have_accessible_name

to_have_attribute

to_have_class

to_have_count

to_have_css

to_have_id

to_have_js_property

to_have_role

to_have_text

to_have_value

to_have_values

to_match_aria_snapshot