Playwright Python — Browser Automation and Testing Guide

Installing Playwright Python

Playwright requires two distinct installation steps: the Python library and the actual browser binaries (bundled versions of Chromium, Firefox, and WebKit that are guaranteed to work with the library version).

Don't skip the --with-deps flag on Linux – it installs system libraries like libgbm that are required for headless browser rendering. In Docker, you'll need those dependencies or your browser will crash silently.

# Step 1: Install the Python bindings
pip install playwright

# Step 2: Provision the browser binaries
# Using --with-deps ensures OS-level dependencies (like libgbm) are present
playwright install --with-deps

# Verify the installation
python -c "from playwright.sync_api import sync_playwright; print('Playwright initialized successfully')"

Your First Playwright Script

Playwright offers two entry points: a Synchronous API (ideal for scripts and data scraping) and an Asynchronous API (standard for high-concurrency tasks). Here is a robust synchronous example using a context manager to ensure clean resource teardown.

The context manager guarantees that the browser is closed even if an exception occurs – critical in production pipelines where leaked processes can exhaust CI resources.

from playwright.sync_api import sync_playwright

# io.thecodeforge package naming convention applied to logic flow
def run_basic_automation():
    with sync_playwright() as p:
        # launch headless=False for visual debugging
        browser = p.chromium.launch(headless=False)
        context = browser.new_context()
        page = context.new_page()

        page.goto("https://thecodeforge.io")

        # Logging page metadata
        print(f"Navigated to: {page.title()}")

        # High-res screenshot for visual regression
        page.screenshot(path="io_thecodeforge_home.png", full_page=True)

        browser.close()

if __name__ == "__main__":
    run_basic_automation()

Finding and Interacting with Elements

Modern web development is dynamic. Brittle CSS selectors and XPaths break the moment a div changes. Playwright advocates for Semantic Locators—locating elements by their accessibility labels or roles. This mirrors how a real user interacts with the page.

In production, you'll also need to handle iframes, shadow DOM, and dynamic id changes. Playwright's locator API chaining lets you build resilient selectors even against poorly written frontends.

from playwright.sync_api import sync_playwright

with sync_playwright() as p:
    browser = p.chromium.launch()
    page = browser.new_page()
    page.goto("https://github.com/login")

    # Best Practice: Use Roles and Labels
    page.get_by_label("Username or email address").fill("thecodeforge_admin")
    page.get_by_label("Password").fill("secure_password_123")

    # Semantic button click
    page.get_by_role("button", name="Sign in").click()

    # Actionability: Playwright automatically waits for the URL and page state
    page.wait_for_url("**/dashboard")
    
    # Extract text from the first available heading locator
    welcome_msg = page.get_by_role("heading").first.inner_text()
    print(f"Dashboard Status: {welcome_msg}")

    browser.close()

Writing Tests with pytest-playwright

For production test suites, manual browser management is an anti-pattern. The pytest-playwright plugin provides managed fixtures, automatic browser cleanup, and parallel execution capabilities.

It also injects fixtures like page, context, and browser directly into test functions, eliminating boilerplate and ensuring consistent teardown even on test failure – a critical leak prevention in large suites.

# Install the plugin
pip install pytest-playwright

Your First pytest-playwright Test

In a pytest environment, the page fixture is injected automatically. We use the expect library for 'web-first' assertions, which will automatically retry until the condition is met or a timeout occurs.

This means you never write time.sleep() again. Playwright retries the assertion internally at a configurable interval (default 500ms), checking if the condition becomes true within the timeout. This eliminates the single biggest source of flakiness in CI/CD.

# io/thecodeforge/tests/test_search.py
import pytest
from playwright.sync_api import Page, expect

def test_homepage_integrity(page: Page):
    """Verify the main page loads with correct SEO title."""
    page.goto("https://thecodeforge.io")
    expect(page).to_have_title("TheCodeForge — Free Programming Tutorials")

def test_search_results_visibility(page: Page):
    """Check that the search interface returns valid results."""
    page.goto("https://thecodeforge.io")
    
    # Search for Java tutorials
    search_box = page.get_by_placeholder("Search tutorials...")
    search_box.fill("Java")
    search_box.press("Enter")
    
    # Assert that the search results container is visible
    results = page.get_by_role("region", name="Search results")
    expect(results).to_be_visible()

Async Playwright for Production Scripts

When building scrapers or backend services (like PDF generators) that require high throughput, the Async API is mandatory. It integrates natively with Python's asyncio to run tasks concurrently without blocking.

Async Playwright shares the same browser process pool among concurrent tasks, making it memory-efficient. A common mistake is creating a new browser per task – instead, use a shared browser and create multiple contexts for isolation.

import asyncio
from playwright.async_api import async_playwright

async def fetch_metadata(url: str) -> dict:
    async with async_playwright() as p:
        browser = await p.chromium.launch()
        page = await browser.new_page(viewport={'width': 1920, 'height': 1080})
        await page.goto(url, wait_until="domcontentloaded")
        title = await page.title()
        await browser.close()
        return {"url": url, "title": title}

async def main():
    urls = ["https://thecodeforge.io/java", "https://thecodeforge.io/python"]
    tasks = [fetch_metadata(url) for url in urls]
    results = await asyncio.gather(*tasks)
    for res in results: print(f"Captured: {res['title']}")

if __name__ == "__main__":
    asyncio.run(main())

Playwright vs Selenium — When to Choose Which

While Selenium has been the industry standard for two decades, Playwright is effectively the 'modern' successor. Selenium's architecture is based on the JSON Wire Protocol, which creates a delay between your code and the browser action. Playwright's WebSocket-based connection is near-instantaneous.

But Selenium still wins in legacy environments: it supports older browsers (IE11), integrates with existing Selenium Grid infrastructure, and is more battle-tested in enterprise settings. Choose Playwright for new projects; keep Selenium for systems that require legacy browser support.

Frequently Asked Questions