StagehandBrowserController
Hierarchy
- BrowserController
- StagehandBrowserController
Index
Methods
__init__
Initialize a new instance.
Parameters
keyword-onlyplaywright: Playwright
Active Playwright instance used to connect to the browser via CDP.
keyword-onlystagehand_client: AsyncStagehand
Active Stagehand REST client used to start and end sessions.
keyword-onlystagehand_options: StagehandOptions
Stagehand-specific configuration (model, env, self-heal, etc.).
optionalkeyword-onlymax_open_pages_per_browser: int = 20
Maximum number of pages that can be open at the same time.
optionalkeyword-onlyheader_generator: HeaderGenerator | None = _DEFAULT_HEADER_GENERATOR
An optional
HeaderGeneratorinstance used to generate and manage HTTP headers for requests made by the browser. By default, a predefined header generator is used. Set toNoneto disable automatic header modifications.
Returns None
close
Close the browser.
Parameters
optionalkeyword-onlyforce: bool = False
Whether to force close all open pages before closing the browser.
Returns None
new_page
Create a new page in the Stagehand-managed browser.
On the first call, starts the Stagehand session with the provided options. On subsequent calls,
browser_new_context_optionsandproxy_infoare ignored because the session context cannot be reconfigured once it is running.Parameters
optionalbrowser_new_context_options: Mapping[str, Any] | None = None
Options merged on top of the plugin's launch options when creating the first session. Ignored if the session already exists.
optionalproxy_info: ProxyInfo | None = None
Proxy injected into the session on first creation.
Returns StagehandPage
register_page_closed
Stop tracking the page as open.
Implementations must call it from the page's
closeevent. TheBrowserPoolalso calls it when closing the page never finishes, in which case that event never arrives, so it can be called more than once for the same page.Parameters
page: Page
The page that is no longer open.
Returns None
Properties
AUTOMATION_LIBRARY
The name of the automation library that the controller is using.
browser_type
Return the type of the browser.
has_free_capacity
Return if the browser has free capacity to open a new page.
idle_time
Return the idle time of the browser controller.
is_browser_connected
Return if the browser is closed.
is_opening_pages
Return if the browser has any new_page calls currently in flight.
last_page_opened_at
Return the time when the last page was opened.
pages
Return the list of opened pages.
pages_count
Return the number of currently open pages.
total_opened_pages
Return the total number of pages opened since the browser was launched.
Controller for managing a Stagehand-controlled browser instance.
It creates and connects to the browser lazily on the first
new_pagecall: Stagehand starts a session, and Playwright then connects to it via CDP. All pages share a single browser context, as Stagehand creates the browser and its context together during session initialisation.