feat(sync): generate sync api (#78)

Author: pavelfeldman

client.py

@@ -12,22 +12,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import asyncio
+from playwright import chromium
 
-from playwright import browser_types
 
+def main() -> None:
+    browser = chromium.launch(headless=False)
+    page = browser.newPage(viewport=0)
+    page.setContent(
+        "<button id=button onclick=\"window.open('http://webkit.org', '_blank')\">Click me</input>"
+    )
+
+    with page.expect_event("popup") as popup:
+        page.click("#button")
+    print(popup.value)
 
-async def run() -> None:
-    print("Launching browser...")
-    browser = await browser_types["webkit"].launch(headless=False)
     print("Contexts in browser: %d" % len(browser.contexts))
     print("Creating context...")
-    context = await browser.newContext(viewport=None)
+    context = browser.newContext(viewport=0)
     print("Contexts in browser: %d" % len(browser.contexts))
     print("Pages in context: %d" % len(context.pages))
 
     print("\nCreating page1...")
-    page1 = await context.newPage()
+    page1 = context.newPage()
     print("Pages in context: %d" % len(context.pages))
     page1.on("framenavigated", lambda frame: print("Frame navigated to %s" % frame.url))
     page1.on("request", lambda request: print("Request %s" % request.url))
@@ -42,42 +48,43 @@ async def run() -> None:
         ),
     )
     print("Navigating page1 to https://example.com...")
-    await page1.goto("https://example.com")
+    page1.goto("https://example.com")
     print("Page1 main frame url: %s" % page1.mainFrame.url)
-    print("Page1 tile: %s" % await page1.title())
+    print("Page1 tile: %s" % page1.title())
     print("Frames in page1: %d" % len(page1.frames))
-    await page1.screenshot(path="example.png")
+    page1.screenshot(path="example.png")
 
     print("\nCreating page2...")
-    page2 = await context.newPage()
+    page2 = context.newPage()
     page2.on("framenavigated", lambda frame: print("Frame navigated to %s" % frame.url))
 
     print("Navigating page2 to https://webkit.org...")
-    await page2.goto("https://webkit.org")
-    print("Page2 tile: %s" % await page2.title())
+    page2.goto("https://webkit.org")
+    print("Page2 tile: %s" % page2.title())
     print("Pages in context: %d" % len(context.pages))
 
     print("\nQuerying body...")
-    body1 = await page1.querySelector("body")
+    body1 = page1.querySelector("body")
     assert body1
-    print("Body text %s" % await body1.textContent())
+    print("Body text %s" % body1.textContent())
 
     print("Closing page1...")
-    await page1.close()
+    page1.close()
     print("Pages in context: %d" % len(context.pages))
 
     print("Navigating page2 to https://cnn.com...")
-    await page2.goto("https://cnn.com")
+    page2.goto("https://cnn.com")
     print("Page2 main frame url: %s" % page2.mainFrame.url)
-    print("Page2 tile: %s" % await page2.title())
+    print("Page2 tile: %s" % page2.title())
     print("Frames in page2: %d" % len(page2.frames))
     print("Pages in context: %d" % len(context.pages))
 
     print("Closing context...")
-    await context.close()
+    context.close()
     print("Contexts in browser: %d" % len(browser.contexts))
     print("Closing browser")
-    await browser.close()
+    browser.close()
 
 
-asyncio.get_event_loop().run_until_complete(run())
+if __name__ == "__main__":
+    main()

playwright/__init__.py

@@ -14,19 +14,20 @@
 
 import playwright.helper as helper
 from playwright._repo_version import version as __version__  # noqa:F401
-from playwright.main import playwright_object
+from playwright.main import playwright_async
+from playwright.sync import Playwright
 
-chromium = playwright_object.chromium
-firefox = playwright_object.firefox
-webkit = playwright_object.webkit
-devices = playwright_object.devices
-selectors = playwright_object.selectors
-browser_types = playwright_object.browser_types
+playwright = Playwright(playwright_async)
+chromium = playwright.chromium
+firefox = playwright.firefox
+webkit = playwright.webkit
+devices = playwright.devices
+selectors = playwright.selectors
 Error = helper.Error
 TimeoutError = helper.TimeoutError
 
 __all__ = [
-    "browser_types",
+    "playwright",
     "chromium",
     "firefox",
     "webkit",

playwright/accessibility.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Dict
+from typing import Any, Dict
 
 from playwright.connection import Channel
 from playwright.element_handle import ElementHandle
@@ -21,6 +21,7 @@
 class Accessibility:
     def __init__(self, channel: Channel) -> None:
         self._channel = channel
+        self._sync_owner: Any = None
 
     async def snapshot(
         self, interestingOnly: bool = True, root: ElementHandle = None

playwright/browser.py

@@ -86,7 +86,7 @@ async def newContext(
 
     async def newPage(
         self,
-        viewport: Dict = None,
+        viewport: Union[Dict, Literal[0]] = None,
         ignoreHTTPSErrors: bool = None,
         javaScriptEnabled: bool = None,
         bypassCSP: bool = None,

playwright/connection.py

@@ -51,6 +51,7 @@ def __init__(
         is_scope: bool = False,
     ) -> None:
         super().__init__()
+        self._sync_owner: Any = None
         self._guid = guid
         self._scope = scope.create_child(guid) if is_scope else scope
         self._channel = Channel(self._scope, guid)

playwright/helper.py

@@ -44,7 +44,7 @@
 RouteHandler = Callable[["Route", "Request"], Any]
 FunctionWithSource = Callable[[Dict], Any]
 
-ColorScheme = Literal["dark", "light", "no-preference"]
+ColorScheme = Literal["light", "dark", "no-preference"]
 DocumentLoadState = Literal["load", "domcontentloaded", "networkidle"]
 KeyboardModifier = Literal["Alt", "Control", "Meta", "Shift"]
 MouseButton = Literal["left", "right", "middle"]

playwright/input.py

@@ -12,13 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Any
+
 from playwright.connection import Channel
 from playwright.helper import MouseButton, locals_to_params
 
 
 class Keyboard:
     def __init__(self, channel: Channel) -> None:
         self._channel = channel
+        self._sync_owner: Any = None
 
     async def down(self, key: str) -> None:
         await self._channel.send("keyboardDown", locals_to_params(locals()))
@@ -39,6 +42,7 @@ async def press(self, key: str, delay: int = None) -> None:
 class Mouse:
     def __init__(self, channel: Channel) -> None:
         self._channel = channel
+        self._sync_owner: Any = None
 
     async def move(self, x: float, y: float, steps: int = None) -> None:
         await self._channel.send("mouseMove", locals_to_params(locals()))

playwright/main.py

@@ -24,11 +24,11 @@
 from playwright.object_factory import create_remote_object
 from playwright.playwright import Playwright
 
-playwright_object: Playwright
+playwright_async: Playwright
 
 
 async def async_init() -> None:
-    global playwright_object
+    global playwright_async
     package_path = os.path.dirname(os.path.abspath(__file__))
     platform = sys.platform
     if platform == "darwin":
@@ -66,7 +66,7 @@ async def async_init() -> None:
     connection = Connection(
         proc.stdout, proc.stdin, create_remote_object, asyncio.get_event_loop()
     )
-    playwright_object = await connection.wait_for_object_with_known_name("playwright")
+    playwright_async = await connection.wait_for_object_with_known_name("playwright")
 
 
 if sys.platform == "win32":

playwright/page.py

@@ -86,6 +86,9 @@ class Page(ChannelOwner):
         Popup="popup",
         Worker="worker",
     )
+    accessibility: Accessibility
+    keyboard: Keyboard
+    mouse: Mouse
 
     def __init__(self, scope: ConnectionScope, guid: str, initializer: Dict) -> None:
         super().__init__(scope, guid, initializer)
@@ -539,7 +542,7 @@ def isClosed(self) -> bool:
     async def click(
         self,
         selector: str,
-        modifiers: KeyboardModifier = None,
+        modifiers: List[KeyboardModifier] = None,
         position: Dict = None,
         delay: int = None,
         button: MouseButton = None,

playwright/playwright.py

@@ -20,16 +20,19 @@
 
 
 class Playwright(ChannelOwner):
+    chromium: BrowserType
+    firefox: BrowserType
+    webkit: BrowserType
+    selectors: Selectors
+    devices: Dict
+
     def __init__(self, scope: ConnectionScope, guid: str, initializer: Dict) -> None:
         super().__init__(scope, guid, initializer)
-        self.chromium: BrowserType = from_channel(initializer["chromium"])
-        self.firefox: BrowserType = from_channel(initializer["firefox"])
-        self.webkit: BrowserType = from_channel(initializer["webkit"])
-        self.selectors: Selectors = from_channel(initializer["selectors"])
+        self.chromium = from_channel(initializer["chromium"])
+        self.firefox = from_channel(initializer["firefox"])
+        self.webkit = from_channel(initializer["webkit"])
+        self.selectors = from_channel(initializer["selectors"])
         self.devices = {
             device["name"]: device["descriptor"]
             for device in initializer["deviceDescriptors"]
         }
-        self.browser_types: Dict[str, BrowserType] = dict(
-            chromium=self.chromium, webkit=self.webkit, firefox=self.firefox
-        )