feat(api): schedule tasks for async route handlers (microsoft#380)

Author: pavelfeldman

playwright/_browser_context.py

@@ -13,10 +13,11 @@
 # limitations under the License.
 
 import asyncio
+import inspect
 import json
 from pathlib import Path
 from types import SimpleNamespace
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union
+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, Geolocation
@@ -84,7 +85,9 @@ def _on_page(self, page: Page) -> None:
     def _on_route(self, route: Route, request: Request) -> None:
         for handler_entry in self._routes:
             if handler_entry.matcher.matches(request.url):
-                handler_entry.handler(route, request)
+                result = cast(Any, handler_entry.handler)(route, request)
+                if inspect.iscoroutine(result):
+                    asyncio.create_task(result)
                 return
         asyncio.create_task(route.continue_())
 

playwright/_helper.py

@@ -44,7 +44,7 @@
     from playwright._network import Request, Route
 
 URLMatch = Union[str, Pattern, Callable[[str], bool]]
-RouteHandler = Callable[["Route", "Request"], Any]
+RouteHandler = Union[Callable[["Route"], Any], Callable[["Route", "Request"], Any]]
 
 ColorScheme = Literal["dark", "light", "no-preference"]
 DocumentLoadState = Literal["domcontentloaded", "load", "networkidle"]

playwright/_network.py

@@ -105,6 +105,7 @@ async def response(self) -> Optional["Response"]:
     def frame(self) -> "Frame":
         return from_channel(self._initializer["frame"])
 
+    @property
     def isNavigationRequest(self) -> bool:
         return self._initializer["isNavigationRequest"]
 

playwright/_page.py

@@ -14,6 +14,7 @@
 
 import asyncio
 import base64
+import inspect
 import sys
 from pathlib import Path
 from types import SimpleNamespace
@@ -267,7 +268,9 @@ def _on_frame_detached(self, frame: Frame) -> None:
     def _on_route(self, route: Route, request: Request) -> None:
         for handler_entry in self._routes:
             if handler_entry.matcher.matches(request.url):
-                handler_entry.handler(route, request)
+                result = cast(Any, handler_entry.handler)(route, request)
+                if inspect.iscoroutine(result):
+                    asyncio.create_task(result)
                 return
         self._browser_context._on_route(route, request)
 

playwright/async_api.py

@@ -174,6 +174,18 @@ def frame(self) -> "Frame":
         """
         return mapping.from_impl(self._impl_obj.frame)
 
+    @property
+    def is_navigation_request(self) -> bool:
+        """Request.is_navigation_request
+
+        Whether this request is driving frame's navigation.
+
+        Returns
+        -------
+        bool
+        """
+        return mapping.from_maybe_impl(self._impl_obj.isNavigationRequest)
+
     @property
     def redirected_from(self) -> typing.Union["Request", NoneType]:
         """Request.redirected_from
@@ -242,17 +254,6 @@ async def response(self) -> typing.Union["Response", NoneType]:
         """
         return mapping.from_impl_nullable(await self._impl_obj.response())
 
-    def is_navigation_request(self) -> bool:
-        """Request.is_navigation_request
-
-        Whether this request is driving frame's navigation.
-
-        Returns
-        -------
-        bool
-        """
-        return mapping.from_maybe_impl(self._impl_obj.isNavigationRequest())
-
 
 mapping.register(RequestImpl, Request)
 
@@ -4606,7 +4607,10 @@ async def add_init_script(
     async def route(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Callable[["Route", "Request"], typing.Any],
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ],
     ) -> NoneType:
         """Page.route
 
@@ -4626,7 +4630,7 @@ async def route(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL to match while routing.
-        handler : Callable[[Route, Request], Any]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any]]
             handler function to route the request.
         """
         return mapping.from_maybe_impl(
@@ -4638,7 +4642,10 @@ async def route(
     async def unroute(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Union[typing.Callable[["Route", "Request"], typing.Any]] = None,
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ] = None,
     ) -> NoneType:
         """Page.unroute
 
@@ -4648,7 +4655,7 @@ async def unroute(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL to match while routing.
-        handler : Optional[Callable[[Route, Request], Any]]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any], NoneType]
             Optional handler function to route the request.
         """
         return mapping.from_maybe_impl(
@@ -6150,7 +6157,10 @@ async def expose_function(self, name: str, binding: typing.Callable) -> NoneType
     async def route(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Callable[["Route", "Request"], typing.Any],
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ],
     ) -> NoneType:
         """BrowserContext.route
 
@@ -6167,7 +6177,7 @@ async def route(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL to match while routing.
-        handler : Callable[[Route, Request], Any]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any]]
             handler function to route the request.
         """
         return mapping.from_maybe_impl(
@@ -6179,7 +6189,10 @@ async def route(
     async def unroute(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Union[typing.Callable[["Route", "Request"], typing.Any]] = None,
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ] = None,
     ) -> NoneType:
         """BrowserContext.unroute
 
@@ -6190,7 +6203,7 @@ async def unroute(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL used to register a routing with browser_context.route(url, handler).
-        handler : Optional[Callable[[Route, Request], Any]]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any], NoneType]
             Optional handler function used to register a routing with browser_context.route(url, handler).
         """
         return mapping.from_maybe_impl(

playwright/sync_api.py

@@ -174,6 +174,18 @@ def frame(self) -> "Frame":
         """
         return mapping.from_impl(self._impl_obj.frame)
 
+    @property
+    def is_navigation_request(self) -> bool:
+        """Request.is_navigation_request
+
+        Whether this request is driving frame's navigation.
+
+        Returns
+        -------
+        bool
+        """
+        return mapping.from_maybe_impl(self._impl_obj.isNavigationRequest)
+
     @property
     def redirected_from(self) -> typing.Union["Request", NoneType]:
         """Request.redirected_from
@@ -242,17 +254,6 @@ def response(self) -> typing.Union["Response", NoneType]:
         """
         return mapping.from_impl_nullable(self._sync(self._impl_obj.response()))
 
-    def is_navigation_request(self) -> bool:
-        """Request.is_navigation_request
-
-        Whether this request is driving frame's navigation.
-
-        Returns
-        -------
-        bool
-        """
-        return mapping.from_maybe_impl(self._impl_obj.isNavigationRequest())
-
 
 mapping.register(RequestImpl, Request)
 
@@ -4764,7 +4765,10 @@ def add_init_script(
     def route(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Callable[["Route", "Request"], typing.Any],
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ],
     ) -> NoneType:
         """Page.route
 
@@ -4784,7 +4788,7 @@ def route(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL to match while routing.
-        handler : Callable[[Route, Request], Any]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any]]
             handler function to route the request.
         """
         return mapping.from_maybe_impl(
@@ -4798,7 +4802,10 @@ def route(
     def unroute(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Union[typing.Callable[["Route", "Request"], typing.Any]] = None,
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ] = None,
     ) -> NoneType:
         """Page.unroute
 
@@ -4808,7 +4815,7 @@ def unroute(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL to match while routing.
-        handler : Optional[Callable[[Route, Request], Any]]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any], NoneType]
             Optional handler function to route the request.
         """
         return mapping.from_maybe_impl(
@@ -6325,7 +6332,10 @@ def expose_function(self, name: str, binding: typing.Callable) -> NoneType:
     def route(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Callable[["Route", "Request"], typing.Any],
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ],
     ) -> NoneType:
         """BrowserContext.route
 
@@ -6342,7 +6352,7 @@ def route(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL to match while routing.
-        handler : Callable[[Route, Request], Any]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any]]
             handler function to route the request.
         """
         return mapping.from_maybe_impl(
@@ -6356,7 +6366,10 @@ def route(
     def unroute(
         self,
         url: typing.Union[str, typing.Pattern, typing.Callable[[str], bool]],
-        handler: typing.Union[typing.Callable[["Route", "Request"], typing.Any]] = None,
+        handler: typing.Union[
+            typing.Callable[["Route"], typing.Any],
+            typing.Callable[["Route", "Request"], typing.Any],
+        ] = None,
     ) -> NoneType:
         """BrowserContext.unroute
 
@@ -6367,7 +6380,7 @@ def unroute(
         ----------
         url : Union[str, Pattern, Callable[[str], bool]]
             A glob pattern, regex pattern or predicate receiving URL used to register a routing with browser_context.route(url, handler).
-        handler : Optional[Callable[[Route, Request], Any]]
+        handler : Union[Callable[[Route], Any], Callable[[Route, Request], Any], NoneType]
             Optional handler function used to register a routing with browser_context.route(url, handler).
         """
         return mapping.from_maybe_impl(

scripts/expected_api_mismatch.txt

@@ -95,10 +95,10 @@ Parameter type mismatch in Frame.dispatchEvent(eventInit=): documented as Option
 Parameter type mismatch in Page.dispatchEvent(eventInit=): documented as Optional[EvaluationArgument], code has Optional[Dict]
 
 # Route
-Parameter type mismatch in Page.route(handler=): documented as function(Route, Request), code has Callable[[Route, Request], Any]
-Parameter type mismatch in Page.unroute(handler=): documented as Optional[function(Route, Request)], code has Optional[Callable[[Route, Request], Any]]
-Parameter type mismatch in BrowserContext.route(handler=): documented as function(Route, Request), code has Callable[[Route, Request], Any]
-Parameter type mismatch in BrowserContext.unroute(handler=): documented as Optional[function(Route, Request)], code has Optional[Callable[[Route, Request], Any]]
+Parameter type mismatch in Page.unroute(handler=): documented as Optional[function(Route, Request)], code has Union[Callable[[Route], Any], Callable[[Route, Request], Any], NoneType]
+Parameter type mismatch in Page.route(handler=): documented as function(Route, Request), code has Union[Callable[[Route], Any], Callable[[Route, Request], Any]]
+Parameter type mismatch in BrowserContext.unroute(handler=): documented as Optional[function(Route, Request)], code has Union[Callable[[Route], Any], Callable[[Route, Request], Any], NoneType]
+Parameter type mismatch in BrowserContext.route(handler=): documented as function(Route, Request), code has Union[Callable[[Route], Any], Callable[[Route, Request], Any]]
 
 # Selectors
 Parameter type mismatch in Selectors.register(script=): documented as Union[Callable, str, Dict], code has Optional[str]

tests/async/test_browsercontext.py

@@ -440,7 +440,7 @@ def handle(route, request):
         assert request.headers["user-agent"]
         assert request.method == "GET"
         assert request.post_data is None
-        assert request.is_navigation_request()
+        assert request.is_navigation_request
         assert request.resource_type == "document"
         assert request.frame == page.main_frame
         assert request.frame.url == "about:blank"