DOM Protocol

DOM domain commands and events for Chrome DevTools Protocol.

Methods

pydoll.protocol.dom.methods

CollectClassNamesFromSubtreeResponse module-attribute

CollectClassNamesFromSubtreeResponse = Response[CollectClassNamesFromSubtreeResult]

CopyToResponse module-attribute

CopyToResponse = Response[CopyToResult]

DescribeNodeResponse module-attribute

DescribeNodeResponse = Response[DescribeNodeResult]

GetAttributesResponse module-attribute

GetAttributesResponse = Response[GetAttributesResult]

GetBoxModelResponse module-attribute

GetBoxModelResponse = Response[GetBoxModelResult]

GetContentQuadsResponse module-attribute

GetContentQuadsResponse = Response[GetContentQuadsResult]

GetDocumentResponse module-attribute

GetDocumentResponse = Response[GetDocumentResult]

GetFlattenedDocumentResponse module-attribute

GetFlattenedDocumentResponse = Response[GetFlattenedDocumentResult]

GetNodesForSubtreeByStyleResponse module-attribute

GetNodesForSubtreeByStyleResponse = Response[GetNodesForSubtreeByStyleResult]

GetNodeForLocationResponse module-attribute

GetNodeForLocationResponse = Response[GetNodeForLocationResult]

GetOuterHTMLResponse module-attribute

GetOuterHTMLResponse = Response[GetOuterHTMLResult]

GetRelayoutBoundaryResponse module-attribute

GetRelayoutBoundaryResponse = Response[GetRelayoutBoundaryResult]

GetSearchResultsResponse module-attribute

GetSearchResultsResponse = Response[GetSearchResultsResult]

GetTopLayerElementsResponse module-attribute

GetTopLayerElementsResponse = Response[GetTopLayerElementsResult]

GetElementByRelationResponse module-attribute

GetElementByRelationResponse = Response[GetElementByRelationResult]

MoveToResponse module-attribute

MoveToResponse = Response[MoveToResult]

PerformSearchResponse module-attribute

PerformSearchResponse = Response[PerformSearchResult]

PushNodeByPathToFrontendResponse module-attribute

PushNodeByPathToFrontendResponse = Response[PushNodeByPathToFrontendResult]

PushNodesByBackendIdsToFrontendResponse module-attribute

PushNodesByBackendIdsToFrontendResponse = Response[PushNodesByBackendIdsToFrontendResult]

QuerySelectorResponse module-attribute

QuerySelectorResponse = Response[QuerySelectorResult]

QuerySelectorAllResponse module-attribute

QuerySelectorAllResponse = Response[QuerySelectorAllResult]

RequestNodeResponse module-attribute

RequestNodeResponse = Response[RequestNodeResult]

ResolveNodeResponse module-attribute

ResolveNodeResponse = Response[ResolveNodeResult]

SetNodeNameResponse module-attribute

SetNodeNameResponse = Response[SetNodeNameResult]

GetNodeStackTracesResponse module-attribute

GetNodeStackTracesResponse = Response[GetNodeStackTracesResult]

GetFileInfoResponse module-attribute

GetFileInfoResponse = Response[GetFileInfoResult]

GetDetachedDomNodesResponse module-attribute

GetDetachedDomNodesResponse = Response[GetDetachedDomNodesResult]

GetFrameOwnerResponse module-attribute

GetFrameOwnerResponse = Response[GetFrameOwnerResult]

GetContainerForNodeResponse module-attribute

GetContainerForNodeResponse = Response[GetContainerForNodeResult]

GetQueryingDescendantsForContainerResponse module-attribute

GetQueryingDescendantsForContainerResponse = Response[GetQueryingDescendantsForContainerResult]

GetAnchorElementResponse module-attribute

GetAnchorElementResponse = Response[GetAnchorElementResult]

ForceShowPopoverResponse module-attribute

ForceShowPopoverResponse = Response[ForceShowPopoverResult]

CollectClassNamesFromSubtreeCommand module-attribute

CollectClassNamesFromSubtreeCommand = Command[CollectClassNamesFromSubtreeParams, CollectClassNamesFromSubtreeResponse]

CopyToCommand module-attribute

CopyToCommand = Command[CopyToParams, CopyToResponse]

DescribeNodeCommand module-attribute

DescribeNodeCommand = Command[DescribeNodeParams, DescribeNodeResponse]

DisableCommand module-attribute

DisableCommand = Command[EmptyParams, EmptyResponse]

DiscardSearchResultsCommand module-attribute

DiscardSearchResultsCommand = Command[DiscardSearchResultsParams, EmptyResponse]

EnableCommand module-attribute

EnableCommand = Command[EnableParams, EmptyResponse]

FocusCommand module-attribute

FocusCommand = Command[FocusParams, EmptyResponse]

ForceShowPopoverCommand module-attribute

ForceShowPopoverCommand = Command[ForceShowPopoverParams, ForceShowPopoverResponse]

GetAnchorElementCommand module-attribute

GetAnchorElementCommand = Command[GetAnchorElementParams, GetAnchorElementResponse]

GetAttributesCommand module-attribute

GetAttributesCommand = Command[GetAttributesParams, GetAttributesResponse]

GetBoxModelCommand module-attribute

GetBoxModelCommand = Command[GetBoxModelParams, GetBoxModelResponse]

GetContainerForNodeCommand module-attribute

GetContainerForNodeCommand = Command[GetContainerForNodeParams, GetContainerForNodeResponse]

GetContentQuadsCommand module-attribute

GetContentQuadsCommand = Command[GetContentQuadsParams, GetContentQuadsResponse]

GetDetachedDomNodesCommand module-attribute

GetDetachedDomNodesCommand = Command[EmptyParams, GetDetachedDomNodesResponse]

GetDocumentCommand module-attribute

GetDocumentCommand = Command[GetDocumentParams, GetDocumentResponse]

GetElementByRelationCommand module-attribute

GetElementByRelationCommand = Command[GetElementByRelationParams, GetElementByRelationResponse]

GetFileInfoCommand module-attribute

GetFileInfoCommand = Command[GetFileInfoParams, GetFileInfoResponse]

GetFlattenedDocumentCommand module-attribute

GetFlattenedDocumentCommand = Command[GetFlattenedDocumentParams, GetFlattenedDocumentResponse]

GetFrameOwnerCommand module-attribute

GetFrameOwnerCommand = Command[GetFrameOwnerParams, GetFrameOwnerResponse]

GetNodeForLocationCommand module-attribute

GetNodeForLocationCommand = Command[GetNodeForLocationParams, GetNodeForLocationResponse]

GetNodeStackTracesCommand module-attribute

GetNodeStackTracesCommand = Command[GetNodeStackTracesParams, GetNodeStackTracesResponse]

GetNodesForSubtreeByStyleCommand module-attribute

GetNodesForSubtreeByStyleCommand = Command[GetNodesForSubtreeByStyleParams, GetNodesForSubtreeByStyleResponse]

GetOuterHTMLCommand module-attribute

GetOuterHTMLCommand = Command[GetOuterHTMLParams, GetOuterHTMLResponse]

GetQueryingDescendantsForContainerCommand module-attribute

GetQueryingDescendantsForContainerCommand = Command[GetQueryingDescendantsForContainerParams, GetQueryingDescendantsForContainerResponse]

GetRelayoutBoundaryCommand module-attribute

GetRelayoutBoundaryCommand = Command[GetRelayoutBoundaryParams, GetRelayoutBoundaryResponse]

GetSearchResultsCommand module-attribute

GetSearchResultsCommand = Command[GetSearchResultsParams, GetSearchResultsResponse]

GetTopLayerElementsCommand module-attribute

GetTopLayerElementsCommand = Command[EmptyParams, GetTopLayerElementsResponse]

HideHighlightCommand module-attribute

HideHighlightCommand = Command[EmptyParams, EmptyResponse]

HighlightNodeCommand module-attribute

HighlightNodeCommand = Command[EmptyParams, EmptyResponse]

HighlightRectCommand module-attribute

HighlightRectCommand = Command[EmptyParams, EmptyResponse]

MarkUndoableStateCommand module-attribute

MarkUndoableStateCommand = Command[EmptyParams, EmptyResponse]

MoveToCommand module-attribute

MoveToCommand = Command[MoveToParams, MoveToResponse]

PerformSearchCommand module-attribute

PerformSearchCommand = Command[PerformSearchParams, PerformSearchResponse]

PushNodeByPathToFrontendCommand module-attribute

PushNodeByPathToFrontendCommand = Command[PushNodeByPathToFrontendParams, PushNodeByPathToFrontendResponse]

PushNodesByBackendIdsToFrontendCommand module-attribute

PushNodesByBackendIdsToFrontendCommand = Command[PushNodesByBackendIdsToFrontendParams, PushNodesByBackendIdsToFrontendResponse]

QuerySelectorCommand module-attribute

QuerySelectorCommand = Command[QuerySelectorParams, QuerySelectorResponse]

QuerySelectorAllCommand module-attribute

QuerySelectorAllCommand = Command[QuerySelectorAllParams, QuerySelectorAllResponse]

RedoCommand module-attribute

RedoCommand = Command[EmptyParams, EmptyResponse]

RemoveAttributeCommand module-attribute

RemoveAttributeCommand = Command[RemoveAttributeParams, EmptyResponse]

RemoveNodeCommand module-attribute

RemoveNodeCommand = Command[RemoveNodeParams, EmptyResponse]

RequestChildNodesCommand module-attribute

RequestChildNodesCommand = Command[RequestChildNodesParams, EmptyResponse]

RequestNodeCommand module-attribute

RequestNodeCommand = Command[RequestNodeParams, RequestNodeResponse]

ResolveNodeCommand module-attribute

ResolveNodeCommand = Command[ResolveNodeParams, ResolveNodeResponse]

ScrollIntoViewIfNeededCommand module-attribute

ScrollIntoViewIfNeededCommand = Command[ScrollIntoViewIfNeededParams, EmptyResponse]

SetAttributeValueCommand module-attribute

SetAttributeValueCommand = Command[SetAttributeValueParams, EmptyResponse]

SetAttributesAsTextCommand module-attribute

SetAttributesAsTextCommand = Command[SetAttributesAsTextParams, EmptyResponse]

SetFileInputFilesCommand module-attribute

SetFileInputFilesCommand = Command[SetFileInputFilesParams, EmptyResponse]

SetInspectedNodeCommand module-attribute

SetInspectedNodeCommand = Command[SetInspectedNodeParams, EmptyResponse]

SetNodeNameCommand module-attribute

SetNodeNameCommand = Command[SetNodeNameParams, SetNodeNameResponse]

SetNodeStackTracesEnabledCommand module-attribute

SetNodeStackTracesEnabledCommand = Command[SetNodeStackTracesEnabledParams, EmptyResponse]

SetNodeValueCommand module-attribute

SetNodeValueCommand = Command[SetNodeValueParams, EmptyResponse]

SetOuterHTMLCommand module-attribute

SetOuterHTMLCommand = Command[SetOuterHTMLParams, EmptyResponse]

UndoCommand module-attribute

UndoCommand = Command[EmptyParams, EmptyResponse]

DomMethod

Bases: str, Enum

DOM domain method names.

COLLECT_CLASS_NAMES_FROM_SUBTREE class-attribute instance-attribute

COLLECT_CLASS_NAMES_FROM_SUBTREE = 'DOM.collectClassNamesFromSubtree'

COPY_TO class-attribute instance-attribute

COPY_TO = 'DOM.copyTo'

DESCRIBE_NODE class-attribute instance-attribute

DESCRIBE_NODE = 'DOM.describeNode'

DISABLE class-attribute instance-attribute

DISABLE = 'DOM.disable'

DISCARD_SEARCH_RESULTS class-attribute instance-attribute

DISCARD_SEARCH_RESULTS = 'DOM.discardSearchResults'

ENABLE class-attribute instance-attribute

ENABLE = 'DOM.enable'

FOCUS class-attribute instance-attribute

FOCUS = 'DOM.focus'

FORCE_SHOW_POPOVER class-attribute instance-attribute

FORCE_SHOW_POPOVER = 'DOM.forceShowPopover'

GET_ANCHOR_ELEMENT class-attribute instance-attribute

GET_ANCHOR_ELEMENT = 'DOM.getAnchorElement'

GET_ATTRIBUTES class-attribute instance-attribute

GET_ATTRIBUTES = 'DOM.getAttributes'

GET_BOX_MODEL class-attribute instance-attribute

GET_BOX_MODEL = 'DOM.getBoxModel'

GET_CONTAINER_FOR_NODE class-attribute instance-attribute

GET_CONTAINER_FOR_NODE = 'DOM.getContainerForNode'

GET_CONTENT_QUADS class-attribute instance-attribute

GET_CONTENT_QUADS = 'DOM.getContentQuads'

GET_DETACHED_DOM_NODES class-attribute instance-attribute

GET_DETACHED_DOM_NODES = 'DOM.getDetachedDomNodes'

GET_DOCUMENT class-attribute instance-attribute

GET_DOCUMENT = 'DOM.getDocument'

GET_ELEMENT_BY_RELATION class-attribute instance-attribute

GET_ELEMENT_BY_RELATION = 'DOM.getElementByRelation'

GET_FILE_INFO class-attribute instance-attribute

GET_FILE_INFO = 'DOM.getFileInfo'

GET_FLATTENED_DOCUMENT class-attribute instance-attribute

GET_FLATTENED_DOCUMENT = 'DOM.getFlattenedDocument'

GET_FRAME_OWNER class-attribute instance-attribute

GET_FRAME_OWNER = 'DOM.getFrameOwner'

GET_NODE_FOR_LOCATION class-attribute instance-attribute

GET_NODE_FOR_LOCATION = 'DOM.getNodeForLocation'

GET_NODE_STACK_TRACES class-attribute instance-attribute

GET_NODE_STACK_TRACES = 'DOM.getNodeStackTraces'

GET_NODES_FOR_SUBTREE_BY_STYLE class-attribute instance-attribute

GET_NODES_FOR_SUBTREE_BY_STYLE = 'DOM.getNodesForSubtreeByStyle'

GET_OUTER_HTML class-attribute instance-attribute

GET_OUTER_HTML = 'DOM.getOuterHTML'

GET_QUERYING_DESCENDANTS_FOR_CONTAINER class-attribute instance-attribute

GET_QUERYING_DESCENDANTS_FOR_CONTAINER = 'DOM.getQueryingDescendantsForContainer'

GET_RELAYOUT_BOUNDARY class-attribute instance-attribute

GET_RELAYOUT_BOUNDARY = 'DOM.getRelayoutBoundary'

GET_SEARCH_RESULTS class-attribute instance-attribute

GET_SEARCH_RESULTS = 'DOM.getSearchResults'

GET_TOP_LAYER_ELEMENTS class-attribute instance-attribute

GET_TOP_LAYER_ELEMENTS = 'DOM.getTopLayerElements'

HIDE_HIGHLIGHT class-attribute instance-attribute

HIDE_HIGHLIGHT = 'DOM.hideHighlight'

HIGHLIGHT_NODE class-attribute instance-attribute

HIGHLIGHT_NODE = 'DOM.highlightNode'

HIGHLIGHT_RECT class-attribute instance-attribute

HIGHLIGHT_RECT = 'DOM.highlightRect'

MARK_UNDOABLE_STATE class-attribute instance-attribute

MARK_UNDOABLE_STATE = 'DOM.markUndoableState'

MOVE_TO class-attribute instance-attribute

MOVE_TO = 'DOM.moveTo'

PERFORM_SEARCH class-attribute instance-attribute

PERFORM_SEARCH = 'DOM.performSearch'

PUSH_NODE_BY_PATH_TO_FRONTEND class-attribute instance-attribute

PUSH_NODE_BY_PATH_TO_FRONTEND = 'DOM.pushNodeByPathToFrontend'

PUSH_NODES_BY_BACKEND_IDS_TO_FRONTEND class-attribute instance-attribute

PUSH_NODES_BY_BACKEND_IDS_TO_FRONTEND = 'DOM.pushNodesByBackendIdsToFrontend'

QUERY_SELECTOR class-attribute instance-attribute

QUERY_SELECTOR = 'DOM.querySelector'

QUERY_SELECTOR_ALL class-attribute instance-attribute

QUERY_SELECTOR_ALL = 'DOM.querySelectorAll'

REDO class-attribute instance-attribute

REDO = 'DOM.redo'

REMOVE_ATTRIBUTE class-attribute instance-attribute

REMOVE_ATTRIBUTE = 'DOM.removeAttribute'

REMOVE_NODE class-attribute instance-attribute

REMOVE_NODE = 'DOM.removeNode'

REQUEST_CHILD_NODES class-attribute instance-attribute

REQUEST_CHILD_NODES = 'DOM.requestChildNodes'

REQUEST_NODE class-attribute instance-attribute

REQUEST_NODE = 'DOM.requestNode'

RESOLVE_NODE class-attribute instance-attribute

RESOLVE_NODE = 'DOM.resolveNode'

SCROLL_INTO_VIEW_IF_NEEDED class-attribute instance-attribute

SCROLL_INTO_VIEW_IF_NEEDED = 'DOM.scrollIntoViewIfNeeded'

SET_ATTRIBUTE_VALUE class-attribute instance-attribute

SET_ATTRIBUTE_VALUE = 'DOM.setAttributeValue'

SET_ATTRIBUTES_AS_TEXT class-attribute instance-attribute

SET_ATTRIBUTES_AS_TEXT = 'DOM.setAttributesAsText'

SET_FILE_INPUT_FILES class-attribute instance-attribute

SET_FILE_INPUT_FILES = 'DOM.setFileInputFiles'

SET_INSPECTED_NODE class-attribute instance-attribute

SET_INSPECTED_NODE = 'DOM.setInspectedNode'

SET_NODE_NAME class-attribute instance-attribute

SET_NODE_NAME = 'DOM.setNodeName'

SET_NODE_STACK_TRACES_ENABLED class-attribute instance-attribute

SET_NODE_STACK_TRACES_ENABLED = 'DOM.setNodeStackTracesEnabled'

SET_NODE_VALUE class-attribute instance-attribute

SET_NODE_VALUE = 'DOM.setNodeValue'

SET_OUTER_HTML class-attribute instance-attribute

SET_OUTER_HTML = 'DOM.setOuterHTML'

UNDO class-attribute instance-attribute

UNDO = 'DOM.undo'

CollectClassNamesFromSubtreeParams

Bases: TypedDict

Parameters for collecting class names from subtree.

nodeId instance-attribute

nodeId

CopyToParams

Bases: TypedDict

Parameters for copying a node.

nodeId instance-attribute

nodeId

targetNodeId instance-attribute

targetNodeId

insertBeforeNodeId instance-attribute

insertBeforeNodeId

DescribeNodeParams

Bases: TypedDict

Parameters for describing a node.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

depth instance-attribute

depth

pierce instance-attribute

pierce

ScrollIntoViewIfNeededParams

Bases: TypedDict

Parameters for scrolling into view if needed.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

rect instance-attribute

rect

DiscardSearchResultsParams

Bases: TypedDict

Parameters for discarding search results.

searchId instance-attribute

searchId

EnableParams

Bases: TypedDict

Parameters for enabling DOM agent.

includeWhitespace instance-attribute

includeWhitespace

FocusParams

Bases: TypedDict

Parameters for focusing an element.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

GetAttributesParams

Bases: TypedDict

Parameters for getting attributes.

nodeId instance-attribute

nodeId

GetBoxModelParams

Bases: TypedDict

Parameters for getting box model.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

GetContentQuadsParams

Bases: TypedDict

Parameters for getting content quads.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

GetDocumentParams

Bases: TypedDict

Parameters for getting document.

depth instance-attribute

depth

pierce instance-attribute

pierce

GetFlattenedDocumentParams

Bases: TypedDict

Parameters for getting flattened document.

depth instance-attribute

depth

pierce instance-attribute

pierce

GetNodesForSubtreeByStyleParams

Bases: TypedDict

Parameters for getting nodes by style.

nodeId instance-attribute

nodeId

computedStyles instance-attribute

computedStyles

pierce instance-attribute

pierce

GetNodeForLocationParams

Bases: TypedDict

Parameters for getting node for location.

x instance-attribute

x

y instance-attribute

y

includeUserAgentShadowDOM instance-attribute

includeUserAgentShadowDOM

ignorePointerEventsNone instance-attribute

ignorePointerEventsNone

GetOuterHTMLParams

Bases: TypedDict

Parameters for getting outer HTML.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

includeShadowDOM instance-attribute

includeShadowDOM

GetRelayoutBoundaryParams

Bases: TypedDict

Parameters for getting relayout boundary.

nodeId instance-attribute

nodeId

GetSearchResultsParams

Bases: TypedDict

Parameters for getting search results.

searchId instance-attribute

searchId

fromIndex instance-attribute

fromIndex

toIndex instance-attribute

toIndex

MoveToParams

Bases: TypedDict

Parameters for moving a node.

nodeId instance-attribute

nodeId

targetNodeId instance-attribute

targetNodeId

insertBeforeNodeId instance-attribute

insertBeforeNodeId

PerformSearchParams

Bases: TypedDict

Parameters for performing search.

query instance-attribute

query

includeUserAgentShadowDOM instance-attribute

includeUserAgentShadowDOM

PushNodeByPathToFrontendParams

Bases: TypedDict

Parameters for pushing node by path to frontend.

path instance-attribute

path

PushNodesByBackendIdsToFrontendParams

Bases: TypedDict

Parameters for pushing nodes by backend IDs to frontend.

backendNodeIds instance-attribute

backendNodeIds

QuerySelectorParams

Bases: TypedDict

Parameters for querySelector.

nodeId instance-attribute

nodeId

selector instance-attribute

selector

QuerySelectorAllParams

Bases: TypedDict

Parameters for querySelectorAll.

nodeId instance-attribute

nodeId

selector instance-attribute

selector

GetElementByRelationParams

Bases: TypedDict

Parameters for getting element by relation.

nodeId instance-attribute

nodeId

relation instance-attribute

relation

RemoveAttributeParams

Bases: TypedDict

Parameters for removing attribute.

nodeId instance-attribute

nodeId

name instance-attribute

name

RemoveNodeParams

Bases: TypedDict

Parameters for removing node.

nodeId instance-attribute

nodeId

RequestChildNodesParams

Bases: TypedDict

Parameters for requesting child nodes.

nodeId instance-attribute

nodeId

depth instance-attribute

depth

pierce instance-attribute

pierce

RequestNodeParams

Bases: TypedDict

Parameters for requesting node.

objectId instance-attribute

objectId

ResolveNodeParams

Bases: TypedDict

Parameters for resolving node.

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectGroup instance-attribute

objectGroup

executionContextId instance-attribute

executionContextId

SetAttributeValueParams

Bases: TypedDict

Parameters for setting attribute value.

nodeId instance-attribute

nodeId

name instance-attribute

name

value instance-attribute

value

SetAttributesAsTextParams

Bases: TypedDict

Parameters for setting attributes as text.

nodeId instance-attribute

nodeId

text instance-attribute

text

name instance-attribute

name

SetFileInputFilesParams

Bases: TypedDict

Parameters for setting file input files.

files instance-attribute

files

nodeId instance-attribute

nodeId

backendNodeId instance-attribute

backendNodeId

objectId instance-attribute

objectId

SetNodeStackTracesEnabledParams

Bases: TypedDict

Parameters for setting node stack traces enabled.

enable instance-attribute

enable

GetNodeStackTracesParams

Bases: TypedDict

Parameters for getting node stack traces.

nodeId instance-attribute

nodeId

GetFileInfoParams

Bases: TypedDict

Parameters for getting file info.

objectId instance-attribute

objectId

SetInspectedNodeParams

Bases: TypedDict

Parameters for setting inspected node.

nodeId instance-attribute

nodeId

SetNodeNameParams

Bases: TypedDict

Parameters for setting node name.

nodeId instance-attribute

nodeId

name instance-attribute

name

SetNodeValueParams

Bases: TypedDict

Parameters for setting node value.

nodeId instance-attribute

nodeId

value instance-attribute

value

SetOuterHTMLParams

Bases: TypedDict

Parameters for setting outer HTML.

nodeId instance-attribute

nodeId

outerHTML instance-attribute

outerHTML

GetFrameOwnerParams

Bases: TypedDict

Parameters for getting frame owner.

frameId instance-attribute

frameId

GetContainerForNodeParams

Bases: TypedDict

Parameters for getting container for node.

nodeId instance-attribute

nodeId

containerName instance-attribute

containerName

physicalAxes instance-attribute

physicalAxes

logicalAxes instance-attribute

logicalAxes

queriesScrollState instance-attribute

queriesScrollState

queriesAnchored instance-attribute

queriesAnchored

GetQueryingDescendantsForContainerParams

Bases: TypedDict

Parameters for getting querying descendants for container.

nodeId instance-attribute

nodeId

GetAnchorElementParams

Bases: TypedDict

Parameters for getting anchor element.

nodeId instance-attribute

nodeId

anchorSpecifier instance-attribute

anchorSpecifier

ForceShowPopoverParams

Bases: TypedDict

Parameters for forcing show popover.

nodeId instance-attribute

nodeId

enable instance-attribute

enable

CollectClassNamesFromSubtreeResult

Bases: TypedDict

Result for collectClassNamesFromSubtree command.

classNames instance-attribute

classNames

CopyToResult

Bases: TypedDict

Result for copyTo command.

nodeId instance-attribute

nodeId

DescribeNodeResult

Bases: TypedDict

Result for describeNode command.

node instance-attribute

node

GetAttributesResult

Bases: TypedDict

Result for getAttributes command.

attributes instance-attribute

attributes

GetBoxModelResult

Bases: TypedDict

Result for getBoxModel command.

model instance-attribute

model

GetContentQuadsResult

Bases: TypedDict

Result for getContentQuads command.

quads instance-attribute

quads

GetDocumentResult

Bases: TypedDict

Result for getDocument command.

root instance-attribute

root

GetFlattenedDocumentResult

Bases: TypedDict

Result for getFlattenedDocument command.

nodes instance-attribute

nodes

GetNodesForSubtreeByStyleResult

Bases: TypedDict

Result for getNodesForSubtreeByStyle command.

nodeIds instance-attribute

nodeIds

GetNodeForLocationResult

Bases: TypedDict

Result for getNodeForLocation command.

backendNodeId instance-attribute

backendNodeId

frameId instance-attribute

frameId

nodeId instance-attribute

nodeId

GetOuterHTMLResult

Bases: TypedDict

Result for getOuterHTML command.

outerHTML instance-attribute

outerHTML

GetRelayoutBoundaryResult

Bases: TypedDict

Result for getRelayoutBoundary command.

nodeId instance-attribute

nodeId

GetSearchResultsResult

Bases: TypedDict

Result for getSearchResults command.

nodeIds instance-attribute

nodeIds

GetTopLayerElementsResult

Bases: TypedDict

Result for getTopLayerElements command.

nodeIds instance-attribute

nodeIds

GetElementByRelationResult

Bases: TypedDict

Result for getElementByRelation command.

nodeId instance-attribute

nodeId

MoveToResult

Bases: TypedDict

Result for moveTo command.

nodeId instance-attribute

nodeId

PerformSearchResult

Bases: TypedDict

Result for performSearch command.

searchId instance-attribute

searchId

resultCount instance-attribute

resultCount

PushNodeByPathToFrontendResult

Bases: TypedDict

Result for pushNodeByPathToFrontend command.

nodeId instance-attribute

nodeId

PushNodesByBackendIdsToFrontendResult

Bases: TypedDict

Result for pushNodesByBackendIdsToFrontend command.

nodeIds instance-attribute

nodeIds

QuerySelectorResult

Bases: TypedDict

Result for querySelector command.

nodeId instance-attribute

nodeId

QuerySelectorAllResult

Bases: TypedDict

Result for querySelectorAll command.

nodeIds instance-attribute

nodeIds

RequestNodeResult

Bases: TypedDict

Result for requestNode command.

nodeId instance-attribute

nodeId

ResolveNodeResult

Bases: TypedDict

Result for resolveNode command.

object instance-attribute

object

SetNodeNameResult

Bases: TypedDict

Result for setNodeName command.

nodeId instance-attribute

nodeId

GetNodeStackTracesResult

Bases: TypedDict

Result for getNodeStackTraces command.

creation instance-attribute

creation

GetFileInfoResult

Bases: TypedDict

Result for getFileInfo command.

path instance-attribute

path

GetDetachedDomNodesResult

Bases: TypedDict

Result for getDetachedDomNodes command.

detachedNodes instance-attribute

detachedNodes

GetFrameOwnerResult

Bases: TypedDict

Result for getFrameOwner command.

backendNodeId instance-attribute

backendNodeId

nodeId instance-attribute

nodeId

GetContainerForNodeResult

Bases: TypedDict

Result for getContainerForNode command.

nodeId instance-attribute

nodeId

GetQueryingDescendantsForContainerResult

Bases: TypedDict

Result for getQueryingDescendantsForContainer command.

nodeIds instance-attribute

nodeIds

GetAnchorElementResult

Bases: TypedDict

Result for getAnchorElement command.

nodeId instance-attribute

nodeId

ForceShowPopoverResult

Bases: TypedDict

Result for forceShowPopover command.

nodeIds instance-attribute

nodeIds

Events

pydoll.protocol.dom.events

AttributeModifiedEvent module-attribute

AttributeModifiedEvent = CDPEvent[AttributeModifiedEventParams]

AttributeRemovedEvent module-attribute

AttributeRemovedEvent = CDPEvent[AttributeRemovedEventParams]

CharacterDataModifiedEvent module-attribute

CharacterDataModifiedEvent = CDPEvent[CharacterDataModifiedEventParams]

ChildNodeCountUpdatedEvent module-attribute

ChildNodeCountUpdatedEvent = CDPEvent[ChildNodeCountUpdatedEventParams]

ChildNodeInsertedEvent module-attribute

ChildNodeInsertedEvent = CDPEvent[ChildNodeInsertedEventParams]

ChildNodeRemovedEvent module-attribute

ChildNodeRemovedEvent = CDPEvent[ChildNodeRemovedEventParams]

DistributedNodesUpdatedEvent module-attribute

DistributedNodesUpdatedEvent = CDPEvent[DistributedNodesUpdatedEventParams]

DocumentUpdatedEvent module-attribute

DocumentUpdatedEvent = CDPEvent[DocumentUpdatedEventParams]

InlineStyleInvalidatedEvent module-attribute

InlineStyleInvalidatedEvent = CDPEvent[InlineStyleInvalidatedEventParams]

PseudoElementAddedEvent module-attribute

PseudoElementAddedEvent = CDPEvent[PseudoElementAddedEventParams]

PseudoElementRemovedEvent module-attribute

PseudoElementRemovedEvent = CDPEvent[PseudoElementRemovedEventParams]

ScrollableFlagUpdatedEvent module-attribute

ScrollableFlagUpdatedEvent = CDPEvent[ScrollableFlagUpdatedEventParams]

ShadowRootPoppedEvent module-attribute

ShadowRootPoppedEvent = CDPEvent[ShadowRootPoppedEventParams]

ShadowRootPushedEvent module-attribute

ShadowRootPushedEvent = CDPEvent[ShadowRootPushedEventParams]

SetChildNodesEvent module-attribute

SetChildNodesEvent = CDPEvent[SetChildNodesEventParams]

TopLayerElementsUpdatedEvent module-attribute

TopLayerElementsUpdatedEvent = CDPEvent[TopLayerElementsUpdatedEventParams]

DomEvent

Bases: str, Enum

Events from the DOM domain of the Chrome DevTools Protocol.

This enumeration contains the names of DOM-related events that can be received from the Chrome DevTools Protocol. These events provide information about changes to the DOM structure, attributes, and other DOM-related activities.

ATTRIBUTE_MODIFIED class-attribute instance-attribute

ATTRIBUTE_MODIFIED = 'DOM.attributeModified'

Fired when Element's attribute is modified.

PARAMETER	DESCRIPTION
nodeId	Id of the node that has changed. TYPE: NodeId
name	Attribute name. TYPE: str
value	Attribute value. TYPE: str

ATTRIBUTE_REMOVED class-attribute instance-attribute

ATTRIBUTE_REMOVED = 'DOM.attributeRemoved'

Fired when Element's attribute is removed.

PARAMETER	DESCRIPTION
nodeId	Id of the node that has changed. TYPE: NodeId
name	Attribute name. TYPE: str

CHARACTER_DATA_MODIFIED class-attribute instance-attribute

CHARACTER_DATA_MODIFIED = 'DOM.characterDataModified'

Mirrors DOMCharacterDataModified event.

PARAMETER	DESCRIPTION
nodeId	Id of the node that has changed. TYPE: NodeId
characterData	New text value. TYPE: str

CHILD_NODE_COUNT_UPDATED class-attribute instance-attribute

CHILD_NODE_COUNT_UPDATED = 'DOM.childNodeCountUpdated'

Fired when Container's child node count has changed.

PARAMETER	DESCRIPTION
nodeId	Id of the node that has changed. TYPE: NodeId
childNodeCount	New node count. TYPE: int

CHILD_NODE_INSERTED class-attribute instance-attribute

CHILD_NODE_INSERTED = 'DOM.childNodeInserted'

Mirrors DOMNodeInserted event.

PARAMETER	DESCRIPTION
parentNodeId	Id of the node that has changed. TYPE: NodeId
previousNodeId	Id of the previous sibling. TYPE: NodeId
node	Inserted node data. TYPE: Node

CHILD_NODE_REMOVED class-attribute instance-attribute

CHILD_NODE_REMOVED = 'DOM.childNodeRemoved'

Mirrors DOMNodeRemoved event.

PARAMETER	DESCRIPTION
parentNodeId	Parent id. TYPE: NodeId
nodeId	Id of the node that has been removed. TYPE: NodeId

DISTRIBUTED_NODES_UPDATED class-attribute instance-attribute

DISTRIBUTED_NODES_UPDATED = 'DOM.distributedNodesUpdated'

Called when distribution is changed.

PARAMETER	DESCRIPTION
insertionPointId	Insertion point where distributed nodes were updated. TYPE: NodeId
distributedNodes	Distributed nodes for given insertion point. TYPE: array[BackendNode]

DOCUMENT_UPDATED class-attribute instance-attribute

DOCUMENT_UPDATED = 'DOM.documentUpdated'

Fired when Document has been totally updated. Node ids are no longer valid.

INLINE_STYLE_INVALIDATED class-attribute instance-attribute

INLINE_STYLE_INVALIDATED = 'DOM.inlineStyleInvalidated'

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

PARAMETER	DESCRIPTION
nodeIds	Ids of the nodes for which the inline styles have been invalidated. TYPE: array[NodeId]

PSEUDO_ELEMENT_ADDED class-attribute instance-attribute

PSEUDO_ELEMENT_ADDED = 'DOM.pseudoElementAdded'

Called when a pseudo element is added to an element.

PARAMETER	DESCRIPTION
parentId	Pseudo element's parent element id. TYPE: NodeId
pseudoElement	The added pseudo element. TYPE: Node

PSEUDO_ELEMENT_REMOVED class-attribute instance-attribute

PSEUDO_ELEMENT_REMOVED = 'DOM.pseudoElementRemoved'

Called when a pseudo element is removed from an element.

PARAMETER	DESCRIPTION
parentId	Pseudo element's parent element id. TYPE: NodeId
pseudoElementId	The removed pseudo element id. TYPE: NodeId

SCROLLABLE_FLAG_UPDATED class-attribute instance-attribute

SCROLLABLE_FLAG_UPDATED = 'DOM.scrollableFlagUpdated'

Fired when a node's scrollability state changes.

PARAMETER	DESCRIPTION
nodeId	The id of the node. TYPE: NodeId
isScrollable	If the node is scrollable. TYPE: bool

SHADOW_ROOT_POPPED class-attribute instance-attribute

SHADOW_ROOT_POPPED = 'DOM.shadowRootPopped'

Called when shadow root is popped from the element.

PARAMETER	DESCRIPTION
hostId	Host element id. TYPE: NodeId
rootId	Shadow root id. TYPE: NodeId

SHADOW_ROOT_PUSHED class-attribute instance-attribute

SHADOW_ROOT_PUSHED = 'DOM.shadowRootPushed'

Called when shadow root is pushed into the element.

PARAMETER	DESCRIPTION
hostId	Host element id. TYPE: NodeId
root	Shadow root. TYPE: Node

SET_CHILD_NODES class-attribute instance-attribute

SET_CHILD_NODES = 'DOM.setChildNodes'

Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.

PARAMETER	DESCRIPTION
parentId	Parent node id to populate with children. TYPE: NodeId
nodes	Child nodes array. TYPE: array[Node]

TOP_LAYER_ELEMENTS_UPDATED class-attribute instance-attribute

TOP_LAYER_ELEMENTS_UPDATED = 'DOM.topLayerElementsUpdated'

Called when top layer elements are changed.

AttributeModifiedEventParams

Bases: TypedDict

Parameters for attributeModified event.

nodeId instance-attribute

nodeId

name instance-attribute

name

value instance-attribute

value

AttributeRemovedEventParams

Bases: TypedDict

Parameters for attributeRemoved event.

nodeId instance-attribute

nodeId

name instance-attribute

name

CharacterDataModifiedEventParams

Bases: TypedDict

Parameters for characterDataModified event.

nodeId instance-attribute

nodeId

characterData instance-attribute

characterData

ChildNodeCountUpdatedEventParams

Bases: TypedDict

Parameters for childNodeCountUpdated event.

nodeId instance-attribute

nodeId

childNodeCount instance-attribute

childNodeCount

ChildNodeInsertedEventParams

Bases: TypedDict

Parameters for childNodeInserted event.

parentNodeId instance-attribute

parentNodeId

previousNodeId instance-attribute

previousNodeId

node instance-attribute

node

ChildNodeRemovedEventParams

Bases: TypedDict

Parameters for childNodeRemoved event.

parentNodeId instance-attribute

parentNodeId

nodeId instance-attribute

nodeId

DistributedNodesUpdatedEventParams

Bases: TypedDict

Parameters for distributedNodesUpdated event.

insertionPointId instance-attribute

insertionPointId

distributedNodes instance-attribute

distributedNodes

DocumentUpdatedEventParams

Bases: TypedDict

Parameters for documentUpdated event.

InlineStyleInvalidatedEventParams

Bases: TypedDict

Parameters for inlineStyleInvalidated event.

nodeIds instance-attribute

nodeIds

PseudoElementAddedEventParams

Bases: TypedDict

Parameters for pseudoElementAdded event.

parentId instance-attribute

parentId

pseudoElement instance-attribute

pseudoElement

PseudoElementRemovedEventParams

Bases: TypedDict

Parameters for pseudoElementRemoved event.

parentId instance-attribute

parentId

pseudoElementId instance-attribute

pseudoElementId

ScrollableFlagUpdatedEventParams

Bases: TypedDict

Parameters for scrollableFlagUpdated event.

nodeId instance-attribute

nodeId

isScrollable instance-attribute

isScrollable

ShadowRootPoppedEventParams

Bases: TypedDict

Parameters for shadowRootPopped event.

hostId instance-attribute

hostId

rootId instance-attribute

rootId

ShadowRootPushedEventParams

Bases: TypedDict

Parameters for shadowRootPushed event.

hostId instance-attribute

hostId

root instance-attribute

root

SetChildNodesEventParams

Bases: TypedDict

Parameters for setChildNodes event.

parentId instance-attribute

parentId

nodes instance-attribute

nodes

TopLayerElementsUpdatedEventParams

Bases: TypedDict

Parameters for topLayerElementsUpdated event.

Types

pydoll.protocol.dom.types

NodeId module-attribute

NodeId = int

BackendNodeId module-attribute

BackendNodeId = int

Quad module-attribute

Quad = Annotated[list[float], 'Format: [x1, y1, x2, y2, x3, y3, x4, y4]']

PseudoType

Bases: str, Enum

Pseudo element type.

FIRST_LINE class-attribute instance-attribute

FIRST_LINE = 'first-line'

FIRST_LETTER class-attribute instance-attribute

FIRST_LETTER = 'first-letter'

CHECKMARK class-attribute instance-attribute

CHECKMARK = 'checkmark'

BEFORE class-attribute instance-attribute

BEFORE = 'before'

AFTER class-attribute instance-attribute

AFTER = 'after'

PICKER_ICON class-attribute instance-attribute

PICKER_ICON = 'picker-icon'

MARKER class-attribute instance-attribute

MARKER = 'marker'

BACKDROP class-attribute instance-attribute

BACKDROP = 'backdrop'

COLUMN class-attribute instance-attribute

COLUMN = 'column'

SELECTION class-attribute instance-attribute

SELECTION = 'selection'

SEARCH_TEXT class-attribute instance-attribute

SEARCH_TEXT = 'search-text'

TARGET_TEXT class-attribute instance-attribute

TARGET_TEXT = 'target-text'

SPELLING_ERROR class-attribute instance-attribute

SPELLING_ERROR = 'spelling-error'

GRAMMAR_ERROR class-attribute instance-attribute

GRAMMAR_ERROR = 'grammar-error'

HIGHLIGHT class-attribute instance-attribute

HIGHLIGHT = 'highlight'

FIRST_LINE_INHERITED class-attribute instance-attribute

FIRST_LINE_INHERITED = 'first-line-inherited'

SCROLL_MARKER class-attribute instance-attribute

SCROLL_MARKER = 'scroll-marker'

SCROLL_MARKER_GROUP class-attribute instance-attribute

SCROLL_MARKER_GROUP = 'scroll-marker-group'

SCROLL_BUTTON class-attribute instance-attribute

SCROLL_BUTTON = 'scroll-button'

SCROLLBAR class-attribute instance-attribute

SCROLLBAR = 'scrollbar'

SCROLLBAR_THUMB class-attribute instance-attribute

SCROLLBAR_THUMB = 'scrollbar-thumb'

SCROLLBAR_BUTTON class-attribute instance-attribute

SCROLLBAR_BUTTON = 'scrollbar-button'

SCROLLBAR_TRACK class-attribute instance-attribute

SCROLLBAR_TRACK = 'scrollbar-track'

SCROLLBAR_TRACK_PIECE class-attribute instance-attribute

SCROLLBAR_TRACK_PIECE = 'scrollbar-track-piece'

SCROLLBAR_CORNER class-attribute instance-attribute

SCROLLBAR_CORNER = 'scrollbar-corner'

RESIZER class-attribute instance-attribute

RESIZER = 'resizer'

INPUT_LIST_BUTTON class-attribute instance-attribute

INPUT_LIST_BUTTON = 'input-list-button'

VIEW_TRANSITION class-attribute instance-attribute

VIEW_TRANSITION = 'view-transition'

VIEW_TRANSITION_GROUP class-attribute instance-attribute

VIEW_TRANSITION_GROUP = 'view-transition-group'

VIEW_TRANSITION_IMAGE_PAIR class-attribute instance-attribute

VIEW_TRANSITION_IMAGE_PAIR = 'view-transition-image-pair'

VIEW_TRANSITION_GROUP_CHILDREN class-attribute instance-attribute

VIEW_TRANSITION_GROUP_CHILDREN = 'view-transition-group-children'

VIEW_TRANSITION_OLD class-attribute instance-attribute

VIEW_TRANSITION_OLD = 'view-transition-old'

VIEW_TRANSITION_NEW class-attribute instance-attribute

VIEW_TRANSITION_NEW = 'view-transition-new'

PLACEHOLDER class-attribute instance-attribute

PLACEHOLDER = 'placeholder'

FILE_SELECTOR_BUTTON class-attribute instance-attribute

FILE_SELECTOR_BUTTON = 'file-selector-button'

DETAILS_CONTENT class-attribute instance-attribute

DETAILS_CONTENT = 'details-content'

PICKER class-attribute instance-attribute

PICKER = 'picker'

PERMISSION_ICON class-attribute instance-attribute

PERMISSION_ICON = 'permission-icon'

ShadowRootType

Bases: str, Enum

Shadow root type.

USER_AGENT class-attribute instance-attribute

USER_AGENT = 'user-agent'

OPEN class-attribute instance-attribute

OPEN = 'open'

CLOSED class-attribute instance-attribute

CLOSED = 'closed'

CompatibilityMode

Bases: str, Enum

Document compatibility mode.

QUIRKS_MODE class-attribute instance-attribute

QUIRKS_MODE = 'QuirksMode'

LIMITED_QUIRKS_MODE class-attribute instance-attribute

LIMITED_QUIRKS_MODE = 'LimitedQuirksMode'

NO_QUIRKS_MODE class-attribute instance-attribute

NO_QUIRKS_MODE = 'NoQuirksMode'

PhysicalAxes

Bases: str, Enum

ContainerSelector physical axes.

HORIZONTAL class-attribute instance-attribute

HORIZONTAL = 'Horizontal'

VERTICAL class-attribute instance-attribute

VERTICAL = 'Vertical'

BOTH class-attribute instance-attribute

BOTH = 'Both'

LogicalAxes

Bases: str, Enum

ContainerSelector logical axes.

INLINE class-attribute instance-attribute

INLINE = 'Inline'

BLOCK class-attribute instance-attribute

BLOCK = 'Block'

BOTH class-attribute instance-attribute

BOTH = 'Both'

ScrollOrientation

Bases: str, Enum

Physical scroll orientation.

HORIZONTAL class-attribute instance-attribute

HORIZONTAL = 'horizontal'

VERTICAL class-attribute instance-attribute

VERTICAL = 'vertical'

IncludeWhitespace

Bases: str, Enum

Include whitespace options.

NONE class-attribute instance-attribute

NONE = 'none'

ALL class-attribute instance-attribute

ALL = 'all'

RelationType

Bases: str, Enum

Element relation types.

POPOVER_TARGET class-attribute instance-attribute

POPOVER_TARGET = 'PopoverTarget'

INTEREST_TARGET class-attribute instance-attribute

INTEREST_TARGET = 'InterestTarget'

COMMAND_FOR class-attribute instance-attribute

COMMAND_FOR = 'CommandFor'

BackendNode

Bases: TypedDict

Backend node with a friendly name.

nodeType instance-attribute

nodeType

nodeName instance-attribute

nodeName

backendNodeId instance-attribute

backendNodeId

Node

Bases: TypedDict

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

nodeId instance-attribute

nodeId

parentId instance-attribute

parentId

backendNodeId instance-attribute

backendNodeId

nodeType instance-attribute

nodeType

nodeName instance-attribute

nodeName

localName instance-attribute

localName

nodeValue instance-attribute

nodeValue

childNodeCount instance-attribute

childNodeCount

children instance-attribute

children

attributes instance-attribute

attributes

documentURL instance-attribute

documentURL

baseURL instance-attribute

baseURL

publicId instance-attribute

publicId

systemId instance-attribute

systemId

internalSubset instance-attribute

internalSubset

xmlVersion instance-attribute

xmlVersion

name instance-attribute

name

value instance-attribute

value

pseudoType instance-attribute

pseudoType

pseudoIdentifier instance-attribute

pseudoIdentifier

shadowRootType instance-attribute

shadowRootType

frameId instance-attribute

frameId

contentDocument instance-attribute

contentDocument

shadowRoots instance-attribute

shadowRoots

templateContent instance-attribute

templateContent

pseudoElements instance-attribute

pseudoElements

importedDocument instance-attribute

importedDocument

distributedNodes instance-attribute

distributedNodes

isSVG instance-attribute

isSVG

compatibilityMode instance-attribute

compatibilityMode

assignedSlot instance-attribute

assignedSlot

isScrollable instance-attribute

isScrollable

DetachedElementInfo

Bases: TypedDict

A structure to hold the top-level node of a detached tree and an array of its retained descendants.

treeNode instance-attribute

treeNode

retainedNodeIds instance-attribute

retainedNodeIds

RGBA

Bases: TypedDict

A structure holding an RGBA color.

r instance-attribute

r

g instance-attribute

g

b instance-attribute

b

a instance-attribute

a

BoxModel

Bases: TypedDict

Box model.

content instance-attribute

content

padding instance-attribute

padding

border instance-attribute

border

margin instance-attribute

margin

width instance-attribute

width

height instance-attribute

height

shapeOutside instance-attribute

shapeOutside

ShapeOutsideInfo

Bases: TypedDict

CSS Shape Outside details.

bounds instance-attribute

bounds

shape instance-attribute

shape

marginShape instance-attribute

marginShape

Rect

Bases: TypedDict

Rectangle.

x instance-attribute

x

y instance-attribute

y

width instance-attribute

width

height instance-attribute

height

CSSComputedStyleProperty

Bases: TypedDict

CSS computed style property.

name instance-attribute

name

value instance-attribute

value