fix: support Path objects in Page.screenshot

Author: mxschmitt

playwright/async_api.py

@@ -1295,7 +1295,7 @@ async def screenshot(
         self,
         timeout: int = None,
         type: Literal["png", "jpeg"] = None,
-        path: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
         quality: int = None,
         omitBackground: bool = None,
     ) -> bytes:
@@ -1309,7 +1309,7 @@ async def screenshot(
             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.
         type : Optional[Literal['png', 'jpeg']]
             Specify screenshot type, defaults to `png`.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.
         quality : Optional[int]
             The quality of the image, between 0-100. Not applicable to `png` images.
@@ -2039,7 +2039,11 @@ def isDetached(self) -> bool:
         return mapping.from_maybe_impl(self._impl_obj.isDetached())
 
     async def addScriptTag(
-        self, url: str = None, path: str = None, content: str = None, type: str = None
+        self,
+        url: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
+        content: str = None,
+        type: str = None,
     ) -> "ElementHandle":
         """Frame.addScriptTag
 
@@ -2049,7 +2053,7 @@ async def addScriptTag(
         ----------
         url : Optional[str]
             URL of a script to be added.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative to current working directory.
         content : Optional[str]
             Raw JavaScript content to be injected into frame.
@@ -2068,7 +2072,10 @@ async def addScriptTag(
         )
 
     async def addStyleTag(
-        self, url: str = None, path: str = None, content: str = None
+        self,
+        url: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
+        content: str = None,
     ) -> "ElementHandle":
         """Frame.addStyleTag
 
@@ -2078,7 +2085,7 @@ async def addStyleTag(
         ----------
         url : Optional[str]
             URL of the `<link>` tag.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             Path to the CSS file to be injected into frame. If `path` is a relative path, then it is resolved relative to current working directory.
         content : Optional[str]
             Raw CSS content to be injected into frame.
@@ -3966,7 +3973,7 @@ async def screenshot(
         self,
         timeout: int = None,
         type: Literal["png", "jpeg"] = None,
-        path: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
         quality: int = None,
         omitBackground: bool = None,
         fullPage: bool = None,
@@ -3982,7 +3989,7 @@ async def screenshot(
             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.
         type : Optional[Literal['png', 'jpeg']]
             Specify screenshot type, defaults to `png`.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.
         quality : Optional[int]
             The quality of the image, between 0-100. Not applicable to `png` images.
@@ -5725,7 +5732,7 @@ async def launchServer(
 
     async def launchPersistentContext(
         self,
-        userDataDir: str,
+        userDataDir: typing.Union[str, pathlib.Path],
         executablePath: str = None,
         args: typing.List[str] = None,
         ignoreDefaultArgs: typing.Union[bool, typing.List[str]] = None,
@@ -5764,7 +5771,7 @@ async def launchPersistentContext(
 
         Parameters
         ----------
-        userDataDir : str
+        userDataDir : Union[str, pathlib.Path]
             Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox.
         executablePath : Optional[str]
             Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk.

playwright/browser_type.py

@@ -100,7 +100,7 @@ async def launchServer(
 
     async def launchPersistentContext(
         self,
-        userDataDir: str,
+        userDataDir: Union[str, Path],
         executablePath: str = None,
         args: List[str] = None,
         ignoreDefaultArgs: Union[bool, List[str]] = None,

playwright/element_handle.py

@@ -175,10 +175,12 @@ async def screenshot(
         self,
         timeout: int = None,
         type: Literal["png", "jpeg"] = None,
-        path: str = None,
+        path: Union[str, Path] = None,
         quality: int = None,
         omitBackground: bool = None,
     ) -> bytes:
+        if path:
+            path = str(Path(path))
         binary = await self._channel.send("screenshot", locals_to_params(locals()))
         return base64.b64decode(binary)
 

playwright/frame.py

@@ -314,7 +314,11 @@ def isDetached(self) -> bool:
         return self._detached
 
     async def addScriptTag(
-        self, url: str = None, path: str = None, content: str = None, type: str = None,
+        self,
+        url: str = None,
+        path: Union[str, Path] = None,
+        content: str = None,
+        type: str = None,
     ) -> ElementHandle:
         params = locals_to_params(locals())
         if path:
@@ -324,7 +328,7 @@ async def addScriptTag(
         return from_channel(await self._channel.send("addScriptTag", params))
 
     async def addStyleTag(
-        self, url: str = None, path: str = None, content: str = None
+        self, url: str = None, path: Union[str, Path] = None, content: str = None
     ) -> ElementHandle:
         params = locals_to_params(locals())
         if path:

playwright/page.py

@@ -15,6 +15,7 @@
 import asyncio
 import base64
 import sys
+from pathlib import Path
 from types import SimpleNamespace
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Union, cast
 
@@ -533,12 +534,14 @@ async def screenshot(
         self,
         timeout: int = None,
         type: Literal["png", "jpeg"] = None,
-        path: str = None,
+        path: Union[str, Path] = None,
         quality: int = None,
         omitBackground: bool = None,
         fullPage: bool = None,
         clip: FloatRect = None,
     ) -> bytes:
+        if path:
+            path = str(Path(path))
         binary = await self._channel.send("screenshot", locals_to_params(locals()))
         return base64.b64decode(binary)
 

playwright/sync_api.py

@@ -1343,7 +1343,7 @@ def screenshot(
         self,
         timeout: int = None,
         type: Literal["png", "jpeg"] = None,
-        path: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
         quality: int = None,
         omitBackground: bool = None,
     ) -> bytes:
@@ -1357,7 +1357,7 @@ def screenshot(
             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.
         type : Optional[Literal['png', 'jpeg']]
             Specify screenshot type, defaults to `png`.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.
         quality : Optional[int]
             The quality of the image, between 0-100. Not applicable to `png` images.
@@ -2115,7 +2115,11 @@ def isDetached(self) -> bool:
         return mapping.from_maybe_impl(self._impl_obj.isDetached())
 
     def addScriptTag(
-        self, url: str = None, path: str = None, content: str = None, type: str = None
+        self,
+        url: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
+        content: str = None,
+        type: str = None,
     ) -> "ElementHandle":
         """Frame.addScriptTag
 
@@ -2125,7 +2129,7 @@ def addScriptTag(
         ----------
         url : Optional[str]
             URL of a script to be added.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative to current working directory.
         content : Optional[str]
             Raw JavaScript content to be injected into frame.
@@ -2146,7 +2150,10 @@ def addScriptTag(
         )
 
     def addStyleTag(
-        self, url: str = None, path: str = None, content: str = None
+        self,
+        url: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
+        content: str = None,
     ) -> "ElementHandle":
         """Frame.addStyleTag
 
@@ -2156,7 +2163,7 @@ def addStyleTag(
         ----------
         url : Optional[str]
             URL of the `<link>` tag.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             Path to the CSS file to be injected into frame. If `path` is a relative path, then it is resolved relative to current working directory.
         content : Optional[str]
             Raw CSS content to be injected into frame.
@@ -4134,7 +4141,7 @@ def screenshot(
         self,
         timeout: int = None,
         type: Literal["png", "jpeg"] = None,
-        path: str = None,
+        path: typing.Union[str, pathlib.Path] = None,
         quality: int = None,
         omitBackground: bool = None,
         fullPage: bool = None,
@@ -4150,7 +4157,7 @@ def screenshot(
             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.
         type : Optional[Literal['png', 'jpeg']]
             Specify screenshot type, defaults to `png`.
-        path : Optional[str]
+        path : Union[str, pathlib.Path, NoneType]
             The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.
         quality : Optional[int]
             The quality of the image, between 0-100. Not applicable to `png` images.
@@ -5961,7 +5968,7 @@ def launchServer(
 
     def launchPersistentContext(
         self,
-        userDataDir: str,
+        userDataDir: typing.Union[str, pathlib.Path],
         executablePath: str = None,
         args: typing.List[str] = None,
         ignoreDefaultArgs: typing.Union[bool, typing.List[str]] = None,
@@ -6000,7 +6007,7 @@ def launchPersistentContext(
 
         Parameters
         ----------
-        userDataDir : str
+        userDataDir : Union[str, pathlib.Path]
             Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox.
         executablePath : Optional[str]
             Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is resolved relative to current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk.