Index

`accessibility` ¶

`AXNode` `dataclass` ¶

A node in the accessibility tree.

`AXNodeId` ¶

Bases: str

Unique accessibility node identifier.

`AXProperty` `dataclass` ¶

Description is missing from the devtools protocol document.

`AXPropertyName` ¶

Bases: str, enum.Enum

Values of AXProperty name:

from 'busy' to 'roledescription': states which apply to every AX node
from 'live' to 'root': attributes which apply to nodes in live regions
from 'autocomplete' to 'valuetext': attributes which apply to widgets
from 'checked' to 'selected': states which apply to widgets
from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.

`AXRelatedNode` `dataclass` ¶

Description is missing from the devtools protocol document.

`AXValue` `dataclass` ¶

A single computed AX property.

`AXValueNativeSourceType` ¶

Bases: str, enum.Enum

Enum of possible native property sources (as a subtype of a particular AXValueSourceType).

`AXValueSource` `dataclass` ¶

A single source for a computed AX property.

`AXValueSourceType` ¶

Bases: str, enum.Enum

Enum of possible property sources.

`AXValueType` ¶

Bases: str, enum.Enum

Enum of possible property types.

`LoadComplete` `dataclass` ¶

The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.

`NodesUpdated` `dataclass` ¶

The nodesUpdated event is sent every time a previously requested node has changed the in tree.

`disable()` `async` ¶

Disables the accessibility domain.

noqa¶

`enable()` `async` ¶

Enables the accessibility domain which causes AXNodeIds to remain consistent between method calls.

This turns on accessibility for the page, which can impact performance until accessibility is disabled. # noqa

`get_ax_node_and_ancestors()` `async` ¶

Fetches a node and all ancestors up to and including the root.

Requires enable() to have been called previously. # noqa

`get_child_ax_nodes()` `async` ¶

Fetches a particular accessibility node by AXNodeId.

Requires enable() to have been called previously. # noqa

`get_full_ax_tree()` `async` ¶

Fetches the entire accessibility tree for the root Document # noqa.

`get_partial_ax_tree()` `async` ¶

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

noqa¶

`get_root_ax_node()` `async` ¶

Fetches the root node.

Requires enable() to have been called previously. # noqa

`query_ax_tree()` `async` ¶

Query a DOM node's accessibility subtree for accessible name and role.

This command computes the name and role for all nodes in the subtree, including those that are ignored for accessibility, and returns those that mactch the specified name and role. If no DOM node is specified, or the DOM node does not exist, the command returns an error. If neither accessibleName or role is specified, it returns all the accessibility nodes in the subtree. # noqa

`animation` ¶

`Animation` `dataclass` ¶

Animation instance.

`AnimationCanceled` `dataclass` ¶

Event for when an animation has been cancelled.

`AnimationCreated` `dataclass` ¶

Event for each animation that has been created.

`AnimationEffect` `dataclass` ¶

AnimationEffect instance.

`AnimationStarted` `dataclass` ¶

Event for animation that has been started.

`KeyframeStyle` `dataclass` ¶

Keyframe Style.

`KeyframesRule` `dataclass` ¶

Keyframes Rule.

`disable()` `async` ¶

Disables animation domain notifications.

noqa¶

`enable()` `async` ¶

Enables animation domain notifications.

noqa¶

`get_current_time()` `async` ¶

Returns the current time of the an animation.

noqa¶

`get_playback_rate()` `async` ¶

Gets the playback rate of the document timeline.

noqa¶

`release_animations()` `async` ¶

Releases a set of animations to no longer be manipulated.

noqa¶

`resolve_animation()` `async` ¶

Gets the remote object of the Animation.

noqa¶

`seek_animations()` `async` ¶

Seek a set of animations to a particular time within each animation.

noqa¶

`set_paused()` `async` ¶

Sets the paused state of a set of animations.

noqa¶

`set_playback_rate()` `async` ¶

Sets the playback rate of the document timeline.

noqa¶

`set_timing()` `async` ¶

Sets the timing of an animation node.

noqa¶

`audits` ¶

`AffectedCookie` `dataclass` ¶

Information about a cookie that is affected by an inspector issue.

`AffectedFrame` `dataclass` ¶

Information about the frame affected by an inspector issue.

`AffectedRequest` `dataclass` ¶

Information about a request that is affected by an inspector issue.

`AttributionReportingIssueDetails` `dataclass` ¶

Details for issues around "Attribution Reporting API" usage.

Explainer: https://github.com/WICG/attribution-reporting-api

`AttributionReportingIssueType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`BlockedByResponseIssueDetails` `dataclass` ¶

Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code.

Currently only used for COEP/COOP, but may be extended to include some CSP errors in the future.

`BlockedByResponseReason` ¶

Bases: str, enum.Enum

Enum indicating the reason a response has been blocked.

These reasons are refinements of the net error BLOCKED_BY_RESPONSE.

`ClientHintIssueDetails` `dataclass` ¶

This issue tracks client hints related issues.

It's used to deprecate old features, encourage the use of new ones, and provide general guidance.

`ClientHintIssueReason` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`ContentSecurityPolicyIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`ContentSecurityPolicyViolationType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`CookieExclusionReason` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`CookieIssueDetails` `dataclass` ¶

This information is currently necessary, as the front-end has a difficult time finding a specific cookie.

With this, we can convey specific error information without the cookie.

`CookieOperation` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`CookieWarningReason` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`CorsIssueDetails` `dataclass` ¶

Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.

`DeprecationIssueDetails` `dataclass` ¶

This issue tracks information needed to print a deprecation message.

https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md

`FederatedAuthRequestIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`FederatedAuthRequestIssueReason` ¶

Bases: str, enum.Enum

Represents the failure reason when a federated authentication reason fails.

Should be updated alongside RequestIdTokenStatus in third_party/blink/public/mojom/devtools/inspector_issue.mojom to include all cases except for success.

`GenericIssueDetails` `dataclass` ¶

Depending on the concrete errorType, different properties are set.

`GenericIssueErrorType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`HeavyAdIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`HeavyAdReason` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`HeavyAdResolutionStatus` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`InspectorIssue` `dataclass` ¶

An inspector issue reported from the back-end.

`InspectorIssueCode` ¶

Bases: str, enum.Enum

A unique identifier for the type of issue.

Each type may use one of the optional fields in InspectorIssueDetails to convey more specific information about the kind of issue.

`InspectorIssueDetails` `dataclass` ¶

This struct holds a list of optional fields with additional information specific to the kind of issue.

When adding a new issue code, please also add a new optional field to this type.

`IssueAdded` `dataclass` ¶

Description is missing from the devtools protocol document.

`IssueId` ¶

Bases: str

A unique id for a DevTools inspector issue.

Allows other entities (e.g. exceptions, CDP message, console messages, etc.) to reference an issue.

`LowTextContrastIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`MixedContentIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`MixedContentResolutionStatus` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`MixedContentResourceType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`NavigatorUserAgentIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`QuirksModeIssueDetails` `dataclass` ¶

Details for issues about documents in Quirks Mode or Limited Quirks Mode that affects page layouting.

`SharedArrayBufferIssueDetails` `dataclass` ¶

Details for a issue arising from an SAB being instantiated in, or transferred to a context that is not cross- origin isolated.

`SharedArrayBufferIssueType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`SourceCodeLocation` `dataclass` ¶

Description is missing from the devtools protocol document.

`TrustedWebActivityIssueDetails` `dataclass` ¶

Description is missing from the devtools protocol document.

`TwaQualityEnforcementViolationType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`check_contrast()` `async` ¶

Runs the contrast check for the target page.

Found issues are reported using Audits.issueAdded event. # noqa

`disable()` `async` ¶

Disables issues domain, prevents further issues from being reported to the client.

noqa¶

`enable()` `async` ¶

Enables issues domain, sends the issues collected so far to the client by means of the issueAdded event.

noqa¶

`get_encoded_response()` `async` ¶

Returns the response body and size if it were re-encoded with the specified settings.

Only applies to images. # noqa

`background_service` ¶

`BackgroundServiceEvent` `dataclass` ¶

Description is missing from the devtools protocol document.

`BackgroundServiceEventReceived` `dataclass` ¶

Called with all existing backgroundServiceEvents when enabled, and all new events afterwards if enabled and recording.

`EventMetadata` `dataclass` ¶

A key-value pair for additional event information to pass along.

`RecordingStateChanged` `dataclass` ¶

Called when the recording state for the service has been updated.

`ServiceName` ¶

Bases: str, enum.Enum

The Background Service that will be associated with the commands/events.

Every Background Service operates independently, but they share the same API.

`clear_events()` `async` ¶

Clears all stored data for the service.

noqa¶

`set_recording()` `async` ¶

Set the recording state for the service.

noqa¶

`start_observing()` `async` ¶

Enables event updates for the service.

noqa¶

`stop_observing()` `async` ¶

Disables event updates for the service.

noqa¶

`browser` ¶

`Bounds` `dataclass` ¶

Browser window bounds information.

`BrowserCommandId` ¶

Bases: str, enum.Enum

Browser command ids used by executeBrowserCommand.

`BrowserContextID` ¶

Bases: str

Description is missing from the devtools protocol document.

`Bucket` `dataclass` ¶

Chrome histogram bucket.

`DownloadProgress` `dataclass` ¶

Fired when download makes progress.

Last call has |done| == true.

`DownloadWillBegin` `dataclass` ¶

Fired when page is about to start a download.

`Histogram` `dataclass` ¶

Chrome histogram.

`PermissionDescriptor` `dataclass` ¶

Definition of PermissionDescriptor defined in the Permissions API:

https://w3c.github.io/permissions/#dictdef-permissiondescriptor.

`PermissionSetting` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`PermissionType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`WindowID` ¶

Bases: int

Description is missing from the devtools protocol document.

`WindowState` ¶

Bases: str, enum.Enum

The state of the browser window.

`cancel_download()` `async` ¶

Cancel a download if in progress # noqa.

`close()` `async` ¶

Close browser gracefully.

noqa¶

`crash()` `async` ¶

Crashes browser on the main thread.

noqa¶

`crash_gpu_process()` `async` ¶

Crashes GPU process.

noqa¶

`execute_browser_command()` `async` ¶

Invoke custom browser commands used by telemetry.

noqa¶

`get_browser_command_line()` `async` ¶

Returns the command line switches for the browser process if, and only if.

--enable-automation is on the commandline. # noqa

`get_histogram()` `async` ¶

Get a Chrome histogram by name.

noqa¶

`get_histograms()` `async` ¶

Get Chrome histograms.

noqa¶

`get_version()` `async` ¶

Returns version information.

noqa¶

`get_window_bounds()` `async` ¶

Get position and size of the browser window.

noqa¶

`get_window_for_target()` `async` ¶

Get the browser window that contains the devtools target.

noqa¶

`grant_permissions()` `async` ¶

Grant specific permissions to the given origin and reject all others.

noqa¶

`reset_permissions()` `async` ¶

Reset all permission management for all origins.

noqa¶

`set_dock_tile()` `async` ¶

Set dock tile details, platform-specific.

noqa¶

`set_download_behavior()` `async` ¶

Set the behavior when downloading a file.

noqa¶

`set_permission()` `async` ¶

Set permission settings for given origin.

noqa¶

`set_window_bounds()` `async` ¶

Set position and/or size of the browser window.

noqa¶

`cache_storage` ¶

`Cache` `dataclass` ¶

Cache identifier.

`CacheId` ¶

Bases: str

Unique identifier of the Cache object.

`CachedResponse` `dataclass` ¶

Cached response.

`CachedResponseType` ¶

Bases: str, enum.Enum

Type of HTTP response cached.

`DataEntry` `dataclass` ¶

Data entry.

`Header` `dataclass` ¶

Description is missing from the devtools protocol document.

`delete_cache()` `async` ¶

Deletes a cache.

noqa¶

`delete_entry()` `async` ¶

Deletes a cache entry.

noqa¶

`request_cache_names()` `async` ¶

Requests cache names.

noqa¶

`request_cached_response()` `async` ¶

Fetches cache entry.

noqa¶

`request_entries()` `async` ¶

Requests data from cache.

noqa¶

`cast` ¶

`IssueUpdated` `dataclass` ¶

This is fired whenever the outstanding issue/error message changes.

|issueMessage| is empty if there is no issue.

`Sink` `dataclass` ¶

Description is missing from the devtools protocol document.

`SinksUpdated` `dataclass` ¶

This is fired whenever the list of available sinks changes.

A sink is a device or a software surface that you can cast to.

`disable()` `async` ¶

Stops observing for sinks and issues.

noqa¶

`enable()` `async` ¶

Starts observing for sinks that can be used for tab mirroring, and if set, sinks compatible with.

|presentationUrl| as well. When sinks are found, a.

|sinksUpdated| event is fired. Also starts observing for issue messages. When an issue is added or removed, an |issueUpdated| event is fired. # noqa

`set_sink_to_use()` `async` ¶

Sets a sink to be used when the web page requests the browser to choose a sink via Presentation API, Remote Playback API, or Cast SDK.

noqa¶

`start_desktop_mirroring()` `async` ¶

Starts mirroring the desktop to the sink.

noqa¶

`start_tab_mirroring()` `async` ¶

Starts mirroring the tab to the sink.

noqa¶

`stop_casting()` `async` ¶

Stops the active Cast session on the sink.

noqa¶

`console` ¶

`ConsoleMessage` `dataclass` ¶

Console message.

`MessageAdded` `dataclass` ¶

Issued when new console message is added.

`clear_messages()` `async` ¶

Does nothing.

noqa¶

`disable()` `async` ¶

Disables console domain, prevents further console messages from being reported to the client.

noqa¶

`enable()` `async` ¶

Enables console domain, sends the messages collected so far to the client by means of the messageAdded notification.

noqa¶

`css` ¶

`CSSComputedStyleProperty` `dataclass` ¶

Description is missing from the devtools protocol document.

`CSSContainerQuery` `dataclass` ¶

CSS container query rule descriptor.

`CSSKeyframeRule` `dataclass` ¶

CSS keyframe rule representation.

`CSSKeyframesRule` `dataclass` ¶

CSS keyframes rule representation.

`CSSLayer` `dataclass` ¶

CSS Layer at-rule descriptor.

`CSSLayerData` `dataclass` ¶

CSS Layer data.

`CSSMedia` `dataclass` ¶

CSS media rule descriptor.

`CSSPositionFallbackRule` `dataclass` ¶

CSS position-fallback rule representation.

`CSSProperty` `dataclass` ¶

CSS property declaration data.

`CSSRule` `dataclass` ¶

CSS rule representation.

`CSSScope` `dataclass` ¶

CSS Scope at-rule descriptor.

`CSSStyle` `dataclass` ¶

CSS style representation.

`CSSStyleSheetHeader` `dataclass` ¶

CSS stylesheet metainformation.

`CSSSupports` `dataclass` ¶

CSS Supports at-rule descriptor.

`CSSTryRule` `dataclass` ¶

CSS try rule representation.

`FontFace` `dataclass` ¶

Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions and additional information such as platformFontFamily and fontVariationAxes.

`FontVariationAxis` `dataclass` ¶

Information about font variation axes for variable fonts.

`FontsUpdated` `dataclass` ¶

Fires whenever a web font is updated.

A non-empty font parameter indicates a successfully loaded web font.

`InheritedPseudoElementMatches` `dataclass` ¶

Inherited pseudo element matches from pseudos of an ancestor node.

`InheritedStyleEntry` `dataclass` ¶

Inherited CSS rule collection from ancestor node.

`MediaQuery` `dataclass` ¶

Media query descriptor.

`MediaQueryExpression` `dataclass` ¶

Media query expression descriptor.

`MediaQueryResultChanged` `dataclass` ¶

Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation considers only viewport-dependent media features.

`PlatformFontUsage` `dataclass` ¶

Information about amount of glyphs that were rendered with given font.

`PseudoElementMatches` `dataclass` ¶

CSS rule collection for a single pseudo style.

`RuleMatch` `dataclass` ¶

Match data for a CSS rule.

`RuleUsage` `dataclass` ¶

CSS coverage information.

`SelectorList` `dataclass` ¶

Selector list data.

`ShorthandEntry` `dataclass` ¶

Description is missing from the devtools protocol document.

`SourceRange` `dataclass` ¶

Text range within a resource.

All numbers are zero-based.

`StyleDeclarationEdit` `dataclass` ¶

A descriptor of operation to mutate style declaration text.

`StyleSheetAdded` `dataclass` ¶

Fired whenever an active document stylesheet is added.

`StyleSheetChanged` `dataclass` ¶

Fired whenever a stylesheet is changed as a result of the client operation.

`StyleSheetId` ¶

Bases: str

Description is missing from the devtools protocol document.

`StyleSheetOrigin` ¶

Bases: str, enum.Enum

Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via inspector" rules), "regular" for regular stylesheets.

`StyleSheetRemoved` `dataclass` ¶

Fired whenever an active document stylesheet is removed.

`Value` `dataclass` ¶

Data for a simple selector (these are delimited by commas in a selector list).

`add_rule()` `async` ¶

Inserts a new rule with the given ruleText in a stylesheet with given styleSheetId, at the position specified by location.

noqa¶

`collect_class_names()` `async` ¶

Returns all class names from specified stylesheet.

noqa¶

`create_style_sheet()` `async` ¶

Creates a new special "via-inspector" stylesheet in the frame with given frameId.

noqa¶

`disable()` `async` ¶

Disables the CSS agent for the given page.

noqa¶

`enable()` `async` ¶

Enables the CSS agent for the given page.

Clients should not assume that the CSS agent has been enabled until the result of this command is received. # noqa

`force_pseudo_state()` `async` ¶

Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.

noqa¶

`get_background_colors()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_computed_style_for_node()` `async` ¶

Returns the computed style for a DOM node identified by nodeId.

noqa¶

`get_inline_styles_for_node()` `async` ¶

Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM attributes) for a DOM node identified by nodeId.

noqa¶

`get_layers_for_node()` `async` ¶

Returns all layers parsed by the rendering engine for the tree scope of a node.

Given a DOM element identified by nodeId, getLayersForNode returns the root layer for the nearest ancestor document or shadow root. The layer root contains the full layer tree for the tree scope and their ordering. # noqa

`get_matched_styles_for_node()` `async` ¶

Returns requested styles for a DOM node identified by nodeId.

noqa¶

`get_media_queries()` `async` ¶

Returns all media queries parsed by the rendering engine.

noqa¶

`get_platform_fonts_for_node()` `async` ¶

Requests information about platform fonts which we used to render child TextNodes in the given node.

noqa¶

`get_style_sheet_text()` `async` ¶

Returns the current textual content for a stylesheet.

noqa¶

`set_container_query_text()` `async` ¶

Modifies the expression of a container query.

noqa¶

`set_effective_property_value_for_node()` `async` ¶

Find a rule with the given active property for the given node and set the new value for this property # noqa.

`set_keyframe_key()` `async` ¶

Modifies the keyframe rule key text.

noqa¶

`set_local_fonts_enabled()` `async` ¶

Enables/disables rendering of local CSS fonts (enabled by default).

noqa¶

`set_media_text()` `async` ¶

Modifies the rule selector.

noqa¶

`set_rule_selector()` `async` ¶

Modifies the rule selector.

noqa¶

`set_scope_text()` `async` ¶

Modifies the expression of a scope at-rule.

noqa¶

`set_style_sheet_text()` `async` ¶

Sets the new stylesheet text.

noqa¶

`set_style_texts()` `async` ¶

Applies specified style edits one after another in the given order.

noqa¶

`set_supports_text()` `async` ¶

Modifies the expression of a supports at-rule.

noqa¶

`start_rule_usage_tracking()` `async` ¶

Enables the selector recording.

noqa¶

`stop_rule_usage_tracking()` `async` ¶

Stop tracking rule usage and return the list of rules that were used since last call to takeCoverageDelta (or since start of coverage instrumentation).

noqa¶

`take_computed_style_updates()` `async` ¶

Polls the next batch of computed style updates.

noqa¶

`take_coverage_delta()` `async` ¶

Obtain list of rules that became used since last call to this method (or since start of coverage instrumentation).

noqa¶

`track_computed_style_updates()` `async` ¶

Starts tracking the given computed styles for updates.

The specified array of properties replaces the one previously specified. Pass empty array to disable tracking. Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified. The changes to computed style properties are only tracked for nodes pushed to the front-end by the DOM agent. If no changes to the tracked properties occur after the node has been pushed to the front-end, no updates will be issued for the node. # noqa

`database` ¶

`AddDatabase` `dataclass` ¶

Description is missing from the devtools protocol document.

`Database` `dataclass` ¶

Database object.

`DatabaseId` ¶

Bases: str

Unique identifier of Database object.

`Error` `dataclass` ¶

Database error.

`disable()` `async` ¶

Disables database tracking, prevents database events from being sent to the client.

noqa¶

`enable()` `async` ¶

Enables database tracking, database events will now be delivered to the client.

noqa¶

`execute_sql()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_database_table_names()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`debugger` ¶

`BreakLocation` `dataclass` ¶

Description is missing from the devtools protocol document.

`BreakpointId` ¶

Bases: str

Breakpoint identifier.

`BreakpointResolved` `dataclass` ¶

Fired when breakpoint is resolved to an actual script and location.

`CallFrame` `dataclass` ¶

JavaScript call frame.

Array of call frames form the call stack.

`CallFrameId` ¶

Bases: str

Call frame identifier.

`DebugSymbols` `dataclass` ¶

Debug symbols available for a wasm script.

`Location` `dataclass` ¶

Location in the source code.

`LocationRange` `dataclass` ¶

Location range within one script.

`Paused` `dataclass` ¶

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

`Resumed` `dataclass` ¶

Fired when the virtual machine resumed execution.

`Scope` `dataclass` ¶

Scope description.

`ScriptFailedToParse` `dataclass` ¶

Fired when virtual machine fails to parse the script.

`ScriptLanguage` ¶

Bases: str, enum.Enum

Enum of possible script languages.

`ScriptParsed` `dataclass` ¶

Fired when virtual machine parses script.

This event is also fired for all known and uncollected scripts upon enabling debugger.

`ScriptPosition` `dataclass` ¶

Location in the source code.

`SearchMatch` `dataclass` ¶

Search match for resource.

`WasmDisassemblyChunk` `dataclass` ¶

Description is missing from the devtools protocol document.

`continue_to_location()` `async` ¶

Continues execution until specific location is reached.

noqa¶

`disable()` `async` ¶

Disables debugger for given page.

noqa¶

`disassemble_wasm_module()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`enable()` `async` ¶

Enables debugger for the given page.

Clients should not assume that the debugging has been enabled until the result for this command is received. # noqa

`evaluate_on_call_frame()` `async` ¶

Evaluates expression on a given call frame.

noqa¶

`get_possible_breakpoints()` `async` ¶

Returns possible locations for breakpoint.

scriptId in start and end range locations should be the same. # noqa

`get_script_source()` `async` ¶

Returns source for the script with given id.

noqa¶

`get_stack_trace()` `async` ¶

Returns stack trace with given stackTraceId.

noqa¶

`get_wasm_bytecode()` `async` ¶

This command is deprecated.

Use getScriptSource instead. # noqa

`next_wasm_disassembly_chunk()` `async` ¶

Disassemble the next chunk of lines for the module corresponding to the stream.

If disassembly is complete, this API will invalidate the streamId and return an empty chunk. Any subsequent calls for the now invalid stream will return errors. # noqa

`pause()` `async` ¶

Stops on the next JavaScript statement.

noqa¶

`pause_on_async_call()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`remove_breakpoint()` `async` ¶

Removes JavaScript breakpoint.

noqa¶

`restart_frame()` `async` ¶

Restarts particular call frame from the beginning. The old, deprecated behavior of restartFrame is to stay paused and allow further CDP commands after a restart was scheduled. This can cause problems with restarting, so we now continue execution immediatly after it has been scheduled until we reach the beginning of the restarted frame.

To stay back-wards compatible, restartFrame now expects a mode parameter to be present. If the mode parameter is missing, restartFrame errors out.

The various return values are deprecated and callFrames is always empty. Use the call frames from the Debugger#paused events instead, that fires once V8 pauses at the beginning of the restarted function. # noqa

`resume()` `async` ¶

Resumes JavaScript execution.

noqa¶

`search_in_content()` `async` ¶

Searches for given string in script content.

noqa¶

`set_async_call_stack_depth()` `async` ¶

Enables or disables async call stacks tracking.

noqa¶

`set_blackbox_patterns()` `async` ¶

Replace previous blackbox patterns with passed ones.

Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. # noqa

`set_blackboxed_ranges()` `async` ¶

Makes backend skip steps in the script in blackboxed ranges.

VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted. # noqa

`set_breakpoint()` `async` ¶

Sets JavaScript breakpoint at a given location.

noqa¶

`set_breakpoint_by_url()` `async` ¶

Sets JavaScript breakpoint at given location specified either by URL or URL regex.

Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads. # noqa

`set_breakpoint_on_function_call()` `async` ¶

Sets JavaScript breakpoint before each call to the given function.

If another function was created from the same source as a given one, calling it will also trigger the breakpoint. # noqa

`set_breakpoints_active()` `async` ¶

Activates / deactivates all breakpoints on the page.

noqa¶

`set_instrumentation_breakpoint()` `async` ¶

Sets instrumentation breakpoint.

noqa¶

`set_pause_on_exceptions()` `async` ¶

Defines pause on exceptions state.

Can be set to stop on all exceptions, uncaught exceptions, or caught exceptions, no exceptions. Initial pause on exceptions state is none. # noqa

`set_return_value()` `async` ¶

Changes return value in top frame.

Available only at return break position. # noqa

`set_script_source()` `async` ¶

Edits JavaScript source live.

In general, functions that are currently on the stack can not be edited with a single exception: If the edited function is the top-most stack frame and that is the only activation of that function on the stack. In this case the live edit will be successful and a Debugger.restartFrame for the top-most function is automatically triggered. # noqa

`set_skip_all_pauses()` `async` ¶

Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).

noqa¶

`set_variable_value()` `async` ¶

Changes value of variable in a callframe.

Object-based scopes are not supported and must be mutated manually. # noqa

`step_into()` `async` ¶

Steps into the function call.

noqa¶

`step_out()` `async` ¶

Steps out of the function call.

noqa¶

`step_over()` `async` ¶

Steps over the statement.

noqa¶

`device_access` ¶

`DeviceId` ¶

Bases: str

A device id.

`DeviceRequestPrompted` `dataclass` ¶

A device request opened a user prompt to select a device.

Respond with the selectPrompt or cancelPrompt command.

`PromptDevice` `dataclass` ¶

Device information displayed in a user prompt to select a device.

`RequestId` ¶

Bases: str

Device request id.

`cancel_prompt()` `async` ¶

Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.

noqa¶

`disable()` `async` ¶

Disable events in this domain.

noqa¶

`enable()` `async` ¶

Enable events in this domain.

noqa¶

`select_prompt()` `async` ¶

Select a device in response to a DeviceAccess.deviceRequestPrompted event.

noqa¶

`device_orientation` ¶

`clear_device_orientation_override()` `async` ¶

Clears the overridden Device Orientation.

noqa¶

`set_device_orientation_override()` `async` ¶

Overrides the Device Orientation.

noqa¶

`dom` ¶

`AttributeModified` `dataclass` ¶

Fired when Element's attribute is modified.

`AttributeRemoved` `dataclass` ¶

Fired when Element's attribute is removed.

`BackendNode` `dataclass` ¶

Backend node with a friendly name.

`BackendNodeId` ¶

Bases: int

Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.

`BoxModel` `dataclass` ¶

Box model.

`CSSComputedStyleProperty` `dataclass` ¶

Description is missing from the devtools protocol document.

`CharacterDataModified` `dataclass` ¶

Mirrors DOMCharacterDataModified event.

`ChildNodeCountUpdated` `dataclass` ¶

Fired when Container's child node count has changed.

`ChildNodeInserted` `dataclass` ¶

Mirrors DOMNodeInserted event.

`ChildNodeRemoved` `dataclass` ¶

Mirrors DOMNodeRemoved event.

`CompatibilityMode` ¶

Bases: str, enum.Enum

Document compatibility mode.

`DistributedNodesUpdated` `dataclass` ¶

Called when distribution is changed.

`DocumentUpdated` `dataclass` ¶

Fired when Document has been totally updated.

Node ids are no longer valid.

`InlineStyleInvalidated` `dataclass` ¶

Fired when Element's inline style is modified via a CSS property modification.

`LogicalAxes` ¶

Bases: str, enum.Enum

ContainerSelector logical axes.

`Node` `dataclass` ¶

DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.

DOMNode is a base node mirror type.

`NodeId` ¶

Bases: int

Unique DOM node identifier.

`PhysicalAxes` ¶

Bases: str, enum.Enum

ContainerSelector physical axes.

`PseudoElementAdded` `dataclass` ¶

Called when a pseudo element is added to an element.

`PseudoElementRemoved` `dataclass` ¶

Called when a pseudo element is removed from an element.

`PseudoType` ¶

Bases: str, enum.Enum

Pseudo element type.

`Quad` `dataclass` ¶

An array of quad vertices, x immediately followed by y for each point, points clock-wise.

`RGBA` `dataclass` ¶

A structure holding an RGBA color.

`Rect` `dataclass` ¶

Rectangle.

`SetChildNodes` `dataclass` ¶

Fired when backend wants to provide client with the missing DOM structure.

This happens upon most of the calls requesting node ids.

`ShadowRootPopped` `dataclass` ¶

Called when shadow root is popped from the element.

`ShadowRootPushed` `dataclass` ¶

Called when shadow root is pushed into the element.

`ShadowRootType` ¶

Bases: str, enum.Enum

Shadow root type.

`ShapeOutsideInfo` `dataclass` ¶

CSS Shape Outside details.

`TopLayerElementsUpdated` `dataclass` ¶

Called when top layer elements are changed.

`collect_class_names_from_subtree()` `async` ¶

Collects class names for the node with given id and all of it's child nodes.

noqa¶

`copy_to()` `async` ¶

Creates a deep copy of the specified node and places it into the target container before the given anchor.

noqa¶

`describe_node()` `async` ¶

Describes node given its id, does not require domain to be enabled.

Does not start tracking any objects, can be used for automation. # noqa

`disable()` `async` ¶

Disables DOM agent for the given page.

noqa¶

`discard_search_results()` `async` ¶

Discards search results from the session with the given id.

getSearchResults should no longer be called for that search. # noqa

`enable()` `async` ¶

Enables DOM agent for the given page.

noqa¶

`focus()` `async` ¶

Focuses the given element.

noqa¶

`get_attributes()` `async` ¶

Returns attributes for the specified node.

noqa¶

`get_box_model()` `async` ¶

Returns boxes for the given node.

noqa¶

`get_container_for_node()` `async` ¶

Returns the query container of the given node based on container query conditions: containerName, physical, and logical axes. If no axes are provided, the style container is returned, which is the direct parent or the closest element with a matching container-name. # noqa

`get_content_quads()` `async` ¶

Returns quads that describe node position on the page.

This method might return multiple quads for inline nodes. # noqa

`get_document()` `async` ¶

Returns the root DOM node (and optionally the subtree) to the caller.

Implicitly enables the DOM domain events for the current target. # noqa

`get_file_info()` `async` ¶

Returns file information for the given File wrapper.

noqa¶

`get_flattened_document()` `async` ¶

Returns the root DOM node (and optionally the subtree) to the caller.

Deprecated, as it is not designed to work well with the rest of the DOM agent. Use DOMSnapshot.captureSnapshot instead. # noqa

`get_frame_owner()` `async` ¶

Returns iframe node that owns iframe with the given domain.

noqa¶

`get_node_for_location()` `async` ¶

Returns node id at given location.

Depending on whether DOM domain is enabled, nodeId is either returned or not. # noqa

`get_node_stack_traces()` `async` ¶

Gets stack traces associated with a Node.

As of now, only provides stack trace for Node creation. # noqa

`get_nodes_for_subtree_by_style()` `async` ¶

Finds nodes with a given computed style in a subtree.

noqa¶

`get_outer_html()` `async` ¶

Returns node's HTML markup.

noqa¶

`get_querying_descendants_for_container()` `async` ¶

Returns the descendants of a container query container that have container queries against this container.

noqa¶

`get_relayout_boundary()` `async` ¶

Returns the id of the nearest ancestor that is a relayout boundary.

noqa¶

`get_search_results()` `async` ¶

Returns search results from given fromIndex to given toIndex from the search with the given identifier.

noqa¶

`get_top_layer_elements()` `async` ¶

Returns NodeIds of current top layer elements.

Top layer is rendered closest to the user within a viewport, therefore its elements always appear on top of all other content. # noqa

`hide_highlight()` `async` ¶

Hides any highlight.

noqa¶

`highlight_node()` `async` ¶

Highlights DOM node.

noqa¶

`highlight_rect()` `async` ¶

Highlights given rectangle.

noqa¶

`mark_undoable_state()` `async` ¶

Marks last undoable state.

noqa¶

`move_to()` `async` ¶

Moves node into the new container, places it before the given anchor.

noqa¶

`perform_search()` `async` ¶

Searches for a given string in the DOM tree.

Use getSearchResults to access search results or cancelSearch to end this search session. # noqa

`push_node_by_path_to_frontend()` `async` ¶

Requests that the node is sent to the caller given its path.

// FIXME, use XPath # noqa

`push_nodes_by_backend_ids_to_frontend()` `async` ¶

Requests that a batch of nodes is sent to the caller given their backend node ids.

noqa¶

`query_selector()` `async` ¶

Executes querySelector on a given node.

noqa¶

`query_selector_all()` `async` ¶

Executes querySelectorAll on a given node.

noqa¶

`redo()` `async` ¶

Re-does the last undone action.

noqa¶

`remove_attribute()` `async` ¶

Removes attribute with given name from an element with given id.

noqa¶

`remove_node()` `async` ¶

Removes node with given id.

noqa¶

`request_child_nodes()` `async` ¶

Requests that children of the node with given id are returned to the caller in form of setChildNodes events where not only immediate children are retrieved, but all children down to the specified depth.

noqa¶

`request_node()` `async` ¶

Requests that the node is sent to the caller given the JavaScript node object reference.

All nodes that form the path from the node to the root are also sent to the client as a series of setChildNodes notifications. # noqa

`resolve_node()` `async` ¶

Resolves the JavaScript node object for a given NodeId or BackendNodeId.

noqa¶

`scroll_into_view_if_needed()` `async` ¶

Scrolls the specified rect of the given node into view if not already visible.

Note: exactly one between nodeId, backendNodeId and objectId should be passed to identify the node. # noqa

`set_attribute_value()` `async` ¶

Sets attribute for an element with given id.

noqa¶

`set_attributes_as_text()` `async` ¶

Sets attributes on element with given id.

This method is useful when user edits some existing attribute value and types in several attribute name/value pairs.

noqa¶

`set_file_input_files()` `async` ¶

Sets files for the given file input element.

noqa¶

`set_inspected_node()` `async` ¶

Enables console to refer to the node with given id via $x (see Command Line API for more details.

$x functions). # noqa

`set_node_name()` `async` ¶

Sets node name for a node with given id.

noqa¶

`set_node_stack_traces_enabled()` `async` ¶

Sets if stack traces should be captured for Nodes.

See Node.getNodeStackTraces. Default is disabled. # noqa

`set_node_value()` `async` ¶

Sets node value for a node with given id.

noqa¶

`set_outer_html()` `async` ¶

Sets node HTML markup, returns new node id.

noqa¶

`undo()` `async` ¶

Undoes the last performed action.

noqa¶

`dom_debugger` ¶

`CSPViolationType` ¶

Bases: str, enum.Enum

CSP Violation type.

`DOMBreakpointType` ¶

Bases: str, enum.Enum

DOM breakpoint type.

`EventListener` `dataclass` ¶

Object event listener.

`get_event_listeners()` `async` ¶

Returns event listeners of the given object.

noqa¶

`remove_dom_breakpoint()` `async` ¶

Removes DOM breakpoint that was set using setDOMBreakpoint.

noqa¶

`remove_event_listener_breakpoint()` `async` ¶

Removes breakpoint on particular DOM event.

noqa¶

`remove_instrumentation_breakpoint()` `async` ¶

Removes breakpoint on particular native event.

noqa¶

`remove_xhr_breakpoint()` `async` ¶

Removes breakpoint from XMLHttpRequest.

noqa¶

`set_break_on_csp_violation()` `async` ¶

Sets breakpoint on particular CSP violations.

noqa¶

`set_dom_breakpoint()` `async` ¶

Sets breakpoint on particular operation with DOM.

noqa¶

`set_event_listener_breakpoint()` `async` ¶

Sets breakpoint on particular DOM event.

noqa¶

`set_instrumentation_breakpoint()` `async` ¶

Sets breakpoint on particular native event.

noqa¶

`set_xhr_breakpoint()` `async` ¶

Sets breakpoint on XMLHttpRequest.

noqa¶

`dom_snapshot` ¶

`ArrayOfStrings` `dataclass` ¶

Index of the string in the strings table.

`ComputedStyle` `dataclass` ¶

A subset of the full ComputedStyle as defined by the request whitelist.

`DOMNode` `dataclass` ¶

A Node in the DOM tree.

`DocumentSnapshot` `dataclass` ¶

Document snapshot.

`InlineTextBox` `dataclass` ¶

Details of post layout rendered text positions.

The exact layout should not be regarded as stable and may change between versions.

`LayoutTreeNode` `dataclass` ¶

Details of an element in the DOM tree with a LayoutObject.

`LayoutTreeSnapshot` `dataclass` ¶

Table of details of an element in the DOM tree with a LayoutObject.

`NameValue` `dataclass` ¶

A name/value pair.

`NodeTreeSnapshot` `dataclass` ¶

Table containing nodes.

`RareBooleanData` `dataclass` ¶

Description is missing from the devtools protocol document.

`RareIntegerData` `dataclass` ¶

Description is missing from the devtools protocol document.

`RareStringData` `dataclass` ¶

Data that is only present on rare nodes.

`Rectangle` `dataclass` ¶

Description is missing from the devtools protocol document.

`StringIndex` ¶

Bases: int

Index of the string in the strings table.

`TextBoxSnapshot` `dataclass` ¶

Table of details of the post layout rendered text positions.

The exact layout should not be regarded as stable and may change between versions.

`capture_snapshot()` `async` ¶

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.

Shadow DOM in the returned DOM tree is flattened. # noqa

`disable()` `async` ¶

Disables DOM snapshot agent for the given page.

noqa¶

`enable()` `async` ¶

Enables DOM snapshot agent for the given page.

noqa¶

`get_snapshot()` `async` ¶

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.

Shadow DOM in the returned DOM tree is flattened. # noqa

`dom_storage` ¶

`DomStorageItemAdded` `dataclass` ¶

Description is missing from the devtools protocol document.

`DomStorageItemRemoved` `dataclass` ¶

Description is missing from the devtools protocol document.

`DomStorageItemUpdated` `dataclass` ¶

Description is missing from the devtools protocol document.

`DomStorageItemsCleared` `dataclass` ¶

Description is missing from the devtools protocol document.

`Item` `dataclass` ¶

DOM Storage item.

`SerializedStorageKey` ¶

Bases: str

Description is missing from the devtools protocol document.

`StorageId` `dataclass` ¶

DOM Storage identifier.

`clear()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`disable()` `async` ¶

Disables storage tracking, prevents storage events from being sent to the client.

noqa¶

`enable()` `async` ¶

Enables storage tracking, storage events will now be delivered to the client.

noqa¶

`get_dom_storage_items()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`remove_dom_storage_item()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_dom_storage_item()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`emulation` ¶

`DisabledImageType` ¶

Bases: str, enum.Enum

Enum of image types that can be disabled.

`DisplayFeature` `dataclass` ¶

Description is missing from the devtools protocol document.

`MediaFeature` `dataclass` ¶

Description is missing from the devtools protocol document.

`ScreenOrientation` `dataclass` ¶

Screen orientation.

`UserAgentBrandVersion` `dataclass` ¶

Used to specify User Agent Cient Hints to emulate.

See https://wicg.github.io/ua-client-hints

`UserAgentMetadata` `dataclass` ¶

Used to specify User Agent Cient Hints to emulate.

See https://wicg.github.io/ua-client-hints Missing optional values will be filled in by the target with what it would normally use.

`VirtualTimeBudgetExpired` `dataclass` ¶

Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.

`VirtualTimePolicy` ¶

Bases: str, enum.Enum

advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to allow the next delayed task (if any) to run; pause: The virtual time base may not advance; pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending resource fetches.

`can_emulate()` `async` ¶

Tells whether emulation is supported.

noqa¶

`clear_device_metrics_override()` `async` ¶

Clears the overridden device metrics.

noqa¶

`clear_geolocation_override()` `async` ¶

Clears the overridden Geolocation Position and Error.

noqa¶

`clear_idle_override()` `async` ¶

Clears Idle state overrides.

noqa¶

`reset_page_scale_factor()` `async` ¶

Requests that page scale factor is reset to initial values.

noqa¶

`set_auto_dark_mode_override()` `async` ¶

Automatically render all web contents using a dark theme.

noqa¶

`set_automation_override()` `async` ¶

Allows overriding the automation flag.

noqa¶

`set_cpu_throttling_rate()` `async` ¶

Enables CPU throttling to emulate slow CPUs.

noqa¶

`set_default_background_color_override()` `async` ¶

Sets or clears an override of the default background color of the frame.

This override is used if the content does not specify one. # noqa

`set_device_metrics_override()` `async` ¶

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

noqa¶

`set_disabled_image_types()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_document_cookie_disabled()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_emit_touch_events_for_mouse()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_emulated_media()` `async` ¶

Emulates the given media type or media feature for CSS media queries.

noqa¶

`set_emulated_vision_deficiency()` `async` ¶

Emulates the given vision deficiency.

noqa¶

`set_focus_emulation_enabled()` `async` ¶

Enables or disables simulating a focused and active page.

noqa¶

`set_geolocation_override()` `async` ¶

Overrides the Geolocation Position or Error.

Omitting any of the parameters emulates position unavailable. # noqa

`set_hardware_concurrency_override()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_idle_override()` `async` ¶

Overrides the Idle state.

noqa¶

`set_locale_override()` `async` ¶

Overrides default host system locale with the specified one.

noqa¶

`set_navigator_overrides()` `async` ¶

Overrides value returned by the javascript navigator object.

noqa¶

`set_page_scale_factor()` `async` ¶

Sets a specified page scale factor.

noqa¶

`set_script_execution_disabled()` `async` ¶

Switches script execution in the page.

noqa¶

`set_scrollbars_hidden()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_timezone_override()` `async` ¶

Overrides default host system timezone with the specified one.

noqa¶

`set_touch_emulation_enabled()` `async` ¶

Enables touch on platforms which do not support them.

noqa¶

`set_user_agent_override()` `async` ¶

Allows overriding user agent with the given string.

noqa¶

`set_virtual_time_policy()` `async` ¶

Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy.

Note this supersedes any previous time budget. # noqa

`set_visible_size()` `async` ¶

Resizes the frame/viewport of the page.

Note that this does not affect the frame's container (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported on Android. # noqa

`event_breakpoints` ¶

`remove_instrumentation_breakpoint()` `async` ¶

Removes breakpoint on particular native event.

noqa¶

`set_instrumentation_breakpoint()` `async` ¶

Sets breakpoint on particular native event.

noqa¶

`fed_cm` ¶

`Account` `dataclass` ¶

Corresponds to IdentityRequestAccount.

`DialogShown` `dataclass` ¶

Description is missing from the devtools protocol document.

`LoginState` ¶

Bases: str, enum.Enum

Whether this is a sign-up or sign-in action for this account, i.e. whether this account has ever been used to sign in to this RP before.

`disable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`dismiss_dialog()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`enable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`reset_cooldown()` `async` ¶

Resets the cooldown time, if any, to allow the next FedCM call to show a dialog even if one was recently dismissed by the user.

noqa¶

`select_account()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`fetch` ¶

`AuthChallenge` `dataclass` ¶

Authorization challenge for HTTP status code 401 or 407.

`AuthChallengeResponse` `dataclass` ¶

Response to an AuthChallenge.

`AuthRequired` `dataclass` ¶

Issued when the domain is enabled with handleAuthRequests set to true.

The request is paused until client responds with continueWithAuth.

`HeaderEntry` `dataclass` ¶

Response HTTP header entry.

`RequestId` ¶

Bases: str

Unique request identifier.

`RequestPattern` `dataclass` ¶

Description is missing from the devtools protocol document.

`RequestPaused` `dataclass` ¶

Issued when the domain is enabled and the request URL matches the specified filter.

The request is paused until the client responds with one of continueRequest, failRequest or fulfillRequest. The stage of the request can be determined by presence of responseErrorReason and responseStatusCode -- the request is at the response stage if either of these fields is present and in the request stage otherwise.

`RequestStage` ¶

Bases: str, enum.Enum

Stages of the request to handle.

Request will intercept before the request is sent. Response will intercept after the response is received (but before response body is received).

`continue_request()` `async` ¶

Continues the request, optionally modifying some of its parameters.

noqa¶

`continue_response()` `async` ¶

Continues loading of the paused response, optionally modifying the response headers.

If either responseCode or headers are modified, all of them must be present. # noqa

`continue_with_auth()` `async` ¶

Continues a request supplying authChallengeResponse following authRequired event.

noqa¶

`disable()` `async` ¶

Disables the fetch domain.

noqa¶

`enable()` `async` ¶

Enables issuing of requestPaused events.

A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.

noqa¶

`fail_request()` `async` ¶

Causes the request to fail with specified reason.

noqa¶

`fulfill_request()` `async` ¶

Provides response to the request.

noqa¶

`get_response_body()` `async` ¶

Causes the body of the response to be received from the server and returned as a single string.

May only be issued for a request that is paused in the Response stage and is mutually exclusive with takeResponseBodyForInterceptionAsStream. Calling other methods that affect the request or disabling fetch domain before body is received results in an undefined behavior. # noqa

`take_response_body_as_stream()` `async` ¶

Returns a handle to the stream representing the response body.

The request must be paused in the HeadersReceived stage. Note that after this command the request can't be continued as is -- client either needs to cancel it or to provide the response body. The stream only supports sequential read, IO.read will fail if the position is specified. This method is mutually exclusive with getResponseBody. Calling other methods that affect the request or disabling fetch domain before body is received results in an undefined behavior. # noqa

`headless_experimental` ¶

`ScreenshotParams` `dataclass` ¶

Encoding options for a screenshot.

`begin_frame()` `async` ¶

Sends a BeginFrame to the target and returns when the frame was completed.

Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gle/chrome-headless-rendering for more background. # noqa

`disable()` `async` ¶

Disables headless events for the target.

noqa¶

`enable()` `async` ¶

Enables headless events for the target.

noqa¶

`heap_profiler` ¶

`AddHeapSnapshotChunk` `dataclass` ¶

Description is missing from the devtools protocol document.

`HeapSnapshotObjectId` ¶

Bases: str

Heap snapshot object id.

`HeapStatsUpdate` `dataclass` ¶

If heap objects tracking has been started then backend may send update for one or more fragments.

`LastSeenObjectId` `dataclass` ¶

If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp.

If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.

`ReportHeapSnapshotProgress` `dataclass` ¶

Description is missing from the devtools protocol document.

`ResetProfiles` `dataclass` ¶

Description is missing from the devtools protocol document.

`SamplingHeapProfile` `dataclass` ¶

Sampling profile.

`SamplingHeapProfileNode` `dataclass` ¶

Sampling Heap Profile node.

Holds callsite information, allocation statistics and child nodes.

`SamplingHeapProfileSample` `dataclass` ¶

A single sample from a sampling profile.

`add_inspected_heap_object()` `async` ¶

Enables console to refer to the node with given id via $x (see Command Line API for more details.

$x functions). # noqa

`collect_garbage()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`disable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`enable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_heap_object_id()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_object_by_heap_object_id()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_sampling_profile()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`start_sampling()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`start_tracking_heap_objects()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`stop_sampling()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`stop_tracking_heap_objects()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`take_heap_snapshot()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`indexed_db` ¶

`DataEntry` `dataclass` ¶

Data entry.

`DatabaseWithObjectStores` `dataclass` ¶

Database with an array of object stores.

`Key` `dataclass` ¶

Key.

`KeyPath` `dataclass` ¶

Key path.

`KeyRange` `dataclass` ¶

Key range.

`ObjectStore` `dataclass` ¶

Object store.

`ObjectStoreIndex` `dataclass` ¶

Object store index.

`clear_object_store()` `async` ¶

Clears all entries from an object store.

noqa¶

`delete_database()` `async` ¶

Deletes a database.

noqa¶

`delete_object_store_entries()` `async` ¶

Delete a range of entries from an object store # noqa.

`disable()` `async` ¶

Disables events from backend.

noqa¶

`enable()` `async` ¶

Enables events from backend.

noqa¶

`get_metadata()` `async` ¶

Gets metadata of an object store.

noqa¶

`request_data()` `async` ¶

Requests data from object store or index.

noqa¶

`request_database()` `async` ¶

Requests database with given name in given frame.

noqa¶

`request_database_names()` `async` ¶

Requests database names for given security origin.

noqa¶

`input` ¶

`DragData` `dataclass` ¶

Description is missing from the devtools protocol document.

`DragDataItem` `dataclass` ¶

Description is missing from the devtools protocol document.

`DragIntercepted` `dataclass` ¶

Emitted only when Input.setInterceptDrags is enabled.

Use this data with Input.dispatchDragEvent to restore normal drag and drop behavior.

`GestureSourceType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`MouseButton` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`TimeSinceEpoch` ¶

Bases: float

UTC time in seconds, counted from January 1, 1970.

`TouchPoint` `dataclass` ¶

Description is missing from the devtools protocol document.

`dispatch_drag_event()` `async` ¶

Dispatches a drag event into the page.

noqa¶

`dispatch_key_event()` `async` ¶

Dispatches a key event to the page.

noqa¶

`dispatch_mouse_event()` `async` ¶

Dispatches a mouse event to the page.

noqa¶

`dispatch_touch_event()` `async` ¶

Dispatches a touch event to the page.

noqa¶

`emulate_touch_from_mouse_event()` `async` ¶

Emulates touch event from the mouse event parameters.

noqa¶

`ime_set_composition()` `async` ¶

This method sets the current candidate text for ime.

Use imeCommitComposition to commit the final text. Use imeSetComposition with empty string as text to cancel composition. # noqa

`insert_text()` `async` ¶

This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.

noqa¶

`set_ignore_input_events()` `async` ¶

Ignores input events (useful while auditing page).

noqa¶

`set_intercept_drags()` `async` ¶

Prevents default drag and drop behavior and instead emits Input.dragIntercepted events.

Drag and drop behavior can be directly controlled via Input.dispatchDragEvent. # noqa

`synthesize_pinch_gesture()` `async` ¶

Synthesizes a pinch gesture over a time period by issuing appropriate touch events.

noqa¶

`synthesize_scroll_gesture()` `async` ¶

Synthesizes a scroll gesture over a time period by issuing appropriate touch events.

noqa¶

`synthesize_tap_gesture()` `async` ¶

Synthesizes a tap gesture over a time period by issuing appropriate touch events.

noqa¶

`inspector` ¶

`Detached` `dataclass` ¶

Fired when remote debugging connection is about to be terminated.

Contains detach reason.

`TargetCrashed` `dataclass` ¶

Fired when debugging target has crashed.

`TargetReloadedAfterCrash` `dataclass` ¶

Fired when debugging target has reloaded after crash.

`disable()` `async` ¶

Disables inspector domain notifications.

noqa¶

`enable()` `async` ¶

Enables inspector domain notifications.

noqa¶

`io` ¶

`StreamHandle` ¶

Bases: str

This is either obtained from another method or specified as blob:<uuid> where <uuid&gt is an UUID of a Blob.

`close()` `async` ¶

Close the stream, discard any temporary backing storage.

noqa¶

`read()` `async` ¶

Read a chunk of the stream # noqa.

`resolve_blob()` `async` ¶

Return UUID of Blob object specified by a remote object id.

noqa¶

`layer_tree` ¶

`Layer` `dataclass` ¶

Information about a compositing layer.

`LayerId` ¶

Bases: str

Unique Layer identifier.

`LayerPainted` `dataclass` ¶

Description is missing from the devtools protocol document.

`LayerTreeDidChange` `dataclass` ¶

Description is missing from the devtools protocol document.

`PaintProfile` `dataclass` ¶

Array of timings, one per paint step.

`PictureTile` `dataclass` ¶

Serialized fragment of layer picture along with its offset within the layer.

`ScrollRect` `dataclass` ¶

Rectangle where scrolling happens on the main thread.

`SnapshotId` ¶

Bases: str

Unique snapshot identifier.

`StickyPositionConstraint` `dataclass` ¶

Sticky position constraints.

`compositing_reasons()` `async` ¶

Provides the reasons why the given layer was composited.

noqa¶

`disable()` `async` ¶

Disables compositing tree inspection.

noqa¶

`enable()` `async` ¶

Enables compositing tree inspection.

noqa¶

`load_snapshot()` `async` ¶

Returns the snapshot identifier.

noqa¶

`make_snapshot()` `async` ¶

Returns the layer snapshot identifier.

noqa¶

`profile_snapshot()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`release_snapshot()` `async` ¶

Releases layer snapshot captured by the back-end.

noqa¶

`replay_snapshot()` `async` ¶

Replays the layer snapshot and returns the resulting bitmap.

noqa¶

`snapshot_command_log()` `async` ¶

Replays the layer snapshot and returns canvas log.

noqa¶

`log` ¶

`EntryAdded` `dataclass` ¶

Issued when new message was logged.

`LogEntry` `dataclass` ¶

Log entry.

`ViolationSetting` `dataclass` ¶

Violation configuration setting.

`clear()` `async` ¶

Clears the log.

noqa¶

`disable()` `async` ¶

Disables log domain, prevents further log entries from being reported to the client.

noqa¶

`enable()` `async` ¶

Enables log domain, sends the entries collected so far to the client by means of the entryAdded notification.

noqa¶

`start_violations_report()` `async` ¶

start violation reporting.

noqa¶

`stop_violations_report()` `async` ¶

Stop violation reporting.

noqa¶

`media` ¶

`PlayerError` `dataclass` ¶

Corresponds to kMediaError.

`PlayerErrorSourceLocation` `dataclass` ¶

Represents logged source line numbers reported in an error.

NOTE: file and line are from chromium c++ implementation code, not js.

`PlayerErrorsRaised` `dataclass` ¶

Send a list of any errors that need to be delivered.

`PlayerEvent` `dataclass` ¶

Corresponds to kMediaEventTriggered.

`PlayerEventsAdded` `dataclass` ¶

Send events as a list, allowing them to be batched on the browser for less congestion.

If batched, events must ALWAYS be in chronological order.

`PlayerId` ¶

Bases: str

Players will get an ID that is unique within the agent context.

`PlayerMessage` `dataclass` ¶

Have one type per entry in MediaLogRecord::Type Corresponds to kMessage.

`PlayerMessagesLogged` `dataclass` ¶

Send a list of any messages that need to be delivered.

`PlayerPropertiesChanged` `dataclass` ¶

This can be called multiple times, and can be used to set / override / remove player properties.

A null propValue indicates removal.

`PlayerProperty` `dataclass` ¶

Corresponds to kMediaPropertyChange.

`PlayersCreated` `dataclass` ¶

Called whenever a player is created, or when a new agent joins and receives a list of active players.

If an agent is restored, it will receive the full list of player ids and all events again.

`Timestamp` ¶

Bases: float

Description is missing from the devtools protocol document.

`disable()` `async` ¶

Disables the Media domain.

noqa¶

`enable()` `async` ¶

Enables the Media domain # noqa.

`memory` ¶

`Module` `dataclass` ¶

Executable module information.

`PressureLevel` ¶

Bases: str, enum.Enum

Memory pressure level.

`SamplingProfile` `dataclass` ¶

Array of heap profile samples.

`SamplingProfileNode` `dataclass` ¶

Heap profile sample.

`forcibly_purge_java_script_memory()` `async` ¶

Simulate OomIntervention by purging V8 memory.

noqa¶

`get_all_time_sampling_profile()` `async` ¶

Retrieve native memory allocations profile collected since renderer process startup.

noqa¶

`get_browser_sampling_profile()` `async` ¶

Retrieve native memory allocations profile collected since browser process startup.

noqa¶

`get_dom_counters()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_sampling_profile()` `async` ¶

Retrieve native memory allocations profile collected since last startSampling call.

noqa¶

`prepare_for_leak_detection()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_pressure_notifications_suppressed()` `async` ¶

Enable/disable suppressing memory pressure notifications in all processes.

noqa¶

`simulate_pressure_notification()` `async` ¶

Simulate a memory pressure notification in all processes.

noqa¶

`start_sampling()` `async` ¶

Start collecting native memory profile.

noqa¶

`stop_sampling()` `async` ¶

Stop collecting native memory profile.

noqa¶

`network` ¶

`AlternateProtocolUsage` ¶

Bases: str, enum.Enum

The reason why Chrome uses a specific transport protocol for HTTP semantics.

`AuthChallenge` `dataclass` ¶

Authorization challenge for HTTP status code 401 or 407.

`AuthChallengeResponse` `dataclass` ¶

Response to an AuthChallenge.

`BlockedCookieWithReason` `dataclass` ¶

A cookie with was not sent with a request with the corresponding reason.

`BlockedReason` ¶

Bases: str, enum.Enum

The reason why request was blocked.

`BlockedSetCookieWithReason` `dataclass` ¶

A cookie which was not stored from a response with the corresponding reason.

`CachedResource` `dataclass` ¶

Information about the cached resource.

`CertificateTransparencyCompliance` ¶

Bases: str, enum.Enum

Whether the request complied with Certificate Transparency policy.

`ClientSecurityState` `dataclass` ¶

Description is missing from the devtools protocol document.

`ConnectTiming` `dataclass` ¶

Description is missing from the devtools protocol document.

`ConnectionType` ¶

Bases: str, enum.Enum

The underlying connection technology that the browser is supposedly using.

`ContentEncoding` ¶

Bases: str, enum.Enum

List of content encodings supported by the backend.

`Cookie` `dataclass` ¶

Cookie object.

`CookieBlockedReason` ¶

Bases: str, enum.Enum

Types of reasons why a cookie may not be sent with a request.

`CookieParam` `dataclass` ¶

Cookie parameter object.

`CookiePriority` ¶

Bases: str, enum.Enum

Represents the cookie's 'Priority' status:

https://tools.ietf.org/html/draft-west-cookie-priority-00

`CookieSameSite` ¶

Bases: str, enum.Enum

Represents the cookie's 'SameSite' status:

https://tools.ietf.org/html/draft-west-first-party-cookies

`CookieSourceScheme` ¶

Bases: str, enum.Enum

Represents the source scheme of the origin that originally set the cookie.

A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme. This is a temporary ability and it will be removed in the future.

`CorsError` ¶

Bases: str, enum.Enum

The reason why request was blocked.

`CorsErrorStatus` `dataclass` ¶

Description is missing from the devtools protocol document.

`CrossOriginEmbedderPolicyStatus` `dataclass` ¶

Description is missing from the devtools protocol document.

`CrossOriginEmbedderPolicyValue` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`CrossOriginOpenerPolicyStatus` `dataclass` ¶

Description is missing from the devtools protocol document.

`CrossOriginOpenerPolicyValue` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`DataReceived` `dataclass` ¶

Fired when data chunk was received over the network.

`ErrorReason` ¶

Bases: str, enum.Enum

Network level fetch failure reason.

`EventSourceMessageReceived` `dataclass` ¶

Fired when EventSource message is received.

`Headers` `dataclass` ¶

Request / response headers as keys / values of JSON object.

`IPAddressSpace` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`Initiator` `dataclass` ¶

Information about the request initiator.

`InterceptionId` ¶

Bases: str

Unique intercepted request identifier.

`InterceptionStage` ¶

Bases: str, enum.Enum

Stages of the interception to begin intercepting.

Request will intercept before the request is sent. Response will intercept after the response is received.

`LoadNetworkResourceOptions` `dataclass` ¶

An options object that may be extended later to better support CORS, CORB and streaming.

`LoadNetworkResourcePageResult` `dataclass` ¶

An object providing the result of a network resource load.

`LoaderId` ¶

Bases: str

Unique loader identifier.

`LoadingFailed` `dataclass` ¶

Fired when HTTP request has failed to load.

`LoadingFinished` `dataclass` ¶

Fired when HTTP request has finished loading.

`MonotonicTime` ¶

Bases: float

Monotonically increasing time in seconds since an arbitrary point in the past.

`PostDataEntry` `dataclass` ¶

Post data entry for HTTP request.

`PrivateNetworkRequestPolicy` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`ReportId` ¶

Bases: str

Description is missing from the devtools protocol document.

`ReportStatus` ¶

Bases: str, enum.Enum

The status of a Reporting API report.

`ReportingApiEndpoint` `dataclass` ¶

Description is missing from the devtools protocol document.

`ReportingApiEndpointsChangedForOrigin` `dataclass` ¶

Description is missing from the devtools protocol document.

`ReportingApiReport` `dataclass` ¶

An object representing a report generated by the Reporting API.

`ReportingApiReportAdded` `dataclass` ¶

Is sent whenever a new report is added.

And after 'enableReportingApi' for all existing reports.

`ReportingApiReportUpdated` `dataclass` ¶

Description is missing from the devtools protocol document.

`Request` `dataclass` ¶

HTTP request data.

`RequestId` ¶

Bases: str

Unique request identifier.

`RequestIntercepted` `dataclass` ¶

Details of an intercepted HTTP request, which must be either allowed, blocked, modified or mocked.

Deprecated, use Fetch.requestPaused instead.

`RequestPattern` `dataclass` ¶

Request pattern for interception.

`RequestServedFromCache` `dataclass` ¶

Fired if request ended up loading from cache.

`RequestWillBeSent` `dataclass` ¶

Fired when page is about to send HTTP request.

`RequestWillBeSentExtraInfo` `dataclass` ¶

Fired when additional information about a requestWillBeSent event is available from the network stack.

Not every requestWillBeSent event will have an additional requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent or requestWillBeSentExtraInfo will be fired first for the same request.

`ResourceChangedPriority` `dataclass` ¶

Fired when resource loading priority is changed.

`ResourcePriority` ¶

Bases: str, enum.Enum

Loading priority of a resource request.

`ResourceTiming` `dataclass` ¶

Timing information for the request.

`ResourceType` ¶

Bases: str, enum.Enum

Resource type as it was perceived by the rendering engine.

`Response` `dataclass` ¶

HTTP response data.

`ResponseReceived` `dataclass` ¶

Fired when HTTP response is available.

`ResponseReceivedExtraInfo` `dataclass` ¶

Fired when additional information about a responseReceived event is available from the network stack.

Not every responseReceived event will have an additional responseReceivedExtraInfo for it, and responseReceivedExtraInfo may be fired before or after responseReceived.

`SecurityDetails` `dataclass` ¶

Security details about a request.

`SecurityIsolationStatus` `dataclass` ¶

Description is missing from the devtools protocol document.

`ServiceWorkerResponseSource` ¶

Bases: str, enum.Enum

Source of serviceworker response.

`SetCookieBlockedReason` ¶

Bases: str, enum.Enum

Types of reasons why a cookie may not be stored from a response.

`SignedCertificateTimestamp` `dataclass` ¶

Details of a signed certificate timestamp (SCT).

`SignedExchangeError` `dataclass` ¶

Information about a signed exchange response.

`SignedExchangeErrorField` ¶

Bases: str, enum.Enum

Field type for a signed exchange related error.

`SignedExchangeHeader` `dataclass` ¶

Information about a signed exchange header.

https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation

`SignedExchangeInfo` `dataclass` ¶

Information about a signed exchange response.

`SignedExchangeReceived` `dataclass` ¶

Fired when a signed exchange was received over the network.

`SignedExchangeSignature` `dataclass` ¶

Information about a signed exchange signature.

https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1

`SubresourceWebBundleInnerResponseError` `dataclass` ¶

Fired when request for resources within a .wbn file failed.

`SubresourceWebBundleInnerResponseParsed` `dataclass` ¶

Fired when handling requests for resources within a .wbn file.

Note: this will only be fired for resources that are requested by the webpage.

`SubresourceWebBundleMetadataError` `dataclass` ¶

Fired once when parsing the .wbn file has failed.

`SubresourceWebBundleMetadataReceived` `dataclass` ¶

Fired once when parsing the .wbn file has succeeded.

The event contains the information about the web bundle contents.

`TimeSinceEpoch` ¶

Bases: float

UTC time in seconds, counted from January 1, 1970.

`TrustTokenOperationDone` `dataclass` ¶

Fired exactly once for each Trust Token operation.

Depending on the type of the operation and whether the operation succeeded or failed, the event is fired before the corresponding request was sent or after the response was received.

`TrustTokenOperationType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`TrustTokenParams` `dataclass` ¶

Determines what type of Trust Token operation is executed and depending on the type, some additional parameters.

The values are specified in third_party/blink/renderer/core/fetch/trust_token.idl.

`WebSocketClosed` `dataclass` ¶

Fired when WebSocket is closed.

`WebSocketCreated` `dataclass` ¶

Fired upon WebSocket creation.

`WebSocketFrame` `dataclass` ¶

WebSocket message data.

This represents an entire WebSocket message, not just a fragmented frame as the name suggests.

`WebSocketFrameError` `dataclass` ¶

Fired when WebSocket message error occurs.

`WebSocketFrameReceived` `dataclass` ¶

Fired when WebSocket message is received.

`WebSocketFrameSent` `dataclass` ¶

Fired when WebSocket message is sent.

`WebSocketHandshakeResponseReceived` `dataclass` ¶

Fired when WebSocket handshake response becomes available.

`WebSocketRequest` `dataclass` ¶

WebSocket request data.

`WebSocketResponse` `dataclass` ¶

WebSocket response data.

`WebSocketWillSendHandshakeRequest` `dataclass` ¶

Fired when WebSocket is about to initiate handshake.

`WebTransportClosed` `dataclass` ¶

Fired when WebTransport is disposed.

`WebTransportConnectionEstablished` `dataclass` ¶

Fired when WebTransport handshake is finished.

`WebTransportCreated` `dataclass` ¶

Fired upon WebTransport creation.

`can_clear_browser_cache()` `async` ¶

Tells whether clearing browser cache is supported.

noqa¶

`can_clear_browser_cookies()` `async` ¶

Tells whether clearing browser cookies is supported.

noqa¶

`can_emulate_network_conditions()` `async` ¶

Tells whether emulation of network conditions is supported.

noqa¶

`clear_accepted_encodings_override()` `async` ¶

Clears accepted encodings set by setAcceptedEncodings # noqa.

`clear_browser_cache()` `async` ¶

Clears browser cache.

noqa¶

`clear_browser_cookies()` `async` ¶

Clears browser cookies.

noqa¶

`continue_intercepted_request()` `async` ¶

Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes.

If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId. Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead. # noqa

`delete_cookies()` `async` ¶

Deletes browser cookies with matching name and url or domain/path pair.

noqa¶

`disable()` `async` ¶

Disables network tracking, prevents network events from being sent to the client.

noqa¶

`emulate_network_conditions()` `async` ¶

Activates emulation of network conditions.

noqa¶

`enable()` `async` ¶

Enables network tracking, network events will now be delivered to the client.

noqa¶

`enable_reporting_api()` `async` ¶

Enables tracking for the Reporting API, events generated by the Reporting API will now be delivered to the client.

Enabling triggers 'reportingApiReportAdded' for all existing reports. # noqa

`get_all_cookies()` `async` ¶

Returns all browser cookies.

Depending on the backend support, will return detailed cookie information in the cookies field. Deprecated. Use Storage.getCookies instead. # noqa

`get_certificate()` `async` ¶

Returns the DER-encoded certificate.

noqa¶

`get_cookies()` `async` ¶

Returns all browser cookies for the current URL.

Depending on the backend support, will return detailed cookie information in the cookies field. # noqa

`get_request_post_data()` `async` ¶

Returns post data sent with the request.

Returns an error when no data was sent with the request. # noqa

`get_response_body()` `async` ¶

Returns content served for the given request.

noqa¶

`get_response_body_for_interception()` `async` ¶

Returns content served for the given currently intercepted request.

noqa¶

`get_security_isolation_status()` `async` ¶

Returns information about the COEP/COOP isolation status.

noqa¶

`load_network_resource()` `async` ¶

Fetches the resource and returns the content.

noqa¶

`replay_xhr()` `async` ¶

This method sends a new XMLHttpRequest which is identical to the original one.

The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password. # noqa

`search_in_response_body()` `async` ¶

Searches for given string in response content.

noqa¶

`set_accepted_encodings()` `async` ¶

Sets a list of content encodings that will be accepted.

Empty list means no encoding is accepted. # noqa

`set_attach_debug_stack()` `async` ¶

Specifies whether to attach a page script stack id in requests # noqa.

`set_blocked_ur_ls()` `async` ¶

Blocks URLs from loading.

noqa¶

`set_bypass_service_worker()` `async` ¶

Toggles ignoring of service worker for each request.

noqa¶

`set_cache_disabled()` `async` ¶

Toggles ignoring cache for each request.

If true, cache will not be used. # noqa

`set_cookie()` `async` ¶

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

noqa¶

`set_cookies()` `async` ¶

Sets given cookies.

noqa¶

`set_extra_http_headers()` `async` ¶

Specifies whether to always send extra HTTP headers with the requests from this page.

noqa¶

`set_request_interception()` `async` ¶

Sets the requests to intercept that match the provided patterns and optionally resource types.

Deprecated, please use Fetch.enable instead. # noqa

`set_user_agent_override()` `async` ¶

Allows overriding user agent with the given string.

noqa¶

`take_response_body_for_interception_as_stream()` `async` ¶

Returns a handle to the stream representing the response body.

Note that after this command, the intercepted request can't be continued as is -- you either need to cancel it or to provide the response body. The stream only supports sequential read, IO.read will fail if the position is specified.

noqa¶

`overlay` ¶

`BoxStyle` `dataclass` ¶

Style information for drawing a box.

`ColorFormat` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`ContainerQueryContainerHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`ContainerQueryHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`ContrastAlgorithm` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`FlexContainerHighlightConfig` `dataclass` ¶

Configuration data for the highlighting of Flex container elements.

`FlexItemHighlightConfig` `dataclass` ¶

Configuration data for the highlighting of Flex item elements.

`FlexNodeHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`GridHighlightConfig` `dataclass` ¶

Configuration data for the highlighting of Grid elements.

`GridNodeHighlightConfig` `dataclass` ¶

Configurations for Persistent Grid Highlight.

`HighlightConfig` `dataclass` ¶

Configuration data for the highlighting of page elements.

`HingeConfig` `dataclass` ¶

Configuration for dual screen hinge.

`InspectMode` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`InspectModeCanceled` `dataclass` ¶

Fired when user cancels the inspect mode.

`InspectNodeRequested` `dataclass` ¶

Fired when the node should be inspected.

This happens after call to setInspectMode or when user manually inspects an element.

`IsolatedElementHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`IsolationModeHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`LineStyle` `dataclass` ¶

Style information for drawing a line.

`NodeHighlightRequested` `dataclass` ¶

Fired when the node should be highlighted.

This happens after call to setInspectMode.

`ScreenshotRequested` `dataclass` ¶

Fired when user asks to capture screenshot of some area on the page.

`ScrollSnapContainerHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`ScrollSnapHighlightConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`SourceOrderConfig` `dataclass` ¶

Configuration data for drawing the source order of an elements children.

`disable()` `async` ¶

Disables domain notifications.

noqa¶

`enable()` `async` ¶

Enables domain notifications.

noqa¶

`get_grid_highlight_objects_for_test()` `async` ¶

For Persistent Grid testing.

noqa¶

`get_highlight_object_for_test()` `async` ¶

For testing.

noqa¶

`get_source_order_highlight_object_for_test()` `async` ¶

For Source Order Viewer testing.

noqa¶

`hide_highlight()` `async` ¶

Hides any highlight.

noqa¶

`highlight_frame()` `async` ¶

Highlights owner element of the frame with given id.

Deprecated: Doesn't work reliablity and cannot be fixed due to process separatation (the owner node might be in a different process). Determine the owner node in the client and use highlightNode. # noqa

`highlight_node()` `async` ¶

Highlights DOM node with given id or with the given JavaScript object wrapper.

Either nodeId or objectId must be specified. # noqa

`highlight_quad()` `async` ¶

Highlights given quad.

Coordinates are absolute with respect to the main frame viewport. # noqa

`highlight_rect()` `async` ¶

Highlights given rectangle.

Coordinates are absolute with respect to the main frame viewport. # noqa

`highlight_source_order()` `async` ¶

Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper.

Either nodeId or objectId must be specified. # noqa

`set_inspect_mode()` `async` ¶

Enters the 'inspect' mode.

In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection. # noqa

`set_paused_in_debugger_message()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_show_ad_highlights()` `async` ¶

Highlights owner element of all frames detected to be ads.

noqa¶

`set_show_container_query_overlays()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_show_debug_borders()` `async` ¶

Requests that backend shows debug borders on layers # noqa.

`set_show_flex_overlays()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_show_fps_counter()` `async` ¶

Requests that backend shows the FPS counter # noqa.

`set_show_grid_overlays()` `async` ¶

Highlight multiple elements with the CSS Grid overlay.

noqa¶

`set_show_hinge()` `async` ¶

Add a dual screen device hinge # noqa.

`set_show_hit_test_borders()` `async` ¶

Deprecated, no longer has any effect.

noqa¶

`set_show_isolated_elements()` `async` ¶

Show elements in isolation mode with overlays.

noqa¶

`set_show_layout_shift_regions()` `async` ¶

Requests that backend shows layout shift regions # noqa.

`set_show_paint_rects()` `async` ¶

Requests that backend shows paint rectangles # noqa.

`set_show_scroll_bottleneck_rects()` `async` ¶

Requests that backend shows scroll bottleneck rects # noqa.

`set_show_scroll_snap_overlays()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_show_viewport_size_on_resize()` `async` ¶

Paints viewport size upon main frame resize.

noqa¶

`set_show_web_vitals()` `async` ¶

Request that backend shows an overlay with web vital metrics.

noqa¶

`page` ¶

`AdFrameExplanation` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`AdFrameStatus` `dataclass` ¶

Indicates whether a frame has been identified as an ad and why.

`AdFrameType` ¶

Bases: str, enum.Enum

Indicates whether a frame has been identified as an ad.

`AdScriptId` `dataclass` ¶

Identifies the bottom-most script which caused the frame to be labelled as an ad.

`AppManifestError` `dataclass` ¶

Error while paring app manifest.

`AppManifestParsedProperties` `dataclass` ¶

Parsed app manifest properties.

`AutoResponseMode` ¶

Bases: str, enum.Enum

Enum of possible auto-reponse for permisison / prompt dialogs.

`BackForwardCacheNotRestoredExplanation` `dataclass` ¶

Description is missing from the devtools protocol document.

`BackForwardCacheNotRestoredExplanationTree` `dataclass` ¶

Description is missing from the devtools protocol document.

`BackForwardCacheNotRestoredReason` ¶

Bases: str, enum.Enum

List of not restored reasons for back-forward cache.

`BackForwardCacheNotRestoredReasonType` ¶

Bases: str, enum.Enum

Types of not restored reasons for back-forward cache.

`BackForwardCacheNotUsed` `dataclass` ¶

Fired for failed bfcache history navigations if BackForwardCache feature is enabled.

Do not assume any ordering with the Page.frameNavigated event. This event is fired only for main-frame history navigation where the document changes (non-same-document navigations), when bfcache navigation fails.

`ClientNavigationDisposition` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`ClientNavigationReason` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`CompilationCacheParams` `dataclass` ¶

Per-script compilation cache parameters for Page.produceCompilationCache

`CompilationCacheProduced` `dataclass` ¶

Issued for every compilation cache generated.

Is only available if Page.setGenerateCompilationCache is enabled.

`CrossOriginIsolatedContextType` ¶

Bases: str, enum.Enum

Indicates whether the frame is cross-origin isolated and why it is the case.

`DialogType` ¶

Bases: str, enum.Enum

Javascript dialog type.

`DocumentOpened` `dataclass` ¶

Fired when opening document to write to.

`DomContentEventFired` `dataclass` ¶

Description is missing from the devtools protocol document.

`DownloadProgress` `dataclass` ¶

Fired when download makes progress.

Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead.

`DownloadWillBegin` `dataclass` ¶

Fired when page is about to start a download.

Deprecated. Use Browser.downloadWillBegin instead.

`FileChooserOpened` `dataclass` ¶

Emitted only when page.interceptFileChooser is enabled.

`FontFamilies` `dataclass` ¶

Generic font families collection.

`FontSizes` `dataclass` ¶

Default font sizes.

`Frame` `dataclass` ¶

Information about the Frame on the page.

`FrameAttached` `dataclass` ¶

Fired when frame has been attached to its parent.

`FrameClearedScheduledNavigation` `dataclass` ¶

Fired when frame no longer has a scheduled navigation.

`FrameDetached` `dataclass` ¶

Fired when frame has been detached from its parent.

`FrameId` ¶

Bases: str

Unique frame identifier.

`FrameNavigated` `dataclass` ¶

Fired once navigation of the frame has completed.

Frame is now associated with the new loader.

`FrameRequestedNavigation` `dataclass` ¶

Fired when a renderer-initiated navigation is requested.

Navigation may still be cancelled after the event is issued.

`FrameResized` `dataclass` ¶

Description is missing from the devtools protocol document.

`FrameResource` `dataclass` ¶

Information about the Resource on the page.

`FrameResourceTree` `dataclass` ¶

Information about the Frame hierarchy along with their cached resources.

`FrameScheduledNavigation` `dataclass` ¶

Fired when frame schedules a potential navigation.

`FrameStartedLoading` `dataclass` ¶

Fired when frame has started loading.

`FrameStoppedLoading` `dataclass` ¶

Fired when frame has stopped loading.

`FrameTree` `dataclass` ¶

Information about the Frame hierarchy.

`GatedAPIFeatures` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`InstallabilityError` `dataclass` ¶

The installability error.

`InstallabilityErrorArgument` `dataclass` ¶

Description is missing from the devtools protocol document.

`InterstitialHidden` `dataclass` ¶

Fired when interstitial page was hidden.

`InterstitialShown` `dataclass` ¶

Fired when interstitial page was shown.

`JavascriptDialogClosed` `dataclass` ¶

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.

`JavascriptDialogOpening` `dataclass` ¶

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.

`LayoutViewport` `dataclass` ¶

Layout viewport position and dimensions.

`LifecycleEvent` `dataclass` ¶

Fired for top level page lifecycle events such as navigation, load, paint, etc.

`LoadEventFired` `dataclass` ¶

Description is missing from the devtools protocol document.

`NavigatedWithinDocument` `dataclass` ¶

Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.

`NavigationEntry` `dataclass` ¶

Navigation history entry.

`NavigationType` ¶

Bases: str, enum.Enum

The type of a frameNavigated event.

`OriginTrial` `dataclass` ¶

Description is missing from the devtools protocol document.

`OriginTrialStatus` ¶

Bases: str, enum.Enum

Status for an Origin Trial.

`OriginTrialToken` `dataclass` ¶

Description is missing from the devtools protocol document.

`OriginTrialTokenStatus` ¶

Bases: str, enum.Enum

Origin Trial(https://www.chromium.org/blink/origin-trials) support.

Status for an Origin Trial token.

`OriginTrialTokenWithStatus` `dataclass` ¶

Description is missing from the devtools protocol document.

`OriginTrialUsageRestriction` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`PermissionsPolicyBlockLocator` `dataclass` ¶

Description is missing from the devtools protocol document.

`PermissionsPolicyBlockReason` ¶

Bases: str, enum.Enum

Reason for a permissions policy feature to be disabled.

`PermissionsPolicyFeature` ¶

Bases: str, enum.Enum

All Permissions Policy features.

This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.

`PermissionsPolicyFeatureState` `dataclass` ¶

Description is missing from the devtools protocol document.

`ReferrerPolicy` ¶

Bases: str, enum.Enum

The referring-policy used for the navigation.

`ScreencastFrame` `dataclass` ¶

Compressed image data requested by the startScreencast.

`ScreencastFrameMetadata` `dataclass` ¶

Screencast frame metadata.

`ScreencastVisibilityChanged` `dataclass` ¶

Fired when the page with currently enabled screencast was shown or hidden `.

`ScriptFontFamilies` `dataclass` ¶

Font families collection for a script.

`ScriptIdentifier` ¶

Bases: str

Unique script identifier.

`SecureContextType` ¶

Bases: str, enum.Enum

Indicates whether the frame is a secure context and why it is the case.

`TransitionType` ¶

Bases: str, enum.Enum

Transition type.

`Viewport` `dataclass` ¶

Viewport for capturing screenshot.

`VisualViewport` `dataclass` ¶

Visual viewport position, dimensions, and scale.

`WindowOpen` `dataclass` ¶

Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.

`add_compilation_cache()` `async` ¶

Seeds compilation cache for given url.

Compilation cache does not survive cross-process navigation. # noqa

`add_script_to_evaluate_on_load()` `async` ¶

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

noqa¶

`add_script_to_evaluate_on_new_document()` `async` ¶

Evaluates given script in every frame upon creation (before loading frame's scripts).

noqa¶

`bring_to_front()` `async` ¶

Brings page to front (activates tab).

noqa¶

`capture_screenshot()` `async` ¶

Capture page screenshot.

noqa¶

`capture_snapshot()` `async` ¶

Returns a snapshot of the page as a string.

For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles. # noqa

`clear_compilation_cache()` `async` ¶

Clears seeded compilation cache.

noqa¶

`clear_device_metrics_override()` `async` ¶

Clears the overridden device metrics.

noqa¶

`clear_device_orientation_override()` `async` ¶

Clears the overridden Device Orientation.

noqa¶

`clear_geolocation_override()` `async` ¶

Clears the overridden Geolocation Position and Error.

noqa¶

`close()` `async` ¶

Tries to close page, running its beforeunload hooks, if any.

noqa¶

`crash()` `async` ¶

Crashes renderer on the IO thread, generates minidumps.

noqa¶

`create_isolated_world()` `async` ¶

Creates an isolated world for the given frame.

noqa¶

`delete_cookie()` `async` ¶

Deletes browser cookie with given name, domain and path.

noqa¶

`disable()` `async` ¶

Disables page domain notifications.

noqa¶

`enable()` `async` ¶

Enables page domain notifications.

noqa¶

`generate_test_report()` `async` ¶

Generates a report for testing.

noqa¶

`get_ad_script_id()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_app_id()` `async` ¶

Returns the unique (PWA) app id.

Only returns values if the feature flag 'WebAppEnableManifestId' is enabled # noqa

`get_app_manifest()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_cookies()` `async` ¶

Returns all browser cookies for the page and all of its subframes.

Depending on the backend support, will return detailed cookie information in the cookies field. # noqa

`get_frame_tree()` `async` ¶

Returns present frame tree structure.

noqa¶

`get_installability_errors()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_layout_metrics()` `async` ¶

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

noqa¶

`get_manifest_icons()` `async` ¶

Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

noqa¶

`get_navigation_history()` `async` ¶

Returns navigation history for the current page.

noqa¶

`get_origin_trials()` `async` ¶

Get Origin Trials on given frame.

noqa¶

`get_permissions_policy_state()` `async` ¶

Get Permissions Policy state on given frame.

noqa¶

`get_resource_content()` `async` ¶

Returns content of the given resource.

noqa¶

`get_resource_tree()` `async` ¶

Returns present frame / resource tree structure.

noqa¶

`handle_java_script_dialog()` `async` ¶

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

noqa¶

`navigate()` `async` ¶

Navigates current page to the given URL.

noqa¶

`navigate_to_history_entry()` `async` ¶

Navigates current page to the given history entry.

noqa¶

`print_to_pdf()` `async` ¶

Print page as PDF.

noqa¶

`produce_compilation_cache()` `async` ¶

Requests backend to produce compilation cache for the specified scripts.

scripts are appeneded to the list of scripts for which the cache would be produced. The list may be reset during page navigation. When script with a matching URL is encountered, the cache is optionally produced upon backend discretion, based on internal heuristics. See also: Page.compilationCacheProduced. # noqa

`reload()` `async` ¶

Reloads given page optionally ignoring the cache.

noqa¶

`remove_script_to_evaluate_on_load()` `async` ¶

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

noqa¶

`remove_script_to_evaluate_on_new_document()` `async` ¶

Removes given script from the list.

noqa¶

`reset_navigation_history()` `async` ¶

Resets navigation history for the current page.

noqa¶

`screencast_frame_ack()` `async` ¶

Acknowledges that a screencast frame has been received by the frontend.

noqa¶

`search_in_resource()` `async` ¶

Searches for given string in resource content.

noqa¶

`set_ad_blocking_enabled()` `async` ¶

Enable Chrome's experimental ad filter on all sites.

noqa¶

`set_bypass_csp()` `async` ¶

Enable page Content Security Policy by-passing.

noqa¶

`set_device_metrics_override()` `async` ¶

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

noqa¶

`set_device_orientation_override()` `async` ¶

Overrides the Device Orientation.

noqa¶

`set_document_content()` `async` ¶

Sets given markup as the document's HTML.

noqa¶

`set_download_behavior()` `async` ¶

Set the behavior when downloading a file.

noqa¶

`set_font_families()` `async` ¶

Set generic font families.

noqa¶

`set_font_sizes()` `async` ¶

Set default font sizes.

noqa¶

`set_geolocation_override()` `async` ¶

Overrides the Geolocation Position or Error.

Omitting any of the parameters emulates position unavailable. # noqa

`set_intercept_file_chooser_dialog()` `async` ¶

Intercept file chooser requests and transfer control to protocol clients.

When file chooser interception is enabled, native file chooser dialog is not shown. Instead, a protocol event Page.fileChooserOpened is emitted. # noqa

`set_lifecycle_events_enabled()` `async` ¶

Controls whether page will emit lifecycle events.

noqa¶

`set_rph_registration_mode()` `async` ¶

Extensions for Custom Handlers API:

https://html.spec.whatwg.org/multipage/system-state.html#rph-automation # noqa

`set_spc_transaction_mode()` `async` ¶

Sets the Secure Payment Confirmation transaction mode.

https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode # noqa

`set_touch_emulation_enabled()` `async` ¶

Toggles mouse event-based touch event emulation.

noqa¶

`set_web_lifecycle_state()` `async` ¶

Tries to update the web lifecycle state of the page.

It will transition the page to the given state according to: https://github.com/WICG/web-lifecycle/ # noqa

`start_screencast()` `async` ¶

Starts sending each frame using the screencastFrame event.

noqa¶

`stop_loading()` `async` ¶

Force the page stop all navigations and pending resource fetches.

noqa¶

`stop_screencast()` `async` ¶

Stops sending each frame in the screencastFrame.

noqa¶

`wait_for_debugger()` `async` ¶

Pauses page execution.

Can be resumed using generic Runtime.runIfWaitingForDebugger. # noqa

`performance` ¶

`Metric` `dataclass` ¶

Run-time execution metric.

`Metrics` `dataclass` ¶

Current values of the metrics.

`disable()` `async` ¶

Disable collecting and reporting metrics.

noqa¶

`enable()` `async` ¶

Enable collecting and reporting metrics.

noqa¶

`get_metrics()` `async` ¶

Retrieve current values of run-time metrics.

noqa¶

`set_time_domain()` `async` ¶

Sets time domain to use for collecting and reporting duration metrics.

Note that this must be called before enabling metrics collection. Calling this method while metrics collection is enabled returns an error. # noqa

`performance_timeline` ¶

`LargestContentfulPaint` `dataclass` ¶

See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl.

`LayoutShift` `dataclass` ¶

See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl.

`LayoutShiftAttribution` `dataclass` ¶

Description is missing from the devtools protocol document.

`TimelineEvent` `dataclass` ¶

Description is missing from the devtools protocol document.

`TimelineEventAdded` `dataclass` ¶

Sent when a performance timeline event is added.

See reportPerformanceTimeline method.

`enable()` `async` ¶

Previously buffered events would be reported before method returns.

`preload` ¶

`PrefetchStatusUpdated` `dataclass` ¶

Fired when a prefetch attempt is updated.

`PreloadingAttemptKey` `dataclass` ¶

A key that identifies a preloading attempt.

The url used is the url specified by the trigger (i.e. the initial URL), and not the final url that is navigated to. For example, prerendering allows same-origin main frame navigations during the attempt, but the attempt is still keyed with the initial URL.

`PreloadingAttemptSource` `dataclass` ¶

Lists sources for a preloading attempt, specifically the ids of rule sets that had a speculation rule that triggered the attempt, and the BackendNodeIds of or elements that triggered the attempt (in the case of attempts triggered by a document rule).

It is possible for mulitple rule sets and links to trigger a single attempt.

`PreloadingAttemptSourcesUpdated` `dataclass` ¶

Send a list of sources for all preloading attempts in a document.

`PreloadingStatus` ¶

Bases: str, enum.Enum

Preloading status values, see also PreloadingTriggeringOutcome.

This status is shared by prefetchStatusUpdated and prerenderStatusUpdated.

`PrerenderAttemptCompleted` `dataclass` ¶

Fired when a prerender attempt is completed.

`PrerenderFinalStatus` ¶

Bases: str, enum.Enum

List of FinalStatus reasons for Prerender2.

`PrerenderStatusUpdated` `dataclass` ¶

Fired when a prerender attempt is updated.

`RuleSet` `dataclass` ¶

Corresponds to SpeculationRuleSet.

`RuleSetErrorType` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`RuleSetId` ¶

Bases: str

Unique id.

`RuleSetRemoved` `dataclass` ¶

Description is missing from the devtools protocol document.

`RuleSetUpdated` `dataclass` ¶

Upsert.

Currently, it is only emitted when a rule set added.

`SpeculationAction` ¶

Bases: str, enum.Enum

The type of preloading attempted.

It corresponds to mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it isn't being used by clients).

`SpeculationTargetHint` ¶

Bases: str, enum.Enum

Corresponds to mojom::SpeculationTargetHint.

See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints

`disable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`enable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`profiler` ¶

`ConsoleProfileFinished` `dataclass` ¶

Description is missing from the devtools protocol document.

`ConsoleProfileStarted` `dataclass` ¶

Sent when new profile recording is started using console.profile() call.

`CoverageRange` `dataclass` ¶

Coverage data for a source range.

`FunctionCoverage` `dataclass` ¶

Coverage data for a JavaScript function.

`PositionTickInfo` `dataclass` ¶

Specifies a number of samples attributed to a certain source position.

`PreciseCoverageDeltaUpdate` `dataclass` ¶

Reports coverage delta since the last poll (either from an event like this, or from takePreciseCoverage for the current isolate.

May only be sent if precise code coverage has been started. This event can be trigged by the embedder to, for example, trigger collection of coverage data immediately at a certain point in time.

`Profile` `dataclass` ¶

Profile.

`ProfileNode` `dataclass` ¶

Profile node.

Holds callsite information, execution statistics and child nodes.

`ScriptCoverage` `dataclass` ¶

Coverage data for a JavaScript script.

`disable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`enable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`get_best_effort_coverage()` `async` ¶

Collect coverage data for the current isolate.

The coverage data may be incomplete due to garbage collection. # noqa

`set_sampling_interval()` `async` ¶

Changes CPU profiler sampling interval.

Must be called before CPU profiles recording started. # noqa

`start()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`start_precise_coverage()` `async` ¶

Enable precise code coverage.

Coverage data for JavaScript executed before enabling precise code coverage may be incomplete. Enabling prevents running optimized code and resets execution counters. # noqa

`stop()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`stop_precise_coverage()` `async` ¶

Disable precise code coverage.

Disabling releases unnecessary execution count records and allows executing optimized code. # noqa

`take_precise_coverage()` `async` ¶

Collect coverage data for the current isolate, and resets execution counters.

Precise code coverage needs to have started. # noqa

`runtime` ¶

`BindingCalled` `dataclass` ¶

Notification is issued every time when binding is called.

`CallArgument` `dataclass` ¶

Represents function call argument.

Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified.

`CallFrame` `dataclass` ¶

Stack entry for runtime errors and assertions.

`ConsoleAPICalled` `dataclass` ¶

Issued when console API was called.

`CustomPreview` `dataclass` ¶

Description is missing from the devtools protocol document.

`EntryPreview` `dataclass` ¶

Description is missing from the devtools protocol document.

`ExceptionDetails` `dataclass` ¶

Detailed information about exception (or error) that was thrown during script compilation or execution.

`ExceptionRevoked` `dataclass` ¶

Issued when unhandled exception was revoked.

`ExceptionThrown` `dataclass` ¶

Issued when exception was thrown and unhandled.

`ExecutionContextCreated` `dataclass` ¶

Issued when new execution context is created.

`ExecutionContextDescription` `dataclass` ¶

Description of an isolated world.

`ExecutionContextDestroyed` `dataclass` ¶

Issued when execution context is destroyed.

`ExecutionContextId` ¶

Bases: int

Id of an execution context.

`ExecutionContextsCleared` `dataclass` ¶

Issued when all executionContexts were cleared in browser.

`InspectRequested` `dataclass` ¶

Issued when object should be inspected (for example, as a result of inspect() command line API call).

`InternalPropertyDescriptor` `dataclass` ¶

Object internal property descriptor.

This property isn't normally visible in JavaScript code.

`ObjectPreview` `dataclass` ¶

Object containing abbreviated remote object value.

`PrivatePropertyDescriptor` `dataclass` ¶

Object private field descriptor.

`PropertyDescriptor` `dataclass` ¶

Object property descriptor.

`PropertyPreview` `dataclass` ¶

Description is missing from the devtools protocol document.

`RemoteObject` `dataclass` ¶

Mirror object referencing original JavaScript object.

`RemoteObjectId` ¶

Bases: str

Unique object identifier.

`ScriptId` ¶

Bases: str

Unique script identifier.

`StackTrace` `dataclass` ¶

Call frames for assertions or error messages.

`StackTraceId` `dataclass` ¶

If debuggerId is set stack trace comes from another debugger and can be resolved there.

This allows to track cross-debugger calls. See Runtime.StackTrace and Debugger.paused for usages.

`TimeDelta` ¶

Bases: float

Number of milliseconds.

`Timestamp` ¶

Bases: float

Number of milliseconds since epoch.

`UniqueDebuggerId` ¶

Bases: str

Unique identifier of current debugger.

`UnserializableValue` ¶

Bases: str

Primitive value which cannot be JSON-stringified.

Includes values -0, NaN, Infinity, -Infinity, and bigint literals.

`WebDriverValue` `dataclass` ¶

Represents the value serialiazed by the WebDriver BiDi specification https://w3c.github.io/webdriver-bidi.

`add_binding()` `async` ¶

If executionContextId is empty, adds binding with the given name on the global objects of all inspected contexts, including those created later, bindings survive reloads.

Binding function takes exactly one argument, this argument should be string, in case of any other input, function throws an exception. Each binding function call produces Runtime.bindingCalled notification. # noqa

`await_promise()` `async` ¶

Add handler to promise with given promise object id.

noqa¶

`call_function_on()` `async` ¶

Calls function with given declaration on the given object.

Object group of the result is inherited from the target object. # noqa

`compile_script()` `async` ¶

Compiles expression.

noqa¶

`disable()` `async` ¶

Disables reporting of execution contexts creation.

noqa¶

`discard_console_entries()` `async` ¶

Discards collected exceptions and console API calls.

noqa¶

`enable()` `async` ¶

Enables reporting of execution contexts creation by means of executionContextCreated event.

When the reporting gets enabled the event will be sent immediately for each existing execution context. # noqa

`evaluate()` `async` ¶

Evaluates expression on global object.

noqa¶

`get_exception_details()` `async` ¶

This method tries to lookup and populate exception details for a JavaScript Error object.

Note that the stackTrace portion of the resulting exceptionDetails will only be populated if the Runtime domain was enabled at the time when the Error was thrown. # noqa

`get_heap_usage()` `async` ¶

Returns the JavaScript heap usage.

It is the total usage of the corresponding isolate not scoped to a particular Runtime. # noqa

`get_isolate_id()` `async` ¶

Returns the isolate id.

noqa¶

`get_properties()` `async` ¶

Returns properties of a given object.

Object group of the result is inherited from the target object. # noqa

`global_lexical_scope_names()` `async` ¶

Returns all let, const and class variables from global scope.

noqa¶

`query_objects()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`release_object()` `async` ¶

Releases remote object with given id.

noqa¶

`release_object_group()` `async` ¶

Releases all remote objects that belong to a given group.

noqa¶

`remove_binding()` `async` ¶

This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications.

noqa¶

`run_if_waiting_for_debugger()` `async` ¶

Tells inspected instance to run if it was waiting for debugger to attach.

noqa¶

`run_script()` `async` ¶

Runs script with given id in a given context.

noqa¶

`set_async_call_stack_depth()` `async` ¶

Enables or disables async call stacks tracking.

noqa¶

`set_custom_object_formatter_enabled()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_max_call_stack_size_to_capture()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`terminate_execution()` `async` ¶

Terminate current or next JavaScript execution.

Will cancel the termination when the outer-most script execution ends. # noqa

`schema` ¶

`Domain` `dataclass` ¶

Description of the protocol domain.

`get_domains()` `async` ¶

Returns supported domains.

noqa¶

`security` ¶

`CertificateError` `dataclass` ¶

There is a certificate error.

If overriding certificate errors is enabled, then it should be handled with the handleCertificateError command. Note: this event does not fire if the certificate error has been allowed internally. Only one client per target should override certificate errors at the same time.

`CertificateErrorAction` ¶

Bases: str, enum.Enum

The action to take when a certificate error occurs.

continue will continue processing the request and cancel will cancel the request.

`CertificateId` ¶

Bases: int

An internal certificate ID value.

`CertificateSecurityState` `dataclass` ¶

Details about the security state of the page certificate.

`InsecureContentStatus` `dataclass` ¶

Information about insecure content on the page.

`MixedContentType` ¶

Bases: str, enum.Enum

A description of mixed content (HTTP resources on HTTPS pages), as defined by https://www.w3.org/TR/mixed- content/#categories.

`SafetyTipInfo` `dataclass` ¶

Description is missing from the devtools protocol document.

`SafetyTipStatus` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`SecurityState` ¶

Bases: str, enum.Enum

The security level of a page or resource.

`SecurityStateChanged` `dataclass` ¶

The security state of the page changed.

No longer being sent.

`SecurityStateExplanation` `dataclass` ¶

An explanation of an factor contributing to the security state.

`VisibleSecurityState` `dataclass` ¶

Security state information about the page.

`VisibleSecurityStateChanged` `dataclass` ¶

The security state of the page changed.

`disable()` `async` ¶

Disables tracking security state changes.

noqa¶

`enable()` `async` ¶

Enables tracking security state changes.

noqa¶

`handle_certificate_error()` `async` ¶

Handles a certificate error that fired a certificateError event.

noqa¶

`set_ignore_certificate_errors()` `async` ¶

Enable/disable whether all certificate errors should be ignored.

noqa¶

`set_override_certificate_errors()` `async` ¶

Enable/disable overriding certificate errors.

If enabled, all certificate error events need to be handled by the DevTools client and should be answered with handleCertificateError commands. # noqa

`service_worker` ¶

`RegistrationID` ¶

Bases: str

Description is missing from the devtools protocol document.

`ServiceWorkerErrorMessage` `dataclass` ¶

ServiceWorker error message.

`ServiceWorkerRegistration` `dataclass` ¶

ServiceWorker registration.

`ServiceWorkerVersion` `dataclass` ¶

ServiceWorker version.

`ServiceWorkerVersionRunningStatus` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`ServiceWorkerVersionStatus` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`WorkerErrorReported` `dataclass` ¶

Description is missing from the devtools protocol document.

`WorkerRegistrationUpdated` `dataclass` ¶

Description is missing from the devtools protocol document.

`WorkerVersionUpdated` `dataclass` ¶

Description is missing from the devtools protocol document.

`deliver_push_message()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`disable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`dispatch_periodic_sync_event()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`dispatch_sync_event()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`enable()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`inspect_worker()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`set_force_update_on_page_load()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`skip_waiting()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`start_worker()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`stop_all_workers()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`stop_worker()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`unregister()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`update_registration()` `async` ¶

Description is missing from the devtools protocol document.

noqa¶

`storage` ¶

`CacheStorageContentUpdated` `dataclass` ¶

A cache's contents have been modified.

`CacheStorageListUpdated` `dataclass` ¶

A cache has been added/deleted.

`IndexedDBContentUpdated` `dataclass` ¶

The origin's IndexedDB object store has been modified.

`IndexedDBListUpdated` `dataclass` ¶

The origin's IndexedDB database list has been modified.

`InterestGroupAccessType` ¶

Bases: str, enum.Enum

Enum of interest group access types.

`InterestGroupAccessed` `dataclass` ¶

One of the interest groups was accessed by the associated page.

`InterestGroupAd` `dataclass` ¶

Ad advertising element inside an interest group.

`InterestGroupDetails` `dataclass` ¶

The full details of an interest group.

`SerializedStorageKey` ¶

Bases: str

Description is missing from the devtools protocol document.

`SharedStorageAccessParams` `dataclass` ¶

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

`SharedStorageAccessType` ¶

Bases: str, enum.Enum

Enum of shared storage access types.

`SharedStorageAccessed` `dataclass` ¶

Shared storage was accessed by the associated page.

The following parameters are included in all events.

`SharedStorageEntry` `dataclass` ¶

Struct for a single key-value pair in an origin's shared storage.

`SharedStorageMetadata` `dataclass` ¶

Details for an origin's shared storage.

`SharedStorageReportingMetadata` `dataclass` ¶

Pair of reporting metadata details for a candidate URL for selectURL().

`SharedStorageUrlWithMetadata` `dataclass` ¶

Bundles a candidate URL with its reporting metadata.

`StorageBucketCreatedOrUpdated` `dataclass` ¶

Description is missing from the devtools protocol document.

`StorageBucketDeleted` `dataclass` ¶

Description is missing from the devtools protocol document.

`StorageBucketInfo` `dataclass` ¶

Description is missing from the devtools protocol document.

`StorageBucketsDurability` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`StorageType` ¶

Bases: str, enum.Enum

Enum of possible storage types.

`TrustTokens` `dataclass` ¶

Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.

`UsageForType` `dataclass` ¶

Usage for a storage type.

`clear_cookies()` `async` ¶

Clears cookies.

noqa¶

`clear_data_for_origin()` `async` ¶

Clears storage for origin.

noqa¶

`clear_data_for_storage_key()` `async` ¶

Clears storage for storage key.

noqa¶

`clear_shared_storage_entries()` `async` ¶

Clears all entries for a given origin's shared storage.

noqa¶

`clear_trust_tokens()` `async` ¶

Removes all Trust Tokens issued by the provided issuerOrigin.

Leaves other stored data, including the issuer's Redemption Records, intact. # noqa

`delete_shared_storage_entry()` `async` ¶

Deletes entry for key (if it exists) for a given origin's shared storage.

noqa¶

`delete_storage_bucket()` `async` ¶

Deletes the Storage Bucket with the given storage key and bucket name.

noqa¶

`get_cookies()` `async` ¶

Returns all browser cookies.

noqa¶

`get_interest_group_details()` `async` ¶

Gets details for a named interest group.

noqa¶

`get_shared_storage_entries()` `async` ¶

Gets the entries in an given origin's shared storage.

noqa¶

`get_shared_storage_metadata()` `async` ¶

Gets metadata for an origin's shared storage.

noqa¶

`get_storage_key_for_frame()` `async` ¶

Returns a storage key given a frame id.

noqa¶

`get_trust_tokens()` `async` ¶

Returns the number of stored Trust Tokens per issuer for the current browsing context.

noqa¶

`get_usage_and_quota()` `async` ¶

Returns usage and quota in bytes.

noqa¶

`override_quota_for_origin()` `async` ¶

Override quota for the specified origin # noqa.

`reset_shared_storage_budget()` `async` ¶

Resets the budget for ownerOrigin by clearing all budget withdrawals.

noqa¶

`set_cookies()` `async` ¶

Sets given cookies.

noqa¶

`set_interest_group_tracking()` `async` ¶

Enables/Disables issuing of interestGroupAccessed events.

noqa¶

`set_shared_storage_entry()` `async` ¶

Sets entry with key and value for a given origin's shared storage.

noqa¶

`set_shared_storage_tracking()` `async` ¶

Enables/disables issuing of sharedStorageAccessed events.

noqa¶

`set_storage_bucket_tracking()` `async` ¶

Set tracking for a storage key's buckets.

noqa¶

`track_cache_storage_for_origin()` `async` ¶

Registers origin to be notified when an update occurs to its cache storage list.

noqa¶

`track_cache_storage_for_storage_key()` `async` ¶

Registers storage key to be notified when an update occurs to its cache storage list.

noqa¶

`track_indexed_db_for_origin()` `async` ¶

Registers origin to be notified when an update occurs to its IndexedDB.

noqa¶

`track_indexed_db_for_storage_key()` `async` ¶

Registers storage key to be notified when an update occurs to its IndexedDB.

noqa¶

`untrack_cache_storage_for_origin()` `async` ¶

Unregisters origin from receiving notifications for cache storage.

noqa¶

`untrack_cache_storage_for_storage_key()` `async` ¶

Unregisters storage key from receiving notifications for cache storage.

noqa¶

`untrack_indexed_db_for_origin()` `async` ¶

Unregisters origin from receiving notifications for IndexedDB.

noqa¶

`untrack_indexed_db_for_storage_key()` `async` ¶

Unregisters storage key from receiving notifications for IndexedDB.

noqa¶

`system_info` ¶

`GPUDevice` `dataclass` ¶

Describes a single graphics processor (GPU).

`GPUInfo` `dataclass` ¶

Provides information about the GPU(s) on the system.

`ImageDecodeAcceleratorCapability` `dataclass` ¶

Describes a supported image decoding profile with its associated minimum and maximum resolutions and subsampling.

`ImageType` ¶

Bases: str, enum.Enum

Image format of a given image.

`ProcessInfo` `dataclass` ¶

Represents process info.

`Size` `dataclass` ¶

Describes the width and height dimensions of an entity.

`SubsamplingFormat` ¶

Bases: str, enum.Enum

YUV subsampling type of the pixels of a given image.

`VideoDecodeAcceleratorCapability` `dataclass` ¶

Describes a supported video decoding profile with its associated minimum and maximum resolutions.

`VideoEncodeAcceleratorCapability` `dataclass` ¶

Describes a supported video encoding profile with its associated maximum resolution and maximum framerate.

`get_feature_state()` `async` ¶

Returns information about the feature state.

noqa¶

`get_info()` `async` ¶

Returns information about the system.

noqa¶

`get_process_info()` `async` ¶

Returns information about all running processes.

noqa¶

`target` ¶

`AttachedToTarget` `dataclass` ¶

Issued when attached to target because of auto-attach or attachToTarget command.

`DetachedFromTarget` `dataclass` ¶

Issued when detached from target for any reason (including detachFromTarget command).

Can be issued multiple times per target if multiple sessions have been attached to it.

`FilterEntry` `dataclass` ¶

A filter used by target query/discovery/auto-attach operations.

`ReceivedMessageFromTarget` `dataclass` ¶

Notifies about a new protocol message received from the session (as reported in attachedToTarget event).

`RemoteLocation` `dataclass` ¶

Description is missing from the devtools protocol document.

`SessionID` ¶

Bases: str

Unique identifier of attached debugging session.

`TargetCrashed` `dataclass` ¶

Issued when a target has crashed.

`TargetCreated` `dataclass` ¶

Issued when a possible inspection target is created.

`TargetDestroyed` `dataclass` ¶

Issued when a target is destroyed.

`TargetFilter` `dataclass` ¶

The entries in TargetFilter are matched sequentially against targets and the first entry that matches determines if the target is included or not, depending on the value of exclude field in the entry. If filter is not specified, the one assumed is.

[{type: "browser", exclude: true}, {type: "tab", exclude: true}, {}] (i.e. include everything but browser and tab).

`TargetID` ¶

Bases: str

Description is missing from the devtools protocol document.

`TargetInfo` `dataclass` ¶

Description is missing from the devtools protocol document.

`TargetInfoChanged` `dataclass` ¶

Issued when some information about a target has changed.

This only happens between targetCreated and targetDestroyed.

`activate_target()` `async` ¶

Activates (focuses) the target.

noqa¶

`attach_to_browser_target()` `async` ¶

Attaches to the browser target, only uses flat sessionId mode.

noqa¶

`attach_to_target()` `async` ¶

Attaches to the target with given id.

noqa¶

`auto_attach_related()` `async` ¶

Adds the specified target to the list of targets that will be monitored for any related target creation (such as child frames, child workers and new versions of service worker) and reported through attachedToTarget.

The specified target is also auto-attached. This cancels the effect of any previous setAutoAttach and is also cancelled by subsequent setAutoAttach. Only available at the Browser target. # noqa

`close_target()` `async` ¶

Closes the target.

If the target is a page that gets closed too. # noqa

`create_browser_context()` `async` ¶

Creates a new empty BrowserContext.

Similar to an incognito profile but you can have more than one. # noqa

`create_target()` `async` ¶

Creates a new page.

noqa¶

`detach_from_target()` `async` ¶

Detaches session with given id.

noqa¶

`dispose_browser_context()` `async` ¶

Deletes a BrowserContext.

All the belonging pages will be closed without calling their beforeunload hooks. # noqa

`expose_dev_tools_protocol()` `async` ¶

Inject object to the target's main frame that provides a communication channel with browser target.

Injected object will be available as window[bindingName].

The object has the follwing API: - binding.send(json) - a method to send messages over the remote debugging protocol - binding.onmessage = json => handleMessage(json) - a callback that will be called for the protocol notifications and command responses. # noqa

`get_browser_contexts()` `async` ¶

Returns all browser contexts created with Target.createBrowserContext method.

noqa¶

`get_target_info()` `async` ¶

Returns information about a target.

noqa¶

`get_targets()` `async` ¶

Retrieves a list of available targets.

noqa¶

`send_message_to_target()` `async` ¶

Sends protocol message over session with given id.

Consider using flat mode instead; see commands attachToTarget, setAutoAttach, and crbug.com/991325. # noqa

`set_auto_attach()` `async` ¶

Controls whether to automatically attach to new targets which are considered to be related to this one.

When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets. This also clears all targets added by autoAttachRelated from the list of targets to watch for creation of related targets. # noqa

`set_discover_targets()` `async` ¶

Controls whether to discover available targets and notify via targetCreated/targetInfoChanged/targetDestroyed events.

noqa¶

`set_remote_locations()` `async` ¶

Enables target discovery for the specified locations, when setDiscoverTargets was set to true.

noqa¶

`tethering` ¶

`Accepted` `dataclass` ¶

Informs that port was successfully bound and got a specified connection id.

`bind()` `async` ¶

Request browser port binding.

noqa¶

`unbind()` `async` ¶

Request browser port unbinding.

noqa¶

`tracing` ¶

`BufferUsage` `dataclass` ¶

Description is missing from the devtools protocol document.

`DataCollected` `dataclass` ¶

Contains a bucket of collected trace events.

When tracing is stopped collected events will be sent as a sequence of dataCollected events followed by tracingComplete event.

`MemoryDumpConfig` `dataclass` ¶

Configuration for memory dump.

Used only when "memory-infra" category is enabled.

`MemoryDumpLevelOfDetail` ¶

Bases: str, enum.Enum

Details exposed when memory request explicitly declared.

Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

`StreamCompression` ¶

Bases: str, enum.Enum

Compression type to use for traces returned via streams.

`StreamFormat` ¶

Bases: str, enum.Enum

Data format of a trace.

Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon.

`TraceConfig` `dataclass` ¶

Description is missing from the devtools protocol document.

`TracingBackend` ¶

Bases: str, enum.Enum

Backend type to use for tracing.

chrome uses the Chrome-integrated tracing service and is supported on all platforms. system is only supported on Chrome OS and uses the Perfetto system tracing service. auto chooses system when the perfettoConfig provided to Tracing.start specifies at least one non-Chrome data source; otherwise uses chrome.

`TracingComplete` `dataclass` ¶

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

`end()` `async` ¶

Stop trace events collection.

noqa¶

`get_categories()` `async` ¶

Gets supported tracing categories.

noqa¶

`record_clock_sync_marker()` `async` ¶

Record a clock sync marker in the trace.

noqa¶

`request_memory_dump()` `async` ¶

Request a global memory dump.

noqa¶

`start()` `async` ¶

Start trace events collection.

noqa¶

`web_audio` ¶

`AudioListener` `dataclass` ¶

Protocol object for AudioListener.

`AudioListenerCreated` `dataclass` ¶

Notifies that the construction of an AudioListener has finished.

`AudioListenerWillBeDestroyed` `dataclass` ¶

Notifies that a new AudioListener has been created.

`AudioNode` `dataclass` ¶

Protocol object for AudioNode.

`AudioNodeCreated` `dataclass` ¶

Notifies that a new AudioNode has been created.

`AudioNodeWillBeDestroyed` `dataclass` ¶

Notifies that an existing AudioNode has been destroyed.

`AudioParam` `dataclass` ¶

Protocol object for AudioParam.

`AudioParamCreated` `dataclass` ¶

Notifies that a new AudioParam has been created.

`AudioParamWillBeDestroyed` `dataclass` ¶

Notifies that an existing AudioParam has been destroyed.

`AutomationRate` ¶

Bases: str, enum.Enum

Enum of AudioParam::AutomationRate from the spec.

`BaseAudioContext` `dataclass` ¶

Protocol object for BaseAudioContext.

`ChannelCountMode` ¶

Bases: str, enum.Enum

Enum of AudioNode::ChannelCountMode from the spec.

`ChannelInterpretation` ¶

Bases: str, enum.Enum

Enum of AudioNode::ChannelInterpretation from the spec.

`ContextChanged` `dataclass` ¶

Notifies that existing BaseAudioContext has changed some properties (id stays the same)..

`ContextCreated` `dataclass` ¶

Notifies that a new BaseAudioContext has been created.

`ContextRealtimeData` `dataclass` ¶

Fields in AudioContext that change in real-time.

`ContextState` ¶

Bases: str, enum.Enum

Enum of AudioContextState from the spec.

`ContextType` ¶

Bases: str, enum.Enum

Enum of BaseAudioContext types.

`ContextWillBeDestroyed` `dataclass` ¶

Notifies that an existing BaseAudioContext will be destroyed.

`GraphObjectId` ¶

Bases: str

An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API.

`NodeParamConnected` `dataclass` ¶

Notifies that an AudioNode is connected to an AudioParam.

`NodeParamDisconnected` `dataclass` ¶

Notifies that an AudioNode is disconnected to an AudioParam.

`NodeType` ¶

Bases: str

Enum of AudioNode types.

`NodesConnected` `dataclass` ¶

Notifies that two AudioNodes are connected.

`NodesDisconnected` `dataclass` ¶

Notifies that AudioNodes are disconnected.

The destination can be null, and it means all the outgoing connections from the source are disconnected.

`ParamType` ¶

Bases: str

Enum of AudioParam types.

`disable()` `async` ¶

Disables the WebAudio domain.

noqa¶

`enable()` `async` ¶

Enables the WebAudio domain and starts sending context lifetime events.

noqa¶

`get_realtime_data()` `async` ¶

Fetch the realtime data from the registered contexts.

noqa¶

`web_authn` ¶

`AuthenticatorId` ¶

Bases: str

Description is missing from the devtools protocol document.

`AuthenticatorProtocol` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`AuthenticatorTransport` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`Credential` `dataclass` ¶

Description is missing from the devtools protocol document.

`CredentialAdded` `dataclass` ¶

Triggered when a credential is added to an authenticator.

`CredentialAsserted` `dataclass` ¶

Triggered when a credential is used in a webauthn assertion.

`Ctap2Version` ¶

Bases: str, enum.Enum

Description is missing from the devtools protocol document.

`VirtualAuthenticatorOptions` `dataclass` ¶

Description is missing from the devtools protocol document.

`add_credential()` `async` ¶

Adds the credential to the specified authenticator.

noqa¶

`add_virtual_authenticator()` `async` ¶

Creates and adds a virtual authenticator.

noqa¶

`clear_credentials()` `async` ¶

Clears all the credentials from the specified device.

noqa¶

`disable()` `async` ¶

Disable the WebAuthn domain.

noqa¶

`enable()` `async` ¶

Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator.

noqa¶

`get_credential()` `async` ¶

Returns a single credential stored in the given virtual authenticator that matches the credential ID.

noqa¶

`get_credentials()` `async` ¶

Returns all the credentials stored in the given virtual authenticator.

noqa¶

`remove_credential()` `async` ¶

Removes a credential from the authenticator.

noqa¶

`remove_virtual_authenticator()` `async` ¶

Removes the given authenticator.

noqa¶

`set_automatic_presence_simulation()` `async` ¶

Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.

The default is true. # noqa

`set_response_override_bits()` `async` ¶

Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.

noqa¶

`set_user_verified()` `async` ¶

Sets whether User Verification succeeds or fails for an authenticator.

The default is true. # noqa

Index

accessibility ¶

AXNode dataclass ¶

AXNodeId ¶

AXProperty dataclass ¶

AXPropertyName ¶

AXRelatedNode dataclass ¶

AXValue dataclass ¶

AXValueNativeSourceType ¶

AXValueSource dataclass ¶

AXValueSourceType ¶

AXValueType ¶

LoadComplete dataclass ¶

NodesUpdated dataclass ¶

disable() async ¶

noqa¶

enable() async ¶

get_ax_node_and_ancestors() async ¶

get_child_ax_nodes() async ¶

get_full_ax_tree() async ¶

get_partial_ax_tree() async ¶

noqa¶

get_root_ax_node() async ¶

query_ax_tree() async ¶

animation ¶

Animation dataclass ¶

AnimationCanceled dataclass ¶

AnimationCreated dataclass ¶

AnimationEffect dataclass ¶

AnimationStarted dataclass ¶

KeyframeStyle dataclass ¶

KeyframesRule dataclass ¶

disable() async ¶

noqa¶

enable() async ¶

noqa¶

get_current_time() async ¶

noqa¶

get_playback_rate() async ¶

noqa¶

release_animations() async ¶

noqa¶

resolve_animation() async ¶

noqa¶

seek_animations() async ¶

noqa¶

set_paused() async ¶

noqa¶

set_playback_rate() async ¶

noqa¶

set_timing() async ¶

noqa¶

audits ¶

AffectedCookie dataclass ¶

AffectedFrame dataclass ¶

AffectedRequest dataclass ¶

AttributionReportingIssueDetails dataclass ¶

AttributionReportingIssueType ¶

BlockedByResponseIssueDetails dataclass ¶

BlockedByResponseReason ¶

ClientHintIssueDetails dataclass ¶

ClientHintIssueReason ¶

ContentSecurityPolicyIssueDetails dataclass ¶

ContentSecurityPolicyViolationType ¶

CookieExclusionReason ¶

CookieIssueDetails dataclass ¶

CookieOperation ¶

CookieWarningReason ¶

CorsIssueDetails dataclass ¶

DeprecationIssueDetails dataclass ¶

FederatedAuthRequestIssueDetails dataclass ¶

FederatedAuthRequestIssueReason ¶

GenericIssueDetails dataclass ¶

GenericIssueErrorType ¶

HeavyAdIssueDetails dataclass ¶

HeavyAdReason ¶

HeavyAdResolutionStatus ¶

InspectorIssue dataclass ¶

InspectorIssueCode ¶

InspectorIssueDetails dataclass ¶

`accessibility` ¶

`AXNode` `dataclass` ¶

`AXNodeId` ¶

`AXProperty` `dataclass` ¶

`AXPropertyName` ¶

`AXRelatedNode` `dataclass` ¶

`AXValue` `dataclass` ¶

`AXValueNativeSourceType` ¶

`AXValueSource` `dataclass` ¶

`AXValueSourceType` ¶

`AXValueType` ¶

`LoadComplete` `dataclass` ¶

`NodesUpdated` `dataclass` ¶

`disable()` `async` ¶

`enable()` `async` ¶

`get_ax_node_and_ancestors()` `async` ¶

`get_child_ax_nodes()` `async` ¶

`get_full_ax_tree()` `async` ¶

`get_partial_ax_tree()` `async` ¶

`get_root_ax_node()` `async` ¶

`query_ax_tree()` `async` ¶

`animation` ¶

`Animation` `dataclass` ¶

`AnimationCanceled` `dataclass` ¶

`AnimationCreated` `dataclass` ¶

`AnimationEffect` `dataclass` ¶

`AnimationStarted` `dataclass` ¶

`KeyframeStyle` `dataclass` ¶

`KeyframesRule` `dataclass` ¶

`disable()` `async` ¶

`enable()` `async` ¶

`get_current_time()` `async` ¶

`get_playback_rate()` `async` ¶

`release_animations()` `async` ¶

`resolve_animation()` `async` ¶

`seek_animations()` `async` ¶

`set_paused()` `async` ¶

`set_playback_rate()` `async` ¶

`set_timing()` `async` ¶

`audits` ¶

`AffectedCookie` `dataclass` ¶

`AffectedFrame` `dataclass` ¶

`AffectedRequest` `dataclass` ¶

`AttributionReportingIssueDetails` `dataclass` ¶

`AttributionReportingIssueType` ¶

`BlockedByResponseIssueDetails` `dataclass` ¶

`BlockedByResponseReason` ¶

`ClientHintIssueDetails` `dataclass` ¶

`ClientHintIssueReason` ¶

`ContentSecurityPolicyIssueDetails` `dataclass` ¶

`ContentSecurityPolicyViolationType` ¶

`CookieExclusionReason` ¶

`CookieIssueDetails` `dataclass` ¶

`CookieOperation` ¶

`CookieWarningReason` ¶

`CorsIssueDetails` `dataclass` ¶

`DeprecationIssueDetails` `dataclass` ¶

`FederatedAuthRequestIssueDetails` `dataclass` ¶

`FederatedAuthRequestIssueReason` ¶

`GenericIssueDetails` `dataclass` ¶

`GenericIssueErrorType` ¶

`HeavyAdIssueDetails` `dataclass` ¶

`HeavyAdReason` ¶

`HeavyAdResolutionStatus` ¶

`InspectorIssue` `dataclass` ¶

`InspectorIssueCode` ¶

`InspectorIssueDetails` `dataclass` ¶

`IssueAdded` `dataclass` ¶

`IssueId` ¶

`LowTextContrastIssueDetails` `dataclass` ¶

`MixedContentIssueDetails` `dataclass` ¶

`MixedContentResolutionStatus` ¶

`MixedContentResourceType` ¶

`NavigatorUserAgentIssueDetails` `dataclass` ¶

`QuirksModeIssueDetails` `dataclass` ¶

`SharedArrayBufferIssueDetails` `dataclass` ¶

`SharedArrayBufferIssueType` ¶

`SourceCodeLocation` `dataclass` ¶

`TrustedWebActivityIssueDetails` `dataclass` ¶

`TwaQualityEnforcementViolationType` ¶