Skip to content

dom_snapshot

ArrayOfStrings

Bases: list

Index of the string in the strings table.

Source code in zendriver/cdp/dom_snapshot.py 
476
477
478
479
480
481
482
483
484
485
486
487
488
489
class ArrayOfStrings(list):
    """
    Index of the string in the strings table.
    """

    def to_json(self) -> typing.List[StringIndex]:
        return self

    @classmethod
    def from_json(cls, json: typing.List[StringIndex]) -> ArrayOfStrings:
        return cls(json)

    def __repr__(self):
        return "ArrayOfStrings({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/dom_snapshot.py 
488
489
def __repr__(self):
    return "ArrayOfStrings({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
484
485
486
@classmethod
def from_json(cls, json: typing.List[StringIndex]) -> ArrayOfStrings:
    return cls(json)

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
481
482
def to_json(self) -> typing.List[StringIndex]:
    return self

ComputedStyle dataclass

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

Source code in zendriver/cdp/dom_snapshot.py 
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
@dataclass
class ComputedStyle:
    """
    A subset of the full ComputedStyle as defined by the request whitelist.
    """

    #: Name/value pairs of computed style properties.
    properties: typing.List[NameValue]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["properties"] = [i.to_json() for i in self.properties]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ComputedStyle:
        return cls(
            properties=[NameValue.from_json(i) for i in json["properties"]],
        )

properties: typing.List[NameValue] instance-attribute

__init__(properties)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
427
428
429
430
431
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ComputedStyle:
    return cls(
        properties=[NameValue.from_json(i) for i in json["properties"]],
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
422
423
424
425
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["properties"] = [i.to_json() for i in self.properties]
    return json

DOMNode dataclass

A Node in the DOM tree.

Source code in zendriver/cdp/dom_snapshot.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
@dataclass
class DOMNode:
    """
    A Node in the DOM tree.
    """

    #: ``Node``'s nodeType.
    node_type: int

    #: ``Node``'s nodeName.
    node_name: str

    #: ``Node``'s nodeValue.
    node_value: str

    #: ``Node``'s id, corresponds to DOM.Node.backendNodeId.
    backend_node_id: dom.BackendNodeId

    #: Only set for textarea elements, contains the text value.
    text_value: typing.Optional[str] = None

    #: Only set for input elements, contains the input's associated text value.
    input_value: typing.Optional[str] = None

    #: Only set for radio and checkbox input elements, indicates if the element has been checked
    input_checked: typing.Optional[bool] = None

    #: Only set for option elements, indicates if the element has been selected
    option_selected: typing.Optional[bool] = None

    #: The indexes of the node's child nodes in the ``domNodes`` array returned by ``getSnapshot``, if
    #: any.
    child_node_indexes: typing.Optional[typing.List[int]] = None

    #: Attributes of an ``Element`` node.
    attributes: typing.Optional[typing.List[NameValue]] = None

    #: Indexes of pseudo elements associated with this node in the ``domNodes`` array returned by
    #: ``getSnapshot``, if any.
    pseudo_element_indexes: typing.Optional[typing.List[int]] = None

    #: The index of the node's related layout tree node in the ``layoutTreeNodes`` array returned by
    #: ``getSnapshot``, if any.
    layout_node_index: typing.Optional[int] = None

    #: Document URL that ``Document`` or ``FrameOwner`` node points to.
    document_url: typing.Optional[str] = None

    #: Base URL that ``Document`` or ``FrameOwner`` node uses for URL completion.
    base_url: typing.Optional[str] = None

    #: Only set for documents, contains the document's content language.
    content_language: typing.Optional[str] = None

    #: Only set for documents, contains the document's character set encoding.
    document_encoding: typing.Optional[str] = None

    #: ``DocumentType`` node's publicId.
    public_id: typing.Optional[str] = None

    #: ``DocumentType`` node's systemId.
    system_id: typing.Optional[str] = None

    #: Frame ID for frame owner elements and also for the document node.
    frame_id: typing.Optional[page.FrameId] = None

    #: The index of a frame owner element's content document in the ``domNodes`` array returned by
    #: ``getSnapshot``, if any.
    content_document_index: typing.Optional[int] = None

    #: Type of a pseudo element node.
    pseudo_type: typing.Optional[dom.PseudoType] = None

    #: Shadow root type.
    shadow_root_type: typing.Optional[dom.ShadowRootType] = None

    #: Whether this DOM node responds to mouse clicks. This includes nodes that have had click
    #: event listeners attached via JavaScript as well as anchor tags that naturally navigate when
    #: clicked.
    is_clickable: typing.Optional[bool] = None

    #: Details of the node's event listeners, if any.
    event_listeners: typing.Optional[typing.List[dom_debugger.EventListener]] = None

    #: The selected url for nodes with a srcset attribute.
    current_source_url: typing.Optional[str] = None

    #: The url of the script (if any) that generates this node.
    origin_url: typing.Optional[str] = None

    #: Scroll offsets, set when this node is a Document.
    scroll_offset_x: typing.Optional[float] = None

    scroll_offset_y: typing.Optional[float] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["nodeType"] = self.node_type
        json["nodeName"] = self.node_name
        json["nodeValue"] = self.node_value
        json["backendNodeId"] = self.backend_node_id.to_json()
        if self.text_value is not None:
            json["textValue"] = self.text_value
        if self.input_value is not None:
            json["inputValue"] = self.input_value
        if self.input_checked is not None:
            json["inputChecked"] = self.input_checked
        if self.option_selected is not None:
            json["optionSelected"] = self.option_selected
        if self.child_node_indexes is not None:
            json["childNodeIndexes"] = [i for i in self.child_node_indexes]
        if self.attributes is not None:
            json["attributes"] = [i.to_json() for i in self.attributes]
        if self.pseudo_element_indexes is not None:
            json["pseudoElementIndexes"] = [i for i in self.pseudo_element_indexes]
        if self.layout_node_index is not None:
            json["layoutNodeIndex"] = self.layout_node_index
        if self.document_url is not None:
            json["documentURL"] = self.document_url
        if self.base_url is not None:
            json["baseURL"] = self.base_url
        if self.content_language is not None:
            json["contentLanguage"] = self.content_language
        if self.document_encoding is not None:
            json["documentEncoding"] = self.document_encoding
        if self.public_id is not None:
            json["publicId"] = self.public_id
        if self.system_id is not None:
            json["systemId"] = self.system_id
        if self.frame_id is not None:
            json["frameId"] = self.frame_id.to_json()
        if self.content_document_index is not None:
            json["contentDocumentIndex"] = self.content_document_index
        if self.pseudo_type is not None:
            json["pseudoType"] = self.pseudo_type.to_json()
        if self.shadow_root_type is not None:
            json["shadowRootType"] = self.shadow_root_type.to_json()
        if self.is_clickable is not None:
            json["isClickable"] = self.is_clickable
        if self.event_listeners is not None:
            json["eventListeners"] = [i.to_json() for i in self.event_listeners]
        if self.current_source_url is not None:
            json["currentSourceURL"] = self.current_source_url
        if self.origin_url is not None:
            json["originURL"] = self.origin_url
        if self.scroll_offset_x is not None:
            json["scrollOffsetX"] = self.scroll_offset_x
        if self.scroll_offset_y is not None:
            json["scrollOffsetY"] = self.scroll_offset_y
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DOMNode:
        return cls(
            node_type=int(json["nodeType"]),
            node_name=str(json["nodeName"]),
            node_value=str(json["nodeValue"]),
            backend_node_id=dom.BackendNodeId.from_json(json["backendNodeId"]),
            text_value=(
                str(json["textValue"])
                if json.get("textValue", None) is not None
                else None
            ),
            input_value=(
                str(json["inputValue"])
                if json.get("inputValue", None) is not None
                else None
            ),
            input_checked=(
                bool(json["inputChecked"])
                if json.get("inputChecked", None) is not None
                else None
            ),
            option_selected=(
                bool(json["optionSelected"])
                if json.get("optionSelected", None) is not None
                else None
            ),
            child_node_indexes=(
                [int(i) for i in json["childNodeIndexes"]]
                if json.get("childNodeIndexes", None) is not None
                else None
            ),
            attributes=(
                [NameValue.from_json(i) for i in json["attributes"]]
                if json.get("attributes", None) is not None
                else None
            ),
            pseudo_element_indexes=(
                [int(i) for i in json["pseudoElementIndexes"]]
                if json.get("pseudoElementIndexes", None) is not None
                else None
            ),
            layout_node_index=(
                int(json["layoutNodeIndex"])
                if json.get("layoutNodeIndex", None) is not None
                else None
            ),
            document_url=(
                str(json["documentURL"])
                if json.get("documentURL", None) is not None
                else None
            ),
            base_url=(
                str(json["baseURL"]) if json.get("baseURL", None) is not None else None
            ),
            content_language=(
                str(json["contentLanguage"])
                if json.get("contentLanguage", None) is not None
                else None
            ),
            document_encoding=(
                str(json["documentEncoding"])
                if json.get("documentEncoding", None) is not None
                else None
            ),
            public_id=(
                str(json["publicId"])
                if json.get("publicId", None) is not None
                else None
            ),
            system_id=(
                str(json["systemId"])
                if json.get("systemId", None) is not None
                else None
            ),
            frame_id=(
                page.FrameId.from_json(json["frameId"])
                if json.get("frameId", None) is not None
                else None
            ),
            content_document_index=(
                int(json["contentDocumentIndex"])
                if json.get("contentDocumentIndex", None) is not None
                else None
            ),
            pseudo_type=(
                dom.PseudoType.from_json(json["pseudoType"])
                if json.get("pseudoType", None) is not None
                else None
            ),
            shadow_root_type=(
                dom.ShadowRootType.from_json(json["shadowRootType"])
                if json.get("shadowRootType", None) is not None
                else None
            ),
            is_clickable=(
                bool(json["isClickable"])
                if json.get("isClickable", None) is not None
                else None
            ),
            event_listeners=(
                [
                    dom_debugger.EventListener.from_json(i)
                    for i in json["eventListeners"]
                ]
                if json.get("eventListeners", None) is not None
                else None
            ),
            current_source_url=(
                str(json["currentSourceURL"])
                if json.get("currentSourceURL", None) is not None
                else None
            ),
            origin_url=(
                str(json["originURL"])
                if json.get("originURL", None) is not None
                else None
            ),
            scroll_offset_x=(
                float(json["scrollOffsetX"])
                if json.get("scrollOffsetX", None) is not None
                else None
            ),
            scroll_offset_y=(
                float(json["scrollOffsetY"])
                if json.get("scrollOffsetY", None) is not None
                else None
            ),
        )

attributes: typing.Optional[typing.List[NameValue]] = None class-attribute instance-attribute

backend_node_id: dom.BackendNodeId instance-attribute

base_url: typing.Optional[str] = None class-attribute instance-attribute

child_node_indexes: typing.Optional[typing.List[int]] = None class-attribute instance-attribute

content_document_index: typing.Optional[int] = None class-attribute instance-attribute

content_language: typing.Optional[str] = None class-attribute instance-attribute

current_source_url: typing.Optional[str] = None class-attribute instance-attribute

document_encoding: typing.Optional[str] = None class-attribute instance-attribute

document_url: typing.Optional[str] = None class-attribute instance-attribute

event_listeners: typing.Optional[typing.List[dom_debugger.EventListener]] = None class-attribute instance-attribute

frame_id: typing.Optional[page.FrameId] = None class-attribute instance-attribute

input_checked: typing.Optional[bool] = None class-attribute instance-attribute

input_value: typing.Optional[str] = None class-attribute instance-attribute

is_clickable: typing.Optional[bool] = None class-attribute instance-attribute

layout_node_index: typing.Optional[int] = None class-attribute instance-attribute

node_name: str instance-attribute

node_type: int instance-attribute

node_value: str instance-attribute

option_selected: typing.Optional[bool] = None class-attribute instance-attribute

origin_url: typing.Optional[str] = None class-attribute instance-attribute

pseudo_element_indexes: typing.Optional[typing.List[int]] = None class-attribute instance-attribute

pseudo_type: typing.Optional[dom.PseudoType] = None class-attribute instance-attribute

public_id: typing.Optional[str] = None class-attribute instance-attribute

scroll_offset_x: typing.Optional[float] = None class-attribute instance-attribute

scroll_offset_y: typing.Optional[float] = None class-attribute instance-attribute

shadow_root_type: typing.Optional[dom.ShadowRootType] = None class-attribute instance-attribute

system_id: typing.Optional[str] = None class-attribute instance-attribute

text_value: typing.Optional[str] = None class-attribute instance-attribute

__init__(node_type, node_name, node_value, backend_node_id, text_value=None, input_value=None, input_checked=None, option_selected=None, child_node_indexes=None, attributes=None, pseudo_element_indexes=None, layout_node_index=None, document_url=None, base_url=None, content_language=None, document_encoding=None, public_id=None, system_id=None, frame_id=None, content_document_index=None, pseudo_type=None, shadow_root_type=None, is_clickable=None, event_listeners=None, current_source_url=None, origin_url=None, scroll_offset_x=None, scroll_offset_y=None)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DOMNode:
    return cls(
        node_type=int(json["nodeType"]),
        node_name=str(json["nodeName"]),
        node_value=str(json["nodeValue"]),
        backend_node_id=dom.BackendNodeId.from_json(json["backendNodeId"]),
        text_value=(
            str(json["textValue"])
            if json.get("textValue", None) is not None
            else None
        ),
        input_value=(
            str(json["inputValue"])
            if json.get("inputValue", None) is not None
            else None
        ),
        input_checked=(
            bool(json["inputChecked"])
            if json.get("inputChecked", None) is not None
            else None
        ),
        option_selected=(
            bool(json["optionSelected"])
            if json.get("optionSelected", None) is not None
            else None
        ),
        child_node_indexes=(
            [int(i) for i in json["childNodeIndexes"]]
            if json.get("childNodeIndexes", None) is not None
            else None
        ),
        attributes=(
            [NameValue.from_json(i) for i in json["attributes"]]
            if json.get("attributes", None) is not None
            else None
        ),
        pseudo_element_indexes=(
            [int(i) for i in json["pseudoElementIndexes"]]
            if json.get("pseudoElementIndexes", None) is not None
            else None
        ),
        layout_node_index=(
            int(json["layoutNodeIndex"])
            if json.get("layoutNodeIndex", None) is not None
            else None
        ),
        document_url=(
            str(json["documentURL"])
            if json.get("documentURL", None) is not None
            else None
        ),
        base_url=(
            str(json["baseURL"]) if json.get("baseURL", None) is not None else None
        ),
        content_language=(
            str(json["contentLanguage"])
            if json.get("contentLanguage", None) is not None
            else None
        ),
        document_encoding=(
            str(json["documentEncoding"])
            if json.get("documentEncoding", None) is not None
            else None
        ),
        public_id=(
            str(json["publicId"])
            if json.get("publicId", None) is not None
            else None
        ),
        system_id=(
            str(json["systemId"])
            if json.get("systemId", None) is not None
            else None
        ),
        frame_id=(
            page.FrameId.from_json(json["frameId"])
            if json.get("frameId", None) is not None
            else None
        ),
        content_document_index=(
            int(json["contentDocumentIndex"])
            if json.get("contentDocumentIndex", None) is not None
            else None
        ),
        pseudo_type=(
            dom.PseudoType.from_json(json["pseudoType"])
            if json.get("pseudoType", None) is not None
            else None
        ),
        shadow_root_type=(
            dom.ShadowRootType.from_json(json["shadowRootType"])
            if json.get("shadowRootType", None) is not None
            else None
        ),
        is_clickable=(
            bool(json["isClickable"])
            if json.get("isClickable", None) is not None
            else None
        ),
        event_listeners=(
            [
                dom_debugger.EventListener.from_json(i)
                for i in json["eventListeners"]
            ]
            if json.get("eventListeners", None) is not None
            else None
        ),
        current_source_url=(
            str(json["currentSourceURL"])
            if json.get("currentSourceURL", None) is not None
            else None
        ),
        origin_url=(
            str(json["originURL"])
            if json.get("originURL", None) is not None
            else None
        ),
        scroll_offset_x=(
            float(json["scrollOffsetX"])
            if json.get("scrollOffsetX", None) is not None
            else None
        ),
        scroll_offset_y=(
            float(json["scrollOffsetY"])
            if json.get("scrollOffsetY", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["nodeType"] = self.node_type
    json["nodeName"] = self.node_name
    json["nodeValue"] = self.node_value
    json["backendNodeId"] = self.backend_node_id.to_json()
    if self.text_value is not None:
        json["textValue"] = self.text_value
    if self.input_value is not None:
        json["inputValue"] = self.input_value
    if self.input_checked is not None:
        json["inputChecked"] = self.input_checked
    if self.option_selected is not None:
        json["optionSelected"] = self.option_selected
    if self.child_node_indexes is not None:
        json["childNodeIndexes"] = [i for i in self.child_node_indexes]
    if self.attributes is not None:
        json["attributes"] = [i.to_json() for i in self.attributes]
    if self.pseudo_element_indexes is not None:
        json["pseudoElementIndexes"] = [i for i in self.pseudo_element_indexes]
    if self.layout_node_index is not None:
        json["layoutNodeIndex"] = self.layout_node_index
    if self.document_url is not None:
        json["documentURL"] = self.document_url
    if self.base_url is not None:
        json["baseURL"] = self.base_url
    if self.content_language is not None:
        json["contentLanguage"] = self.content_language
    if self.document_encoding is not None:
        json["documentEncoding"] = self.document_encoding
    if self.public_id is not None:
        json["publicId"] = self.public_id
    if self.system_id is not None:
        json["systemId"] = self.system_id
    if self.frame_id is not None:
        json["frameId"] = self.frame_id.to_json()
    if self.content_document_index is not None:
        json["contentDocumentIndex"] = self.content_document_index
    if self.pseudo_type is not None:
        json["pseudoType"] = self.pseudo_type.to_json()
    if self.shadow_root_type is not None:
        json["shadowRootType"] = self.shadow_root_type.to_json()
    if self.is_clickable is not None:
        json["isClickable"] = self.is_clickable
    if self.event_listeners is not None:
        json["eventListeners"] = [i.to_json() for i in self.event_listeners]
    if self.current_source_url is not None:
        json["currentSourceURL"] = self.current_source_url
    if self.origin_url is not None:
        json["originURL"] = self.origin_url
    if self.scroll_offset_x is not None:
        json["scrollOffsetX"] = self.scroll_offset_x
    if self.scroll_offset_y is not None:
        json["scrollOffsetY"] = self.scroll_offset_y
    return json

DocumentSnapshot dataclass

Document snapshot.

Source code in zendriver/cdp/dom_snapshot.py 
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
@dataclass
class DocumentSnapshot:
    """
    Document snapshot.
    """

    #: Document URL that ``Document`` or ``FrameOwner`` node points to.
    document_url: StringIndex

    #: Document title.
    title: StringIndex

    #: Base URL that ``Document`` or ``FrameOwner`` node uses for URL completion.
    base_url: StringIndex

    #: Contains the document's content language.
    content_language: StringIndex

    #: Contains the document's character set encoding.
    encoding_name: StringIndex

    #: ``DocumentType`` node's publicId.
    public_id: StringIndex

    #: ``DocumentType`` node's systemId.
    system_id: StringIndex

    #: Frame ID for frame owner elements and also for the document node.
    frame_id: StringIndex

    #: A table with dom nodes.
    nodes: NodeTreeSnapshot

    #: The nodes in the layout tree.
    layout: LayoutTreeSnapshot

    #: The post-layout inline text nodes.
    text_boxes: TextBoxSnapshot

    #: Horizontal scroll offset.
    scroll_offset_x: typing.Optional[float] = None

    #: Vertical scroll offset.
    scroll_offset_y: typing.Optional[float] = None

    #: Document content width.
    content_width: typing.Optional[float] = None

    #: Document content height.
    content_height: typing.Optional[float] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["documentURL"] = self.document_url.to_json()
        json["title"] = self.title.to_json()
        json["baseURL"] = self.base_url.to_json()
        json["contentLanguage"] = self.content_language.to_json()
        json["encodingName"] = self.encoding_name.to_json()
        json["publicId"] = self.public_id.to_json()
        json["systemId"] = self.system_id.to_json()
        json["frameId"] = self.frame_id.to_json()
        json["nodes"] = self.nodes.to_json()
        json["layout"] = self.layout.to_json()
        json["textBoxes"] = self.text_boxes.to_json()
        if self.scroll_offset_x is not None:
            json["scrollOffsetX"] = self.scroll_offset_x
        if self.scroll_offset_y is not None:
            json["scrollOffsetY"] = self.scroll_offset_y
        if self.content_width is not None:
            json["contentWidth"] = self.content_width
        if self.content_height is not None:
            json["contentHeight"] = self.content_height
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DocumentSnapshot:
        return cls(
            document_url=StringIndex.from_json(json["documentURL"]),
            title=StringIndex.from_json(json["title"]),
            base_url=StringIndex.from_json(json["baseURL"]),
            content_language=StringIndex.from_json(json["contentLanguage"]),
            encoding_name=StringIndex.from_json(json["encodingName"]),
            public_id=StringIndex.from_json(json["publicId"]),
            system_id=StringIndex.from_json(json["systemId"]),
            frame_id=StringIndex.from_json(json["frameId"]),
            nodes=NodeTreeSnapshot.from_json(json["nodes"]),
            layout=LayoutTreeSnapshot.from_json(json["layout"]),
            text_boxes=TextBoxSnapshot.from_json(json["textBoxes"]),
            scroll_offset_x=(
                float(json["scrollOffsetX"])
                if json.get("scrollOffsetX", None) is not None
                else None
            ),
            scroll_offset_y=(
                float(json["scrollOffsetY"])
                if json.get("scrollOffsetY", None) is not None
                else None
            ),
            content_width=(
                float(json["contentWidth"])
                if json.get("contentWidth", None) is not None
                else None
            ),
            content_height=(
                float(json["contentHeight"])
                if json.get("contentHeight", None) is not None
                else None
            ),
        )

base_url: StringIndex instance-attribute

content_height: typing.Optional[float] = None class-attribute instance-attribute

content_language: StringIndex instance-attribute

content_width: typing.Optional[float] = None class-attribute instance-attribute

document_url: StringIndex instance-attribute

encoding_name: StringIndex instance-attribute

frame_id: StringIndex instance-attribute

layout: LayoutTreeSnapshot instance-attribute

nodes: NodeTreeSnapshot instance-attribute

public_id: StringIndex instance-attribute

scroll_offset_x: typing.Optional[float] = None class-attribute instance-attribute

scroll_offset_y: typing.Optional[float] = None class-attribute instance-attribute

system_id: StringIndex instance-attribute

text_boxes: TextBoxSnapshot instance-attribute

title: StringIndex instance-attribute

__init__(document_url, title, base_url, content_language, encoding_name, public_id, system_id, frame_id, nodes, layout, text_boxes, scroll_offset_x=None, scroll_offset_y=None, content_width=None, content_height=None)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DocumentSnapshot:
    return cls(
        document_url=StringIndex.from_json(json["documentURL"]),
        title=StringIndex.from_json(json["title"]),
        base_url=StringIndex.from_json(json["baseURL"]),
        content_language=StringIndex.from_json(json["contentLanguage"]),
        encoding_name=StringIndex.from_json(json["encodingName"]),
        public_id=StringIndex.from_json(json["publicId"]),
        system_id=StringIndex.from_json(json["systemId"]),
        frame_id=StringIndex.from_json(json["frameId"]),
        nodes=NodeTreeSnapshot.from_json(json["nodes"]),
        layout=LayoutTreeSnapshot.from_json(json["layout"]),
        text_boxes=TextBoxSnapshot.from_json(json["textBoxes"]),
        scroll_offset_x=(
            float(json["scrollOffsetX"])
            if json.get("scrollOffsetX", None) is not None
            else None
        ),
        scroll_offset_y=(
            float(json["scrollOffsetY"])
            if json.get("scrollOffsetY", None) is not None
            else None
        ),
        content_width=(
            float(json["contentWidth"])
            if json.get("contentWidth", None) is not None
            else None
        ),
        content_height=(
            float(json["contentHeight"])
            if json.get("contentHeight", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["documentURL"] = self.document_url.to_json()
    json["title"] = self.title.to_json()
    json["baseURL"] = self.base_url.to_json()
    json["contentLanguage"] = self.content_language.to_json()
    json["encodingName"] = self.encoding_name.to_json()
    json["publicId"] = self.public_id.to_json()
    json["systemId"] = self.system_id.to_json()
    json["frameId"] = self.frame_id.to_json()
    json["nodes"] = self.nodes.to_json()
    json["layout"] = self.layout.to_json()
    json["textBoxes"] = self.text_boxes.to_json()
    if self.scroll_offset_x is not None:
        json["scrollOffsetX"] = self.scroll_offset_x
    if self.scroll_offset_y is not None:
        json["scrollOffsetY"] = self.scroll_offset_y
    if self.content_width is not None:
        json["contentWidth"] = self.content_width
    if self.content_height is not None:
        json["contentHeight"] = self.content_height
    return json

InlineTextBox dataclass

Details of post layout rendered text positions. The exact layout should not be regarded as stable and may change between versions.

Source code in zendriver/cdp/dom_snapshot.py 
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
@dataclass
class InlineTextBox:
    """
    Details of post layout rendered text positions. The exact layout should not be regarded as
    stable and may change between versions.
    """

    #: The bounding box in document coordinates. Note that scroll offset of the document is ignored.
    bounding_box: dom.Rect

    #: The starting index in characters, for this post layout textbox substring. Characters that
    #: would be represented as a surrogate pair in UTF-16 have length 2.
    start_character_index: int

    #: The number of characters in this post layout textbox substring. Characters that would be
    #: represented as a surrogate pair in UTF-16 have length 2.
    num_characters: int

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["boundingBox"] = self.bounding_box.to_json()
        json["startCharacterIndex"] = self.start_character_index
        json["numCharacters"] = self.num_characters
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InlineTextBox:
        return cls(
            bounding_box=dom.Rect.from_json(json["boundingBox"]),
            start_character_index=int(json["startCharacterIndex"]),
            num_characters=int(json["numCharacters"]),
        )

bounding_box: dom.Rect instance-attribute

num_characters: int instance-attribute

start_character_index: int instance-attribute

__init__(bounding_box, start_character_index, num_characters)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
326
327
328
329
330
331
332
@classmethod
def from_json(cls, json: T_JSON_DICT) -> InlineTextBox:
    return cls(
        bounding_box=dom.Rect.from_json(json["boundingBox"]),
        start_character_index=int(json["startCharacterIndex"]),
        num_characters=int(json["numCharacters"]),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
319
320
321
322
323
324
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["boundingBox"] = self.bounding_box.to_json()
    json["startCharacterIndex"] = self.start_character_index
    json["numCharacters"] = self.num_characters
    return json

LayoutTreeNode dataclass

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

Source code in zendriver/cdp/dom_snapshot.py 
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
@dataclass
class LayoutTreeNode:
    """
    Details of an element in the DOM tree with a LayoutObject.
    """

    #: The index of the related DOM node in the ``domNodes`` array returned by ``getSnapshot``.
    dom_node_index: int

    #: The bounding box in document coordinates. Note that scroll offset of the document is ignored.
    bounding_box: dom.Rect

    #: Contents of the LayoutText, if any.
    layout_text: typing.Optional[str] = None

    #: The post-layout inline text nodes, if any.
    inline_text_nodes: typing.Optional[typing.List[InlineTextBox]] = None

    #: Index into the ``computedStyles`` array returned by ``getSnapshot``.
    style_index: typing.Optional[int] = None

    #: Global paint order index, which is determined by the stacking order of the nodes. Nodes
    #: that are painted together will have the same index. Only provided if includePaintOrder in
    #: getSnapshot was true.
    paint_order: typing.Optional[int] = None

    #: Set to true to indicate the element begins a new stacking context.
    is_stacking_context: typing.Optional[bool] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["domNodeIndex"] = self.dom_node_index
        json["boundingBox"] = self.bounding_box.to_json()
        if self.layout_text is not None:
            json["layoutText"] = self.layout_text
        if self.inline_text_nodes is not None:
            json["inlineTextNodes"] = [i.to_json() for i in self.inline_text_nodes]
        if self.style_index is not None:
            json["styleIndex"] = self.style_index
        if self.paint_order is not None:
            json["paintOrder"] = self.paint_order
        if self.is_stacking_context is not None:
            json["isStackingContext"] = self.is_stacking_context
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LayoutTreeNode:
        return cls(
            dom_node_index=int(json["domNodeIndex"]),
            bounding_box=dom.Rect.from_json(json["boundingBox"]),
            layout_text=(
                str(json["layoutText"])
                if json.get("layoutText", None) is not None
                else None
            ),
            inline_text_nodes=(
                [InlineTextBox.from_json(i) for i in json["inlineTextNodes"]]
                if json.get("inlineTextNodes", None) is not None
                else None
            ),
            style_index=(
                int(json["styleIndex"])
                if json.get("styleIndex", None) is not None
                else None
            ),
            paint_order=(
                int(json["paintOrder"])
                if json.get("paintOrder", None) is not None
                else None
            ),
            is_stacking_context=(
                bool(json["isStackingContext"])
                if json.get("isStackingContext", None) is not None
                else None
            ),
        )

bounding_box: dom.Rect instance-attribute

dom_node_index: int instance-attribute

inline_text_nodes: typing.Optional[typing.List[InlineTextBox]] = None class-attribute instance-attribute

is_stacking_context: typing.Optional[bool] = None class-attribute instance-attribute

layout_text: typing.Optional[str] = None class-attribute instance-attribute

paint_order: typing.Optional[int] = None class-attribute instance-attribute

style_index: typing.Optional[int] = None class-attribute instance-attribute

__init__(dom_node_index, bounding_box, layout_text=None, inline_text_nodes=None, style_index=None, paint_order=None, is_stacking_context=None)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
@classmethod
def from_json(cls, json: T_JSON_DICT) -> LayoutTreeNode:
    return cls(
        dom_node_index=int(json["domNodeIndex"]),
        bounding_box=dom.Rect.from_json(json["boundingBox"]),
        layout_text=(
            str(json["layoutText"])
            if json.get("layoutText", None) is not None
            else None
        ),
        inline_text_nodes=(
            [InlineTextBox.from_json(i) for i in json["inlineTextNodes"]]
            if json.get("inlineTextNodes", None) is not None
            else None
        ),
        style_index=(
            int(json["styleIndex"])
            if json.get("styleIndex", None) is not None
            else None
        ),
        paint_order=(
            int(json["paintOrder"])
            if json.get("paintOrder", None) is not None
            else None
        ),
        is_stacking_context=(
            bool(json["isStackingContext"])
            if json.get("isStackingContext", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["domNodeIndex"] = self.dom_node_index
    json["boundingBox"] = self.bounding_box.to_json()
    if self.layout_text is not None:
        json["layoutText"] = self.layout_text
    if self.inline_text_nodes is not None:
        json["inlineTextNodes"] = [i.to_json() for i in self.inline_text_nodes]
    if self.style_index is not None:
        json["styleIndex"] = self.style_index
    if self.paint_order is not None:
        json["paintOrder"] = self.paint_order
    if self.is_stacking_context is not None:
        json["isStackingContext"] = self.is_stacking_context
    return json

LayoutTreeSnapshot dataclass

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

Source code in zendriver/cdp/dom_snapshot.py 
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
@dataclass
class LayoutTreeSnapshot:
    """
    Table of details of an element in the DOM tree with a LayoutObject.
    """

    #: Index of the corresponding node in the ``NodeTreeSnapshot`` array returned by ``captureSnapshot``.
    node_index: typing.List[int]

    #: Array of indexes specifying computed style strings, filtered according to the ``computedStyles`` parameter passed to ``captureSnapshot``.
    styles: typing.List[ArrayOfStrings]

    #: The absolute position bounding box.
    bounds: typing.List[Rectangle]

    #: Contents of the LayoutText, if any.
    text: typing.List[StringIndex]

    #: Stacking context information.
    stacking_contexts: RareBooleanData

    #: Global paint order index, which is determined by the stacking order of the nodes. Nodes
    #: that are painted together will have the same index. Only provided if includePaintOrder in
    #: captureSnapshot was true.
    paint_orders: typing.Optional[typing.List[int]] = None

    #: The offset rect of nodes. Only available when includeDOMRects is set to true
    offset_rects: typing.Optional[typing.List[Rectangle]] = None

    #: The scroll rect of nodes. Only available when includeDOMRects is set to true
    scroll_rects: typing.Optional[typing.List[Rectangle]] = None

    #: The client rect of nodes. Only available when includeDOMRects is set to true
    client_rects: typing.Optional[typing.List[Rectangle]] = None

    #: The list of background colors that are blended with colors of overlapping elements.
    blended_background_colors: typing.Optional[typing.List[StringIndex]] = None

    #: The list of computed text opacities.
    text_color_opacities: typing.Optional[typing.List[float]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["nodeIndex"] = [i for i in self.node_index]
        json["styles"] = [i.to_json() for i in self.styles]
        json["bounds"] = [i.to_json() for i in self.bounds]
        json["text"] = [i.to_json() for i in self.text]
        json["stackingContexts"] = self.stacking_contexts.to_json()
        if self.paint_orders is not None:
            json["paintOrders"] = [i for i in self.paint_orders]
        if self.offset_rects is not None:
            json["offsetRects"] = [i.to_json() for i in self.offset_rects]
        if self.scroll_rects is not None:
            json["scrollRects"] = [i.to_json() for i in self.scroll_rects]
        if self.client_rects is not None:
            json["clientRects"] = [i.to_json() for i in self.client_rects]
        if self.blended_background_colors is not None:
            json["blendedBackgroundColors"] = [
                i.to_json() for i in self.blended_background_colors
            ]
        if self.text_color_opacities is not None:
            json["textColorOpacities"] = [i for i in self.text_color_opacities]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LayoutTreeSnapshot:
        return cls(
            node_index=[int(i) for i in json["nodeIndex"]],
            styles=[ArrayOfStrings.from_json(i) for i in json["styles"]],
            bounds=[Rectangle.from_json(i) for i in json["bounds"]],
            text=[StringIndex.from_json(i) for i in json["text"]],
            stacking_contexts=RareBooleanData.from_json(json["stackingContexts"]),
            paint_orders=(
                [int(i) for i in json["paintOrders"]]
                if json.get("paintOrders", None) is not None
                else None
            ),
            offset_rects=(
                [Rectangle.from_json(i) for i in json["offsetRects"]]
                if json.get("offsetRects", None) is not None
                else None
            ),
            scroll_rects=(
                [Rectangle.from_json(i) for i in json["scrollRects"]]
                if json.get("scrollRects", None) is not None
                else None
            ),
            client_rects=(
                [Rectangle.from_json(i) for i in json["clientRects"]]
                if json.get("clientRects", None) is not None
                else None
            ),
            blended_background_colors=(
                [StringIndex.from_json(i) for i in json["blendedBackgroundColors"]]
                if json.get("blendedBackgroundColors", None) is not None
                else None
            ),
            text_color_opacities=(
                [float(i) for i in json["textColorOpacities"]]
                if json.get("textColorOpacities", None) is not None
                else None
            ),
        )

blended_background_colors: typing.Optional[typing.List[StringIndex]] = None class-attribute instance-attribute

bounds: typing.List[Rectangle] instance-attribute

client_rects: typing.Optional[typing.List[Rectangle]] = None class-attribute instance-attribute

node_index: typing.List[int] instance-attribute

offset_rects: typing.Optional[typing.List[Rectangle]] = None class-attribute instance-attribute

paint_orders: typing.Optional[typing.List[int]] = None class-attribute instance-attribute

scroll_rects: typing.Optional[typing.List[Rectangle]] = None class-attribute instance-attribute

stacking_contexts: RareBooleanData instance-attribute

styles: typing.List[ArrayOfStrings] instance-attribute

text: typing.List[StringIndex] instance-attribute

text_color_opacities: typing.Optional[typing.List[float]] = None class-attribute instance-attribute

__init__(node_index, styles, bounds, text, stacking_contexts, paint_orders=None, offset_rects=None, scroll_rects=None, client_rects=None, blended_background_colors=None, text_color_opacities=None)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
@classmethod
def from_json(cls, json: T_JSON_DICT) -> LayoutTreeSnapshot:
    return cls(
        node_index=[int(i) for i in json["nodeIndex"]],
        styles=[ArrayOfStrings.from_json(i) for i in json["styles"]],
        bounds=[Rectangle.from_json(i) for i in json["bounds"]],
        text=[StringIndex.from_json(i) for i in json["text"]],
        stacking_contexts=RareBooleanData.from_json(json["stackingContexts"]),
        paint_orders=(
            [int(i) for i in json["paintOrders"]]
            if json.get("paintOrders", None) is not None
            else None
        ),
        offset_rects=(
            [Rectangle.from_json(i) for i in json["offsetRects"]]
            if json.get("offsetRects", None) is not None
            else None
        ),
        scroll_rects=(
            [Rectangle.from_json(i) for i in json["scrollRects"]]
            if json.get("scrollRects", None) is not None
            else None
        ),
        client_rects=(
            [Rectangle.from_json(i) for i in json["clientRects"]]
            if json.get("clientRects", None) is not None
            else None
        ),
        blended_background_colors=(
            [StringIndex.from_json(i) for i in json["blendedBackgroundColors"]]
            if json.get("blendedBackgroundColors", None) is not None
            else None
        ),
        text_color_opacities=(
            [float(i) for i in json["textColorOpacities"]]
            if json.get("textColorOpacities", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["nodeIndex"] = [i for i in self.node_index]
    json["styles"] = [i.to_json() for i in self.styles]
    json["bounds"] = [i.to_json() for i in self.bounds]
    json["text"] = [i.to_json() for i in self.text]
    json["stackingContexts"] = self.stacking_contexts.to_json()
    if self.paint_orders is not None:
        json["paintOrders"] = [i for i in self.paint_orders]
    if self.offset_rects is not None:
        json["offsetRects"] = [i.to_json() for i in self.offset_rects]
    if self.scroll_rects is not None:
        json["scrollRects"] = [i.to_json() for i in self.scroll_rects]
    if self.client_rects is not None:
        json["clientRects"] = [i.to_json() for i in self.client_rects]
    if self.blended_background_colors is not None:
        json["blendedBackgroundColors"] = [
            i.to_json() for i in self.blended_background_colors
        ]
    if self.text_color_opacities is not None:
        json["textColorOpacities"] = [i for i in self.text_color_opacities]
    return json

NameValue dataclass

A name/value pair.

Source code in zendriver/cdp/dom_snapshot.py 
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
@dataclass
class NameValue:
    """
    A name/value pair.
    """

    #: Attribute/property name.
    name: str

    #: Attribute/property value.
    value: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["value"] = self.value
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> NameValue:
        return cls(
            name=str(json["name"]),
            value=str(json["value"]),
        )

name: str instance-attribute

value: str instance-attribute

__init__(name, value)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
452
453
454
455
456
457
@classmethod
def from_json(cls, json: T_JSON_DICT) -> NameValue:
    return cls(
        name=str(json["name"]),
        value=str(json["value"]),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
446
447
448
449
450
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["value"] = self.value
    return json

NodeTreeSnapshot dataclass

Table containing nodes.

Source code in zendriver/cdp/dom_snapshot.py 
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
@dataclass
class NodeTreeSnapshot:
    """
    Table containing nodes.
    """

    #: Parent node index.
    parent_index: typing.Optional[typing.List[int]] = None

    #: ``Node``'s nodeType.
    node_type: typing.Optional[typing.List[int]] = None

    #: Type of the shadow root the ``Node`` is in. String values are equal to the ``ShadowRootType`` enum.
    shadow_root_type: typing.Optional[RareStringData] = None

    #: ``Node``'s nodeName.
    node_name: typing.Optional[typing.List[StringIndex]] = None

    #: ``Node``'s nodeValue.
    node_value: typing.Optional[typing.List[StringIndex]] = None

    #: ``Node``'s id, corresponds to DOM.Node.backendNodeId.
    backend_node_id: typing.Optional[typing.List[dom.BackendNodeId]] = None

    #: Attributes of an ``Element`` node. Flatten name, value pairs.
    attributes: typing.Optional[typing.List[ArrayOfStrings]] = None

    #: Only set for textarea elements, contains the text value.
    text_value: typing.Optional[RareStringData] = None

    #: Only set for input elements, contains the input's associated text value.
    input_value: typing.Optional[RareStringData] = None

    #: Only set for radio and checkbox input elements, indicates if the element has been checked
    input_checked: typing.Optional[RareBooleanData] = None

    #: Only set for option elements, indicates if the element has been selected
    option_selected: typing.Optional[RareBooleanData] = None

    #: The index of the document in the list of the snapshot documents.
    content_document_index: typing.Optional[RareIntegerData] = None

    #: Type of a pseudo element node.
    pseudo_type: typing.Optional[RareStringData] = None

    #: Pseudo element identifier for this node. Only present if there is a
    #: valid pseudoType.
    pseudo_identifier: typing.Optional[RareStringData] = None

    #: Whether this DOM node responds to mouse clicks. This includes nodes that have had click
    #: event listeners attached via JavaScript as well as anchor tags that naturally navigate when
    #: clicked.
    is_clickable: typing.Optional[RareBooleanData] = None

    #: The selected url for nodes with a srcset attribute.
    current_source_url: typing.Optional[RareStringData] = None

    #: The url of the script (if any) that generates this node.
    origin_url: typing.Optional[RareStringData] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        if self.parent_index is not None:
            json["parentIndex"] = [i for i in self.parent_index]
        if self.node_type is not None:
            json["nodeType"] = [i for i in self.node_type]
        if self.shadow_root_type is not None:
            json["shadowRootType"] = self.shadow_root_type.to_json()
        if self.node_name is not None:
            json["nodeName"] = [i.to_json() for i in self.node_name]
        if self.node_value is not None:
            json["nodeValue"] = [i.to_json() for i in self.node_value]
        if self.backend_node_id is not None:
            json["backendNodeId"] = [i.to_json() for i in self.backend_node_id]
        if self.attributes is not None:
            json["attributes"] = [i.to_json() for i in self.attributes]
        if self.text_value is not None:
            json["textValue"] = self.text_value.to_json()
        if self.input_value is not None:
            json["inputValue"] = self.input_value.to_json()
        if self.input_checked is not None:
            json["inputChecked"] = self.input_checked.to_json()
        if self.option_selected is not None:
            json["optionSelected"] = self.option_selected.to_json()
        if self.content_document_index is not None:
            json["contentDocumentIndex"] = self.content_document_index.to_json()
        if self.pseudo_type is not None:
            json["pseudoType"] = self.pseudo_type.to_json()
        if self.pseudo_identifier is not None:
            json["pseudoIdentifier"] = self.pseudo_identifier.to_json()
        if self.is_clickable is not None:
            json["isClickable"] = self.is_clickable.to_json()
        if self.current_source_url is not None:
            json["currentSourceURL"] = self.current_source_url.to_json()
        if self.origin_url is not None:
            json["originURL"] = self.origin_url.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> NodeTreeSnapshot:
        return cls(
            parent_index=(
                [int(i) for i in json["parentIndex"]]
                if json.get("parentIndex", None) is not None
                else None
            ),
            node_type=(
                [int(i) for i in json["nodeType"]]
                if json.get("nodeType", None) is not None
                else None
            ),
            shadow_root_type=(
                RareStringData.from_json(json["shadowRootType"])
                if json.get("shadowRootType", None) is not None
                else None
            ),
            node_name=(
                [StringIndex.from_json(i) for i in json["nodeName"]]
                if json.get("nodeName", None) is not None
                else None
            ),
            node_value=(
                [StringIndex.from_json(i) for i in json["nodeValue"]]
                if json.get("nodeValue", None) is not None
                else None
            ),
            backend_node_id=(
                [dom.BackendNodeId.from_json(i) for i in json["backendNodeId"]]
                if json.get("backendNodeId", None) is not None
                else None
            ),
            attributes=(
                [ArrayOfStrings.from_json(i) for i in json["attributes"]]
                if json.get("attributes", None) is not None
                else None
            ),
            text_value=(
                RareStringData.from_json(json["textValue"])
                if json.get("textValue", None) is not None
                else None
            ),
            input_value=(
                RareStringData.from_json(json["inputValue"])
                if json.get("inputValue", None) is not None
                else None
            ),
            input_checked=(
                RareBooleanData.from_json(json["inputChecked"])
                if json.get("inputChecked", None) is not None
                else None
            ),
            option_selected=(
                RareBooleanData.from_json(json["optionSelected"])
                if json.get("optionSelected", None) is not None
                else None
            ),
            content_document_index=(
                RareIntegerData.from_json(json["contentDocumentIndex"])
                if json.get("contentDocumentIndex", None) is not None
                else None
            ),
            pseudo_type=(
                RareStringData.from_json(json["pseudoType"])
                if json.get("pseudoType", None) is not None
                else None
            ),
            pseudo_identifier=(
                RareStringData.from_json(json["pseudoIdentifier"])
                if json.get("pseudoIdentifier", None) is not None
                else None
            ),
            is_clickable=(
                RareBooleanData.from_json(json["isClickable"])
                if json.get("isClickable", None) is not None
                else None
            ),
            current_source_url=(
                RareStringData.from_json(json["currentSourceURL"])
                if json.get("currentSourceURL", None) is not None
                else None
            ),
            origin_url=(
                RareStringData.from_json(json["originURL"])
                if json.get("originURL", None) is not None
                else None
            ),
        )

attributes: typing.Optional[typing.List[ArrayOfStrings]] = None class-attribute instance-attribute

backend_node_id: typing.Optional[typing.List[dom.BackendNodeId]] = None class-attribute instance-attribute

content_document_index: typing.Optional[RareIntegerData] = None class-attribute instance-attribute

current_source_url: typing.Optional[RareStringData] = None class-attribute instance-attribute

input_checked: typing.Optional[RareBooleanData] = None class-attribute instance-attribute

input_value: typing.Optional[RareStringData] = None class-attribute instance-attribute

is_clickable: typing.Optional[RareBooleanData] = None class-attribute instance-attribute

node_name: typing.Optional[typing.List[StringIndex]] = None class-attribute instance-attribute

node_type: typing.Optional[typing.List[int]] = None class-attribute instance-attribute

node_value: typing.Optional[typing.List[StringIndex]] = None class-attribute instance-attribute

option_selected: typing.Optional[RareBooleanData] = None class-attribute instance-attribute

origin_url: typing.Optional[RareStringData] = None class-attribute instance-attribute

parent_index: typing.Optional[typing.List[int]] = None class-attribute instance-attribute

pseudo_identifier: typing.Optional[RareStringData] = None class-attribute instance-attribute

pseudo_type: typing.Optional[RareStringData] = None class-attribute instance-attribute

shadow_root_type: typing.Optional[RareStringData] = None class-attribute instance-attribute

text_value: typing.Optional[RareStringData] = None class-attribute instance-attribute

__init__(parent_index=None, node_type=None, shadow_root_type=None, node_name=None, node_value=None, backend_node_id=None, attributes=None, text_value=None, input_value=None, input_checked=None, option_selected=None, content_document_index=None, pseudo_type=None, pseudo_identifier=None, is_clickable=None, current_source_url=None, origin_url=None)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
@classmethod
def from_json(cls, json: T_JSON_DICT) -> NodeTreeSnapshot:
    return cls(
        parent_index=(
            [int(i) for i in json["parentIndex"]]
            if json.get("parentIndex", None) is not None
            else None
        ),
        node_type=(
            [int(i) for i in json["nodeType"]]
            if json.get("nodeType", None) is not None
            else None
        ),
        shadow_root_type=(
            RareStringData.from_json(json["shadowRootType"])
            if json.get("shadowRootType", None) is not None
            else None
        ),
        node_name=(
            [StringIndex.from_json(i) for i in json["nodeName"]]
            if json.get("nodeName", None) is not None
            else None
        ),
        node_value=(
            [StringIndex.from_json(i) for i in json["nodeValue"]]
            if json.get("nodeValue", None) is not None
            else None
        ),
        backend_node_id=(
            [dom.BackendNodeId.from_json(i) for i in json["backendNodeId"]]
            if json.get("backendNodeId", None) is not None
            else None
        ),
        attributes=(
            [ArrayOfStrings.from_json(i) for i in json["attributes"]]
            if json.get("attributes", None) is not None
            else None
        ),
        text_value=(
            RareStringData.from_json(json["textValue"])
            if json.get("textValue", None) is not None
            else None
        ),
        input_value=(
            RareStringData.from_json(json["inputValue"])
            if json.get("inputValue", None) is not None
            else None
        ),
        input_checked=(
            RareBooleanData.from_json(json["inputChecked"])
            if json.get("inputChecked", None) is not None
            else None
        ),
        option_selected=(
            RareBooleanData.from_json(json["optionSelected"])
            if json.get("optionSelected", None) is not None
            else None
        ),
        content_document_index=(
            RareIntegerData.from_json(json["contentDocumentIndex"])
            if json.get("contentDocumentIndex", None) is not None
            else None
        ),
        pseudo_type=(
            RareStringData.from_json(json["pseudoType"])
            if json.get("pseudoType", None) is not None
            else None
        ),
        pseudo_identifier=(
            RareStringData.from_json(json["pseudoIdentifier"])
            if json.get("pseudoIdentifier", None) is not None
            else None
        ),
        is_clickable=(
            RareBooleanData.from_json(json["isClickable"])
            if json.get("isClickable", None) is not None
            else None
        ),
        current_source_url=(
            RareStringData.from_json(json["currentSourceURL"])
            if json.get("currentSourceURL", None) is not None
            else None
        ),
        origin_url=(
            RareStringData.from_json(json["originURL"])
            if json.get("originURL", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    if self.parent_index is not None:
        json["parentIndex"] = [i for i in self.parent_index]
    if self.node_type is not None:
        json["nodeType"] = [i for i in self.node_type]
    if self.shadow_root_type is not None:
        json["shadowRootType"] = self.shadow_root_type.to_json()
    if self.node_name is not None:
        json["nodeName"] = [i.to_json() for i in self.node_name]
    if self.node_value is not None:
        json["nodeValue"] = [i.to_json() for i in self.node_value]
    if self.backend_node_id is not None:
        json["backendNodeId"] = [i.to_json() for i in self.backend_node_id]
    if self.attributes is not None:
        json["attributes"] = [i.to_json() for i in self.attributes]
    if self.text_value is not None:
        json["textValue"] = self.text_value.to_json()
    if self.input_value is not None:
        json["inputValue"] = self.input_value.to_json()
    if self.input_checked is not None:
        json["inputChecked"] = self.input_checked.to_json()
    if self.option_selected is not None:
        json["optionSelected"] = self.option_selected.to_json()
    if self.content_document_index is not None:
        json["contentDocumentIndex"] = self.content_document_index.to_json()
    if self.pseudo_type is not None:
        json["pseudoType"] = self.pseudo_type.to_json()
    if self.pseudo_identifier is not None:
        json["pseudoIdentifier"] = self.pseudo_identifier.to_json()
    if self.is_clickable is not None:
        json["isClickable"] = self.is_clickable.to_json()
    if self.current_source_url is not None:
        json["currentSourceURL"] = self.current_source_url.to_json()
    if self.origin_url is not None:
        json["originURL"] = self.origin_url.to_json()
    return json

RareBooleanData dataclass

Source code in zendriver/cdp/dom_snapshot.py 
516
517
518
519
520
521
522
523
524
525
526
527
528
529
@dataclass
class RareBooleanData:
    index: typing.List[int]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["index"] = [i for i in self.index]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> RareBooleanData:
        return cls(
            index=[int(i) for i in json["index"]],
        )

index: typing.List[int] instance-attribute

__init__(index)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
525
526
527
528
529
@classmethod
def from_json(cls, json: T_JSON_DICT) -> RareBooleanData:
    return cls(
        index=[int(i) for i in json["index"]],
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
520
521
522
523
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["index"] = [i for i in self.index]
    return json

RareIntegerData dataclass

Source code in zendriver/cdp/dom_snapshot.py 
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
@dataclass
class RareIntegerData:
    index: typing.List[int]

    value: typing.List[int]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["index"] = [i for i in self.index]
        json["value"] = [i for i in self.value]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> RareIntegerData:
        return cls(
            index=[int(i) for i in json["index"]],
            value=[int(i) for i in json["value"]],
        )

index: typing.List[int] instance-attribute

value: typing.List[int] instance-attribute

__init__(index, value)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
544
545
546
547
548
549
@classmethod
def from_json(cls, json: T_JSON_DICT) -> RareIntegerData:
    return cls(
        index=[int(i) for i in json["index"]],
        value=[int(i) for i in json["value"]],
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
538
539
540
541
542
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["index"] = [i for i in self.index]
    json["value"] = [i for i in self.value]
    return json

RareStringData dataclass

Data that is only present on rare nodes.

Source code in zendriver/cdp/dom_snapshot.py 
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
@dataclass
class RareStringData:
    """
    Data that is only present on rare nodes.
    """

    index: typing.List[int]

    value: typing.List[StringIndex]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["index"] = [i for i in self.index]
        json["value"] = [i.to_json() for i in self.value]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> RareStringData:
        return cls(
            index=[int(i) for i in json["index"]],
            value=[StringIndex.from_json(i) for i in json["value"]],
        )

index: typing.List[int] instance-attribute

value: typing.List[StringIndex] instance-attribute

__init__(index, value)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
508
509
510
511
512
513
@classmethod
def from_json(cls, json: T_JSON_DICT) -> RareStringData:
    return cls(
        index=[int(i) for i in json["index"]],
        value=[StringIndex.from_json(i) for i in json["value"]],
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
502
503
504
505
506
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["index"] = [i for i in self.index]
    json["value"] = [i.to_json() for i in self.value]
    return json

Rectangle

Bases: list

Source code in zendriver/cdp/dom_snapshot.py 
552
553
554
555
556
557
558
559
560
561
class Rectangle(list):
    def to_json(self) -> typing.List[float]:
        return self

    @classmethod
    def from_json(cls, json: typing.List[float]) -> Rectangle:
        return cls(json)

    def __repr__(self):
        return "Rectangle({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/dom_snapshot.py 
560
561
def __repr__(self):
    return "Rectangle({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
556
557
558
@classmethod
def from_json(cls, json: typing.List[float]) -> Rectangle:
    return cls(json)

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
553
554
def to_json(self) -> typing.List[float]:
    return self

StringIndex

Bases: int

Index of the string in the strings table.

Source code in zendriver/cdp/dom_snapshot.py 
460
461
462
463
464
465
466
467
468
469
470
471
472
473
class StringIndex(int):
    """
    Index of the string in the strings table.
    """

    def to_json(self) -> int:
        return self

    @classmethod
    def from_json(cls, json: int) -> StringIndex:
        return cls(json)

    def __repr__(self):
        return "StringIndex({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/dom_snapshot.py 
472
473
def __repr__(self):
    return "StringIndex({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
468
469
470
@classmethod
def from_json(cls, json: int) -> StringIndex:
    return cls(json)

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
465
466
def to_json(self) -> int:
    return self

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.

Source code in zendriver/cdp/dom_snapshot.py 
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
@dataclass
class TextBoxSnapshot:
    """
    Table of details of the post layout rendered text positions. The exact layout should not be regarded as
    stable and may change between versions.
    """

    #: Index of the layout tree node that owns this box collection.
    layout_index: typing.List[int]

    #: The absolute position bounding box.
    bounds: typing.List[Rectangle]

    #: The starting index in characters, for this post layout textbox substring. Characters that
    #: would be represented as a surrogate pair in UTF-16 have length 2.
    start: typing.List[int]

    #: The number of characters in this post layout textbox substring. Characters that would be
    #: represented as a surrogate pair in UTF-16 have length 2.
    length: typing.List[int]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["layoutIndex"] = [i for i in self.layout_index]
        json["bounds"] = [i.to_json() for i in self.bounds]
        json["start"] = [i for i in self.start]
        json["length"] = [i for i in self.length]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> TextBoxSnapshot:
        return cls(
            layout_index=[int(i) for i in json["layoutIndex"]],
            bounds=[Rectangle.from_json(i) for i in json["bounds"]],
            start=[int(i) for i in json["start"]],
            length=[int(i) for i in json["length"]],
        )

bounds: typing.List[Rectangle] instance-attribute

layout_index: typing.List[int] instance-attribute

length: typing.List[int] instance-attribute

start: typing.List[int] instance-attribute

__init__(layout_index, bounds, start, length)

from_json(json) classmethod

Source code in zendriver/cdp/dom_snapshot.py 
 998
 999
1000
1001
1002
1003
1004
1005
@classmethod
def from_json(cls, json: T_JSON_DICT) -> TextBoxSnapshot:
    return cls(
        layout_index=[int(i) for i in json["layoutIndex"]],
        bounds=[Rectangle.from_json(i) for i in json["bounds"]],
        start=[int(i) for i in json["start"]],
        length=[int(i) for i in json["length"]],
    )

to_json()

Source code in zendriver/cdp/dom_snapshot.py 
990
991
992
993
994
995
996
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["layoutIndex"] = [i for i in self.layout_index]
    json["bounds"] = [i.to_json() for i in self.bounds]
    json["start"] = [i for i in self.start]
    json["length"] = [i for i in self.length]
    return json

capture_snapshot(computed_styles, include_paint_order=None, include_dom_rects=None, include_blended_background_colors=None, include_text_color_opacities=None)

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.

Parameters:

Name Type Description Default
computed_styles List[str]

Whitelist of computed styles to return.

 required
include_paint_order Optional[bool]

(Optional) Whether to include layout object paint orders into the snapshot.

 None
include_dom_rects Optional[bool]

(Optional) Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot

 None
include_blended_background_colors Optional[bool]

(EXPERIMENTAL) (Optional) Whether to include blended background colors in the snapshot (default: false). Blended background color is achieved by blending background colors of all elements that overlap with the current element.

 None
include_text_color_opacities Optional[bool]

(EXPERIMENTAL) (Optional) Whether to include text color opacity in the snapshot (default: false). An element might have the opacity property set that affects the text color of the element. The final text color opacity is computed based on the opacity of all overlapping elements.

 None

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[List[DocumentSnapshot], List[str]]]

A tuple with the following items: 0. documents - The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document. 1. strings - Shared string table that all string properties refer to with indexes.
Source code in zendriver/cdp/dom_snapshot.py 
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
def capture_snapshot(
    computed_styles: typing.List[str],
    include_paint_order: typing.Optional[bool] = None,
    include_dom_rects: typing.Optional[bool] = None,
    include_blended_background_colors: typing.Optional[bool] = None,
    include_text_color_opacities: typing.Optional[bool] = None,
) -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[typing.List[DocumentSnapshot], typing.List[str]],
]:
    """
    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.

    :param computed_styles: Whitelist of computed styles to return.
    :param include_paint_order: *(Optional)* Whether to include layout object paint orders into the snapshot.
    :param include_dom_rects: *(Optional)* Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
    :param include_blended_background_colors: **(EXPERIMENTAL)** *(Optional)* Whether to include blended background colors in the snapshot (default: false). Blended background color is achieved by blending background colors of all elements that overlap with the current element.
    :param include_text_color_opacities: **(EXPERIMENTAL)** *(Optional)* Whether to include text color opacity in the snapshot (default: false). An element might have the opacity property set that affects the text color of the element. The final text color opacity is computed based on the opacity of all overlapping elements.
    :returns: A tuple with the following items:

        0. **documents** - The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
        1. **strings** - Shared string table that all string properties refer to with indexes.
    """
    params: T_JSON_DICT = dict()
    params["computedStyles"] = [i for i in computed_styles]
    if include_paint_order is not None:
        params["includePaintOrder"] = include_paint_order
    if include_dom_rects is not None:
        params["includeDOMRects"] = include_dom_rects
    if include_blended_background_colors is not None:
        params["includeBlendedBackgroundColors"] = include_blended_background_colors
    if include_text_color_opacities is not None:
        params["includeTextColorOpacities"] = include_text_color_opacities
    cmd_dict: T_JSON_DICT = {
        "method": "DOMSnapshot.captureSnapshot",
        "params": params,
    }
    json = yield cmd_dict
    return (
        [DocumentSnapshot.from_json(i) for i in json["documents"]],
        [str(i) for i in json["strings"]],
    )

disable()

Disables DOM snapshot agent for the given page.

Source code in zendriver/cdp/dom_snapshot.py 
1008
1009
1010
1011
1012
1013
1014
1015
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables DOM snapshot agent for the given page.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "DOMSnapshot.disable",
    }
    json = yield cmd_dict

enable()

Enables DOM snapshot agent for the given page.

Source code in zendriver/cdp/dom_snapshot.py 
1018
1019
1020
1021
1022
1023
1024
1025
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables DOM snapshot agent for the given page.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "DOMSnapshot.enable",
    }
    json = yield cmd_dict

get_snapshot(computed_style_whitelist, include_event_listeners=None, include_paint_order=None, include_user_agent_shadow_tree=None)

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.

.. deprecated:: 1.3

Parameters:

Name Type Description Default
computed_style_whitelist List[str]

Whitelist of computed styles to return.

 required
include_event_listeners Optional[bool]

(Optional) Whether or not to retrieve details of DOM listeners (default false).

 None
include_paint_order Optional[bool]

(Optional) Whether to determine and include the paint order index of LayoutTreeNodes (default false).

 None
include_user_agent_shadow_tree Optional[bool]

(Optional) Whether to include UA shadow tree in the snapshot (default false).

 None

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[List[DOMNode], List[LayoutTreeNode], List[ComputedStyle]]]

A tuple with the following items: 0. domNodes - The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document. 1. layoutTreeNodes - The nodes in the layout tree. 2. computedStyles - Whitelisted ComputedStyle properties for each node in the layout tree.
Source code in zendriver/cdp/dom_snapshot.py 
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
@deprecated(version="1.3")
def get_snapshot(
    computed_style_whitelist: typing.List[str],
    include_event_listeners: typing.Optional[bool] = None,
    include_paint_order: typing.Optional[bool] = None,
    include_user_agent_shadow_tree: typing.Optional[bool] = None,
) -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[
        typing.List[DOMNode], typing.List[LayoutTreeNode], typing.List[ComputedStyle]
    ],
]:
    """
    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.

    .. deprecated:: 1.3

    :param computed_style_whitelist: Whitelist of computed styles to return.
    :param include_event_listeners: *(Optional)* Whether or not to retrieve details of DOM listeners (default false).
    :param include_paint_order: *(Optional)* Whether to determine and include the paint order index of LayoutTreeNodes (default false).
    :param include_user_agent_shadow_tree: *(Optional)* Whether to include UA shadow tree in the snapshot (default false).
    :returns: A tuple with the following items:

        0. **domNodes** - The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
        1. **layoutTreeNodes** - The nodes in the layout tree.
        2. **computedStyles** - Whitelisted ComputedStyle properties for each node in the layout tree.
    """
    params: T_JSON_DICT = dict()
    params["computedStyleWhitelist"] = [i for i in computed_style_whitelist]
    if include_event_listeners is not None:
        params["includeEventListeners"] = include_event_listeners
    if include_paint_order is not None:
        params["includePaintOrder"] = include_paint_order
    if include_user_agent_shadow_tree is not None:
        params["includeUserAgentShadowTree"] = include_user_agent_shadow_tree
    cmd_dict: T_JSON_DICT = {
        "method": "DOMSnapshot.getSnapshot",
        "params": params,
    }
    json = yield cmd_dict
    return (
        [DOMNode.from_json(i) for i in json["domNodes"]],
        [LayoutTreeNode.from_json(i) for i in json["layoutTreeNodes"]],
        [ComputedStyle.from_json(i) for i in json["computedStyles"]],
    )