feat(roll): improved parameter validation, rolling 1.5 apis (#229)

Author: pavelfeldman

playwright/async_api.py

@@ -2295,6 +2295,7 @@ async def dblclick(
         button: Literal["left", "middle", "right"] = None,
         timeout: int = None,
         force: bool = None,
+        noWaitAfter: bool = None,
     ) -> NoneType:
         """Frame.dblclick
 
@@ -2326,6 +2327,8 @@ async def dblclick(
             Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
         force : Optional[bool]
             Whether to bypass the actionability checks. Defaults to `false`.
+        noWaitAfter : Optional[bool]
+            Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`.
         """
         return mapping.from_maybe_impl(
             await self._impl_obj.dblclick(
@@ -2336,6 +2339,7 @@ async def dblclick(
                 button=button,
                 timeout=timeout,
                 force=force,
+                noWaitAfter=noWaitAfter,
             )
         )
 
@@ -4314,6 +4318,7 @@ async def dblclick(
         button: Literal["left", "middle", "right"] = None,
         timeout: int = None,
         force: bool = None,
+        noWaitAfter: bool = None,
     ) -> NoneType:
         """Page.dblclick
 
@@ -4347,6 +4352,8 @@ async def dblclick(
             Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
         force : Optional[bool]
             Whether to bypass the actionability checks. Defaults to `false`.
+        noWaitAfter : Optional[bool]
+            Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`.
         """
         return mapping.from_maybe_impl(
             await self._impl_obj.dblclick(
@@ -4357,6 +4364,7 @@ async def dblclick(
                 button=button,
                 timeout=timeout,
                 force=force,
+                noWaitAfter=noWaitAfter,
             )
         )
 
@@ -5576,6 +5584,8 @@ async def newContext(
         colorScheme: Literal["dark", "light", "no-preference"] = None,
         acceptDownloads: bool = None,
         defaultBrowserType: str = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> "BrowserContext":
         """Browser.newContext
 
@@ -5616,6 +5626,10 @@ async def newContext(
             Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See page.emulateMedia(options) for more details. Defaults to '`light`'.
         acceptDownloads : Optional[bool]
             Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
+        videosPath : Optional[str]
+            Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded.
+        videoSize : Optional[{"width": int, "height": int}]
+            Specifies dimensions of the automatically recorded video. Can only be used if `videosPath` is set. If not specified the size will be equal to `viewport`. If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
 
         Returns
         -------
@@ -5641,6 +5655,8 @@ async def newContext(
                 colorScheme=colorScheme,
                 acceptDownloads=acceptDownloads,
                 defaultBrowserType=defaultBrowserType,
+                videosPath=videosPath,
+                videoSize=videoSize,
             )
         )
 
@@ -5664,6 +5680,8 @@ async def newPage(
         colorScheme: Literal["dark", "light", "no-preference"] = None,
         acceptDownloads: bool = None,
         defaultBrowserType: str = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> "Page":
         """Browser.newPage
 
@@ -5705,6 +5723,10 @@ async def newPage(
             Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See page.emulateMedia(options) for more details. Defaults to '`light`'.
         acceptDownloads : Optional[bool]
             Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
+        videosPath : Optional[str]
+            Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded.
+        videoSize : Optional[{"width": int, "height": int}]
+            Specifies dimensions of the automatically recorded video. Can only be used if `videosPath` is set. If not specified the size will be equal to `viewport`. If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
 
         Returns
         -------
@@ -5730,6 +5752,8 @@ async def newPage(
                 colorScheme=colorScheme,
                 acceptDownloads=acceptDownloads,
                 defaultBrowserType=defaultBrowserType,
+                videosPath=videosPath,
+                videoSize=videoSize,
             )
         )
 
@@ -5789,6 +5813,9 @@ async def launch(
         downloadsPath: typing.Union[str, pathlib.Path] = None,
         slowMo: int = None,
         chromiumSandbox: bool = None,
+        firefoxUserPrefs: typing.Union[
+            typing.Dict[str, typing.Union[str, int, bool]]
+        ] = None,
     ) -> "Browser":
         """BrowserType.launch
 
@@ -5829,6 +5856,8 @@ async def launch(
             Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
         chromiumSandbox : Optional[bool]
             Enable Chromium sandboxing. Defaults to `false`.
+        firefoxUserPrefs : Optional[Dict[str, Union[str, int, bool]]]
+            Firefox user preferences. Learn more about the Firefox user preferences at `about:config`.
 
         Returns
         -------
@@ -5851,6 +5880,7 @@ async def launch(
                 downloadsPath=downloadsPath,
                 slowMo=slowMo,
                 chromiumSandbox=chromiumSandbox,
+                firefoxUserPrefs=mapping.to_impl(firefoxUserPrefs),
             )
         )
 
@@ -5888,6 +5918,8 @@ async def launchPersistentContext(
         colorScheme: Literal["dark", "light", "no-preference"] = None,
         acceptDownloads: bool = None,
         chromiumSandbox: bool = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> "BrowserContext":
         """BrowserType.launchPersistentContext
 
@@ -5958,6 +5990,10 @@ async def launchPersistentContext(
             Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
         chromiumSandbox : Optional[bool]
             Enable Chromium sandboxing. Defaults to `true`.
+        videosPath : Optional[str]
+            Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded.
+        videoSize : Optional[{"width": int, "height": int}]
+            Specifies dimensions of the automatically recorded video. Can only be used if `videosPath` is set. If not specified the size will be equal to `viewport`. If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
 
         Returns
         -------
@@ -5998,6 +6034,8 @@ async def launchPersistentContext(
                 colorScheme=colorScheme,
                 acceptDownloads=acceptDownloads,
                 chromiumSandbox=chromiumSandbox,
+                videosPath=videosPath,
+                videoSize=videoSize,
             )
         )
 

playwright/browser.py

@@ -86,6 +86,8 @@ async def newContext(
         colorScheme: ColorScheme = None,
         acceptDownloads: bool = None,
         defaultBrowserType: str = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> BrowserContext:
         params = locals_to_params(locals())
         # Python is strict in which variables gets passed to methods. We get this
@@ -123,6 +125,8 @@ async def newPage(
         colorScheme: ColorScheme = None,
         acceptDownloads: bool = None,
         defaultBrowserType: str = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> Page:
         params = locals_to_params(locals())
         # Python is strict in which variables gets passed to methods. We get this

playwright/browser_type.py

@@ -61,6 +61,7 @@ async def launch(
         downloadsPath: Union[str, Path] = None,
         slowMo: int = None,
         chromiumSandbox: bool = None,
+        firefoxUserPrefs: Dict[str, Union[str, int, bool]] = None,
     ) -> Browser:
         params = locals_to_params(locals())
         normalize_launch_params(params)
@@ -105,6 +106,8 @@ async def launchPersistentContext(
         colorScheme: ColorScheme = None,
         acceptDownloads: bool = None,
         chromiumSandbox: bool = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> BrowserContext:
         userDataDir = str(Path(userDataDir))
         params = locals_to_params(locals())

playwright/frame.py

@@ -372,6 +372,7 @@ async def dblclick(
         button: MouseButton = None,
         timeout: int = None,
         force: bool = None,
+        noWaitAfter: bool = None,
     ) -> None:
         await self._channel.send("dblclick", locals_to_params(locals()))
 

playwright/page.py

@@ -615,6 +615,7 @@ async def dblclick(
         button: MouseButton = None,
         timeout: int = None,
         force: bool = None,
+        noWaitAfter: bool = None,
     ) -> None:
         return await self._main_frame.dblclick(**locals_to_params(locals()))
 

playwright/sync_api.py

@@ -2377,6 +2377,7 @@ def dblclick(
         button: Literal["left", "middle", "right"] = None,
         timeout: int = None,
         force: bool = None,
+        noWaitAfter: bool = None,
     ) -> NoneType:
         """Frame.dblclick
 
@@ -2408,6 +2409,8 @@ def dblclick(
             Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
         force : Optional[bool]
             Whether to bypass the actionability checks. Defaults to `false`.
+        noWaitAfter : Optional[bool]
+            Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`.
         """
         return mapping.from_maybe_impl(
             self._sync(
@@ -2419,6 +2422,7 @@ def dblclick(
                     button=button,
                     timeout=timeout,
                     force=force,
+                    noWaitAfter=noWaitAfter,
                 )
             )
         )
@@ -4488,6 +4492,7 @@ def dblclick(
         button: Literal["left", "middle", "right"] = None,
         timeout: int = None,
         force: bool = None,
+        noWaitAfter: bool = None,
     ) -> NoneType:
         """Page.dblclick
 
@@ -4521,6 +4526,8 @@ def dblclick(
             Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
         force : Optional[bool]
             Whether to bypass the actionability checks. Defaults to `false`.
+        noWaitAfter : Optional[bool]
+            Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`.
         """
         return mapping.from_maybe_impl(
             self._sync(
@@ -4532,6 +4539,7 @@ def dblclick(
                     button=button,
                     timeout=timeout,
                     force=force,
+                    noWaitAfter=noWaitAfter,
                 )
             )
         )
@@ -5806,6 +5814,8 @@ def newContext(
         colorScheme: Literal["dark", "light", "no-preference"] = None,
         acceptDownloads: bool = None,
         defaultBrowserType: str = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> "BrowserContext":
         """Browser.newContext
 
@@ -5846,6 +5856,10 @@ def newContext(
             Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See page.emulateMedia(options) for more details. Defaults to '`light`'.
         acceptDownloads : Optional[bool]
             Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
+        videosPath : Optional[str]
+            Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded.
+        videoSize : Optional[{"width": int, "height": int}]
+            Specifies dimensions of the automatically recorded video. Can only be used if `videosPath` is set. If not specified the size will be equal to `viewport`. If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
 
         Returns
         -------
@@ -5872,6 +5886,8 @@ def newContext(
                     colorScheme=colorScheme,
                     acceptDownloads=acceptDownloads,
                     defaultBrowserType=defaultBrowserType,
+                    videosPath=videosPath,
+                    videoSize=videoSize,
                 )
             )
         )
@@ -5896,6 +5912,8 @@ def newPage(
         colorScheme: Literal["dark", "light", "no-preference"] = None,
         acceptDownloads: bool = None,
         defaultBrowserType: str = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> "Page":
         """Browser.newPage
 
@@ -5937,6 +5955,10 @@ def newPage(
             Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See page.emulateMedia(options) for more details. Defaults to '`light`'.
         acceptDownloads : Optional[bool]
             Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
+        videosPath : Optional[str]
+            Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded.
+        videoSize : Optional[{"width": int, "height": int}]
+            Specifies dimensions of the automatically recorded video. Can only be used if `videosPath` is set. If not specified the size will be equal to `viewport`. If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
 
         Returns
         -------
@@ -5963,6 +5985,8 @@ def newPage(
                     colorScheme=colorScheme,
                     acceptDownloads=acceptDownloads,
                     defaultBrowserType=defaultBrowserType,
+                    videosPath=videosPath,
+                    videoSize=videoSize,
                 )
             )
         )
@@ -6023,6 +6047,9 @@ def launch(
         downloadsPath: typing.Union[str, pathlib.Path] = None,
         slowMo: int = None,
         chromiumSandbox: bool = None,
+        firefoxUserPrefs: typing.Union[
+            typing.Dict[str, typing.Union[str, int, bool]]
+        ] = None,
     ) -> "Browser":
         """BrowserType.launch
 
@@ -6063,6 +6090,8 @@ def launch(
             Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
         chromiumSandbox : Optional[bool]
             Enable Chromium sandboxing. Defaults to `false`.
+        firefoxUserPrefs : Optional[Dict[str, Union[str, int, bool]]]
+            Firefox user preferences. Learn more about the Firefox user preferences at `about:config`.
 
         Returns
         -------
@@ -6086,6 +6115,7 @@ def launch(
                     downloadsPath=downloadsPath,
                     slowMo=slowMo,
                     chromiumSandbox=chromiumSandbox,
+                    firefoxUserPrefs=mapping.to_impl(firefoxUserPrefs),
                 )
             )
         )
@@ -6124,6 +6154,8 @@ def launchPersistentContext(
         colorScheme: Literal["dark", "light", "no-preference"] = None,
         acceptDownloads: bool = None,
         chromiumSandbox: bool = None,
+        videosPath: str = None,
+        videoSize: IntSize = None,
     ) -> "BrowserContext":
         """BrowserType.launchPersistentContext
 
@@ -6194,6 +6226,10 @@ def launchPersistentContext(
             Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
         chromiumSandbox : Optional[bool]
             Enable Chromium sandboxing. Defaults to `true`.
+        videosPath : Optional[str]
+            Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded.
+        videoSize : Optional[{"width": int, "height": int}]
+            Specifies dimensions of the automatically recorded video. Can only be used if `videosPath` is set. If not specified the size will be equal to `viewport`. If `viewport` is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
 
         Returns
         -------
@@ -6235,6 +6271,8 @@ def launchPersistentContext(
                     colorScheme=colorScheme,
                     acceptDownloads=acceptDownloads,
                     chromiumSandbox=chromiumSandbox,
+                    videosPath=videosPath,
+                    videoSize=videoSize,
                 )
             )
         )