feat: accept pathlib in the API (microsoft#110)

Author: mxschmitt

build_driver.py

@@ -17,9 +17,10 @@
 import re
 import shutil
 import subprocess
-from pathlib import Path
 
-_dirname = Path(os.path.dirname(os.path.abspath(__file__)))
+from playwright.path_utils import get_file_dirname
+
+_dirname = get_file_dirname()
 
 driver_path = _dirname / "driver"
 package_path = _dirname / "playwright"

build_package.py

@@ -12,16 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 import shutil
 import subprocess
 
-folder = os.path.dirname(os.path.abspath(__file__))
-if os.path.exists(os.path.join(folder, "build")):
-    shutil.rmtree(os.path.join(folder, "build"))
-if os.path.exists(os.path.join(folder, "dist")):
-    shutil.rmtree(os.path.join(folder, "dist"))
-if os.path.exists(os.path.join(folder, "playwright.egg-info")):
-    shutil.rmtree(os.path.join(folder, "playwright.egg-info"))
+from playwright.path_utils import get_file_dirname
+
+_dirname = get_file_dirname()
+_build_dir = _dirname / "build"
+if _build_dir.exists():
+    shutil.rmtree(_build_dir)
+_dist_dir = _dirname / "dist"
+if _dist_dir.exists():
+    shutil.rmtree(_dist_dir)
+_egg_dir = _dirname / "playwright.egg-info"
+if _egg_dir.exists():
+    shutil.rmtree(_egg_dir)
 
 subprocess.run("python setup.py sdist bdist_wheel", shell=True)

playwright/async_api.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 
+import pathlib
 import sys
 import typing
 
@@ -870,7 +871,12 @@ async def selectText(self, timeout: int = None) -> NoneType:
     async def setInputFiles(
         self,
         files: typing.Union[
-            str, FilePayload, typing.List[str], typing.List[FilePayload]
+            str,
+            pathlib.Path,
+            FilePayload,
+            typing.List[str],
+            typing.List[pathlib.Path],
+            typing.List[FilePayload],
         ],
         timeout: int = None,
         noWaitAfter: bool = None,
@@ -1877,7 +1883,12 @@ async def setInputFiles(
         self,
         selector: str,
         files: typing.Union[
-            str, FilePayload, typing.List[str], typing.List[FilePayload]
+            str,
+            pathlib.Path,
+            FilePayload,
+            typing.List[str],
+            typing.List[pathlib.Path],
+            typing.List[FilePayload],
         ],
         timeout: int = None,
         noWaitAfter: bool = None,

playwright/element_handle.py

@@ -16,6 +16,7 @@
 import mimetypes
 import os
 import sys
+from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union, cast
 
 from playwright.connection import ChannelOwner, from_nullable_channel
@@ -123,7 +124,7 @@ async def selectText(self, timeout: int = None) -> None:
 
     async def setInputFiles(
         self,
-        files: Union[str, FilePayload, List[str], List[FilePayload]],
+        files: Union[str, Path, FilePayload, List[str], List[Path], List[FilePayload]],
         timeout: int = None,
         noWaitAfter: bool = None,
     ) -> None:
@@ -242,16 +243,16 @@ def convert_select_option_values(arg: ValuesToSelect) -> Any:
 
 
 def normalize_file_payloads(
-    files: Union[str, FilePayload, List[str], List[FilePayload]]
+    files: Union[str, Path, FilePayload, List[str], List[Path], List[FilePayload]]
 ) -> List[FilePayload]:
     file_list = files if isinstance(files, list) else [files]
     file_payloads: List[FilePayload] = []
     for item in file_list:
-        if isinstance(item, str):
+        if isinstance(item, str) or isinstance(item, Path):
             with open(item, mode="rb") as fd:
                 file: FilePayload = {
                     "name": os.path.basename(item),
-                    "mimeType": mimetypes.guess_type(item)[0]
+                    "mimeType": mimetypes.guess_type(str(Path(item)))[0]
                     or "application/octet-stream",
                     "buffer": base64.b64encode(fd.read()).decode(),
                 }

playwright/frame.py

@@ -14,6 +14,7 @@
 
 import asyncio
 import sys
+from pathlib import Path
 from typing import TYPE_CHECKING, Any, Awaitable, Dict, List, Optional, Set, Union, cast
 
 from pyee import BaseEventEmitter
@@ -280,7 +281,7 @@ async def addScriptTag(
         params = locals_to_params(locals())
         if path:
             with open(path, "r") as file:
-                params["content"] = file.read() + "\n//# sourceURL=" + path
+                params["content"] = file.read() + "\n//# sourceURL=" + str(Path(path))
                 del params["path"]
         return from_channel(await self._channel.send("addScriptTag", params))
 
@@ -290,7 +291,9 @@ async def addStyleTag(
         params = locals_to_params(locals())
         if path:
             with open(path, "r") as file:
-                params["content"] = file.read() + "\n/*# sourceURL=" + path + "*/"
+                params["content"] = (
+                    file.read() + "\n/*# sourceURL=" + str(Path(path)) + "*/"
+                )
                 del params["path"]
         return from_channel(await self._channel.send("addStyleTag", params))
 
@@ -366,7 +369,7 @@ async def selectOption(
     async def setInputFiles(
         self,
         selector: str,
-        files: Union[str, FilePayload, List[str], List[FilePayload]],
+        files: Union[str, Path, FilePayload, List[str], List[Path], List[FilePayload]],
         timeout: int = None,
         noWaitAfter: bool = None,
     ) -> None:

playwright/main.py

@@ -27,6 +27,7 @@
 from playwright.connection import Connection
 from playwright.helper import Error, not_installed_error
 from playwright.object_factory import create_remote_object
+from playwright.path_utils import get_file_dirname
 from playwright.playwright import Playwright
 from playwright.sync_api import Playwright as SyncPlaywright
 from playwright.sync_base import dispatcher_fiber, set_dispatcher_fiber
@@ -44,20 +45,20 @@ def compute_driver_name() -> str:
 
 
 async def run_driver_async() -> Connection:
-    package_path = os.path.dirname(os.path.abspath(__file__))
+    package_path = get_file_dirname()
     driver_name = compute_driver_name()
-    driver_executable = os.path.join(package_path, driver_name)
-    archive_name = os.path.join(package_path, "drivers", driver_name + ".gz")
+    driver_executable = package_path / driver_name
+    archive_name = package_path / "drivers" / (driver_name + ".gz")
 
-    if not os.path.exists(driver_executable) or os.path.getmtime(
+    if not driver_executable.exists() or os.path.getmtime(
         driver_executable
     ) < os.path.getmtime(archive_name):
         raise not_installed_error(
             "Playwright requires additional post-installation step to be made."
         )
 
     proc = await asyncio.create_subprocess_exec(
-        driver_executable,
+        str(driver_executable),
         stdin=asyncio.subprocess.PIPE,
         stdout=asyncio.subprocess.PIPE,
         stderr=asyncio.subprocess.PIPE,
@@ -124,12 +125,12 @@ def main() -> None:
     if "install" not in sys.argv:
         print('Run "python -m playwright install" to complete installation')
         return
-    package_path = os.path.dirname(os.path.abspath(__file__))
+    package_path = get_file_dirname()
     driver_name = compute_driver_name()
-    driver_executable = os.path.join(package_path, driver_name)
-    archive_name = os.path.join(package_path, "drivers", driver_name + ".gz")
+    driver_executable = package_path / driver_name
+    archive_name = package_path / "drivers" / (driver_name + ".gz")
 
-    if not os.path.exists(driver_executable) or os.path.getmtime(
+    if not driver_executable.exists() or os.path.getmtime(
         driver_executable
     ) < os.path.getmtime(archive_name):
         print(f"Extracting {archive_name} into {driver_executable}...")

playwright/path_utils.py

@@ -0,0 +1,10 @@
+import inspect
+from pathlib import Path
+
+
+def get_file_dirname() -> Path:
+    """Returns the callee (`__file__`) directory name"""
+    frame = inspect.stack()[1]
+    module = inspect.getmodule(frame[0])
+    assert module
+    return Path(module.__file__).parent.absolute()

playwright/sync_api.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 
+import pathlib
 import sys
 import typing
 
@@ -906,7 +907,12 @@ def selectText(self, timeout: int = None) -> NoneType:
     def setInputFiles(
         self,
         files: typing.Union[
-            str, FilePayload, typing.List[str], typing.List[FilePayload]
+            str,
+            pathlib.Path,
+            FilePayload,
+            typing.List[str],
+            typing.List[pathlib.Path],
+            typing.List[FilePayload],
         ],
         timeout: int = None,
         noWaitAfter: bool = None,
@@ -1968,7 +1974,12 @@ def setInputFiles(
         self,
         selector: str,
         files: typing.Union[
-            str, FilePayload, typing.List[str], typing.List[FilePayload]
+            str,
+            pathlib.Path,
+            FilePayload,
+            typing.List[str],
+            typing.List[pathlib.Path],
+            typing.List[FilePayload],
         ],
         timeout: int = None,
         noWaitAfter: bool = None,

scripts/documentation_provider.py

@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 import re
 import sys
-from pathlib import Path
 from typing import Any, Dict, List, cast
 
-_dirname = Path(os.path.dirname(os.path.abspath(__file__)))
+from playwright.path_utils import get_file_dirname
+
+_dirname = get_file_dirname()
 
 
 class DocumentationProvider:

scripts/generate_api.py

@@ -153,6 +153,7 @@ def return_value(value: Any) -> List[str]:
 
 import typing
 import sys
+import pathlib
 
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal