fix(types): added types for devices (microsoft#90)

Author: mxschmitt

playwright/connection.py

@@ -70,9 +70,9 @@ class ConnectionScope:
     def __init__(
         self, connection: "Connection", guid: str, parent: Optional["ConnectionScope"]
     ) -> None:
-        self._connection = connection
-        self._loop = connection._loop
-        self._guid = guid
+        self._connection: "Connection" = connection
+        self._loop: asyncio.AbstractEventLoop = connection._loop
+        self._guid: str = guid
         self._children: List["ConnectionScope"] = list()
         self._objects: Dict[str, ChannelOwner] = dict()
         self._parent = parent

playwright/helper.py

@@ -117,6 +117,21 @@ class FrameNavigatedEvent(TypedDict):
     error: Optional[str]
 
 
+Size = TypedDict("Size", {"width": int, "height": int})
+
+DeviceDescriptor = TypedDict(
+    "DeviceDescriptor",
+    {
+        "userAgent": str,
+        "viewport": Size,
+        "deviceScaleFactor": int,
+        "isMobile": bool,
+        "hasTouch": bool,
+    },
+)
+Devices = Dict[str, DeviceDescriptor]
+
+
 class URLMatcher:
     def __init__(self, match: URLMatch) -> None:
         self._callback: Optional[Callable[[str], bool]] = None

playwright/playwright.py

@@ -16,6 +16,7 @@
 
 from playwright.browser_type import BrowserType
 from playwright.connection import ChannelOwner, ConnectionScope, from_channel
+from playwright.helper import Devices
 from playwright.selectors import Selectors
 
 
@@ -24,7 +25,7 @@ class Playwright(ChannelOwner):
     firefox: BrowserType
     webkit: BrowserType
     selectors: Selectors
-    devices: Dict
+    devices: Devices
 
     def __init__(self, scope: ConnectionScope, guid: str, initializer: Dict) -> None:
         super().__init__(scope, guid, initializer)

playwright/sync.py

@@ -35,6 +35,7 @@
 from playwright.frame import Frame as FrameAsync
 from playwright.helper import (
     ConsoleMessageLocation,
+    DeviceDescriptor,
     Error,
     FilePayload,
     SelectOption,
@@ -2801,7 +2802,7 @@ def selectors(self) -> "Selectors":
         return Selectors._from_async(self._async_obj.selectors)
 
     @property
-    def devices(self) -> typing.Dict:
+    def devices(self) -> typing.Dict[str, DeviceDescriptor]:
         return self._async_obj.devices
 
 

scripts/generate_sync_api.py

@@ -261,7 +261,7 @@ def main() -> None:
 from playwright.element_handle import ElementHandle as ElementHandleAsync
 from playwright.file_chooser import FileChooser as FileChooserAsync
 from playwright.frame import Frame as FrameAsync
-from playwright.helper import ConsoleMessageLocation, Error, FilePayload, SelectOption, Viewport
+from playwright.helper import ConsoleMessageLocation, Error, FilePayload, SelectOption, Viewport, DeviceDescriptor
 from playwright.input import Keyboard as KeyboardAsync, Mouse as MouseAsync
 from playwright.js_handle import JSHandle as JSHandleAsync
 from playwright.network import Request as RequestAsync, Response as ResponseAsync, Route as RouteAsync