English · Python
Appearance
English · Python
Appearance
The LocatorAssertions class provides assertion methods that can be used to make assertions about the Locator state in the tests.
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")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")The opposite of locator_assertions.to_be_attached().
Arguments
The opposite of locator_assertions.to_be_checked().
Arguments
The opposite of locator_assertions.to_be_disabled().
Arguments
The opposite of locator_assertions.to_be_editable().
Arguments
The opposite of locator_assertions.to_be_empty().
Arguments
The opposite of locator_assertions.to_be_enabled().
Arguments
The opposite of locator_assertions.to_be_focused().
Arguments
The opposite of locator_assertions.to_be_hidden().
Arguments
The opposite of locator_assertions.to_be_in_viewport().
Arguments
The opposite of locator_assertions.to_be_visible().
Arguments
The opposite of locator_assertions.to_contain_class().
Arguments
The opposite of locator_assertions.to_contain_text().
Arguments
expected string | RegExp | Array<string> | Array<RegExp> | Array<string | RegExp> Added in: v1.18
Expected substring or RegExp or a list of those.
ignore_case boolean (optional) Added in: v1.23
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
use_inner_text boolean (optional) Added in: v1.18
Whether to use element.innerText instead of element.textContent when retrieving DOM node text.
The opposite of locator_assertions.to_have_accessible_description().
Arguments
Expected accessible description.
ignore_case boolean (optional)
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
Time to retry the assertion for in milliseconds. Defaults to 5000.
The opposite of locator_assertions.to_have_accessible_error_message().
Arguments
Expected accessible error message.
ignore_case boolean (optional)
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
Time to retry the assertion for in milliseconds. Defaults to 5000.
The opposite of locator_assertions.to_have_accessible_name().
Arguments
Expected accessible name.
ignore_case boolean (optional)
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
Time to retry the assertion for in milliseconds. Defaults to 5000.
The opposite of locator_assertions.to_have_attribute().
Arguments
Attribute name.
value string | RegExp (optional) Added in: v1.62
Expected attribute value. If not specified, the assertion verifies that the attribute is absent.
ignore_case boolean (optional) Added in: v1.40
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
The opposite of locator_assertions.to_have_class().
Arguments
expected string | RegExp | Array<string> | Array<RegExp> | Array<string | RegExp> Added in: v1.18
Expected class or RegExp or a list of those.
The opposite of locator_assertions.to_have_count().
Arguments
Expected count.
The opposite of locator_assertions.to_have_css().
Arguments
The opposite of locator_assertions.to_have_id().
Arguments
The opposite of locator_assertions.to_have_js_property().
Arguments
Property name.
Property value.
The opposite of locator_assertions.to_have_role().
Arguments
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"
Required aria role.
The opposite of locator_assertions.to_have_text().
Arguments
expected string | RegExp | Array<string> | Array<RegExp> | Array<string | RegExp> Added in: v1.18
Expected string or RegExp or a list of those.
ignore_case boolean (optional) Added in: v1.23
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
use_inner_text boolean (optional) Added in: v1.18
Whether to use element.innerText instead of element.textContent when retrieving DOM node text.
The opposite of locator_assertions.to_have_value().
Arguments
The opposite of locator_assertions.to_have_values().
Arguments
The opposite of locator_assertions.to_match_aria_snapshot().
Arguments
Ensures that Locator points to an element that is connected to a Document or a ShadowRoot.
Usage
await expect(page.get_by_text("Hidden text")).to_be_attached()expect(page.get_by_text("Hidden text")).to_be_attached()Arguments
Ensures the Locator points to a checked input.
Usage
from playwright.async_api import expect
locator = page.get_by_label("Subscribe to newsletter")
await expect(locator).to_be_checked()from playwright.sync_api import expect
locator = page.get_by_label("Subscribe to newsletter")
expect(locator).to_be_checked()Arguments
checked boolean (optional) Added in: v1.18
Provides state to assert for. Asserts for input to be checked by default. This option can't be used when indeterminate is set to true.
indeterminate boolean (optional) Added in: v1.50
Asserts that the element is in the indeterminate (mixed) state. Only supported for checkboxes and radio buttons. This option can't be true when checked is provided.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
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.
Usage
from playwright.async_api import expect
locator = page.locator("button.submit")
await expect(locator).to_be_disabled()from playwright.sync_api import expect
locator = page.locator("button.submit")
expect(locator).to_be_disabled()Arguments
Ensures the Locator points to an editable element.
Usage
from playwright.async_api import expect
locator = page.get_by_role("textbox")
await expect(locator).to_be_editable()from playwright.sync_api import expect
locator = page.get_by_role("textbox")
expect(locator).to_be_editable()Arguments
Ensures the Locator points to an empty editable element or to a DOM node that has no text.
Usage
from playwright.async_api import expect
locator = page.locator("div.warning")
await expect(locator).to_be_empty()from playwright.sync_api import expect
locator = page.locator("div.warning")
expect(locator).to_be_empty()Arguments
Ensures the Locator points to an enabled element.
Usage
from playwright.async_api import expect
locator = page.locator("button.submit")
await expect(locator).to_be_enabled()from playwright.sync_api import expect
locator = page.locator("button.submit")
expect(locator).to_be_enabled()Arguments
Ensures the Locator points to a focused DOM node.
Usage
from playwright.async_api import expect
locator = page.get_by_role("textbox")
await expect(locator).to_be_focused()from playwright.sync_api import expect
locator = page.get_by_role("textbox")
expect(locator).to_be_focused()Arguments
Ensures that Locator either does not resolve to any DOM node, or resolves to a non-visible one.
Usage
from playwright.async_api import expect
locator = page.locator('.my-element')
await expect(locator).to_be_hidden()from playwright.sync_api import expect
locator = page.locator('.my-element')
expect(locator).to_be_hidden()Arguments
Ensures the Locator points to an element that intersects viewport, according to the intersection observer API.
Usage
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)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)Arguments
Ensures that Locator points to an attached and visible DOM node.
To check that at least one element from the list is visible, use locator.first().
Usage
# 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()# 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()Arguments
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.
Usage
<div class='middle selected row' id='component'></div>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")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")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>from playwright.async_api import expect
locator = page.locator(".list > .component")
await expect(locator).to_contain_class(["inactive", "active", "inactive"])from playwright.sync_api import expect
locator = page.locator(".list > .component")
await expect(locator).to_contain_class(["inactive", "active", "inactive"])Arguments
expected string | Array<string>
A string containing expected class names, separated by spaces, or a list of such strings to assert multiple elements.
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.
Details
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.
Usage
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"))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"))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:
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"])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"])Arguments
expected string | RegExp | Array<string> | Array<RegExp> | Array<string | RegExp> Added in: v1.18
Expected substring or RegExp or a list of those.
ignore_case boolean (optional) Added in: v1.23
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
use_inner_text boolean (optional) Added in: v1.18
Whether to use element.innerText instead of element.textContent when retrieving DOM node text.
Ensures the Locator points to an element with a given accessible description.
Usage
locator = page.get_by_test_id("save-button")
await expect(locator).to_have_accessible_description("Save results to disk")locator = page.get_by_test_id("save-button")
expect(locator).to_have_accessible_description("Save results to disk")Arguments
Expected accessible description.
ignore_case boolean (optional)
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
Time to retry the assertion for in milliseconds. Defaults to 5000.
Ensures the Locator points to an element with a given aria errormessage.
Usage
locator = page.get_by_test_id("username-input")
await expect(locator).to_have_accessible_error_message("Username is required.")locator = page.get_by_test_id("username-input")
expect(locator).to_have_accessible_error_message("Username is required.")Arguments
Expected accessible error message.
ignore_case boolean (optional)
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
Time to retry the assertion for in milliseconds. Defaults to 5000.
Ensures the Locator points to an element with a given accessible name.
Usage
locator = page.get_by_test_id("save-button")
await expect(locator).to_have_accessible_name("Save to disk")locator = page.get_by_test_id("save-button")
expect(locator).to_have_accessible_name("Save to disk")Arguments
Expected accessible name.
ignore_case boolean (optional)
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
Time to retry the assertion for in milliseconds. Defaults to 5000.
Ensures the Locator points to an element with given attribute.
Usage
from playwright.async_api import expect
locator = page.locator("input")
await expect(locator).to_have_attribute("type", "text")
await expect(locator).to_have_attribute("disabled")
await expect(locator).not_to_have_attribute("readonly")from playwright.sync_api import expect
locator = page.locator("input")
expect(locator).to_have_attribute("type", "text")
expect(locator).to_have_attribute("disabled")
expect(locator).not_to_have_attribute("readonly")Arguments
Attribute name.
value string | RegExp (optional) Added in: v1.62
Expected attribute value. If not specified, the assertion verifies that the attribute is present.
ignore_case boolean (optional) Added in: v1.40
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
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 locator_assertions.to_contain_class().
Usage
<div class='middle selected row' id='component'></div>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|$)"))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|$)"))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:
from playwright.async_api import expect
locator = page.locator(".list > .component")
await expect(locator).to_have_class(["component", "component selected", "component"])from playwright.sync_api import expect
locator = page.locator(".list > .component")
expect(locator).to_have_class(["component", "component selected", "component"])Arguments
expected string | RegExp | Array<string> | Array<RegExp> | Array<string | RegExp> Added in: v1.18
Expected class or RegExp or a list of those.
Ensures the Locator resolves to an exact number of DOM nodes.
Usage
from playwright.async_api import expect
locator = page.locator("list > .component")
await expect(locator).to_have_count(3)from playwright.sync_api import expect
locator = page.locator("list > .component")
expect(locator).to_have_count(3)Arguments
Expected count.
Ensures the Locator resolves to an element with the given computed CSS style.
Usage
from playwright.async_api import expect
locator = page.get_by_role("button")
await expect(locator).to_have_css("display", "flex")from playwright.sync_api import expect
locator = page.get_by_role("button")
expect(locator).to_have_css("display", "flex")Arguments
Ensures the Locator points to an element with the given DOM Node ID.
Usage
from playwright.async_api import expect
locator = page.get_by_role("textbox")
await expect(locator).to_have_id("lastname")from playwright.sync_api import expect
locator = page.get_by_role("textbox")
expect(locator).to_have_id("lastname")Arguments
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.
Usage
from playwright.async_api import expect
locator = page.locator(".component")
await expect(locator).to_have_js_property("loaded", True)from playwright.sync_api import expect
locator = page.locator(".component")
expect(locator).to_have_js_property("loaded", True)Arguments
Property name.
Property value.
Ensures the Locator points to an element with a given ARIA role.
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.
Usage
locator = page.get_by_test_id("save-button")
await expect(locator).to_have_role("button")locator = page.get_by_test_id("save-button")
expect(locator).to_have_role("button")Arguments
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"
Required aria role.
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.
Details
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.
Usage
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, .*"))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, .*"))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:
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"])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"])Arguments
expected string | RegExp | Array<string> | Array<RegExp> | Array<string | RegExp> Added in: v1.18
Expected string or RegExp or a list of those.
ignore_case boolean (optional) Added in: v1.23
Whether to perform case-insensitive match. ignore_case option takes precedence over the corresponding regular expression flag if specified.
timeout float (optional) Added in: v1.18
Time to retry the assertion for in milliseconds. Defaults to 5000.
use_inner_text boolean (optional) Added in: v1.18
Whether to use element.innerText instead of element.textContent when retrieving DOM node text.
Ensures the Locator points to an element with the given input value. You can use regular expressions for the value as well.
Usage
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]"))import re
from playwright.sync_api import expect
locator = page.locator("input[type=number]")
expect(locator).to_have_value(re.compile(r"[0-9]"))Arguments
Ensures the Locator points to multi-select/combobox (i.e. a select with the multiple attribute) and the specified values are selected.
Usage
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>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")])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")])Arguments
Asserts that the target element matches the given accessibility snapshot.
Usage
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?"
''')page.goto("https://demo.playwright.dev/todomvc/")
expect(page.locator('body')).to_match_aria_snapshot('''
- heading "todos"
- textbox "What needs to be done?"
''')Arguments