api(snake): go snake (microsoft#375)

Author: pavelfeldman

buildbots/assets/stub.py

@@ -3,7 +3,7 @@
 with sync_playwright() as p:
     for browser_type in [p.chromium, p.firefox, p.webkit]:
         browser = browser_type.launch()
-        page = browser.newPage()
-        page.setContent("<h1>Test 123</h1>")
+        page = browser.new_page()
+        page.set_content("<h1>Test 123</h1>")
         page.screenshot(path=f"{browser_type.name}.png")
         browser.close()

client.py

@@ -18,8 +18,8 @@
 
 def main(playwright: Playwright) -> None:
     browser = playwright.chromium.launch(headless=False)
-    page = browser.newPage(viewport=0)
-    page.setContent(
+    page = browser.new_page(viewport=0)
+    page.set_content(
         "<button id=button onclick=\"window.open('http://webkit.org', '_blank')\">Click me</input>"
     )
 
@@ -29,12 +29,12 @@ def main(playwright: Playwright) -> None:
 
     print("Contexts in browser: %d" % len(browser.contexts))
     print("Creating context...")
-    context = browser.newContext(viewport=0)
+    context = browser.new_context(viewport=0)
     print("Contexts in browser: %d" % len(browser.contexts))
     print("Pages in context: %d" % len(context.pages))
 
     print("\nCreating page1...")
-    page1 = context.newPage()
+    page1 = context.new_page()
     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))
@@ -50,13 +50,13 @@ def main(playwright: Playwright) -> None:
     )
     print("Navigating page1 to https://example.com...")
     page1.goto("https://example.com")
-    print("Page1 main frame url: %s" % page1.mainFrame.url)
+    print("Page1 main frame url: %s" % page1.main_frame.url)
     print("Page1 tile: %s" % page1.title())
     print("Frames in page1: %d" % len(page1.frames))
     page1.screenshot(path="example.png")
 
     print("\nCreating page2...")
-    page2 = context.newPage()
+    page2 = context.new_page()
     page2.on("framenavigated", lambda frame: print("Frame navigated to %s" % frame.url))
 
     print("Navigating page2 to https://webkit.org...")
@@ -65,17 +65,17 @@ def main(playwright: Playwright) -> None:
     print("Pages in context: %d" % len(context.pages))
 
     print("\nQuerying body...")
-    body1 = page1.querySelector("body")
+    body1 = page1.query_selector("body")
     assert body1
-    print("Body text %s" % body1.textContent())
+    print("Body text %s" % body1.text_content())
 
     print("Closing page1...")
     page1.close()
     print("Pages in context: %d" % len(context.pages))
 
     print("Navigating page2 to https://cnn.com...")
     page2.goto("https://cnn.com")
-    print("Page2 main frame url: %s" % page2.mainFrame.url)
+    print("Page2 main frame url: %s" % page2.main_frame.url)
     print("Page2 tile: %s" % page2.title())
     print("Frames in page2: %d" % len(page2.frames))
     print("Pages in context: %d" % len(context.pages))

playwright/__init__.py

@@ -19,28 +19,28 @@
 and for the async API [here](async_api.html).
 """
 
-import playwright._types as types
+import playwright._api_structures as api_structures
+import playwright._api_types as api_types
 from playwright._main import AsyncPlaywrightContextManager, SyncPlaywrightContextManager
 
-ConsoleMessageLocation = types.ConsoleMessageLocation
-Cookie = types.Cookie
-Credentials = types.Credentials
-DeviceDescriptor = types.DeviceDescriptor
-Error = types.Error
-FilePayload = types.FilePayload
-FloatRect = types.FloatRect
-Geolocation = types.Geolocation
-IntSize = types.IntSize
-MousePosition = types.MousePosition
-PdfMargins = types.PdfMargins
-ProxyServer = types.ProxyServer
-RecordHarOptions = types.RecordHarOptions
-RecordVideoOptions = types.RecordVideoOptions
-RequestFailure = types.RequestFailure
-ResourceTiming = types.ResourceTiming
-SelectOption = types.SelectOption
-StorageState = types.StorageState
-TimeoutError = types.TimeoutError
+DeviceDescriptor = api_types.DeviceDescriptor
+Error = api_types.Error
+FilePayload = api_types.FilePayload
+FloatRect = api_types.FloatRect
+Geolocation = api_types.Geolocation
+HttpCredentials = api_types.HttpCredentials
+PdfMargins = api_types.PdfMargins
+ProxySettings = api_types.ProxySettings
+RecordHarOptions = api_types.RecordHarOptions
+RecordVideoOptions = api_types.RecordVideoOptions
+RequestFailure = api_types.RequestFailure
+OptionSelector = api_types.OptionSelector
+SourceLocation = api_types.SourceLocation
+TimeoutError = api_types.TimeoutError
+
+Cookie = api_structures.Cookie
+ResourceTiming = api_structures.ResourceTiming
+StorageState = api_structures.StorageState
 
 
 def async_playwright() -> AsyncPlaywrightContextManager:
@@ -54,23 +54,21 @@ def sync_playwright() -> SyncPlaywrightContextManager:
 __all__ = [
     "async_playwright",
     "sync_playwright",
-    "ConsoleMessageLocation",
     "Cookie",
-    "Credentials",
+    "HttpCredentials",
     "DeviceDescriptor",
     "Error",
     "FilePayload",
     "FloatRect",
     "Geolocation",
-    "IntSize",
-    "MousePosition",
     "PdfMargins",
-    "ProxyServer",
+    "ProxySettings",
     "RecordHarOptions",
     "RecordVideoOptions",
     "RequestFailure",
     "ResourceTiming",
-    "SelectOption",
+    "OptionSelector",
+    "SourceLocation",
     "StorageState",
     "TimeoutError",
 ]

playwright/_api_structures.py

@@ -0,0 +1,55 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys
+from typing import Dict, List, Optional
+
+if sys.version_info >= (3, 8):  # pragma: no cover
+    from typing import Literal, TypedDict
+else:  # pragma: no cover
+    from typing_extensions import Literal, TypedDict
+
+# These are the structures that we like keeping in a JSON form for their potential reuse between SDKs / services.
+
+# Explicitly mark optional params as such for the documentation
+# If there is at least one optional param, set total=False for better mypy handling.
+
+
+class Cookie(TypedDict, total=False):
+    name: str
+    value: str
+    url: Optional[str]
+    domain: Optional[str]
+    path: Optional[str]
+    expires: Optional[int]
+    httpOnly: Optional[bool]
+    secure: Optional[bool]
+    sameSite: Optional[Literal["Strict", "Lax", "None"]]
+
+
+class StorageState(TypedDict, total=False):
+    cookies: Optional[List[Cookie]]
+    origins: Optional[List[Dict]]
+
+
+class ResourceTiming(TypedDict):
+    startTime: float
+    domainLookupStart: float
+    domainLookupEnd: float
+    connectStart: float
+    secureConnectionStart: float
+    connectEnd: float
+    requestStart: float
+    responseStart: float
+    responseEnd: float