chore: rename expect.set_timeout to set_options (microsoft#1927)

mxschmitt · web-flow · commit d4a874f3eebb · 2023-05-17T17:53:56.000-07:00
diff --git a/playwright/async_api/__init__.py b/playwright/async_api/__init__.py
@@ -91,8 +91,18 @@ class Expect:
     def __init__(self) -> None:
         self._timeout: Optional[float] = None
 
-    def set_timeout(self, timeout: float) -> None:
-        self._timeout = timeout
+    def set_options(self, timeout: float = None) -> None:
+        """
+        This method sets global `expect()` options.
+
+        Args:
+            timeout (float): Timeout value in milliseconds. Default to 5000 milliseconds.
+
+        Returns:
+            None
+        """
+        if timeout is not None:
+            self._timeout = timeout
 
     @overload
     def __call__(self, actual: Page, message: Optional[str] = None) -> PageAssertions:
diff --git a/playwright/sync_api/__init__.py b/playwright/sync_api/__init__.py
@@ -91,8 +91,18 @@ class Expect:
     def __init__(self) -> None:
         self._timeout: Optional[float] = None
 
-    def set_timeout(self, timeout: float) -> None:
-        self._timeout = timeout
+    def set_options(self, timeout: float = None) -> None:
+        """
+        This method sets global `expect()` options.
+
+        Args:
+            timeout (float): Timeout value in milliseconds. Default to 5000 milliseconds.
+
+        Returns:
+            None
+        """
+        if timeout is not None:
+            self._timeout = timeout
 
     @overload
     def __call__(self, actual: Page, message: Optional[str] = None) -> PageAssertions:
diff --git a/tests/async/test_assertions.py b/tests/async/test_assertions.py
@@ -800,11 +800,11 @@ async def test_should_be_able_to_set_custom_timeout(page: Page) -> None:
 
 async def test_should_be_able_to_set_custom_global_timeout(page: Page) -> None:
     try:
-        expect.set_timeout(111)
+        expect.set_options(timeout=111)
         with pytest.raises(AssertionError) as exc_info:
             await expect(page.locator("#a1")).to_be_visible()
         assert "LocatorAssertions.to_be_visible with timeout 111ms" in str(
             exc_info.value
         )
     finally:
-        expect.set_timeout(None)
+        expect.set_options(timeout=None)
diff --git a/tests/sync/test_assertions.py b/tests/sync/test_assertions.py
@@ -862,11 +862,11 @@ def test_should_be_able_to_set_custom_timeout(page: Page) -> None:
 
 def test_should_be_able_to_set_custom_global_timeout(page: Page) -> None:
     try:
-        expect.set_timeout(111)
+        expect.set_options(timeout=111)
         with pytest.raises(AssertionError) as exc_info:
             expect(page.locator("#a1")).to_be_visible()
         assert "LocatorAssertions.to_be_visible with timeout 111ms" in str(
             exc_info.value
         )
     finally:
-        expect.set_timeout(5_000)
+        expect.set_options(timeout=5_000)
