Skip to main content

PlaywrightBrowserPlugin

A plugin for managing Playwright automation library.

It is a plugin designed to manage browser instances using the Playwright automation library. It acts as a factory for creating new browser instances and provides a unified interface for interacting with different browser types (chromium, firefox, and webkit). This class integrates configuration options for browser launches (headless mode, executable paths, sandboxing, ...). It also manages browser contexts and the number of pages open within each browser instance, ensuring that resource limits are respected.

Hierarchy

Index

Methods

Properties

Methods

__aenter__

  • Enter the context manager and initialize the browser plugin.

    Returns BaseBrowserPlugin

__aexit__

  • async __aexit__(*, exc_type, exc_value, exc_traceback): None

  • Exit the context manager and close the browser plugin.

    Parameters

    • optionalkeyword-onlyexc_type: type[BaseException] | None
    • optionalkeyword-onlyexc_value: BaseException | None
    • optionalkeyword-onlyexc_traceback: TracebackType | None

    Returns None

__init__

  • __init__(*, browser_type, browser_launch_options, browser_new_context_options, max_open_pages_per_browser): None

  • A default constructor.

    Parameters

    • optionalkeyword-onlybrowser_type: BrowserType = 'chromium'

      The type of browser to launch ('chromium', 'firefox', or 'webkit').

    • optionalkeyword-onlybrowser_launch_options: dict[str, Any] | None = None

      Keyword arguments to pass to the browser launch method. These options are provided directly to Playwright's browser_type.launch method. For more details, refer to the Playwright documentation: https://playwright.dev/python/docs/api/class-browsertype#browser-type-launch.

    • optionalkeyword-onlybrowser_new_context_options: dict[str, Any] | None = None

      Keyword arguments to pass to the browser new context method. These options are provided directly to Playwright's browser.new_context method. For more details, refer to the Playwright documentation: https://playwright.dev/python/docs/api/class-browser#browser-new-context.

    • optionalkeyword-onlymax_open_pages_per_browser: int = 20

      The maximum number of pages that can be opened in a single browser instance. Once reached, a new browser instance will be launched to handle the excess.

    Returns None

new_browser

Properties

active

active: bool

Indicate whether the context is active.

AUTOMATION_LIBRARY

AUTOMATION_LIBRARY: str | None

The name of the automation library that the plugin is managing.

browser_launch_options

browser_launch_options: Mapping[str, Any]

Return the options for the browser.launch method.

Keyword arguments to pass to the browser launch method. These options are provided directly to Playwright's browser_type.launch method. For more details, refer to the Playwright documentation: https://playwright.dev/python/docs/api/class-browsertype#browser-type-launch.

browser_new_context_options

browser_new_context_options: Mapping[str, Any]

Return the options for the browser.new_context method.

Keyword arguments to pass to the browser new context method. These options are provided directly to Playwright's browser.new_context method. For more details, refer to the Playwright documentation: https://playwright.dev/python/docs/api/class-browser#browser-new-context.

browser_type

browser_type: BrowserType

Return the browser type name.

max_open_pages_per_browser

max_open_pages_per_browser: int

Return the maximum number of pages that can be opened in a single browser.

Page Options