refactor: rename OnFrame to ScreencastFrame

Author: Skn0tt

playwright/_impl/_api_structures.py

@@ -328,5 +328,5 @@ class PausedDetails(TypedDict):
     title: str
 
 
-class OnFrame(TypedDict):
+class ScreencastFrame(TypedDict):
     data: bytes

playwright/_impl/_screencast.py

@@ -24,7 +24,7 @@
     Union,
 )
 
-from playwright._impl._api_structures import OnFrame
+from playwright._impl._api_structures import ScreencastFrame
 from playwright._impl._artifact import Artifact
 from playwright._impl._connection import from_channel
 from playwright._impl._disposable import DisposableStub
@@ -38,7 +38,7 @@ def __init__(self, page: "Page") -> None:
         self._page = page
         self._started = False
         self._save_path: Optional[Union[str, Path]] = None
-        self._on_frame: Optional[Callable[[OnFrame], Awaitable[Any]]] = None
+        self._on_frame: Optional[Callable[[ScreencastFrame], Awaitable[Any]]] = None
         self._artifact: Optional[Artifact] = None
         self._page._channel.on("screencastFrame", self._handle_frame)
 
@@ -50,7 +50,7 @@ async def start(
         self,
         path: Union[str, Path] = None,
         quality: int = None,
-        onFrame: Callable[[OnFrame], Awaitable[Any]] = None,
+        onFrame: Callable[[ScreencastFrame], Awaitable[Any]] = None,
     ) -> DisposableStub:
         if self._started:
             raise Exception("Screencast is already started")

playwright/async_api/_generated.py

@@ -27,7 +27,6 @@
     Geolocation,
     HttpCredentials,
     NameValue,
-    OnFrame,
     PausedDetails,
     PausedDetailsLocation,
     PdfMargins,
@@ -36,6 +35,7 @@
     RemoteAddr,
     RequestSizes,
     ResourceTiming,
+    ScreencastFrame,
     SecurityDetails,
     SetCookieParam,
     SourceLocation,
@@ -21599,7 +21599,7 @@ async def start(
         path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
         quality: typing.Optional[int] = None,
         on_frame: typing.Optional[
-            typing.Callable[[OnFrame], typing.Awaitable[typing.Any]]
+            typing.Callable[[ScreencastFrame], typing.Awaitable[typing.Any]]
         ] = None,
     ) -> "AsyncContextManager":
         """Screencast.start

playwright/sync_api/_generated.py

@@ -27,7 +27,6 @@
     Geolocation,
     HttpCredentials,
     NameValue,
-    OnFrame,
     PausedDetails,
     PausedDetailsLocation,
     PdfMargins,
@@ -36,6 +35,7 @@
     RemoteAddr,
     RequestSizes,
     ResourceTiming,
+    ScreencastFrame,
     SecurityDetails,
     SetCookieParam,
     SourceLocation,
@@ -21689,7 +21689,7 @@ def start(
         path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
         quality: typing.Optional[int] = None,
         on_frame: typing.Optional[
-            typing.Callable[[OnFrame], typing.Awaitable[typing.Any]]
+            typing.Callable[[ScreencastFrame], typing.Awaitable[typing.Any]]
         ] = None,
     ) -> "SyncContextManager":
         """Screencast.start

scripts/generate_api.py

@@ -227,7 +227,7 @@ def return_value(value: Any) -> List[str]:
 from typing import Literal
 
 
-from playwright._impl._api_structures import Cookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation, PausedDetails, PausedDetailsLocation, OnFrame, Bind
+from playwright._impl._api_structures import Cookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation, PausedDetails, PausedDetailsLocation, ScreencastFrame, Bind
 from playwright._impl._browser import Browser as BrowserImpl
 from playwright._impl._browser_context import BrowserContext as BrowserContextImpl
 from playwright._impl._browser_type import BrowserType as BrowserTypeImpl