patchright 1.48.0__py3-none-win32.whl

patchright/_impl/_assertions.py

@@ -0,0 +1,779 @@
+import collections.abc
+from typing import Any, List, Optional, Pattern, Sequence, Union
+from urllib.parse import urljoin
+from patchright._impl._api_structures import (
+    AriaRole,
+    ExpectedTextValue,
+    FrameExpectOptions,
+)
+from patchright._impl._connection import format_call_log
+from patchright._impl._errors import Error
+from patchright._impl._fetch import APIResponse
+from patchright._impl._helper import is_textual_mime_type
+from patchright._impl._locator import Locator
+from patchright._impl._page import Page
+from patchright._impl._str_utils import escape_regex_flags
+
+
+class AssertionsBase:
+
+    def __init__(
+        self,
+        locator: Locator,
+        timeout: float = None,
+        is_not: bool = False,
+        message: Optional[str] = None,
+    ) -> None:
+        self._actual_locator = locator
+        self._loop = locator._loop
+        self._dispatcher_fiber = locator._dispatcher_fiber
+        self._timeout = timeout
+        self._is_not = is_not
+        self._custom_message = message
+
+    async def _expect_impl(
+        self,
+        expression: str,
+        expect_options: FrameExpectOptions,
+        expected: Any,
+        message: str,
+    ) -> None:
+        __tracebackhide__ = True
+        expect_options["isNot"] = self._is_not
+        if expect_options.get("timeout") is None:
+            expect_options["timeout"] = self._timeout or 5000
+        if expect_options["isNot"]:
+            message = message.replace("expected to", "expected not to")
+        if "useInnerText" in expect_options and expect_options["useInnerText"] is None:
+            del expect_options["useInnerText"]
+        result = await self._actual_locator._expect(expression, expect_options)
+        if result["matches"] == self._is_not:
+            actual = result.get("received")
+            if self._custom_message:
+                out_message = self._custom_message
+                if expected is not None:
+                    out_message += f"\nExpected value: '{expected or '<None>'}'"
+            else:
+                out_message = (
+                    f"{message} '{expected}'" if expected is not None else f"{message}"
+                )
+            raise AssertionError(
+                f"{out_message}\nActual value: {actual} {format_call_log(result.get('log'))}"
+            )
+
+
+class PageAssertions(AssertionsBase):
+
+    def __init__(
+        self,
+        page: Page,
+        timeout: float = None,
+        is_not: bool = False,
+        message: Optional[str] = None,
+    ) -> None:
+        super().__init__(page.locator(":root"), timeout, is_not, message)
+        self._actual_page = page
+
+    @property
+    def _not(self) -> "PageAssertions":
+        return PageAssertions(
+            self._actual_page, self._timeout, not self._is_not, self._custom_message
+        )
+
+    async def to_have_title(
+        self, titleOrRegExp: Union[Pattern[str], str], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        expected_values = to_expected_text_values(
+            [titleOrRegExp], normalize_white_space=True
+        )
+        await self._expect_impl(
+            "to.have.title",
+            FrameExpectOptions(expectedText=expected_values, timeout=timeout),
+            titleOrRegExp,
+            "Page title expected to be",
+        )
+
+    async def not_to_have_title(
+        self, titleOrRegExp: Union[Pattern[str], str], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_title(titleOrRegExp, timeout)
+
+    async def to_have_url(
+        self,
+        urlOrRegExp: Union[str, Pattern[str]],
+        timeout: float = None,
+        ignoreCase: bool = None,
+    ) -> None:
+        __tracebackhide__ = True
+        base_url = self._actual_page.context._options.get("baseURL")
+        if isinstance(urlOrRegExp, str) and base_url:
+            urlOrRegExp = urljoin(base_url, urlOrRegExp)
+        expected_text = to_expected_text_values([urlOrRegExp], ignoreCase=ignoreCase)
+        await self._expect_impl(
+            "to.have.url",
+            FrameExpectOptions(expectedText=expected_text, timeout=timeout),
+            urlOrRegExp,
+            "Page URL expected to be",
+        )
+
+    async def not_to_have_url(
+        self,
+        urlOrRegExp: Union[Pattern[str], str],
+        timeout: float = None,
+        ignoreCase: bool = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_url(urlOrRegExp, timeout, ignoreCase)
+
+
+class LocatorAssertions(AssertionsBase):
+
+    def __init__(
+        self,
+        locator: Locator,
+        timeout: float = None,
+        is_not: bool = False,
+        message: Optional[str] = None,
+    ) -> None:
+        super().__init__(locator, timeout, is_not, message)
+        self._actual_locator = locator
+
+    @property
+    def _not(self) -> "LocatorAssertions":
+        return LocatorAssertions(
+            self._actual_locator, self._timeout, not self._is_not, self._custom_message
+        )
+
+    async def to_contain_text(
+        self,
+        expected: Union[
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
+            Pattern[str],
+            str,
+        ],
+        useInnerText: bool = None,
+        timeout: float = None,
+        ignoreCase: bool = None,
+    ) -> None:
+        __tracebackhide__ = True
+        if isinstance(expected, collections.abc.Sequence) and (
+            not isinstance(expected, str)
+        ):
+            expected_text = to_expected_text_values(
+                expected,
+                match_substring=True,
+                normalize_white_space=True,
+                ignoreCase=ignoreCase,
+            )
+            await self._expect_impl(
+                "to.contain.text.array",
+                FrameExpectOptions(
+                    expectedText=expected_text,
+                    useInnerText=useInnerText,
+                    timeout=timeout,
+                ),
+                expected,
+                "Locator expected to contain text",
+            )
+        else:
+            expected_text = to_expected_text_values(
+                [expected],
+                match_substring=True,
+                normalize_white_space=True,
+                ignoreCase=ignoreCase,
+            )
+            await self._expect_impl(
+                "to.have.text",
+                FrameExpectOptions(
+                    expectedText=expected_text,
+                    useInnerText=useInnerText,
+                    timeout=timeout,
+                ),
+                expected,
+                "Locator expected to contain text",
+            )
+
+    async def not_to_contain_text(
+        self,
+        expected: Union[
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
+            Pattern[str],
+            str,
+        ],
+        useInnerText: bool = None,
+        timeout: float = None,
+        ignoreCase: bool = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_contain_text(expected, useInnerText, timeout, ignoreCase)
+
+    async def to_have_attribute(
+        self,
+        name: str,
+        value: Union[str, Pattern[str]],
+        ignoreCase: bool = None,
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        expected_text = to_expected_text_values([value], ignoreCase=ignoreCase)
+        await self._expect_impl(
+            "to.have.attribute.value",
+            FrameExpectOptions(
+                expressionArg=name, expectedText=expected_text, timeout=timeout
+            ),
+            value,
+            "Locator expected to have attribute",
+        )
+
+    async def not_to_have_attribute(
+        self,
+        name: str,
+        value: Union[str, Pattern[str]],
+        ignoreCase: bool = None,
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_attribute(
+            name, value, ignoreCase=ignoreCase, timeout=timeout
+        )
+
+    async def to_have_class(
+        self,
+        expected: Union[
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
+            Pattern[str],
+            str,
+        ],
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        if isinstance(expected, collections.abc.Sequence) and (
+            not isinstance(expected, str)
+        ):
+            expected_text = to_expected_text_values(expected)
+            await self._expect_impl(
+                "to.have.class.array",
+                FrameExpectOptions(expectedText=expected_text, timeout=timeout),
+                expected,
+                "Locator expected to have class",
+            )
+        else:
+            expected_text = to_expected_text_values([expected])
+            await self._expect_impl(
+                "to.have.class",
+                FrameExpectOptions(expectedText=expected_text, timeout=timeout),
+                expected,
+                "Locator expected to have class",
+            )
+
+    async def not_to_have_class(
+        self,
+        expected: Union[
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
+            Pattern[str],
+            str,
+        ],
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_class(expected, timeout)
+
+    async def to_have_count(self, count: int, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.have.count",
+            FrameExpectOptions(expectedNumber=count, timeout=timeout),
+            count,
+            "Locator expected to have count",
+        )
+
+    async def not_to_have_count(self, count: int, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_count(count, timeout)
+
+    async def to_have_css(
+        self, name: str, value: Union[str, Pattern[str]], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        expected_text = to_expected_text_values([value])
+        await self._expect_impl(
+            "to.have.css",
+            FrameExpectOptions(
+                expressionArg=name, expectedText=expected_text, timeout=timeout
+            ),
+            value,
+            "Locator expected to have CSS",
+        )
+
+    async def not_to_have_css(
+        self, name: str, value: Union[str, Pattern[str]], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_css(name, value, timeout)
+
+    async def to_have_id(
+        self, id: Union[str, Pattern[str]], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        expected_text = to_expected_text_values([id])
+        await self._expect_impl(
+            "to.have.id",
+            FrameExpectOptions(expectedText=expected_text, timeout=timeout),
+            id,
+            "Locator expected to have ID",
+        )
+
+    async def not_to_have_id(
+        self, id: Union[str, Pattern[str]], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_id(id, timeout)
+
+    async def to_have_js_property(
+        self, name: str, value: Any, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.have.property",
+            FrameExpectOptions(
+                expressionArg=name, expectedValue=value, timeout=timeout
+            ),
+            value,
+            "Locator expected to have JS Property",
+        )
+
+    async def not_to_have_js_property(
+        self, name: str, value: Any, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_js_property(name, value, timeout)
+
+    async def to_have_value(
+        self, value: Union[str, Pattern[str]], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        expected_text = to_expected_text_values([value])
+        await self._expect_impl(
+            "to.have.value",
+            FrameExpectOptions(expectedText=expected_text, timeout=timeout),
+            value,
+            "Locator expected to have Value",
+        )
+
+    async def not_to_have_value(
+        self, value: Union[str, Pattern[str]], timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_value(value, timeout)
+
+    async def to_have_values(
+        self,
+        values: Union[
+            Sequence[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]]
+        ],
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        expected_text = to_expected_text_values(values)
+        await self._expect_impl(
+            "to.have.values",
+            FrameExpectOptions(expectedText=expected_text, timeout=timeout),
+            values,
+            "Locator expected to have Values",
+        )
+
+    async def not_to_have_values(
+        self,
+        values: Union[
+            Sequence[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]]
+        ],
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_values(values, timeout)
+
+    async def to_have_text(
+        self,
+        expected: Union[
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
+            Pattern[str],
+            str,
+        ],
+        useInnerText: bool = None,
+        timeout: float = None,
+        ignoreCase: bool = None,
+    ) -> None:
+        __tracebackhide__ = True
+        if isinstance(expected, collections.abc.Sequence) and (
+            not isinstance(expected, str)
+        ):
+            expected_text = to_expected_text_values(
+                expected, normalize_white_space=True, ignoreCase=ignoreCase
+            )
+            await self._expect_impl(
+                "to.have.text.array",
+                FrameExpectOptions(
+                    expectedText=expected_text,
+                    useInnerText=useInnerText,
+                    timeout=timeout,
+                ),
+                expected,
+                "Locator expected to have text",
+            )
+        else:
+            expected_text = to_expected_text_values(
+                [expected], normalize_white_space=True, ignoreCase=ignoreCase
+            )
+            await self._expect_impl(
+                "to.have.text",
+                FrameExpectOptions(
+                    expectedText=expected_text,
+                    useInnerText=useInnerText,
+                    timeout=timeout,
+                ),
+                expected,
+                "Locator expected to have text",
+            )
+
+    async def not_to_have_text(
+        self,
+        expected: Union[
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
+            Pattern[str],
+            str,
+        ],
+        useInnerText: bool = None,
+        timeout: float = None,
+        ignoreCase: bool = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_text(expected, useInnerText, timeout, ignoreCase)
+
+    async def to_be_attached(
+        self, attached: bool = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            (
+                "to.be.attached"
+                if attached is None or attached is True
+                else "to.be.detached"
+            ),
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be attached",
+        )
+
+    async def to_be_checked(self, timeout: float = None, checked: bool = None) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            (
+                "to.be.checked"
+                if checked is None or checked is True
+                else "to.be.unchecked"
+            ),
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be checked",
+        )
+
+    async def not_to_be_attached(
+        self, attached: bool = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_attached(attached=attached, timeout=timeout)
+
+    async def not_to_be_checked(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_checked(timeout)
+
+    async def to_be_disabled(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.be.disabled",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be disabled",
+        )
+
+    async def not_to_be_disabled(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_disabled(timeout)
+
+    async def to_be_editable(
+        self, editable: bool = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        if editable is None:
+            editable = True
+        await self._expect_impl(
+            "to.be.editable" if editable else "to.be.readonly",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be editable",
+        )
+
+    async def not_to_be_editable(
+        self, editable: bool = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_editable(editable, timeout)
+
+    async def to_be_empty(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.be.empty",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be empty",
+        )
+
+    async def not_to_be_empty(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_empty(timeout)
+
+    async def to_be_enabled(self, enabled: bool = None, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        if enabled is None:
+            enabled = True
+        await self._expect_impl(
+            "to.be.enabled" if enabled else "to.be.disabled",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be enabled",
+        )
+
+    async def not_to_be_enabled(
+        self, enabled: bool = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_enabled(enabled, timeout)
+
+    async def to_be_hidden(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.be.hidden",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be hidden",
+        )
+
+    async def not_to_be_hidden(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_hidden(timeout)
+
+    async def to_be_visible(self, visible: bool = None, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        if visible is None:
+            visible = True
+        await self._expect_impl(
+            "to.be.visible" if visible else "to.be.hidden",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be visible",
+        )
+
+    async def not_to_be_visible(
+        self, visible: bool = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_visible(visible, timeout)
+
+    async def to_be_focused(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.be.focused",
+            FrameExpectOptions(timeout=timeout),
+            None,
+            "Locator expected to be focused",
+        )
+
+    async def not_to_be_focused(self, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_focused(timeout)
+
+    async def to_be_in_viewport(
+        self, ratio: float = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._expect_impl(
+            "to.be.in.viewport",
+            FrameExpectOptions(timeout=timeout, expectedNumber=ratio),
+            None,
+            "Locator expected to be in viewport",
+        )
+
+    async def not_to_be_in_viewport(
+        self, ratio: float = None, timeout: float = None
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_in_viewport(ratio=ratio, timeout=timeout)
+
+    async def to_have_accessible_description(
+        self,
+        description: Union[str, Pattern[str]],
+        ignoreCase: bool = None,
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        expected_values = to_expected_text_values([description], ignoreCase=ignoreCase)
+        await self._expect_impl(
+            "to.have.accessible.description",
+            FrameExpectOptions(expectedText=expected_values, timeout=timeout),
+            None,
+            "Locator expected to have accessible description",
+        )
+
+    async def not_to_have_accessible_description(
+        self,
+        name: Union[str, Pattern[str]],
+        ignoreCase: bool = None,
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_accessible_description(name, ignoreCase, timeout)
+
+    async def to_have_accessible_name(
+        self,
+        name: Union[str, Pattern[str]],
+        ignoreCase: bool = None,
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        expected_values = to_expected_text_values([name], ignoreCase=ignoreCase)
+        await self._expect_impl(
+            "to.have.accessible.name",
+            FrameExpectOptions(expectedText=expected_values, timeout=timeout),
+            None,
+            "Locator expected to have accessible name",
+        )
+
+    async def not_to_have_accessible_name(
+        self,
+        name: Union[str, Pattern[str]],
+        ignoreCase: bool = None,
+        timeout: float = None,
+    ) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_accessible_name(name, ignoreCase, timeout)
+
+    async def to_have_role(self, role: AriaRole, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        if isinstance(role, Pattern):
+            raise Error('"role" argument in to_have_role must be a string')
+        expected_values = to_expected_text_values([role])
+        await self._expect_impl(
+            "to.have.role",
+            FrameExpectOptions(expectedText=expected_values, timeout=timeout),
+            None,
+            "Locator expected to have accessible role",
+        )
+
+    async def not_to_have_role(self, role: AriaRole, timeout: float = None) -> None:
+        __tracebackhide__ = True
+        await self._not.to_have_role(role, timeout)
+
+
+class APIResponseAssertions:
+
+    def __init__(
+        self,
+        response: APIResponse,
+        timeout: float = None,
+        is_not: bool = False,
+        message: Optional[str] = None,
+    ) -> None:
+        self._loop = response._loop
+        self._dispatcher_fiber = response._dispatcher_fiber
+        self._timeout = timeout
+        self._is_not = is_not
+        self._actual = response
+        self._custom_message = message
+
+    @property
+    def _not(self) -> "APIResponseAssertions":
+        return APIResponseAssertions(
+            self._actual, self._timeout, not self._is_not, self._custom_message
+        )
+
+    async def to_be_ok(self) -> None:
+        __tracebackhide__ = True
+        if self._is_not is not self._actual.ok:
+            return
+        message = f"Response status expected to be within [200..299] range, was '{self._actual.status}'"
+        if self._is_not:
+            message = message.replace("expected to", "expected not to")
+        out_message = self._custom_message or message
+        out_message += format_call_log(await self._actual._fetch_log())
+        content_type = self._actual.headers.get("content-type")
+        is_text_encoding = content_type and is_textual_mime_type(content_type)
+        text = await self._actual.text() if is_text_encoding else None
+        if text is not None:
+            out_message += f"\n Response Text:\n{text[:1000]}"
+        raise AssertionError(out_message)
+
+    async def not_to_be_ok(self) -> None:
+        __tracebackhide__ = True
+        await self._not.to_be_ok()
+
+
+def expected_regex(
+    pattern: Pattern[str],
+    match_substring: bool,
+    normalize_white_space: bool,
+    ignoreCase: Optional[bool] = None,
+) -> ExpectedTextValue:
+    expected = ExpectedTextValue(
+        regexSource=pattern.pattern,
+        regexFlags=escape_regex_flags(pattern),
+        matchSubstring=match_substring,
+        normalizeWhiteSpace=normalize_white_space,
+        ignoreCase=ignoreCase,
+    )
+    if expected["ignoreCase"] is None:
+        del expected["ignoreCase"]
+    return expected
+
+
+def to_expected_text_values(
+    items: Union[
+        Sequence[Pattern[str]], Sequence[str], Sequence[Union[str, Pattern[str]]]
+    ],
+    match_substring: bool = False,
+    normalize_white_space: bool = False,
+    ignoreCase: Optional[bool] = None,
+) -> Sequence[ExpectedTextValue]:
+    out: List[ExpectedTextValue] = []
+    assert isinstance(items, list)
+    for item in items:
+        if isinstance(item, str):
+            o = ExpectedTextValue(
+                string=item,
+                matchSubstring=match_substring,
+                normalizeWhiteSpace=normalize_white_space,
+                ignoreCase=ignoreCase,
+            )
+            if o["ignoreCase"] is None:
+                del o["ignoreCase"]
+            out.append(o)
+        elif isinstance(item, Pattern):
+            out.append(
+                expected_regex(item, match_substring, normalize_white_space, ignoreCase)
+            )
+        else:
+            raise Error("value must be a string or regular expression")
+    return out