LocatorAssertions

LocatorAssertions クラスは、テストで Locator の状態に関するアサーションを行うために使用できるアサーションメソッドを提供します。

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

メソッド

not_to_be_attached

追加バージョン: v1.33

locatorAssertions.not_to_be_attached

expect(locator).to_be_attached() の反対です。

使用例

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

引数

attached bool (オプション)#
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_checked

追加バージョン: v1.20

locatorAssertions.not_to_be_checked

expect(locator).to_be_checked() の反対です。

使用例

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

引数

timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_disabled

追加バージョン: v1.20

locatorAssertions.not_to_be_disabled

expect(locator).to_be_disabled() の反対です。

使用例

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

引数

timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_editable

追加バージョン: v1.20

locatorAssertions.not_to_be_editable

expect(locator).to_be_editable() の反対です。

使用例

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

引数

editable bool (オプション)追加バージョン: v1.26#
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_empty

追加バージョン: v1.20

locatorAssertions.not_to_be_empty

expect(locator).to_be_empty() の反対です。

使用例

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

引数

timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_enabled

追加バージョン: v1.20

locatorAssertions.not_to_be_enabled

expect(locator).to_be_enabled() の反対です。

使用例

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

引数

enabled bool (オプション)追加バージョン: v1.26#
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_focused

追加バージョン: v1.20

locatorAssertions.not_to_be_focused

expect(locator).to_be_focused() の反対です。

使用例

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

引数

timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_hidden

追加バージョン: v1.20

locatorAssertions.not_to_be_hidden

expect(locator).to_be_hidden() の反対です。

使用例

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

引数

timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_in_viewport

追加バージョン: v1.31

locatorAssertions.not_to_be_in_viewport

expect(locator).to_be_in_viewport() の反対です。

使用例

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

引数

ratio float (オプション)#
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_be_visible

追加バージョン: v1.20

locatorAssertions.not_to_be_visible

expect(locator).to_be_visible() の反対です。

使用例

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

引数

timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。
visible bool (オプション)追加バージョン: v1.26#

戻り値

NoneType #

not_to_contain_text

追加バージョン: v1.20

locatorAssertions.not_to_contain_text

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]追加バージョン: v1.18#

期待される部分文字列、正規表現、またはそれらのリスト。
ignore_case bool (オプション)追加バージョン: v1.23#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。
use_inner_text bool (オプション)追加バージョン: v1.18#

DOMノードテキストを取得するときに、element.textContent の代わりに element.innerText を使用するかどうか。

戻り値

NoneType #

not_to_have_accessible_description

追加バージョン: v1.44

locatorAssertions.not_to_have_accessible_description

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 (オプション)#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_accessible_error_message

追加バージョン: v1.50

locatorAssertions.not_to_have_accessible_error_message

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 (オプション)#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_accessible_name

追加バージョン: v1.44

locatorAssertions.not_to_have_accessible_name

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 (オプション)#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_attribute

追加バージョン: v1.20

locatorAssertions.not_to_have_attribute

expect(locator).to_have_attribute() の反対です。

使用例

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

引数

name str追加バージョン: v1.18#

属性名。
value str | Pattern追加バージョン: v1.18#

期待される属性値。
ignore_case bool (オプション)追加バージョン: v1.40#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_class

追加バージョン: v1.20

locatorAssertions.not_to_have_class

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]追加バージョン: v1.18#

期待されるクラス、正規表現、またはそれらのリスト。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_count

追加バージョン: v1.20

locatorAssertions.not_to_have_count

expect(locator).to_have_count() の反対です。

使用例

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

引数

count int追加バージョン: v1.18#

期待される数。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_css

追加バージョン: v1.20

locatorAssertions.not_to_have_css

expect(locator).to_have_css() の反対です。

使用例

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

引数

name str追加バージョン: v1.18#

CSSプロパティ名。
value str | Pattern追加バージョン: v1.18#

CSSプロパティ値。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_id

追加バージョン: v1.20

locatorAssertions.not_to_have_id

expect(locator).to_have_id() の反対です。

使用例

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

引数

id str | Pattern追加バージョン: v1.18#

要素のID。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_js_property

追加バージョン: v1.20

locatorAssertions.not_to_have_js_property

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追加バージョン: v1.18#

プロパティ名。
value Any追加バージョン: v1.18#

プロパティ値。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_role

追加バージョン: v1.44

locatorAssertions.not_to_have_role

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

必須の ARIA role。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_text

追加バージョン: v1.20

locatorAssertions.not_to_have_text

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]追加バージョン: v1.18#

期待される文字列、正規表現、またはそれらのリスト。
ignore_case bool (オプション)追加バージョン: v1.23#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。
use_inner_text bool (オプション)追加バージョン: v1.18#

DOMノードテキストを取得するときに、element.textContent の代わりに element.innerText を使用するかどうか。

戻り値

NoneType #

not_to_have_value

追加バージョン: v1.20

locatorAssertions.not_to_have_value

expect(locator).to_have_value() の反対です。

使用例

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

引数

value str | Pattern追加バージョン: v1.18#

期待される値。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_have_values

追加バージョン: v1.23

locatorAssertions.not_to_have_values

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 (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

not_to_match_aria_snapshot

追加バージョン: v1.49

locatorAssertions.not_to_match_aria_snapshot

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 (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_attached

追加バージョン: v1.33

locatorAssertions.to_be_attached

Locator がドキュメントまたは 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 (オプション)#
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_checked

追加バージョン: v1.20

locatorAssertions.to_be_checked

Locator がチェックされた入力要素を指していることを保証します。

使用例

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 (オプション)追加バージョン: v1.18#

アサートする状態を提供します。デフォルトでは、入力要素がチェックされていることをアサートします。このオプションは、indeterminate が true に設定されている場合は使用できません。
indeterminate bool (オプション)追加バージョン: v1.50#

要素が不確定（混合）状態であることをアサートします。チェックボックスとラジオボタンでのみサポートされています。このオプションは、checked が指定されている場合は true にできません。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_disabled

追加バージョン: v1.20

locatorAssertions.to_be_disabled

Locator が disabled 状態の要素を指していることを保証します。要素は、"disabled" 属性を持っているか、'aria-disabled' を介して disabled になっている場合に disabled と見なされます。HTML の button, input, select, textarea, option, optgroup などのネイティブコントロール要素のみが、"disabled" 属性を設定することで disabled にできることに注意してください。他の要素の "disabled" 属性はブラウザによって無視されます。

使用例

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 (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_editable

追加バージョン: v1.20

locatorAssertions.to_be_editable

Locator が編集可能な要素を指していることを保証します。

使用例

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 (オプション)追加バージョン: v1.26#
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_empty

追加バージョン: v1.20

locatorAssertions.to_be_empty

Locator が、空の編集可能な要素、またはテキストを持たない DOM ノードを指していることを保証します。

使用例

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 (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_enabled

追加バージョン: v1.20

locatorAssertions.to_be_enabled

Locator が、有効な要素を指していることを保証します。

使用例

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 (オプション)追加バージョン: v1.26#
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_focused

追加バージョン: v1.20

locatorAssertions.to_be_focused

Locator が、フォーカスされた DOM ノードを指していることを保証します。

使用例

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 (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_hidden

追加バージョン: v1.20

locatorAssertions.to_be_hidden

Locator が、DOM ノードに解決されないか、または非表示のノードに解決されることを保証します。

使用例

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 (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_in_viewport

追加バージョン: v1.31

locatorAssertions.to_be_in_viewport

Locator が、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 (オプション)#

要素がビューポートと交差する最小の割合。0 に等しい場合、要素は任意の正の割合でビューポートと交差する必要があります。デフォルトは 0 です。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_be_visible

追加バージョン: v1.20

locatorAssertions.to_be_visible

Locator が、アタッチされていて表示されている DOM ノードを指していることを保証します。

リスト内の少なくとも1つの要素が表示されていることを確認するには、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 (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。
visible bool (オプション)追加バージョン: v1.26#

戻り値

NoneType #

to_contain_text

追加バージョン: v1.20

locatorAssertions.to_contain_text

Locator が、指定されたテキストを含む要素を指していることを保証します。要素のテキストコンテンツを計算する際には、すべてのネストされた要素が考慮されます。値には正規表現も使用できます。

使用例

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

期待値として配列を渡した場合、期待される動作は次のとおりです。

Locator は要素のリストに解決されます。
このリストのサブセットからの要素は、期待される配列からのテキストをそれぞれ含んでいます。
一致する要素のサブセットは、期待される配列と同じ順序を持ちます。
期待される配列からの各テキスト値は、リスト内の一部の要素によって一致されます。

たとえば、次のリストを考えてみましょう

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

アサーションをどのように使用できるか見てみましょう

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", "Text 4"])

# ✖ 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", "Text 4"])

# ✖ 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]追加バージョン: v1.18#

期待される部分文字列、正規表現、またはそれらのリスト。
ignore_case bool (オプション)追加バージョン: v1.23#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。
use_inner_text bool (オプション)追加バージョン: v1.18#

DOMノードテキストを取得するときに、element.textContent の代わりに element.innerText を使用するかどうか。

戻り値

NoneType #

詳細

expected パラメーターが文字列の場合、Playwright は、一致する前に、実際のテキストと期待される文字列の両方で空白と改行を正規化します。正規表現が使用されている場合、実際のテキストはそのまま一致されます。

to_have_accessible_description

追加バージョン: v1.44

locatorAssertions.to_have_accessible_description

Locator が、指定されたアクセシブルな説明を持つ要素を指していることを保証します。

使用例

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 (オプション)#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_accessible_error_message

追加バージョン: v1.50

locatorAssertions.to_have_accessible_error_message

Locator が、指定された 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 (オプション)#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_accessible_name

追加バージョン: v1.44

locatorAssertions.to_have_accessible_name

Locator が、指定されたアクセシブルな名前を持つ要素を指していることを保証します。

使用例

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 (オプション)#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_attribute

追加バージョン: v1.20

locatorAssertions.to_have_attribute

Locator が、指定された属性を持つ要素を指していることを保証します。

使用例

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追加バージョン: v1.18#

属性名。
value str | Pattern追加バージョン: v1.18#

期待される属性値。
ignore_case bool (オプション)追加バージョン: v1.40#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_class

追加バージョン: v1.20

locatorAssertions.to_have_class

Locator が、指定された CSS クラスを持つ要素を指していることを保証します。文字列が指定された場合、要素の 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(re.compile(r"(^|\\s)selected(\\s|$)"))
expect(locator).to_have_class("middle selected row")

from playwright.async_api import expect

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

配列が渡されると、このメソッドは、特定された要素のリストが、期待されるクラス値の対応するリストと一致することをアサートします。各要素の class 属性は、配列内の対応する文字列または正規表現と照合されます。

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]追加バージョン: v1.18#

期待されるクラス、正規表現、またはそれらのリスト。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_count

追加バージョン: v1.20

locatorAssertions.to_have_count

Locator が、正確な数の DOM ノードに解決されることを保証します。

使用例

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追加バージョン: v1.18#

期待される数。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_css

追加バージョン: v1.20

locatorAssertions.to_have_css

Locator が、指定された計算済みの CSS スタイルを持つ要素に解決されることを保証します。

使用例

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追加バージョン: v1.18#

CSSプロパティ名。
value str | Pattern追加バージョン: v1.18#

CSSプロパティ値。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_id

追加バージョン: v1.20

locatorAssertions.to_have_id

Locator が、指定された DOM ノード 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追加バージョン: v1.18#

要素のID。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_js_property

追加バージョン: v1.20

locatorAssertions.to_have_js_property

Locator が、指定された JavaScript プロパティを持つ要素を指していることを保証します。このプロパティは、プリミティブ型だけでなく、プレーンなシリアライズ可能な JavaScript オブジェクトでもかまいません。

使用例

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追加バージョン: v1.18#

プロパティ名。
value Any追加バージョン: v1.18#

プロパティ値。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_role

追加バージョン: v1.44

locatorAssertions.to_have_role

Locator が、指定された ARIA ロールを持つ要素を指していることを保証します。

ロールは文字列として照合され、ARIA ロール階層は無視されることに注意してください。たとえば、サブクラスロール "switch" を持つ要素に対して、スーパークラスロール "checkbox" をアサートすると失敗します。

使用例

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

必須の ARIA role。
timeout float (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_text

追加バージョン: v1.20

locatorAssertions.to_have_text

Locator が、指定されたテキストを持つ要素を指していることを保証します。要素のテキストコンテンツを計算する際には、すべてのネストされた要素が考慮されます。値には正規表現も使用できます。

使用例

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, .*"))

期待値として配列を渡した場合、期待される動作は次のとおりです。

Locator は要素のリストに解決されます。
要素の数は、配列内の期待される値の数と等しくなります。
リストからの要素は、期待される配列の値と一致するテキストを、順番に1つずつ持ちます。

たとえば、次のリストを考えてみましょう

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

アサーションをどのように使用できるか見てみましょう

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]追加バージョン: v1.18#

期待される文字列、正規表現、またはそれらのリスト。
ignore_case bool (オプション)追加バージョン: v1.23#

大文字と小文字を区別しない一致を実行するかどうか。ignore_case オプションは、指定されている場合、対応する正規表現フラグよりも優先されます。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。
use_inner_text bool (オプション)追加バージョン: v1.18#

DOMノードテキストを取得するときに、element.textContent の代わりに element.innerText を使用するかどうか。

戻り値

NoneType #

詳細

to_have_value

追加バージョン: v1.20

locatorAssertions.to_have_value

Locator が、指定された入力値を持つ要素を指していることを保証します。値には正規表現も使用できます。

使用例

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追加バージョン: v1.18#

期待される値。
timeout float (オプション)追加バージョン: v1.18#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_have_values

追加バージョン: v1.23

locatorAssertions.to_have_values

Locator が、複数選択/コンボボックス (つまり、multiple 属性を持つ select) を指しており、指定された値が選択されていることを保証します。

使用例

たとえば、次の要素が与えられた場合

<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 (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 5000 です。

戻り値

NoneType #

to_match_aria_snapshot

追加バージョン: v1.49

locatorAssertions.to_match_aria_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 (オプション)#

アサーションを再試行する時間（ミリ秒単位）。デフォルトは 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_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_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_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_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