bidiwave

WebDriver BiDi for Python — talk to any browser via W3C standard.

Features

• W3C WebDriver BiDi — standard protocol, not proprietary CDP
• Cross-browser — Chrome, Firefox, Edge (Safari when BiDi support lands)
• Async-first — native async/await with asyncio
• Browsing — contexts, navigation, screenshots, viewport control with DPR, element waiting, CSS/XPath locators, PDF printing, dialog handling, download events, history traversal, user prompt management
• Script — evaluate JS, call functions, typed RemoteValue with match pattern narrowing, preload scripts with channel communication, realm inspection, serialization options, user activation
• Input simulation — clicks, keyboard, scroll, drag & drop, file upload, file dialog events
• Network interception — block, modify, mock requests, cache overrides, response body retrieval, authentication handling, extra headers, data collectors, cache behavior control
• Storage — get, set, delete cookies with full attribute support, partition key support, cookie change monitoring
• Emulation — geolocation, locale, screen orientation, timezone, user agent override, network conditions
• Permissions — grant or deny browser permissions without user dialogs
• Preload scripts — inject JS before page load for polyfills or monitoring with user context support
• Web extensions — install and uninstall browser extensions
• CDP bridge — access Chrome DevTools Protocol for browser-specific features
• Event streaming — 27 event types with async handlers and error isolation
• Type-safe — Pydantic v2 models, full type hints, mypy clean
• Spec-compliant — W3C WebDriver BiDi (WD 2025-07-28), full coverage
• Resilient — automatic reconnection with exponential backoff
• Lightweight — no Selenium, no Playwright required

Install

pip install bidiwave

Quick start

import asyncio
from bidiwave import BiDiClient, StringValue

async def main():
    async with await BiDiClient.connect("ws://localhost:9515/session") as client:
        async with await client.browsing.open("https://example.com") as page:
            # Evaluate JS
            result = await page.evaluate("document.title")
            match result:
                case StringValue(value=title):
                    print(f"Title: {title}")

            # Screenshot
            screenshot = await page.screenshot()
            with open("screenshot.png", "wb") as f:
                f.write(screenshot)

asyncio.run(main())

Console log monitoring

async with await BiDiClient.connect(url) as client:
    async def on_log(entry):
        print(f"[{entry.level}] {entry.text}")

    client.on("log.entryAdded", on_log)
    await client.session.subscribe(["log.entryAdded"])

    async with await client.browsing.open("https://example.com") as page:
        await page.evaluate("console.log('hello!')")
        await asyncio.sleep(2)

Input simulation

async with await BiDiClient.connect(url) as client:
    async with await client.browsing.open("https://example.com") as page:
        ctx = page.id

        # Click at coordinates
        await client.input.click(ctx, x=100, y=200)

        # Type text
        await client.input.type_text(ctx, "Hello, world!")

        # Press Enter
        await client.input.press_key(ctx, "Enter")

        # Scroll down 500px
        await client.input.scroll(ctx, delta_y=500)

        # Drag and drop
        await client.input.drag_and_drop(ctx, 100, 100, 300, 300)

Network interception

async with await BiDiClient.connect(url) as client:
    # Block all requests to ads
    intercept = await client.network.add_intercept(
        phases=["beforeRequestSent"],
        url_patterns=["*ads.example.com*"],
    )

    async with await client.browsing.open("https://example.com") as page:
        await asyncio.sleep(2)

    await client.network.remove_intercept(intercept.intercept_id)

Cookies & storage

from bidiwave import Cookie

async with await BiDiClient.connect(url) as client:
    async with await client.browsing.open("https://example.com") as page:
        # Set a session cookie
        await client.storage.set_cookie(
            page.id,
            cookie=Cookie(
                name="session",
                value="abc123",
                domain="example.com",
                http_only=True,
                secure=True,
            ),
        )

        # Read all cookies
        cookies = await client.storage.get_cookies(page.id)
        for c in cookies:
            print(f"{c.name}={c.value}")

        # Delete one cookie
        await client.storage.delete_cookie(page.id, "session")

Emulation & permissions

from bidiwave import ViewportSize

async with await BiDiClient.connect(url) as client:
    async with await client.browsing.open("https://example.com") as page:
        ctx = page.id

        # Simulate iPhone viewport
        await client.browsing.set_viewport(
            ctx,
            viewport=ViewportSize(width=375, height=812),
            device_pixel_ratio=3.0,
        )

        # Simulate Tokyo location on 3G
        await client.emulation.set_geolocation_override(
            coordinates={"latitude": 35.6762, "longitude": 139.6503, "accuracy": 1.0},
            contexts=[ctx],
        )
        await client.emulation.set_network_conditions(
            network_conditions={
                "offline": False,
                "download_throughput": 50000,
                "upload_throughput": 25000,
                "latency": 400,
            },
            contexts=[ctx],
        )

        # Grant geolocation permission
        await client.permissions.set_permission(
            descriptor={"name": "geolocation"},
            state="granted",
            contexts=[ctx],
        )

Preload scripts

async with await BiDiClient.connect(url) as client:
    # Inject a script that runs before every page load
    result = await client.preload.add_preload_script(
        function_declaration="() => { window.__testMode = true; }",
    )

    async with await client.browsing.open("https://example.com") as page:
        value = await page.evaluate("window.__testMode")
        print(f"Test mode: {value}")

    await client.preload.remove_preload_script(result.script)

Web extensions

async with await BiDiClient.connect(url) as client:
    # Install a browser extension
    result = await client.web_extension.install("/path/to/extension.crx")
    print(f"Installed: {result}")

    # Uninstall when done
    await client.web_extension.uninstall(result.extension)

Launch a browser with BiDi

Chrome / Edge

# Chrome — requires ChromeDriver as BiDi proxy
chromedriver --port=9515

# Edge — requires EdgeDriver
msedgedriver --port=9516

Firefox

Firefox implements BiDi natively — no driver needed:

firefox --headless --remote-debugging-port=9223 --no-remote

See Browser Setup for detailed instructions.

Documentation

Full documentation at mathiaspaulenko.github.io/bidiwave

• Installation
• Quick Start
• Browsing
• Script
• Network Interception
• Input Simulation
• Cookies & Storage
• Emulation
• Permissions
• Preload Scripts
• Web Extensions
• CDP
• Events
• Configuration
• Cookbook
• Error Handling
• API Reference
• Protocol Reference
• Changelog

License

MIT