chore: roll to 1.59.1 (#3050)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: pavelfeldman

.claude/skills/playwright-roll/SKILL.md

@@ -162,18 +162,25 @@ jobs:
       matrix:
         os: [ubuntu-22.04, macos-13, windows-2022]
     runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        # `setup-miniconda` activates the env only for login shells; using
+        # `bash -el` (recommended by the action) ensures `conda` and the
+        # installed `conda-build` are on PATH on every OS, including Windows
+        # where the default shell is pwsh and skips the activation hooks.
+        shell: bash -el {0}
     steps:
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: Get conda
         uses: conda-incubator/setup-miniconda@v3
         with:
-          python-version: 3.9
+          python-version: '3.12'
           channels: conda-forge
           miniconda-version: latest
       - name: Prepare
-        run: conda install conda-build conda-verify
+        run: conda install -n base "conda-build>=26" conda-verify
       - name: Build
         run: conda build .
 

.github/workflows/ci.yml

@@ -31,11 +31,11 @@ jobs:
       - name: Get conda
         uses: conda-incubator/setup-miniconda@v3
         with:
-          python-version: 3.9
+          python-version: '3.12'
           channels: conda-forge
           miniconda-version: latest
       - name: Prepare
-        run: conda install anaconda-client conda-build conda-verify
+        run: conda install -n base anaconda-client "conda-build>=26" conda-verify
       - name: Build and Upload
         env:
           ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }}

.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+# CLAUDE.md
+
+Guidance for Claude when working in this repository.
+
+## What this is
+
+Python bindings for [Playwright](https://playwright.dev). The Python client talks JSON over a pipe to the Node-based driver bundled in `playwright/driver/`. The pipe protocol is defined upstream in `packages/protocol/src/protocol.yml`.
+
+## Layout
+
+- `playwright/_impl/` — hand-written client implementation (one module per object: `_browser.py`, `_page.py`, `_locator.py`, `_network.py`, etc.). Edit these to add or change behavior.
+- `playwright/async_api/_generated.py`, `playwright/sync_api/_generated.py` — **auto-generated**. Never edit by hand; rerun `./scripts/update_api.sh` after changing `_impl/` or the driver.
+- `scripts/generate_api.py`, `scripts/generate_async_api.py`, `scripts/generate_sync_api.py`, `scripts/documentation_provider.py` — codegen and validation. They diff the Python implementation against the driver's `playwright/driver/package/api.json` and abort if either side is out of sync.
+- `scripts/expected_api_mismatch.txt` — explicit allowlist of "documented in JS, not in Python" or "named differently in Python" gaps. Lines that no longer apply must be removed.
+- `tests/async/`, `tests/sync/` — pytest suites. Most new tests are added to the async file with a sync mirror.
+- `setup.py` — `driver_version = "X.Y.Z"` is the source of truth for which driver build is downloaded from `cdn.playwright.dev`.
+- `ROLLING.md`, `CONTRIBUTING.md` — human-facing setup and roll docs.
+
+## Setup
+
+`CONTRIBUTING.md` has the full sequence. The short version:
+
+```sh
+python3 -m venv env && source env/bin/activate
+pip install --upgrade pip
+pip install -r local-requirements.txt
+pip install -e .
+python -m build --wheel        # downloads the driver listed in setup.py
+pre-commit install
+```
+
+If the system lacks `python3-venv`, `uv venv env` is an acceptable substitute (then `uv pip install --python env/bin/python --upgrade pip`).
+
+## Common commands
+
+- Regenerate `_generated.py`: `./scripts/update_api.sh` (runs codegen + pre-commit on the generated files).
+- Lint everything: `pre-commit run --all-files`.
+- Type-check: `mypy playwright`.
+- Run tests: `pytest --browser chromium [-k name]`. Browsers are installed via `playwright install chromium` (do **not** use `--with-deps`, which requires sudo).
+
+When changing public API, edit `_impl/`, then run `./scripts/update_api.sh`. The script regenerates `_generated.py` and validates against the driver's `api.json`. If validation fails, fix the mismatch in `_impl/`, in `expected_api_mismatch.txt`, or in `documentation_provider.py` — not by hand-editing `_generated.py`.
+
+## Rolling Playwright to a new version
+
+This is the recurring high-stakes task. Use the dedicated skill:
+
+→ **[`.claude/skills/playwright-roll/SKILL.md`](.claude/skills/playwright-roll/SKILL.md)**
+
+It documents the full process: the upstream commit-range diff over `docs/src/api/`, how to classify each commit (PORT / MISMATCH / N/A), how to handle the `langs:` filter, the recurring failure modes, and the tests/sync-mirroring conventions.
+
+## House style
+
+- Don't hand-edit generated files.
+- Don't add `# type: ignore` or modify `_generated.py` to silence pyright; fix the source of the mismatch.
+- New public methods on impl classes need a sync test mirror under `tests/sync/`.
+- Keep `expected_api_mismatch.txt` minimal — every entry needs a one-line rationale comment above it.
+- Prefer `locals_to_params(locals())` for forwarding optional kwargs to channel sends, matching the rest of the codebase.

CLAUDE.md

@@ -4,9 +4,9 @@ Playwright is a Python library to automate [Chromium](https://www.chromium.org/H
 
 |          | Linux | macOS | Windows |
 |   :---   | :---: | :---: | :---:   |
-| Chromium <!-- GEN:chromium-version -->145.0.7632.6<!-- GEN:stop --> | ✅ | ✅ | ✅ |
-| WebKit <!-- GEN:webkit-version -->26.0<!-- GEN:stop --> | ✅ | ✅ | ✅ |
-| Firefox <!-- GEN:firefox-version -->146.0.1<!-- GEN:stop --> | ✅ | ✅ | ✅ |
+| Chromium <!-- GEN:chromium-version -->147.0.7727.15<!-- GEN:stop --> | ✅ | ✅ | ✅ |
+| WebKit <!-- GEN:webkit-version -->26.4<!-- GEN:stop --> | ✅ | ✅ | ✅ |
+| Firefox <!-- GEN:firefox-version -->148.0.2<!-- GEN:stop --> | ✅ | ✅ | ✅ |
 
 ## Documentation
 

README.md

@@ -166,6 +166,10 @@ class RemoteAddr(TypedDict):
     port: int
 
 
+class BrowserBindResult(TypedDict):
+    endpoint: str
+
+
 class SecurityDetails(TypedDict):
     issuer: Optional[str]
     protocol: Optional[str]
@@ -311,3 +315,18 @@ class TracingGroupLocation(TypedDict):
     file: str
     line: Optional[int]
     column: Optional[int]
+
+
+class DebuggerLocation(TypedDict):
+    file: str
+    line: Optional[int]
+    column: Optional[int]
+
+
+class DebuggerPausedDetails(TypedDict):
+    location: DebuggerLocation
+    title: str
+
+
+class ScreencastFrame(TypedDict):
+    data: bytes

playwright/_impl/_api_structures.py

@@ -27,6 +27,7 @@
 )
 
 from playwright._impl._api_structures import (
+    BrowserBindResult,
     ClientCertificate,
     Geolocation,
     HttpCredentials,
@@ -247,6 +248,20 @@ def version(self) -> str:
     async def new_browser_cdp_session(self) -> CDPSession:
         return from_channel(await self._channel.send("newBrowserCDPSession", None))
 
+    async def bind(
+        self,
+        title: str,
+        workspaceDir: str = None,
+        host: str = None,
+        port: int = None,
+    ) -> BrowserBindResult:
+        return await self._channel.send_return_as_dict(
+            "startServer", None, locals_to_params(locals())
+        )
+
+    async def unbind(self) -> None:
+        await self._channel.send("stopServer", None)
+
     async def start_tracing(
         self,
         page: Page = None,

playwright/_impl/_browser.py

@@ -46,6 +46,7 @@
     from_nullable_channel,
 )
 from playwright._impl._console_message import ConsoleMessage
+from playwright._impl._debugger import Debugger
 from playwright._impl._dialog import Dialog
 from playwright._impl._errors import Error, TargetClosedError
 from playwright._impl._event_context_manager import EventContextManagerImpl
@@ -122,6 +123,7 @@ def __init__(
         self._base_url: Optional[str] = self._options.get("baseURL")
         self._videos_dir: Optional[str] = self._options.get("recordVideo")
         self._tracing = cast(Tracing, from_channel(initializer["tracing"]))
+        self._debugger: Debugger = cast(Debugger, from_channel(initializer["debugger"]))
         self._har_recorders: Dict[str, HarRecordingMetadata] = {}
         self._request: APIRequestContext = from_channel(initializer["requestContext"])
         self._request._timeout_settings = self._timeout_settings
@@ -582,6 +584,9 @@ def _on_close(self) -> None:
         self._tracing._reset_stack_counter()
         self.emit(BrowserContext.Events.Close, self)
 
+    def is_closed(self) -> bool:
+        return self._closing_or_closed
+
     async def close(self, reason: str = None) -> None:
         if self._closing_or_closed:
             return
@@ -627,6 +632,15 @@ async def storage_state(
             await async_writefile(path, json.dumps(result))
         return result
 
+    async def set_storage_state(
+        self, storageState: Union[StorageState, str, Path]
+    ) -> None:
+        if isinstance(storageState, (str, Path)):
+            state = json.loads(await async_readfile(storageState))
+        else:
+            state = storageState
+        await self._channel.send("setStorageState", None, {"storageState": state})
+
     def _effective_close_reason(self) -> Optional[str]:
         if self._close_reason:
             return self._close_reason
@@ -753,6 +767,10 @@ async def new_cdp_session(self, page: Union[Page, Frame]) -> CDPSession:
     def tracing(self) -> Tracing:
         return self._tracing
 
+    @property
+    def debugger(self) -> Debugger:
+        return self._debugger
+
     @property
     def request(self) -> "APIRequestContext":
         return self._request

playwright/_impl/_browser_context.py

@@ -86,6 +86,7 @@ async def launch(
         downloadsPath: Union[str, Path] = None,
         slowMo: float = None,
         tracesDir: Union[pathlib.Path, str] = None,
+        artifactsDir: Union[pathlib.Path, str] = None,
         chromiumSandbox: bool = None,
         firefoxUserPrefs: Dict[str, Union[str, float, bool]] = None,
     ) -> Browser:
@@ -143,6 +144,7 @@ async def launch_persistent_context(
         contrast: Contrast = None,
         acceptDownloads: bool = None,
         tracesDir: Union[pathlib.Path, str] = None,
+        artifactsDir: Union[pathlib.Path, str] = None,
         chromiumSandbox: bool = None,
         firefoxUserPrefs: Dict[str, Union[str, float, bool]] = None,
         recordHarPath: Union[Path, str] = None,
@@ -213,7 +215,7 @@ async def connect_over_cdp(
 
     async def connect(
         self,
-        wsEndpoint: str,
+        endpoint: str,
         timeout: float = None,
         slowMo: float = None,
         headers: Dict[str, str] = None,
@@ -229,7 +231,7 @@ async def connect(
                 "connect",
                 None,
                 {
-                    "wsEndpoint": wsEndpoint,
+                    "endpoint": endpoint,
                     "headers": headers,
                     "slowMo": slowMo,
                     "timeout": timeout if timeout is not None else 0,
@@ -361,3 +363,5 @@ def normalize_launch_params(params: Dict) -> None:
         params["downloadsPath"] = str(Path(params["downloadsPath"]))
     if "tracesDir" in params:
         params["tracesDir"] = str(Path(params["tracesDir"]))
+    if "artifactsDir" in params:
+        params["artifactsDir"] = str(Path(params["artifactsDir"]))

playwright/_impl/_browser_type.py

@@ -12,21 +12,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from types import SimpleNamespace
 from typing import Any, Dict
 
 from playwright._impl._connection import ChannelOwner
 from playwright._impl._helper import locals_to_params
 
 
 class CDPSession(ChannelOwner):
+    Events = SimpleNamespace(
+        Event="event",
+        Close="close",
+    )
+
     def __init__(
         self, parent: ChannelOwner, type: str, guid: str, initializer: Dict
     ) -> None:
         super().__init__(parent, type, guid, initializer)
         self._channel.on("event", lambda params: self._on_event(params))
+        self._channel.on("close", lambda _: self.emit(CDPSession.Events.Close, self))
 
     def _on_event(self, params: Any) -> None:
         self.emit(params["method"], params.get("params"))
+        self.emit(CDPSession.Events.Event, params)
 
     async def send(self, method: str, params: Dict = None) -> Dict:
         return await self._channel.send("send", None, locals_to_params(locals()))