feat(api): split sync and async entry points (#382)

Author: pavelfeldman

buildbots/assets/stub.py

@@ -1,4 +1,4 @@
-from playwright import sync_playwright
+from playwright.sync_api import sync_playwright
 
 with sync_playwright() as p:
     for browser_type in [p.chromium, p.firefox, p.webkit]:

client.py

@@ -88,5 +88,5 @@ def main(playwright: Playwright) -> None:
 
 
 if __name__ == "__main__":
-    with playwright.sync_playwright() as p:
+    with playwright.sync_api.sync_playwright() as p:
         main(p)

playwright/__init__.py

@@ -11,6 +11,7 @@
 # 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.
+
 """
 Python package `playwright` is a Python library to automate Chromium,
 Firefox and WebKit with a single API. Playwright is built to enable cross-browser
@@ -19,50 +20,6 @@
 and for the async API [here](async_api.html).
 """
 
-import playwright._api_structures as api_structures
-import playwright._api_types as api_types
-from playwright._main import AsyncPlaywrightContextManager, SyncPlaywrightContextManager
-
-DeviceDescriptor = api_types.DeviceDescriptor
-Error = api_types.Error
-FilePayload = api_types.FilePayload
-FloatRect = api_types.FloatRect
-Geolocation = api_types.Geolocation
-PdfMargins = api_types.PdfMargins
-ProxySettings = api_types.ProxySettings
-SourceLocation = api_types.SourceLocation
-TimeoutError = api_types.TimeoutError
-
-Cookie = api_structures.Cookie
-ResourceTiming = api_structures.ResourceTiming
-StorageState = api_structures.StorageState
-
-
-def async_playwright() -> AsyncPlaywrightContextManager:
-    return AsyncPlaywrightContextManager()
-
-
-def sync_playwright() -> SyncPlaywrightContextManager:
-    return SyncPlaywrightContextManager()
-
-
-__all__ = [
-    "async_playwright",
-    "sync_playwright",
-    "Cookie",
-    "DeviceDescriptor",
-    "Error",
-    "FilePayload",
-    "FloatRect",
-    "Geolocation",
-    "PdfMargins",
-    "ProxySettings",
-    "ResourceTiming",
-    "SourceLocation",
-    "StorageState",
-    "TimeoutError",
-]
-
 __pdoc__ = {
     "_accessibility": False,
     "_async_base": False,

playwright/__main__.py

@@ -12,6 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from playwright._main import main
+import os
+import subprocess
+import sys
 
-main()
+from playwright._impl._driver import compute_driver_executable
+
+driver_executable = compute_driver_executable()
+my_env = os.environ.copy()
+my_env["PW_CLI_TARGET_LANG"] = "python"
+subprocess.run([str(driver_executable), *sys.argv[1:]], env=my_env)

playwright/_accessibility.py renamed to playwright/_impl/_accessibility.py

@@ -14,9 +14,9 @@
 
 from typing import Dict, Optional
 
-from playwright._connection import Channel
-from playwright._element_handle import ElementHandle
-from playwright._helper import locals_to_params
+from playwright._impl._connection import Channel
+from playwright._impl._element_handle import ElementHandle
+from playwright._impl._helper import locals_to_params
 
 
 def _ax_node_from_protocol(axNode: Dict) -> Dict:

playwright/_api_structures.py renamed to playwright/_impl/_api_structures.py

@@ -15,7 +15,7 @@
 import asyncio
 from typing import Any, Callable, Coroutine, Generic, Optional, TypeVar, cast
 
-from playwright._impl_to_api_mapping import ImplToApiMapping, ImplWrapper
+from playwright._impl._impl_to_api_mapping import ImplToApiMapping, ImplWrapper
 
 mapping = ImplToApiMapping()
 

playwright/_api_types.py renamed to playwright/_impl/_api_types.py

@@ -18,21 +18,21 @@
 from types import SimpleNamespace
 from typing import TYPE_CHECKING, Dict, List, Tuple, Union
 
-from playwright._api_structures import StorageState
-from playwright._api_types import Geolocation, ProxySettings
-from playwright._browser_context import BrowserContext
-from playwright._connection import ChannelOwner, from_channel
-from playwright._helper import ColorScheme, is_safe_close_error, locals_to_params
-from playwright._network import serialize_headers
-from playwright._page import Page
+from playwright._impl._api_structures import StorageState
+from playwright._impl._api_types import Geolocation, ProxySettings
+from playwright._impl._browser_context import BrowserContext
+from playwright._impl._connection import ChannelOwner, from_channel
+from playwright._impl._helper import ColorScheme, is_safe_close_error, locals_to_params
+from playwright._impl._network import serialize_headers
+from playwright._impl._page import Page
 
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal
 else:  # pragma: no cover
     from typing_extensions import Literal
 
 if TYPE_CHECKING:  # pragma: no cover
-    from playwright._browser_type import BrowserType
+    from playwright._impl._browser_type import BrowserType
 
 
 class Browser(ChannelOwner):

playwright/_async_base.py renamed to playwright/_impl/_async_base.py

@@ -19,11 +19,11 @@
 from types import SimpleNamespace
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union, cast
 
-from playwright._api_structures import Cookie, StorageState
-from playwright._api_types import Error
-from playwright._connection import ChannelOwner, from_channel
-from playwright._event_context_manager import EventContextManagerImpl
-from playwright._helper import (
+from playwright._impl._api_structures import Cookie, StorageState
+from playwright._impl._api_types import Error
+from playwright._impl._connection import ChannelOwner, from_channel
+from playwright._impl._event_context_manager import EventContextManagerImpl
+from playwright._impl._helper import (
     PendingWaitEvent,
     RouteHandler,
     RouteHandlerEntry,
@@ -33,12 +33,12 @@
     is_safe_close_error,
     locals_to_params,
 )
-from playwright._network import Request, Route, serialize_headers
-from playwright._page import BindingCall, Page
-from playwright._wait_helper import WaitHelper
+from playwright._impl._network import Request, Route, serialize_headers
+from playwright._impl._page import BindingCall, Page
+from playwright._impl._wait_helper import WaitHelper
 
 if TYPE_CHECKING:  # pragma: no cover
-    from playwright._browser import Browser
+    from playwright._impl._browser import Browser
 
 
 class BrowserContext(ChannelOwner):