selenium.webdriver.common.bidi.browsing_context

Classes

BrowsingContext(conn)	BiDi implementation of the browsingContext module.
BrowsingContextInfo(context, url, children, ...)	Represents the properties of a navigable.
ContextCreated()	Event class for browsingContext.contextCreated event.
ContextDestroyed()	Event class for browsingContext.contextDestroyed event.
DomContentLoaded()	Event class for browsingContext.domContentLoaded event.
DownloadWillBegin()	Event class for browsingContext.downloadWillBegin event.
DownloadWillBeginParams(context, navigation, ...)	Parameters for the downloadWillBegin event.
EventConfig(event_key, bidi_event, event_class)
FragmentNavigated()	Event class for browsingContext.fragmentNavigated event.
HistoryUpdated()	Event class for browsingContext.historyUpdated event.
HistoryUpdatedParams(context, timestamp, url)	Parameters for the historyUpdated event.
Load()	Event class for browsingContext.load event.
NavigationAborted()	Event class for browsingContext.navigationAborted event.
NavigationCommitted()	Event class for browsingContext.navigationCommitted event.
NavigationFailed()	Event class for browsingContext.navigationFailed event.
NavigationInfo(context, navigation, ...)	Provides details of an ongoing navigation.
NavigationStarted()	Event class for browsingContext.navigationStarted event.
ReadinessState()	Represents the stage of document loading at which a navigation command will return.
UserPromptClosed()	Event class for browsingContext.userPromptClosed event.
UserPromptClosedParams(context, accepted, type)	Parameters for the userPromptClosed event.
UserPromptOpened()	Event class for browsingContext.userPromptOpened event.
UserPromptOpenedParams(context, handler, ...)	Parameters for the userPromptOpened event.
UserPromptType()	Represents the possible user prompt types.

class selenium.webdriver.common.bidi.browsing_context.ReadinessState

Represents the stage of document loading at which a navigation command will return.

NONE = 'none'

INTERACTIVE = 'interactive'

COMPLETE = 'complete'

class selenium.webdriver.common.bidi.browsing_context.UserPromptType

Represents the possible user prompt types.

ALERT = 'alert'

BEFORE_UNLOAD = 'beforeunload'

CONFIRM = 'confirm'

PROMPT = 'prompt'

class selenium.webdriver.common.bidi.browsing_context.NavigationInfo(context: str, navigation: str | None, timestamp: int, url: str)

Provides details of an ongoing navigation.

classmethod from_json(json: dict) → NavigationInfo

Creates a NavigationInfo instance from a dictionary.

Parameters:

json: A dictionary containing the navigation information.

Returns:

NavigationInfo: A new instance of NavigationInfo.

class selenium.webdriver.common.bidi.browsing_context.BrowsingContextInfo(context: str, url: str, children: list[BrowsingContextInfo] | None, client_window: str, user_context: str, parent: str | None = None, original_opener: str | None = None)

Represents the properties of a navigable.

classmethod from_json(json: dict) → BrowsingContextInfo

Creates a BrowsingContextInfo instance from a dictionary.

Parameters:

json: A dictionary containing the browsing context information.

Returns:

BrowsingContextInfo: A new instance of BrowsingContextInfo.

class selenium.webdriver.common.bidi.browsing_context.DownloadWillBeginParams(context: str, navigation: str | None, timestamp: int, url: str, suggested_filename: str)

Parameters for the downloadWillBegin event.

classmethod from_json(json: dict) → DownloadWillBeginParams

Creates a DownloadWillBeginParams instance from a dictionary.

Parameters:

json: A dictionary containing the download parameters.

Returns:

DownloadWillBeginParams: A new instance of DownloadWillBeginParams.

class selenium.webdriver.common.bidi.browsing_context.UserPromptOpenedParams(context: str, handler: str, message: str, type: str, default_value: str | None = None)

Parameters for the userPromptOpened event.

classmethod from_json(json: dict) → UserPromptOpenedParams

Creates a UserPromptOpenedParams instance from a dictionary.

Parameters:

json: A dictionary containing the user prompt parameters.

Returns:

UserPromptOpenedParams: A new instance of UserPromptOpenedParams.

class selenium.webdriver.common.bidi.browsing_context.UserPromptClosedParams(context: str, accepted: bool, type: str, user_text: str | None = None)

Parameters for the userPromptClosed event.

classmethod from_json(json: dict) → UserPromptClosedParams

Creates a UserPromptClosedParams instance from a dictionary.

Parameters:

json: A dictionary containing the user prompt closed parameters.

Returns:

UserPromptClosedParams: A new instance of UserPromptClosedParams.

class selenium.webdriver.common.bidi.browsing_context.HistoryUpdatedParams(context: str, timestamp: int, url: str)

Parameters for the historyUpdated event.

classmethod from_json(json: dict) → HistoryUpdatedParams

Creates a HistoryUpdatedParams instance from a dictionary.

Parameters:

json: A dictionary containing the history updated parameters.

Returns:

HistoryUpdatedParams: A new instance of HistoryUpdatedParams.

class selenium.webdriver.common.bidi.browsing_context.ContextCreated

Event class for browsingContext.contextCreated event.

event_class = 'browsingContext.contextCreated'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.ContextDestroyed

Event class for browsingContext.contextDestroyed event.

event_class = 'browsingContext.contextDestroyed'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.NavigationStarted

Event class for browsingContext.navigationStarted event.

event_class = 'browsingContext.navigationStarted'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.NavigationCommitted

Event class for browsingContext.navigationCommitted event.

event_class = 'browsingContext.navigationCommitted'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.NavigationFailed

Event class for browsingContext.navigationFailed event.

event_class = 'browsingContext.navigationFailed'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.NavigationAborted

Event class for browsingContext.navigationAborted event.

event_class = 'browsingContext.navigationAborted'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.DomContentLoaded

Event class for browsingContext.domContentLoaded event.

event_class = 'browsingContext.domContentLoaded'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.Load

Event class for browsingContext.load event.

event_class = 'browsingContext.load'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.FragmentNavigated

Event class for browsingContext.fragmentNavigated event.

event_class = 'browsingContext.fragmentNavigated'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.DownloadWillBegin

Event class for browsingContext.downloadWillBegin event.

event_class = 'browsingContext.downloadWillBegin'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.UserPromptOpened

Event class for browsingContext.userPromptOpened event.

event_class = 'browsingContext.userPromptOpened'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.UserPromptClosed

Event class for browsingContext.userPromptClosed event.

event_class = 'browsingContext.userPromptClosed'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.HistoryUpdated

Event class for browsingContext.historyUpdated event.

event_class = 'browsingContext.historyUpdated'

classmethod from_json(json: dict)

class selenium.webdriver.common.bidi.browsing_context.EventConfig(event_key: str, bidi_event: str, event_class: type)

event_key: str

bidi_event: str

event_class: type

class selenium.webdriver.common.bidi.browsing_context.BrowsingContext(conn)

BiDi implementation of the browsingContext module.

EVENT_CONFIGS = {'context_created': EventConfig(event_key='context_created', bidi_event='browsingContext.contextCreated', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.ContextCreated'>), 'context_destroyed': EventConfig(event_key='context_destroyed', bidi_event='browsingContext.contextDestroyed', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.ContextDestroyed'>), 'dom_content_loaded': EventConfig(event_key='dom_content_loaded', bidi_event='browsingContext.domContentLoaded', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.DomContentLoaded'>), 'download_will_begin': EventConfig(event_key='download_will_begin', bidi_event='browsingContext.downloadWillBegin', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.DownloadWillBegin'>), 'fragment_navigated': EventConfig(event_key='fragment_navigated', bidi_event='browsingContext.fragmentNavigated', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.FragmentNavigated'>), 'history_updated': EventConfig(event_key='history_updated', bidi_event='browsingContext.historyUpdated', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.HistoryUpdated'>), 'load': EventConfig(event_key='load', bidi_event='browsingContext.load', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.Load'>), 'navigation_aborted': EventConfig(event_key='navigation_aborted', bidi_event='browsingContext.navigationAborted', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.NavigationAborted'>), 'navigation_committed': EventConfig(event_key='navigation_committed', bidi_event='browsingContext.navigationCommitted', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.NavigationCommitted'>), 'navigation_failed': EventConfig(event_key='navigation_failed', bidi_event='browsingContext.navigationFailed', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.NavigationFailed'>), 'navigation_started': EventConfig(event_key='navigation_started', bidi_event='browsingContext.navigationStarted', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.NavigationStarted'>), 'user_prompt_closed': EventConfig(event_key='user_prompt_closed', bidi_event='browsingContext.userPromptClosed', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.UserPromptClosed'>), 'user_prompt_opened': EventConfig(event_key='user_prompt_opened', bidi_event='browsingContext.userPromptOpened', event_class=<class 'selenium.webdriver.common.bidi.browsing_context.UserPromptOpened'>)}

classmethod get_event_names() → list[str]

Get a list of all available event names.

Returns:

List[str]: A list of event names that can be used with event handlers.

activate(context: str) → None

Activates and focuses the given top-level traversable.

Parameters:

context: The browsing context ID to activate.

Raises:

Exception: If the browsing context is not a top-level traversable.

capture_screenshot(context: str, origin: str = 'viewport', format: dict | None = None, clip: dict | None = None) → str

Captures an image of the given navigable, and returns it as a Base64-encoded string.

Parameters:

context: The browsing context ID to capture. origin: The origin of the screenshot, either “viewport” or “document”. format: The format of the screenshot. clip: The clip rectangle of the screenshot.

Returns:

str: The Base64-encoded screenshot.

close(context: str, prompt_unload: bool = False) → None

Closes a top-level traversable.

Parameters:

context: The browsing context ID to close. prompt_unload: Whether to prompt to unload.

Raises:

Exception: If the browsing context is not a top-level traversable.

create(type: str, reference_context: str | None = None, background: bool = False, user_context: str | None = None) → str

Creates a new navigable, either in a new tab or in a new window, and returns its navigable id.

Parameters:

type: The type of the new navigable, either “tab” or “window”. reference_context: The reference browsing context ID. background: Whether to create the new navigable in the background. user_context: The user context ID.

Returns:

str: The browsing context ID of the created navigable.

get_tree(max_depth: int | None = None, root: str | None = None) → list[BrowsingContextInfo]

Returns a tree of all descendent navigables including the given parent itself, or all top-level contexts when no parent is provided.

Parameters:

max_depth: The maximum depth of the tree. root: The root browsing context ID.

Returns:

List[BrowsingContextInfo]: A list of browsing context information.

handle_user_prompt(context: str, accept: bool | None = None, user_text: str | None = None) → None

Allows closing an open prompt.

Parameters:

context: The browsing context ID. accept: Whether to accept the prompt. user_text: The text to enter in the prompt.

locate_nodes(context: str, locator: dict, max_node_count: int | None = None, serialization_options: dict | None = None, start_nodes: list[dict] | None = None) → list[dict]

Returns a list of all nodes matching the specified locator.

Parameters:

context: The browsing context ID. locator: The locator to use. max_node_count: The maximum number of nodes to return. serialization_options: The serialization options. start_nodes: The start nodes.

Returns:

List[Dict]: A list of nodes.

navigate(context: str, url: str, wait: str | None = None) → dict

Navigates a navigable to the given URL.

Parameters:

context: The browsing context ID. url: The URL to navigate to. wait: The readiness state to wait for.

Returns:

Dict: A dictionary containing the navigation result.

print(context: str, background: bool = False, margin: dict | None = None, orientation: str = 'portrait', page: dict | None = None, page_ranges: list[int | str] | None = None, scale: float = 1.0, shrink_to_fit: bool = True) → str

Creates a paginated representation of a document, and returns it as a PDF document represented as a Base64-encoded string.

Parameters:

context: The browsing context ID. background: Whether to include the background. margin: The margin parameters. orientation: The orientation, either “portrait” or “landscape”. page: The page parameters. page_ranges: The page ranges. scale: The scale. shrink_to_fit: Whether to shrink to fit.

Returns:

str: The Base64-encoded PDF document.

reload(context: str, ignore_cache: bool | None = None, wait: str | None = None) → dict

Reloads a navigable.

Parameters:

context: The browsing context ID. ignore_cache: Whether to ignore the cache. wait: The readiness state to wait for.

Returns:

Dict: A dictionary containing the navigation result.

set_viewport(context: str | None = None, viewport: dict | None = None, device_pixel_ratio: float | None = None, user_contexts: list[str] | None = None) → None

Modifies specific viewport characteristics on the given top-level traversable.

Parameters:

context: The browsing context ID. viewport: The viewport parameters. device_pixel_ratio: The device pixel ratio. user_contexts: The user context IDs.

Raises:

Exception: If the browsing context is not a top-level traversable.

traverse_history(context: str, delta: int) → dict

Traverses the history of a given navigable by a delta.

Parameters:

context: The browsing context ID. delta: The delta to traverse by.

Returns:

Dict: A dictionary containing the traverse history result.

add_event_handler(event: str, callback: Callable, contexts: list[str] | None = None) → int

Add an event handler to the browsing context.

Parameters:

event: The event to subscribe to. callback: The callback function to execute on event. contexts: The browsing context IDs to subscribe to.

Returns:

int: callback id

remove_event_handler(event: str, callback_id: int) → None

Remove an event handler from the browsing context.

Parameters:

event: The event to unsubscribe from. callback_id: The callback id to remove.

clear_event_handlers() → None

Clear all event handlers from the browsing context.