playwright-byob¶

Bring your own browser to Playwright.

playwright-byob is a tiny Python helper for launching Playwright against the real Google Chrome installation already present on a machine. It keeps the API close to Playwright, but chooses practical defaults for headed, persistent Chrome automation.

Installation¶

pip install playwright-byob

With uv:

uv add playwright-byob

Quick start¶

from playwright.sync_api import sync_playwright
from playwright_byob import launch_chrome

with sync_playwright() as p:
    context = launch_chrome(p)
    page = context.new_page()
    page.goto("https://example.com")
    print(page.title())
    context.close()

The default launch uses installed Chrome, opens headed, uses a dedicated playwright-byob Chrome user data directory under the platform app data directory, selects the Default profile inside that directory, disables Playwright's fixed viewport, and removes the --enable-automation default argument. It does not use your daily Chrome profile.

If Chrome is not detected, it raises ChromeNotFoundError; set PLAYWRIGHT_BYOB_CHROME_PATH or pass browser_path=... explicitly.

If the resolved user data directory appears to be open in another Chrome process, it raises ChromeProfileInUseError before launching. This lock check is best-effort because stale lock files can remain after a crash; pass check_profile_lock=False only when you know the lock is stale.

Chrome 136 and newer ignore remote debugging switches for Chrome stable's platform default profile root. Playwright depends on --remote-debugging-pipe, so playwright-byob raises ChromeRemoteDebuggingBlockedError if you explicitly select that root with Chrome stable. Use the default dedicated directory, a temporary directory, or another non-default automation directory instead.

Customize the browser or profile¶

from playwright.sync_api import sync_playwright
from playwright_byob import launch_chrome

with sync_playwright() as p:
    context = launch_chrome(
        p,
        browser_path="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
        user_data_dir="~/Library/Application Support/playwright-byob/work-profile",
        profile_directory=None,
        args=["--window-size=1440,1000"],
        timeout=30_000,
    )

You can also use environment variables:

• PLAYWRIGHT_BYOB_CHROME_PATH
• PLAYWRIGHT_BYOB_USER_DATA_DIR
• PLAYWRIGHT_BYOB_PROFILE_DIRECTORY

Pass browser_path=None to skip installed Chrome detection and use Playwright's channel="chrome" path instead. PLAYWRIGHT_BYOB_USER_DATA_DIR behaves like an explicit path and must not point at Chrome stable's platform default profile root.

Recommended profile patterns¶

Using the installed Chrome binary and using your daily Chrome profile are separate choices. In practice, the most reliable paths are:

1. Installed Chrome with the default automation profile. Call launch_chrome(p) with no profile arguments. State persists in a package-owned non-default directory, separate from normal Chrome.
2. Installed Chrome with a temporary profile. Use tempfile.TemporaryDirectory() as user_data_dir and profile_directory=None, then log in during the run. This avoids downloading Playwright Chromium without touching a personal Chrome profile.
3. Installed Chrome with a custom automation profile. Point user_data_dir at a dedicated non-default directory and usually set profile_directory=None. Keep it out of day-to-day browsing.

Do not point user_data_dir at Chrome stable's platform default profile root, such as ~/Library/Application Support/Google/Chrome, %LOCALAPPDATA%\Google\Chrome\User Data, or ~/.config/google-chrome. Chrome 136+ blocks remote debugging there, and real profiles can expose sensitive state or conflict with an already-running Chrome window.

Playwright's authentication guide also describes saving authenticated browser state to JSON files with context.storage_state(path=...) and keeping those files out of source control. Because playwright-byob launches persistent contexts, it cannot pass storage_state directly at launch time, but exporting state after login is still useful when a workflow later uses standard Playwright contexts.

Privacy note¶

A real Chrome profile or exported storage-state JSON file can contain cookies, local storage, saved sessions, and other sensitive state, so use these intentionally. Tests in this project never read or launch a real user profile. They use temporary directories and fake Playwright objects.

The local integration test is macOS-only and skipped in CI. It launches the installed Chrome executable with an isolated temporary user data directory, then verifies cookie and local storage persistence across two browser sessions.