pytest-playwright-enhanced 0.2.0

A pytest plugin for playwright python

pytest-playwright-enhanced

[!CAUTION] pytest-playwright-enhanced is in the alpha stage.

pytest-playwright-enhanced is a batteries included pytest plugin for the playwright python bindings that offers extended functionality with a focus on removing boilerplate code for projects that wish to test modern web applications and APIs. pytest-playwright-enhanced plans to offer the following:

• Automatic, browser management and installation if required (TBD)
• Improved, human readable APIs that build on top of playwrights API.
• Improved artifacting and debugability.
• Asynchronous support.
• Custom hooks to allow you to plugin and modify behaviour at runtime.
• Much More...

pytest-playwright-enhanced is currently implementing core plugin functionality, the main enhancements will follow shortly.

pytest-playwright-enhanced right now treats browsers, contexts and pages at a function level. This allows easily per test overrides at the small cost of slightly less performance creating browsers, for now it is worth it as it offers much more flexibility and user defined configurations.

---

Quick Start

Quickly get running by doing the following:

• pip install pytest-playwright-enhanced
• pytest <posargs> --acquire-binaries=with-deps

---

Overriding Browser and Context args

There are two methods for overwriting both browser and context arguments at runtime. These are:

import pytest
import typing

@pytest.mark.browser_kwargs(env={}, timeout=15)
@pytest.mark.context_kwargs()
def test_my_app(pw_page):
    # This page will have a preconfigured browser and context from the 
    # marker arguments.
    ...


def my_function(config: pytest.Config) -> dict[typing.Any, typing.Any]:
    return {
        # custom options.
        # inspect CLI if you need via config.
    }

# if you need to calculate the args at runtime, later use:
@pytest.mark.browser_kwargs(callback=my_function)
@pytest.mark.context_kwargs(callback=my_function)
def test_my_app(pw_page):
    # internal machinery will invoke `my_function_that_returns_kwargs` 
    # later to get overrides.  These are merged sensible with CLI and 
    # other PWE defaults.
    ...

Alternatively, if you need more dynamicism, overwrite the fixture and take full control:

import pytest
import typing

@pytest.fixture(scope="function")
def pw_browser_contexts(config: pytest.Config) -> dict[typing.Any, typing.Any]:
    return {
        # Any overrides here,
        # ...
    }

[!CAUTION] If you chose the fixture route, you are responsible for all details, PWE defaults will not be included. Using the markers, a deferred function can be used to calculate args at runtime!

---

Fixtures

---

• pw_playwright - At present this returns the sync Playwright instance.
• pw_multi_browser - Automatically run a test on chromium, firefox and webkit.
• pw_headed - Returns if the browser is running headlessly or not.
• pw_slow_mo - Returns the currently throttle in milliseconds, defaults to 0.
• pw_is_chromium - Returns if the current browser is chromium.
• pw_is_webkit - Returns if the current browser is webkit.
• pw_is_firefox - Returns if the current browser is firefox.
• pw_root_url - Returns the base url auto loaded by Page objects.
• pw_browser - Returns the current Browser instance.
• pw_browser_engine - A string representing the type of browser for this test.
• pw_context - A playwright sync Context object, useful for multi page scenarios.
• pw_context_kwargs - An overridable fixture to control arguments to playwright Context instances.
• pw_page - Returns a new Page instance.
• pw_is_debugging - Returns if playwright will be using PW_DEBUG mode.
• pw_browser_kwargs - An overridable fixture to control arguments to playwright `Browser nstances.

---

Hooks

pytest_playwright_acquire_binaries: Hook in and customise binary acquisition at runtime. pytest_playwright_is_debugging: User defined behaviour for detecting if an IDE is debugging. pytest_playwright_browser_env: Control the environment passed on to playwright browser instances. pytest_playwright_configure_proxy: Return a ProxySettings object in your own hooks to control proxy settings.

---

Markers

• @pytest.mark.only_on_browsers - Only run on a subset of browsers when using the pw_multi_browser fixture.
• @pytest.mark.context_kwargs - Per test level overrides to the context object.
• @pytest.mark.browser_kwargs - Per test level overrides to the browser object.

---