chore: use Sequence for input List like types (#2178)

Author: mxschmitt

playwright/_impl/_api_structures.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 import sys
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Sequence, Union
 
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal, TypedDict
@@ -185,7 +185,7 @@ class ExpectedTextValue(TypedDict, total=False):
 
 class FrameExpectOptions(TypedDict, total=False):
     expressionArg: Any
-    expectedText: Optional[List[ExpectedTextValue]]
+    expectedText: Optional[Sequence[ExpectedTextValue]]
     expectedNumber: Optional[float]
     expectedValue: Optional[Any]
     useInnerText: Optional[bool]

playwright/_impl/_assertions.py

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Any, List, Optional, Pattern, Union
+import collections.abc
+from typing import Any, List, Optional, Pattern, Sequence, Union
 from urllib.parse import urljoin
 
 from playwright._impl._api_structures import ExpectedTextValue, FrameExpectOptions
@@ -149,9 +150,9 @@ def _not(self) -> "LocatorAssertions":
     async def to_contain_text(
         self,
         expected: Union[
-            List[str],
-            List[Pattern[str]],
-            List[Union[Pattern[str], str]],
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
             Pattern[str],
             str,
         ],
@@ -160,7 +161,9 @@ async def to_contain_text(
         ignore_case: bool = None,
     ) -> None:
         __tracebackhide__ = True
-        if isinstance(expected, list):
+        if isinstance(expected, collections.abc.Sequence) and not isinstance(
+            expected, str
+        ):
             expected_text = to_expected_text_values(
                 expected,
                 match_substring=True,
@@ -198,9 +201,9 @@ async def to_contain_text(
     async def not_to_contain_text(
         self,
         expected: Union[
-            List[str],
-            List[Pattern[str]],
-            List[Union[Pattern[str], str]],
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
             Pattern[str],
             str,
         ],
@@ -244,16 +247,18 @@ async def not_to_have_attribute(
     async def to_have_class(
         self,
         expected: Union[
-            List[str],
-            List[Pattern[str]],
-            List[Union[Pattern[str], str]],
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
             Pattern[str],
             str,
         ],
         timeout: float = None,
     ) -> None:
         __tracebackhide__ = True
-        if isinstance(expected, list):
+        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",
@@ -273,9 +278,9 @@ async def to_have_class(
     async def not_to_have_class(
         self,
         expected: Union[
-            List[str],
-            List[Pattern[str]],
-            List[Union[Pattern[str], str]],
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
             Pattern[str],
             str,
         ],
@@ -402,7 +407,9 @@ async def not_to_have_value(
 
     async def to_have_values(
         self,
-        values: Union[List[str], List[Pattern[str]], List[Union[Pattern[str], str]]],
+        values: Union[
+            Sequence[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]]
+        ],
         timeout: float = None,
     ) -> None:
         __tracebackhide__ = True
@@ -416,7 +423,9 @@ async def to_have_values(
 
     async def not_to_have_values(
         self,
-        values: Union[List[str], List[Pattern[str]], List[Union[Pattern[str], str]]],
+        values: Union[
+            Sequence[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]]
+        ],
         timeout: float = None,
     ) -> None:
         __tracebackhide__ = True
@@ -425,9 +434,9 @@ async def not_to_have_values(
     async def to_have_text(
         self,
         expected: Union[
-            List[str],
-            List[Pattern[str]],
-            List[Union[Pattern[str], str]],
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
             Pattern[str],
             str,
         ],
@@ -436,7 +445,9 @@ async def to_have_text(
         ignore_case: bool = None,
     ) -> None:
         __tracebackhide__ = True
-        if isinstance(expected, list):
+        if isinstance(expected, collections.abc.Sequence) and not isinstance(
+            expected, str
+        ):
             expected_text = to_expected_text_values(
                 expected,
                 normalize_white_space=True,
@@ -470,9 +481,9 @@ async def to_have_text(
     async def not_to_have_text(
         self,
         expected: Union[
-            List[str],
-            List[Pattern[str]],
-            List[Union[Pattern[str], str]],
+            Sequence[str],
+            Sequence[Pattern[str]],
+            Sequence[Union[Pattern[str], str]],
             Pattern[str],
             str,
         ],
@@ -758,11 +769,13 @@ def expected_regex(
 
 
 def to_expected_text_values(
-    items: Union[List[Pattern[str]], List[str], List[Union[str, Pattern[str]]]],
+    items: Union[
+        Sequence[Pattern[str]], Sequence[str], Sequence[Union[str, Pattern[str]]]
+    ],
     match_substring: bool = False,
     normalize_white_space: bool = False,
     ignore_case: Optional[bool] = None,
-) -> List[ExpectedTextValue]:
+) -> Sequence[ExpectedTextValue]:
     out: List[ExpectedTextValue] = []
     assert isinstance(items, list)
     for item in items:

playwright/_impl/_browser.py

@@ -15,7 +15,7 @@
 import json
 from pathlib import Path
 from types import SimpleNamespace
-from typing import TYPE_CHECKING, Dict, List, Optional, Pattern, Union, cast
+from typing import TYPE_CHECKING, Dict, List, Optional, Pattern, Sequence, Union, cast
 
 from playwright._impl._api_structures import (
     Geolocation,
@@ -96,7 +96,7 @@ async def new_context(
         locale: str = None,
         timezoneId: str = None,
         geolocation: Geolocation = None,
-        permissions: List[str] = None,
+        permissions: Sequence[str] = None,
         extraHTTPHeaders: Dict[str, str] = None,
         offline: bool = None,
         httpCredentials: HttpCredentials = None,
@@ -141,7 +141,7 @@ async def new_page(
         locale: str = None,
         timezoneId: str = None,
         geolocation: Geolocation = None,
-        permissions: List[str] = None,
+        permissions: Sequence[str] = None,
         extraHTTPHeaders: Dict[str, str] = None,
         offline: bool = None,
         httpCredentials: HttpCredentials = None,
@@ -200,7 +200,7 @@ async def start_tracing(
         page: Page = None,
         path: Union[str, Path] = None,
         screenshots: bool = None,
-        categories: List[str] = None,
+        categories: Sequence[str] = None,
     ) -> None:
         params = locals_to_params(locals())
         if page:

playwright/_impl/_browser_context.py

@@ -25,6 +25,7 @@
     List,
     Optional,
     Pattern,
+    Sequence,
     Set,
     Union,
     cast,
@@ -284,21 +285,21 @@ async def new_page(self) -> Page:
             raise Error("Please use browser.new_context()")
         return from_channel(await self._channel.send("newPage"))
 
-    async def cookies(self, urls: Union[str, List[str]] = None) -> List[Cookie]:
+    async def cookies(self, urls: Union[str, Sequence[str]] = None) -> List[Cookie]:
         if urls is None:
             urls = []
-        if not isinstance(urls, list):
+        if isinstance(urls, str):
             urls = [urls]
         return await self._channel.send("cookies", dict(urls=urls))
 
-    async def add_cookies(self, cookies: List[SetCookieParam]) -> None:
+    async def add_cookies(self, cookies: Sequence[SetCookieParam]) -> None:
         await self._channel.send("addCookies", dict(cookies=cookies))
 
     async def clear_cookies(self) -> None:
         await self._channel.send("clearCookies")
 
     async def grant_permissions(
-        self, permissions: List[str], origin: str = None
+        self, permissions: Sequence[str], origin: str = None
     ) -> None:
         await self._channel.send("grantPermissions", locals_to_params(locals()))
 

playwright/_impl/_browser_type.py

@@ -15,7 +15,7 @@
 import asyncio
 import pathlib
 from pathlib import Path
-from typing import TYPE_CHECKING, Dict, List, Optional, Pattern, Union, cast
+from typing import TYPE_CHECKING, Dict, Optional, Pattern, Sequence, Union, cast
 
 from playwright._impl._api_structures import (
     Geolocation,
@@ -72,8 +72,8 @@ async def launch(
         self,
         executablePath: Union[str, Path] = None,
         channel: str = None,
-        args: List[str] = None,
-        ignoreDefaultArgs: Union[bool, List[str]] = None,
+        args: Sequence[str] = None,
+        ignoreDefaultArgs: Union[bool, Sequence[str]] = None,
         handleSIGINT: bool = None,
         handleSIGTERM: bool = None,
         handleSIGHUP: bool = None,
@@ -101,8 +101,8 @@ async def launch_persistent_context(
         userDataDir: Union[str, Path],
         channel: str = None,
         executablePath: Union[str, Path] = None,
-        args: List[str] = None,
-        ignoreDefaultArgs: Union[bool, List[str]] = None,
+        args: Sequence[str] = None,
+        ignoreDefaultArgs: Union[bool, Sequence[str]] = None,
         handleSIGINT: bool = None,
         handleSIGTERM: bool = None,
         handleSIGHUP: bool = None,
@@ -123,7 +123,7 @@ async def launch_persistent_context(
         locale: str = None,
         timezoneId: str = None,
         geolocation: Geolocation = None,
-        permissions: List[str] = None,
+        permissions: Sequence[str] = None,
         extraHTTPHeaders: Dict[str, str] = None,
         offline: bool = None,
         httpCredentials: HttpCredentials = None,

playwright/_impl/_connection.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import asyncio
+import collections.abc
 import contextvars
 import datetime
 import inspect
@@ -455,7 +456,9 @@ def _replace_channels_with_guids(
             return payload
         if isinstance(payload, Path):
             return str(payload)
-        if isinstance(payload, list):
+        if isinstance(payload, collections.abc.Sequence) and not isinstance(
+            payload, str
+        ):
             return list(map(self._replace_channels_with_guids, payload))
         if isinstance(payload, Channel):
             return dict(guid=payload._guid)