Metadata-Version: 2.4
Name: bidiwave
Version: 1.8.2
Summary: WebDriver BiDi for Python — talk to any browser via W3C standard
Project-URL: Homepage, https://github.com/MathiasPaulenko/bidiwave
Project-URL: Repository, https://github.com/MathiasPaulenko/bidiwave
Project-URL: Issues, https://github.com/MathiasPaulenko/bidiwave/issues
Author-email: Mathias Paulenko <mathias.paulenko@outlook.com>
License: MIT
License-File: LICENSE
Keywords: async,automation,bidi,browser,w3c,webdriver
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.11
Requires-Dist: pydantic>=2.5
Requires-Dist: websockets>=12.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Requires-Dist: twine>=5.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocs>=1.6; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
Description-Content-Type: text/markdown

# bidiwave

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

[![CI](https://github.com/MathiasPaulenko/bidiwave/actions/workflows/ci.yml/badge.svg)](https://github.com/MathiasPaulenko/bidiwave/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/bidiwave)](https://pypi.org/project/bidiwave/)
[![Python](https://img.shields.io/pypi/pyversions/bidiwave)](https://pypi.org/project/bidiwave/)
[![License](https://img.shields.io/github/license/MathiasPaulenko/bidiwave)](LICENSE)

## 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

```bash
pip install bidiwave
```

## Quick start

```python
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

```python
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

```python
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

```python
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

```python
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

```python
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

```python
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

```python
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

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

# Edge — requires EdgeDriver
msedgedriver --port=9516
```

### Firefox

Firefox implements BiDi natively — no driver needed:

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

See [Browser Setup](https://mathiaspaulenko.github.io/bidiwave/guides/browser-setup/)
for detailed instructions.

## Documentation

Full documentation at **[mathiaspaulenko.github.io/bidiwave](https://mathiaspaulenko.github.io/bidiwave/)**

- [Installation](https://mathiaspaulenko.github.io/bidiwave/getting-started/installation/)
- [Quick Start](https://mathiaspaulenko.github.io/bidiwave/getting-started/quick-start/)
- [Browsing](https://mathiaspaulenko.github.io/bidiwave/usage/browsing/)
- [Script](https://mathiaspaulenko.github.io/bidiwave/usage/script/)
- [Network Interception](https://mathiaspaulenko.github.io/bidiwave/usage/network/)
- [Input Simulation](https://mathiaspaulenko.github.io/bidiwave/usage/input/)
- [Cookies & Storage](https://mathiaspaulenko.github.io/bidiwave/usage/storage/)
- [Emulation](https://mathiaspaulenko.github.io/bidiwave/usage/emulation/)
- [Permissions](https://mathiaspaulenko.github.io/bidiwave/usage/permissions/)
- [Preload Scripts](https://mathiaspaulenko.github.io/bidiwave/usage/preload/)
- [Web Extensions](https://mathiaspaulenko.github.io/bidiwave/api/web-extension/)
- [CDP](https://mathiaspaulenko.github.io/bidiwave/usage/cdp/)
- [Events](https://mathiaspaulenko.github.io/bidiwave/usage/events/)
- [Configuration](https://mathiaspaulenko.github.io/bidiwave/usage/configuration/)
- [Cookbook](https://mathiaspaulenko.github.io/bidiwave/guides/cookbook/)
- [Error Handling](https://mathiaspaulenko.github.io/bidiwave/guides/error-handling/)
- [API Reference](https://mathiaspaulenko.github.io/bidiwave/api/client/)
- [Protocol Reference](https://mathiaspaulenko.github.io/bidiwave/reference/protocol-reference/)
- [Changelog](https://mathiaspaulenko.github.io/bidiwave/reference/changelog/)

## License

MIT
