Proper assertion titles

Author: agg23

playwright/_impl/_assertions.py

@@ -51,6 +51,7 @@ async def _expect_impl(
         expect_options: FrameExpectOptions,
         expected: Any,
         message: str,
+        title: str = None,
     ) -> None:
         __tracebackhide__ = True
         expect_options["isNot"] = self._is_not
@@ -60,7 +61,7 @@ async def _expect_impl(
             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)
+        result = await self._actual_locator._expect(expression, expect_options, title)
         if result["matches"] == self._is_not:
             actual = result.get("received")
             if self._custom_message:
@@ -105,6 +106,7 @@ async def to_have_title(
             FrameExpectOptions(expectedText=expected_values, timeout=timeout),
             titleOrRegExp,
             "Page title expected to be",
+            'Expect "to_have_title"',
         )
 
     async def not_to_have_title(
@@ -129,6 +131,7 @@ async def to_have_url(
             FrameExpectOptions(expectedText=expected_text, timeout=timeout),
             urlOrRegExp,
             "Page URL expected to be",
+            'Expect "to_have_url"',
         )
 
     async def not_to_have_url(
@@ -190,6 +193,7 @@ async def to_contain_text(
                 ),
                 expected,
                 "Locator expected to contain text",
+                'Expect "to_contain_text"',
             )
         else:
             expected_text = to_expected_text_values(
@@ -207,6 +211,7 @@ async def to_contain_text(
                 ),
                 expected,
                 "Locator expected to contain text",
+                'Expect "to_contain_text"',
             )
 
     async def not_to_contain_text(
@@ -241,6 +246,7 @@ async def to_have_attribute(
             ),
             value,
             "Locator expected to have attribute",
+            'Expect "to_have_attribute"',
         )
 
     async def not_to_have_attribute(
@@ -276,6 +282,7 @@ async def to_have_class(
                 FrameExpectOptions(expectedText=expected_text, timeout=timeout),
                 expected,
                 "Locator expected to have class",
+                'Expect "to_have_class"',
             )
         else:
             expected_text = to_expected_text_values([expected])
@@ -284,6 +291,7 @@ async def to_have_class(
                 FrameExpectOptions(expectedText=expected_text, timeout=timeout),
                 expected,
                 "Locator expected to have class",
+                'Expect "to_have_class"',
             )
 
     async def not_to_have_class(
@@ -318,6 +326,7 @@ async def to_contain_class(
                 FrameExpectOptions(expectedText=expected_text, timeout=timeout),
                 expected,
                 "Locator expected to contain class names",
+                'Expect "to_contain_class"',
             )
         else:
             expected_text = to_expected_text_values([expected])
@@ -326,6 +335,7 @@ async def to_contain_class(
                 FrameExpectOptions(expectedText=expected_text, timeout=timeout),
                 expected,
                 "Locator expected to contain class",
+                'Expect "to_contain_class"',
             )
 
     async def not_to_contain_class(
@@ -350,6 +360,7 @@ async def to_have_count(
             FrameExpectOptions(expectedNumber=count, timeout=timeout),
             count,
             "Locator expected to have count",
+            'Expect "to_have_count"',
         )
 
     async def not_to_have_count(
@@ -375,6 +386,7 @@ async def to_have_css(
             ),
             value,
             "Locator expected to have CSS",
+            'Expect "to_have_css"',
         )
 
     async def not_to_have_css(
@@ -398,6 +410,7 @@ async def to_have_id(
             FrameExpectOptions(expectedText=expected_text, timeout=timeout),
             id,
             "Locator expected to have ID",
+            'Expect "to_have_id"',
         )
 
     async def not_to_have_id(
@@ -422,6 +435,7 @@ async def to_have_js_property(
             ),
             value,
             "Locator expected to have JS Property",
+            'Expect "to_have_property"',
         )
 
     async def not_to_have_js_property(
@@ -445,6 +459,7 @@ async def to_have_value(
             FrameExpectOptions(expectedText=expected_text, timeout=timeout),
             value,
             "Locator expected to have Value",
+            'Expect "to_have_value"',
         )
 
     async def not_to_have_value(
@@ -469,6 +484,7 @@ async def to_have_values(
             FrameExpectOptions(expectedText=expected_text, timeout=timeout),
             values,
             "Locator expected to have Values",
+            'Expect "to_have_values"',
         )
 
     async def not_to_have_values(
@@ -512,6 +528,7 @@ async def to_have_text(
                 ),
                 expected,
                 "Locator expected to have text",
+                'Expect "to_have_text"',
             )
         else:
             expected_text = to_expected_text_values(
@@ -526,6 +543,7 @@ async def to_have_text(
                 ),
                 expected,
                 "Locator expected to have text",
+                'Expect "to_have_text"',
             )
 
     async def not_to_have_text(
@@ -558,6 +576,7 @@ async def to_be_attached(
             FrameExpectOptions(timeout=timeout),
             None,
             f"Locator expected to be {attached_string}",
+            'Expect "to_be_attached"',
         )
 
     async def to_be_checked(
@@ -582,6 +601,7 @@ async def to_be_checked(
             FrameExpectOptions(timeout=timeout, expectedValue=expected_value),
             None,
             f"Locator expected to be {checked_string}",
+            'Expect "to_be_checked"',
         )
 
     async def not_to_be_attached(
@@ -609,6 +629,7 @@ async def to_be_disabled(
             FrameExpectOptions(timeout=timeout),
             None,
             "Locator expected to be disabled",
+            'Expect "to_be_disabled"',
         )
 
     async def not_to_be_disabled(
@@ -632,6 +653,7 @@ async def to_be_editable(
             FrameExpectOptions(timeout=timeout),
             None,
             f"Locator expected to be {editable_string}",
+            'Expect "to_be_editable"',
         )
 
     async def not_to_be_editable(
@@ -652,6 +674,7 @@ async def to_be_empty(
             FrameExpectOptions(timeout=timeout),
             None,
             "Locator expected to be empty",
+            'Expect "to_be_empty"',
         )
 
     async def not_to_be_empty(
@@ -675,6 +698,7 @@ async def to_be_enabled(
             FrameExpectOptions(timeout=timeout),
             None,
             f"Locator expected to be {enabled_string}",
+            'Expect "to_be_enabled"',
         )
 
     async def not_to_be_enabled(
@@ -695,6 +719,7 @@ async def to_be_hidden(
             FrameExpectOptions(timeout=timeout),
             None,
             "Locator expected to be hidden",
+            'Expect "to_be_hidden"',
         )
 
     async def not_to_be_hidden(
@@ -718,6 +743,7 @@ async def to_be_visible(
             FrameExpectOptions(timeout=timeout),
             None,
             f"Locator expected to be {visible_string}",
+            'Expect "to_be_visible"',
         )
 
     async def not_to_be_visible(
@@ -738,6 +764,7 @@ async def to_be_focused(
             FrameExpectOptions(timeout=timeout),
             None,
             "Locator expected to be focused",
+            'Expect "to_be_focused"',
         )
 
     async def not_to_be_focused(
@@ -758,6 +785,7 @@ async def to_be_in_viewport(
             FrameExpectOptions(timeout=timeout, expectedNumber=ratio),
             None,
             "Locator expected to be in viewport",
+            'Expect "to_be_in_viewport"',
         )
 
     async def not_to_be_in_viewport(
@@ -781,6 +809,7 @@ async def to_have_accessible_description(
             FrameExpectOptions(expectedText=expected_values, timeout=timeout),
             None,
             "Locator expected to have accessible description",
+            'Expect "to_have_accessible_description"',
         )
 
     async def not_to_have_accessible_description(
@@ -807,6 +836,7 @@ async def to_have_accessible_name(
             FrameExpectOptions(expectedText=expected_values, timeout=timeout),
             None,
             "Locator expected to have accessible name",
+            'Expect "to_have_accessible_name"',
         )
 
     async def not_to_have_accessible_name(
@@ -828,6 +858,7 @@ async def to_have_role(self, role: AriaRole, timeout: float = None) -> None:
             FrameExpectOptions(expectedText=expected_values, timeout=timeout),
             None,
             "Locator expected to have accessible role",
+            'Expect "to_have_role"',
         )
 
     async def to_have_accessible_error_message(
@@ -845,6 +876,7 @@ async def to_have_accessible_error_message(
             FrameExpectOptions(expectedText=expected_values, timeout=timeout),
             None,
             "Locator expected to have accessible error message",
+            'Expect "to_have_accessible_error_message"',
         )
 
     async def not_to_have_accessible_error_message(
@@ -871,6 +903,7 @@ async def to_match_aria_snapshot(
             FrameExpectOptions(expectedValue=expected, timeout=timeout),
             expected,
             "Locator expected to match Aria snapshot",
+            'Expect "to_match_aria_snapshot"',
         )
 
     async def not_to_match_aria_snapshot(

playwright/_impl/_connection.py

@@ -55,27 +55,48 @@ def __init__(self, connection: "Connection", object: "ChannelOwner") -> None:
         self._guid = object._guid
         self._object = object
         self.on("error", lambda exc: self._connection._on_event_listener_error(exc))
-        self._is_internal_type = False
         self._timeout_calculator: Optional[Callable[[Optional[float]], float]] = None
 
-    async def send(self, method: str, params: Dict = None) -> Any:
+    async def send(
+        self,
+        method: str,
+        params: Dict = None,
+        is_internal: bool = False,
+        title: str = None,
+    ) -> Any:
         return await self._connection.wrap_api_call(
             lambda: self._inner_send(method, params, False),
-            self._is_internal_type,
+            is_internal,
+            title,
         )
 
-    async def send_return_as_dict(self, method: str, params: Dict = None) -> Any:
+    async def send_return_as_dict(
+        self,
+        method: str,
+        params: Dict = None,
+        is_internal: bool = False,
+        title: str = None,
+    ) -> Any:
         return await self._connection.wrap_api_call(
             lambda: self._inner_send(method, params, True),
-            self._is_internal_type,
+            is_internal,
+            title,
         )
 
-    def send_no_reply(self, method: str, params: Dict = None) -> None:
+    def send_no_reply(
+        self,
+        method: str,
+        params: Dict = None,
+        is_internal: bool = False,
+        title: str = None,
+    ) -> None:
         # No reply messages are used to e.g. waitForEventInfo(after).
         self._connection.wrap_api_call_sync(
             lambda: self._connection._send_message_to_server(
                 self._object, method, {} if params is None else params, True
-            )
+            ),
+            is_internal,
+            title,
         )
 
     async def _inner_send(
@@ -360,6 +381,9 @@ def _send_message_to_server(
         }
         if location:
             metadata["location"] = location  # type: ignore
+        title = stack_trace_information["title"]
+        if title:
+            metadata["title"] = title
         message = {
             "id": id,
             "guid": object._guid,
@@ -512,7 +536,7 @@ def _replace_guids_with_channels(self, payload: Any) -> Any:
         return payload
 
     async def wrap_api_call(
-        self, cb: Callable[[], Any], is_internal: bool = False
+        self, cb: Callable[[], Any], is_internal: bool = False, title: str = None
     ) -> Any:
         if self._api_zone.get():
             return await cb()
@@ -521,7 +545,7 @@ async def wrap_api_call(
             task, "__pw_stack__", None
         ) or inspect.stack(0)
 
-        parsed_st = _extract_stack_trace_information_from_stack(st, is_internal)
+        parsed_st = _extract_stack_trace_information_from_stack(st, is_internal, title)
         self._api_zone.set(parsed_st)
         try:
             return await cb()
@@ -531,15 +555,15 @@ async def wrap_api_call(
             self._api_zone.set(None)
 
     def wrap_api_call_sync(
-        self, cb: Callable[[], Any], is_internal: bool = False
+        self, cb: Callable[[], Any], is_internal: bool = False, title: str = None
     ) -> Any:
         if self._api_zone.get():
             return cb()
         task = asyncio.current_task(self._loop)
         st: List[inspect.FrameInfo] = getattr(
             task, "__pw_stack__", None
         ) or inspect.stack(0)
-        parsed_st = _extract_stack_trace_information_from_stack(st, is_internal)
+        parsed_st = _extract_stack_trace_information_from_stack(st, is_internal, title)
         self._api_zone.set(parsed_st)
         try:
             return cb()
@@ -567,10 +591,11 @@ class StackFrame(TypedDict):
 class ParsedStackTrace(TypedDict):
     frames: List[StackFrame]
     apiName: Optional[str]
+    title: Optional[str]
 
 
 def _extract_stack_trace_information_from_stack(
-    st: List[inspect.FrameInfo], is_internal: bool
+    st: List[inspect.FrameInfo], is_internal: bool, title: str = None
 ) -> ParsedStackTrace:
     playwright_module_path = str(Path(playwright.__file__).parents[0])
     last_internal_api_name = ""
@@ -610,6 +635,7 @@ def _extract_stack_trace_information_from_stack(
     return {
         "frames": parsed_frames,
         "apiName": "" if is_internal else api_name,
+        "title": title,
     }