-calling await tab will do a lot of stuff under the hood, and ensures all references
+
calling await tab await page and/or await page.sleep()
+it “breathe” by calling await page await page.sleep() also, it’s ensuring url
@@ -1027,7 +1027,7 @@
async wait ( t = None )
waits until the event listener reports idle (no new events received in certain timespan).
-when t is provided, ensures waiting for t seconds, no matter what.
+when t t
Parameters:
t (Union int float
@@ -1071,7 +1071,7 @@
diff --git a/docs/_build/html/nodriver/quickstart.html b/docs/_build/html/nodriver/quickstart.html
index c5cc5c1..edc03ac 100644
--- a/docs/_build/html/nodriver/quickstart.html
+++ b/docs/_build/html/nodriver/quickstart.html
@@ -5,7 +5,7 @@
Quickstart guide - nodriver documentation
Audits Autofill BackgroundService BluetoothEmulation Browser CacheStorage Cast Extensions FedCm Fetch FileSystem HeadlessExperimental HeapProfiler IndexedDB Python Module Index - nodriver documentation
+ Python Module Index - nodriver documentation
NODRIVER - nodriver documentation
Search - nodriver documentation Search - nodriver documentation TITLE - nodriver documentation
Audits Autofill BackgroundService BluetoothEmulation Browser CacheStorage Cast Extensions FedCm Fetch FileSystem HeadlessExperimental HeapProfiler IndexedDB ` element.
-#### native_source_value*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
+#### native_source_value *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
The value, such as a node or node list, of the native source.
-#### invalid*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### invalid *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Whether the value for this property is invalid.
-#### invalid_reason*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### invalid_reason *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Reason for the value being invalid, if it is.
### *class* AXRelatedNode(backend_dom_node_id, idref=None, text=None)
-#### backend_dom_node_id*: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
+#### backend_dom_node_id *: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
The BackendNodeId of the related DOM node.
-#### idref*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### idref *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The IDRef value provided, if any.
-#### text*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### text *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The text alternative of this node in the current context.
### *class* AXProperty(name, value)
-#### name*: [`AXPropertyName`](#nodriver.cdp.accessibility.AXPropertyName)*
+#### name *: [`AXPropertyName`](#nodriver.cdp.accessibility.AXPropertyName)*
The name of this property.
-#### value*: [`AXValue`](#nodriver.cdp.accessibility.AXValue)*
+#### value *: [`AXValue`](#nodriver.cdp.accessibility.AXValue)*
The value of this property.
@@ -164,19 +164,19 @@ The value of this property.
A single computed AX property.
-#### type_*: [`AXValueType`](#nodriver.cdp.accessibility.AXValueType)*
+#### type_ *: [`AXValueType`](#nodriver.cdp.accessibility.AXValueType)*
The type of this value.
-#### value*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Any`](https://docs.python.org/3/library/typing.html#typing.Any)]* *= None*
+#### value *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Any`](https://docs.python.org/3/library/typing.html#typing.Any)]* *= None*
The computed value of this property.
-#### related_nodes*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXRelatedNode`](#nodriver.cdp.accessibility.AXRelatedNode)]]* *= None*
+#### related_nodes *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXRelatedNode`](#nodriver.cdp.accessibility.AXRelatedNode)]]* *= None*
One or more related nodes, if applicable.
-#### sources*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXValueSource`](#nodriver.cdp.accessibility.AXValueSource)]]* *= None*
+#### sources *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXValueSource`](#nodriver.cdp.accessibility.AXValueSource)]]* *= None*
The sources which contributed to the computation of this property.
@@ -275,55 +275,55 @@ Values of AXProperty name:
A node in the accessibility tree.
-#### node_id*: [`AXNodeId`](#nodriver.cdp.accessibility.AXNodeId)*
+#### node_id *: [`AXNodeId`](#nodriver.cdp.accessibility.AXNodeId)*
Unique identifier for this node.
-#### ignored*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### ignored *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether this node is ignored for accessibility
-#### ignored_reasons*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXProperty`](#nodriver.cdp.accessibility.AXProperty)]]* *= None*
+#### ignored_reasons *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXProperty`](#nodriver.cdp.accessibility.AXProperty)]]* *= None*
Collection of reasons why this node is hidden.
-#### role*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
+#### role *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
This `Node`’s role, whether explicit or implicit.
-#### chrome_role*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
+#### chrome_role *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
This `Node`’s Chrome raw role.
-#### name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
+#### name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
The accessible name for this `Node`.
-#### description*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
+#### description *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
The accessible description for this `Node`.
-#### value*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
+#### value *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXValue`](#nodriver.cdp.accessibility.AXValue)]* *= None*
The value for this `Node`.
-#### properties*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXProperty`](#nodriver.cdp.accessibility.AXProperty)]]* *= None*
+#### properties *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXProperty`](#nodriver.cdp.accessibility.AXProperty)]]* *= None*
All other properties
-#### parent_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXNodeId`](#nodriver.cdp.accessibility.AXNodeId)]* *= None*
+#### parent_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AXNodeId`](#nodriver.cdp.accessibility.AXNodeId)]* *= None*
ID for this node’s parent.
-#### child_ids*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNodeId`](#nodriver.cdp.accessibility.AXNodeId)]]* *= None*
+#### child_ids *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNodeId`](#nodriver.cdp.accessibility.AXNodeId)]]* *= None*
IDs for each of this node’s child nodes.
-#### backend_dom_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### backend_dom_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
The backend ID for the associated DOM node, if any.
-#### frame_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]* *= None*
+#### frame_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]* *= None*
The frame ID for the frame associated with this nodes document.
@@ -361,9 +361,9 @@ Requires `enable()` to have been called previously.
**EXPERIMENTAL**
* **Parameters:**
- * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to get.
- * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to get.
- * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node wrapper to get.
+ * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to get.
+ * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to get.
+ * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node wrapper to get.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]]
* **Returns:**
@@ -377,7 +377,7 @@ Requires `enable()` to have been called previously.
* **Parameters:**
* **id** –
- * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* The frame in whose document the node resides. If omitted, the root frame is used.
+ * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* The frame in whose document the node resides. If omitted, the root frame is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]]
* **Returns:**
@@ -389,8 +389,8 @@ Fetches the entire accessibility tree for the root Document
**EXPERIMENTAL**
* **Parameters:**
- * **depth** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.
- * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* The frame for whose document the AX tree should be retrieved. If omitted, the root frame is used.
+ * **depth** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.
+ * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* The frame for whose document the AX tree should be retrieved. If omitted, the root frame is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]]
* **Returns:**
@@ -402,10 +402,10 @@ Fetches the accessibility node and partial accessibility tree for this DOM node,
**EXPERIMENTAL**
* **Parameters:**
- * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to get the partial accessibility tree for.
- * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to get the partial accessibility tree for.
- * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node wrapper to get the partial accessibility tree for.
- * **fetch_relatives** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to fetch this node’s ancestors, siblings and children. Defaults to true.
+ * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to get the partial accessibility tree for.
+ * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to get the partial accessibility tree for.
+ * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node wrapper to get the partial accessibility tree for.
+ * **fetch_relatives** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to fetch this node’s ancestors, siblings and children. Defaults to true.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]]
* **Returns:**
@@ -419,7 +419,7 @@ Requires `enable()` to have been called previously.
**EXPERIMENTAL**
* **Parameters:**
- **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* The frame in whose document the node resides. If omitted, the root frame is used.
+ **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* The frame in whose document the node resides. If omitted, the root frame is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`AXNode`](#nodriver.cdp.accessibility.AXNode)]
* **Returns:**
@@ -435,11 +435,11 @@ node is specified, or the DOM node does not exist, the command returns an error.
**EXPERIMENTAL**
* **Parameters:**
- * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node for the root to query.
- * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node for the root to query.
- * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node wrapper for the root to query.
- * **accessible_name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Find nodes with this computed name.
- * **role** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Find nodes with this computed role.
+ * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node for the root to query.
+ * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node for the root to query.
+ * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node wrapper for the root to query.
+ * **accessible_name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Find nodes with this computed name.
+ * **role** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Find nodes with this computed role.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]]
* **Returns:**
@@ -458,7 +458,7 @@ you use the event’s attributes.
The loadComplete event mirrors the load complete event sent by the browser to assistive
technology when the web page has finished loading.
-#### root*: [`AXNode`](#nodriver.cdp.accessibility.AXNode)*
+#### root *: [`AXNode`](#nodriver.cdp.accessibility.AXNode)*
New document root node.
@@ -468,6 +468,6 @@ New document root node.
The nodesUpdated event is sent every time a previously requested node has changed the in tree.
-#### nodes*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]*
+#### nodes *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AXNode`](#nodriver.cdp.accessibility.AXNode)]*
Updated node data.
diff --git a/docs/_build/markdown/nodriver/cdp/animation.md b/docs/_build/markdown/nodriver/cdp/animation.md
index 05db04c..80f7e19 100644
--- a/docs/_build/markdown/nodriver/cdp/animation.md
+++ b/docs/_build/markdown/nodriver/cdp/animation.md
@@ -18,51 +18,51 @@ arguments to other commands.
Animation instance.
-#### id_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### id_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`Animation`’s id.
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`Animation`’s name.
-#### paused_state*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### paused_state *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
`Animation`’s internal paused state.
-#### play_state*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### play_state *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`Animation`’s play state.
-#### playback_rate*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### playback_rate *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`Animation`’s playback rate.
-#### start_time*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### start_time *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`Animation`’s start time.
Milliseconds for time based animations and
percentage [0 - 100] for scroll driven animations
(i.e. when viewOrScrollTimeline exists).
-#### current_time*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### current_time *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`Animation`’s current time.
-#### type_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### type_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Animation type of `Animation`.
-#### source*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AnimationEffect`](#nodriver.cdp.animation.AnimationEffect)]* *= None*
+#### source *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AnimationEffect`](#nodriver.cdp.animation.AnimationEffect)]* *= None*
`Animation`’s source animation node.
-#### css_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### css_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
A unique ID for `Animation` representing the sources that triggered this CSS
animation/transition.
-#### view_or_scroll_timeline*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ViewOrScrollTimeline`](#nodriver.cdp.animation.ViewOrScrollTimeline)]* *= None*
+#### view_or_scroll_timeline *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ViewOrScrollTimeline`](#nodriver.cdp.animation.ViewOrScrollTimeline)]* *= None*
View or scroll timeline
@@ -70,25 +70,25 @@ View or scroll timeline
Timeline instance
-#### axis*: [`ScrollOrientation`](dom.md#nodriver.cdp.dom.ScrollOrientation)*
+#### axis *: [`ScrollOrientation`](dom.md#nodriver.cdp.dom.ScrollOrientation)*
Orientation of the scroll
-#### source_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### source_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
Scroll container node
-#### start_offset*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### start_offset *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
Represents the starting scroll position of the timeline
as a length offset in pixels from scroll origin.
-#### end_offset*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### end_offset *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
Represents the ending scroll position of the timeline
as a length offset in pixels from scroll origin.
-#### subject_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### subject_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
The element whose principal box’s visibility in the
scrollport defined the progress of the timeline.
@@ -98,46 +98,46 @@ Does not exist for animations with ScrollTimeline
AnimationEffect instance
-#### delay*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### delay *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`AnimationEffect`’s delay.
-#### end_delay*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### end_delay *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`AnimationEffect`’s end delay.
-#### iteration_start*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### iteration_start *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`AnimationEffect`’s iteration start.
-#### iterations*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### iterations *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`AnimationEffect`’s iterations.
-#### duration*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### duration *: [`float`](https://docs.python.org/3/library/functions.html#float)*
`AnimationEffect`’s iteration duration.
Milliseconds for time based animations and
percentage [0 - 100] for scroll driven animations
(i.e. when viewOrScrollTimeline exists).
-#### direction*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### direction *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`AnimationEffect`’s playback direction.
-#### fill*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### fill *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`AnimationEffect`’s fill mode.
-#### easing*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### easing *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`AnimationEffect`’s timing function.
-#### backend_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### backend_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
`AnimationEffect`’s target node.
-#### keyframes_rule*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`KeyframesRule`](#nodriver.cdp.animation.KeyframesRule)]* *= None*
+#### keyframes_rule *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`KeyframesRule`](#nodriver.cdp.animation.KeyframesRule)]* *= None*
`AnimationEffect`’s keyframes.
@@ -145,11 +145,11 @@ percentage [0 - 100] for scroll driven animations
Keyframes Rule
-#### keyframes*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`KeyframeStyle`](#nodriver.cdp.animation.KeyframeStyle)]*
+#### keyframes *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`KeyframeStyle`](#nodriver.cdp.animation.KeyframeStyle)]*
List of animation keyframes.
-#### name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
CSS keyframed animation’s name.
@@ -157,11 +157,11 @@ CSS keyframed animation’s name.
Keyframe Style
-#### offset*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### offset *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Keyframe’s time offset.
-#### easing*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### easing *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
`AnimationEffect`’s timing function.
@@ -280,7 +280,7 @@ you use the event’s attributes.
Event for when an animation has been cancelled.
-#### id_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### id_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Id of the animation that was cancelled.
@@ -288,7 +288,7 @@ Id of the animation that was cancelled.
Event for each animation that has been created.
-#### id_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### id_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Id of the animation that was created.
@@ -296,7 +296,7 @@ Id of the animation that was created.
Event for animation that has been started.
-#### animation*: [`Animation`](#nodriver.cdp.animation.Animation)*
+#### animation *: [`Animation`](#nodriver.cdp.animation.Animation)*
Animation that was started.
@@ -304,6 +304,6 @@ Animation that was started.
Event for animation that has been updated.
-#### animation*: [`Animation`](#nodriver.cdp.animation.Animation)*
+#### animation *: [`Animation`](#nodriver.cdp.animation.Animation)*
Animation that was updated.
diff --git a/docs/_build/markdown/nodriver/cdp/audits.md b/docs/_build/markdown/nodriver/cdp/audits.md
index ad60d8a..d39222b 100644
--- a/docs/_build/markdown/nodriver/cdp/audits.md
+++ b/docs/_build/markdown/nodriver/cdp/audits.md
@@ -20,29 +20,29 @@ arguments to other commands.
Information about a cookie that is affected by an inspector issue.
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The following three properties uniquely identify a cookie
-#### path*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### path *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### domain*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### domain *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* AffectedRequest(request_id, url=None)
Information about a request that is affected by an inspector issue.
-#### request_id*: [`RequestId`](network.md#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](network.md#nodriver.cdp.network.RequestId)*
The unique request id.
-#### url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* AffectedFrame(frame_id)
Information about the frame affected by an inspector issue.
-#### frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
### *class* CookieExclusionReason(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -110,29 +110,29 @@ This information is currently necessary, as the front-end has a difficult
time finding a specific cookie. With this, we can convey specific error
information without the cookie.
-#### cookie_warning_reasons*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`CookieWarningReason`](#nodriver.cdp.audits.CookieWarningReason)]*
+#### cookie_warning_reasons *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`CookieWarningReason`](#nodriver.cdp.audits.CookieWarningReason)]*
-#### cookie_exclusion_reasons*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`CookieExclusionReason`](#nodriver.cdp.audits.CookieExclusionReason)]*
+#### cookie_exclusion_reasons *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`CookieExclusionReason`](#nodriver.cdp.audits.CookieExclusionReason)]*
-#### operation*: [`CookieOperation`](#nodriver.cdp.audits.CookieOperation)*
+#### operation *: [`CookieOperation`](#nodriver.cdp.audits.CookieOperation)*
Optionally identifies the site-for-cookies and the cookie url, which
may be used by the front-end as additional context.
-#### cookie*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedCookie`](#nodriver.cdp.audits.AffectedCookie)]* *= None*
+#### cookie *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedCookie`](#nodriver.cdp.audits.AffectedCookie)]* *= None*
If AffectedCookie is not set then rawCookieLine contains the raw
Set-Cookie header string. This hints at a problem where the
cookie line is syntactically or semantically malformed in a way
that no valid cookie could be created.
-#### raw_cookie_line*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### raw_cookie_line *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### site_for_cookies*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### site_for_cookies *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### cookie_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### cookie_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### request*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
+#### request *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
### *class* MixedContentResolutionStatus(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -204,31 +204,31 @@ that no valid cookie could be created.
### *class* MixedContentIssueDetails(resolution_status, insecure_url, main_resource_url, resource_type=None, request=None, frame=None)
-#### resolution_status*: [`MixedContentResolutionStatus`](#nodriver.cdp.audits.MixedContentResolutionStatus)*
+#### resolution_status *: [`MixedContentResolutionStatus`](#nodriver.cdp.audits.MixedContentResolutionStatus)*
The way the mixed content issue is being resolved.
-#### insecure_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### insecure_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The unsafe http url causing the mixed content issue.
-#### main_resource_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### main_resource_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The url responsible for the call to an unsafe url.
-#### resource_type*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MixedContentResourceType`](#nodriver.cdp.audits.MixedContentResourceType)]* *= None*
+#### resource_type *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MixedContentResourceType`](#nodriver.cdp.audits.MixedContentResourceType)]* *= None*
The type of resource causing the mixed content issue (css, js, iframe,
form,…). Marked as optional because it is mapped to from
blink::mojom::RequestContextType, which will be replaced
by network::mojom::RequestDestination
-#### request*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
+#### request *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
The mixed content request.
Does not always exist (e.g. for unsafe form submission urls).
-#### frame*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
+#### frame *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
Optional because not every mixed content issue is necessarily linked to a frame.
@@ -257,13 +257,13 @@ Details for a request that has been blocked with the BLOCKED_BY_RESPONSE
code. Currently only used for COEP/COOP, but may be extended to include
some CSP errors in the future.
-#### request*: [`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)*
+#### request *: [`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)*
-#### reason*: [`BlockedByResponseReason`](#nodriver.cdp.audits.BlockedByResponseReason)*
+#### reason *: [`BlockedByResponseReason`](#nodriver.cdp.audits.BlockedByResponseReason)*
-#### parent_frame*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
+#### parent_frame *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
-#### blocked_frame*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
+#### blocked_frame *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
### *class* HeavyAdResolutionStatus(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -281,15 +281,15 @@ some CSP errors in the future.
### *class* HeavyAdIssueDetails(resolution, reason, frame)
-#### resolution*: [`HeavyAdResolutionStatus`](#nodriver.cdp.audits.HeavyAdResolutionStatus)*
+#### resolution *: [`HeavyAdResolutionStatus`](#nodriver.cdp.audits.HeavyAdResolutionStatus)*
The resolution status, either blocking the content or warning.
-#### reason*: [`HeavyAdReason`](#nodriver.cdp.audits.HeavyAdReason)*
+#### reason *: [`HeavyAdReason`](#nodriver.cdp.audits.HeavyAdReason)*
The reason the ad was blocked, total network or cpu or peak cpu.
-#### frame*: [`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)*
+#### frame *: [`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)*
The frame that was blocked.
@@ -309,33 +309,33 @@ The frame that was blocked.
### *class* SourceCodeLocation(url, line_number, column_number, script_id=None)
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### line_number*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### line_number *: [`int`](https://docs.python.org/3/library/functions.html#int)*
-#### column_number*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### column_number *: [`int`](https://docs.python.org/3/library/functions.html#int)*
-#### script_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ScriptId`](runtime.md#nodriver.cdp.runtime.ScriptId)]* *= None*
+#### script_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ScriptId`](runtime.md#nodriver.cdp.runtime.ScriptId)]* *= None*
### *class* ContentSecurityPolicyIssueDetails(violated_directive, is_report_only, content_security_policy_violation_type, blocked_url=None, frame_ancestor=None, source_code_location=None, violating_node_id=None)
-#### violated_directive*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### violated_directive *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Specific directive that is violated, causing the CSP issue.
-#### is_report_only*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_report_only *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### content_security_policy_violation_type*: [`ContentSecurityPolicyViolationType`](#nodriver.cdp.audits.ContentSecurityPolicyViolationType)*
+#### content_security_policy_violation_type *: [`ContentSecurityPolicyViolationType`](#nodriver.cdp.audits.ContentSecurityPolicyViolationType)*
-#### blocked_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### blocked_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The url not included in allowed sources.
-#### frame_ancestor*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
+#### frame_ancestor *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
-#### source_code_location*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)]* *= None*
+#### source_code_location *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)]* *= None*
-#### violating_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### violating_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
### *class* SharedArrayBufferIssueType(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -348,46 +348,46 @@ The url not included in allowed sources.
Details for a issue arising from an SAB being instantiated in, or
transferred to a context that is not cross-origin isolated.
-#### source_code_location*: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
+#### source_code_location *: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
-#### is_warning*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_warning *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### type_*: [`SharedArrayBufferIssueType`](#nodriver.cdp.audits.SharedArrayBufferIssueType)*
+#### type_ *: [`SharedArrayBufferIssueType`](#nodriver.cdp.audits.SharedArrayBufferIssueType)*
### *class* LowTextContrastIssueDetails(violating_node_id, violating_node_selector, contrast_ratio, threshold_aa, threshold_aaa, font_size, font_weight)
-#### violating_node_id*: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
+#### violating_node_id *: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
-#### violating_node_selector*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### violating_node_selector *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### contrast_ratio*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### contrast_ratio *: [`float`](https://docs.python.org/3/library/functions.html#float)*
-#### threshold_aa*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### threshold_aa *: [`float`](https://docs.python.org/3/library/functions.html#float)*
-#### threshold_aaa*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### threshold_aaa *: [`float`](https://docs.python.org/3/library/functions.html#float)*
-#### font_size*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### font_size *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### font_weight*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### font_weight *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* CorsIssueDetails(cors_error_status, is_warning, request, location=None, initiator_origin=None, resource_ip_address_space=None, client_security_state=None)
Details for a CORS related issue, e.g. a warning or error related to
CORS RFC1918 enforcement.
-#### cors_error_status*: [`CorsErrorStatus`](network.md#nodriver.cdp.network.CorsErrorStatus)*
+#### cors_error_status *: [`CorsErrorStatus`](network.md#nodriver.cdp.network.CorsErrorStatus)*
-#### is_warning*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_warning *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### request*: [`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)*
+#### request *: [`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)*
-#### location*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)]* *= None*
+#### location *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)]* *= None*
-#### initiator_origin*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### initiator_origin *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### resource_ip_address_space*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`IPAddressSpace`](network.md#nodriver.cdp.network.IPAddressSpace)]* *= None*
+#### resource_ip_address_space *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`IPAddressSpace`](network.md#nodriver.cdp.network.IPAddressSpace)]* *= None*
-#### client_security_state*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ClientSecurityState`](network.md#nodriver.cdp.network.ClientSecurityState)]* *= None*
+#### client_security_state *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ClientSecurityState`](network.md#nodriver.cdp.network.ClientSecurityState)]* *= None*
### *class* AttributionReportingIssueType(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -486,43 +486,43 @@ CORS RFC1918 enforcement.
Details for issues around “Attribution Reporting API” usage.
Explainer: [https://github.com/WICG/attribution-reporting-api](https://github.com/WICG/attribution-reporting-api)
-#### violation_type*: [`AttributionReportingIssueType`](#nodriver.cdp.audits.AttributionReportingIssueType)*
+#### violation_type *: [`AttributionReportingIssueType`](#nodriver.cdp.audits.AttributionReportingIssueType)*
-#### request*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
+#### request *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
-#### violating_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### violating_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
-#### invalid_parameter*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### invalid_parameter *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* QuirksModeIssueDetails(is_limited_quirks_mode, document_node_id, url, frame_id, loader_id)
Details for issues about documents in Quirks Mode
or Limited Quirks Mode that affects page layouting.
-#### is_limited_quirks_mode*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_limited_quirks_mode *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
If false, it means the document’s mode is “quirks”
instead of “limited-quirks”.
-#### document_node_id*: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
+#### document_node_id *: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
-#### loader_id*: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
+#### loader_id *: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
### *class* NavigatorUserAgentIssueDetails(url, location=None)
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### location*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)]* *= None*
+#### location *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)]* *= None*
### *class* SharedDictionaryIssueDetails(shared_dictionary_error, request)
-#### shared_dictionary_error*: [`SharedDictionaryError`](#nodriver.cdp.audits.SharedDictionaryError)*
+#### shared_dictionary_error *: [`SharedDictionaryError`](#nodriver.cdp.audits.SharedDictionaryError)*
-#### request*: [`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)*
+#### request *: [`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)*
### *class* GenericIssueErrorType(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -552,30 +552,30 @@ instead of “limited-quirks”.
Depending on the concrete errorType, different properties are set.
-#### error_type*: [`GenericIssueErrorType`](#nodriver.cdp.audits.GenericIssueErrorType)*
+#### error_type *: [`GenericIssueErrorType`](#nodriver.cdp.audits.GenericIssueErrorType)*
Issues with the same errorType are aggregated in the frontend.
-#### frame_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]* *= None*
+#### frame_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]* *= None*
-#### violating_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
+#### violating_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]* *= None*
-#### violating_node_attribute*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### violating_node_attribute *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### request*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
+#### request *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedRequest`](#nodriver.cdp.audits.AffectedRequest)]* *= None*
### *class* DeprecationIssueDetails(source_code_location, type_, affected_frame=None)
This issue tracks information needed to print a deprecation message.
[https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md)
-#### source_code_location*: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
+#### source_code_location *: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
-#### type_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### type_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5
-#### affected_frame*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
+#### affected_frame *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AffectedFrame`](#nodriver.cdp.audits.AffectedFrame)]* *= None*
### *class* BounceTrackingIssueDetails(tracking_sites)
@@ -585,7 +585,7 @@ receive a user interaction. Note that in this context ‘site’ means eTLD+1.
For example, if the URL `https://example.test:80/bounce` was in the
redirect chain, the site reported would be `example.test`.
-#### tracking_sites*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### tracking_sites *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
### *class* CookieDeprecationMetadataIssueDetails(allowed_sites, opt_out_percentage, is_opt_out_top_level, operation)
@@ -595,13 +595,13 @@ Note that in this context ‘site’ means eTLD+1. For example, if the URL
`https://example.test:80/web_page` was accessing cookies, the site reported
would be `example.test`.
-#### allowed_sites*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### allowed_sites *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
-#### opt_out_percentage*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### opt_out_percentage *: [`float`](https://docs.python.org/3/library/functions.html#float)*
-#### is_opt_out_top_level*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_opt_out_top_level *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### operation*: [`CookieOperation`](#nodriver.cdp.audits.CookieOperation)*
+#### operation *: [`CookieOperation`](#nodriver.cdp.audits.CookieOperation)*
### *class* ClientHintIssueReason(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -611,7 +611,7 @@ would be `example.test`.
### *class* FederatedAuthRequestIssueDetails(federated_auth_request_issue_reason)
-#### federated_auth_request_issue_reason*: [`FederatedAuthRequestIssueReason`](#nodriver.cdp.audits.FederatedAuthRequestIssueReason)*
+#### federated_auth_request_issue_reason *: [`FederatedAuthRequestIssueReason`](#nodriver.cdp.audits.FederatedAuthRequestIssueReason)*
### *class* FederatedAuthRequestIssueReason(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -712,7 +712,7 @@ all cases except for success.
### *class* FederatedAuthUserInfoRequestIssueDetails(federated_auth_user_info_request_issue_reason)
-#### federated_auth_user_info_request_issue_reason*: [`FederatedAuthUserInfoRequestIssueReason`](#nodriver.cdp.audits.FederatedAuthUserInfoRequestIssueReason)*
+#### federated_auth_user_info_request_issue_reason *: [`FederatedAuthUserInfoRequestIssueReason`](#nodriver.cdp.audits.FederatedAuthUserInfoRequestIssueReason)*
### *class* FederatedAuthUserInfoRequestIssueReason(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -743,21 +743,21 @@ third_party/blink/public/mojom/devtools/inspector_issue.mojom.
This issue tracks client hints related issues. It’s used to deprecate old
features, encourage the use of new ones, and provide general guidance.
-#### source_code_location*: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
+#### source_code_location *: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
-#### client_hint_issue_reason*: [`ClientHintIssueReason`](#nodriver.cdp.audits.ClientHintIssueReason)*
+#### client_hint_issue_reason *: [`ClientHintIssueReason`](#nodriver.cdp.audits.ClientHintIssueReason)*
### *class* FailedRequestInfo(url, failure_message, request_id=None)
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The URL that failed to load.
-#### failure_message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### failure_message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The failure message for the failed request.
-#### request_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](network.md#nodriver.cdp.network.RequestId)]* *= None*
+#### request_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](network.md#nodriver.cdp.network.RequestId)]* *= None*
### *class* StyleSheetLoadingIssueReason(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -769,15 +769,15 @@ The failure message for the failed request.
This issue warns when a referenced stylesheet couldn’t be loaded.
-#### source_code_location*: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
+#### source_code_location *: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
Source code position that referenced the failing stylesheet.
-#### style_sheet_loading_issue_reason*: [`StyleSheetLoadingIssueReason`](#nodriver.cdp.audits.StyleSheetLoadingIssueReason)*
+#### style_sheet_loading_issue_reason *: [`StyleSheetLoadingIssueReason`](#nodriver.cdp.audits.StyleSheetLoadingIssueReason)*
Reason why the stylesheet couldn’t be loaded.
-#### failed_request_info*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FailedRequestInfo`](#nodriver.cdp.audits.FailedRequestInfo)]* *= None*
+#### failed_request_info *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FailedRequestInfo`](#nodriver.cdp.audits.FailedRequestInfo)]* *= None*
Contains additional info when the failure was due to a request.
@@ -796,15 +796,15 @@ Contains additional info when the failure was due to a request.
This issue warns about errors in property rules that lead to property
registrations being ignored.
-#### source_code_location*: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
+#### source_code_location *: [`SourceCodeLocation`](#nodriver.cdp.audits.SourceCodeLocation)*
Source code position of the property rule.
-#### property_rule_issue_reason*: [`PropertyRuleIssueReason`](#nodriver.cdp.audits.PropertyRuleIssueReason)*
+#### property_rule_issue_reason *: [`PropertyRuleIssueReason`](#nodriver.cdp.audits.PropertyRuleIssueReason)*
Reason why the property rule was discarded.
-#### property_value*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### property_value *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The value of the property rule property that failed to parse
@@ -862,47 +862,47 @@ This struct holds a list of optional fields with additional information
specific to the kind of issue. When adding a new issue code, please also
add a new optional field to this type.
-#### cookie_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieIssueDetails`](#nodriver.cdp.audits.CookieIssueDetails)]* *= None*
+#### cookie_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieIssueDetails`](#nodriver.cdp.audits.CookieIssueDetails)]* *= None*
-#### mixed_content_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MixedContentIssueDetails`](#nodriver.cdp.audits.MixedContentIssueDetails)]* *= None*
+#### mixed_content_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MixedContentIssueDetails`](#nodriver.cdp.audits.MixedContentIssueDetails)]* *= None*
-#### blocked_by_response_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BlockedByResponseIssueDetails`](#nodriver.cdp.audits.BlockedByResponseIssueDetails)]* *= None*
+#### blocked_by_response_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BlockedByResponseIssueDetails`](#nodriver.cdp.audits.BlockedByResponseIssueDetails)]* *= None*
-#### heavy_ad_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`HeavyAdIssueDetails`](#nodriver.cdp.audits.HeavyAdIssueDetails)]* *= None*
+#### heavy_ad_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`HeavyAdIssueDetails`](#nodriver.cdp.audits.HeavyAdIssueDetails)]* *= None*
-#### content_security_policy_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ContentSecurityPolicyIssueDetails`](#nodriver.cdp.audits.ContentSecurityPolicyIssueDetails)]* *= None*
+#### content_security_policy_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ContentSecurityPolicyIssueDetails`](#nodriver.cdp.audits.ContentSecurityPolicyIssueDetails)]* *= None*
-#### shared_array_buffer_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SharedArrayBufferIssueDetails`](#nodriver.cdp.audits.SharedArrayBufferIssueDetails)]* *= None*
+#### shared_array_buffer_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SharedArrayBufferIssueDetails`](#nodriver.cdp.audits.SharedArrayBufferIssueDetails)]* *= None*
-#### low_text_contrast_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LowTextContrastIssueDetails`](#nodriver.cdp.audits.LowTextContrastIssueDetails)]* *= None*
+#### low_text_contrast_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LowTextContrastIssueDetails`](#nodriver.cdp.audits.LowTextContrastIssueDetails)]* *= None*
-#### cors_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CorsIssueDetails`](#nodriver.cdp.audits.CorsIssueDetails)]* *= None*
+#### cors_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CorsIssueDetails`](#nodriver.cdp.audits.CorsIssueDetails)]* *= None*
-#### attribution_reporting_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AttributionReportingIssueDetails`](#nodriver.cdp.audits.AttributionReportingIssueDetails)]* *= None*
+#### attribution_reporting_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AttributionReportingIssueDetails`](#nodriver.cdp.audits.AttributionReportingIssueDetails)]* *= None*
-#### quirks_mode_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`QuirksModeIssueDetails`](#nodriver.cdp.audits.QuirksModeIssueDetails)]* *= None*
+#### quirks_mode_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`QuirksModeIssueDetails`](#nodriver.cdp.audits.QuirksModeIssueDetails)]* *= None*
-#### navigator_user_agent_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NavigatorUserAgentIssueDetails`](#nodriver.cdp.audits.NavigatorUserAgentIssueDetails)]* *= None*
+#### navigator_user_agent_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NavigatorUserAgentIssueDetails`](#nodriver.cdp.audits.NavigatorUserAgentIssueDetails)]* *= None*
-#### generic_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`GenericIssueDetails`](#nodriver.cdp.audits.GenericIssueDetails)]* *= None*
+#### generic_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`GenericIssueDetails`](#nodriver.cdp.audits.GenericIssueDetails)]* *= None*
-#### deprecation_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`DeprecationIssueDetails`](#nodriver.cdp.audits.DeprecationIssueDetails)]* *= None*
+#### deprecation_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`DeprecationIssueDetails`](#nodriver.cdp.audits.DeprecationIssueDetails)]* *= None*
-#### client_hint_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ClientHintIssueDetails`](#nodriver.cdp.audits.ClientHintIssueDetails)]* *= None*
+#### client_hint_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ClientHintIssueDetails`](#nodriver.cdp.audits.ClientHintIssueDetails)]* *= None*
-#### federated_auth_request_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FederatedAuthRequestIssueDetails`](#nodriver.cdp.audits.FederatedAuthRequestIssueDetails)]* *= None*
+#### federated_auth_request_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FederatedAuthRequestIssueDetails`](#nodriver.cdp.audits.FederatedAuthRequestIssueDetails)]* *= None*
-#### bounce_tracking_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BounceTrackingIssueDetails`](#nodriver.cdp.audits.BounceTrackingIssueDetails)]* *= None*
+#### bounce_tracking_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BounceTrackingIssueDetails`](#nodriver.cdp.audits.BounceTrackingIssueDetails)]* *= None*
-#### cookie_deprecation_metadata_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieDeprecationMetadataIssueDetails`](#nodriver.cdp.audits.CookieDeprecationMetadataIssueDetails)]* *= None*
+#### cookie_deprecation_metadata_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieDeprecationMetadataIssueDetails`](#nodriver.cdp.audits.CookieDeprecationMetadataIssueDetails)]* *= None*
-#### stylesheet_loading_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StylesheetLoadingIssueDetails`](#nodriver.cdp.audits.StylesheetLoadingIssueDetails)]* *= None*
+#### stylesheet_loading_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StylesheetLoadingIssueDetails`](#nodriver.cdp.audits.StylesheetLoadingIssueDetails)]* *= None*
-#### property_rule_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`PropertyRuleIssueDetails`](#nodriver.cdp.audits.PropertyRuleIssueDetails)]* *= None*
+#### property_rule_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`PropertyRuleIssueDetails`](#nodriver.cdp.audits.PropertyRuleIssueDetails)]* *= None*
-#### federated_auth_user_info_request_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FederatedAuthUserInfoRequestIssueDetails`](#nodriver.cdp.audits.FederatedAuthUserInfoRequestIssueDetails)]* *= None*
+#### federated_auth_user_info_request_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FederatedAuthUserInfoRequestIssueDetails`](#nodriver.cdp.audits.FederatedAuthUserInfoRequestIssueDetails)]* *= None*
-#### shared_dictionary_issue_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SharedDictionaryIssueDetails`](#nodriver.cdp.audits.SharedDictionaryIssueDetails)]* *= None*
+#### shared_dictionary_issue_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SharedDictionaryIssueDetails`](#nodriver.cdp.audits.SharedDictionaryIssueDetails)]* *= None*
### *class* IssueId
@@ -913,11 +913,11 @@ exceptions, CDP message, console messages, etc.) to reference an issue.
An inspector issue reported from the back-end.
-#### code*: [`InspectorIssueCode`](#nodriver.cdp.audits.InspectorIssueCode)*
+#### code *: [`InspectorIssueCode`](#nodriver.cdp.audits.InspectorIssueCode)*
-#### details*: [`InspectorIssueDetails`](#nodriver.cdp.audits.InspectorIssueDetails)*
+#### details *: [`InspectorIssueDetails`](#nodriver.cdp.audits.InspectorIssueDetails)*
-#### issue_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`IssueId`](#nodriver.cdp.audits.IssueId)]* *= None*
+#### issue_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`IssueId`](#nodriver.cdp.audits.IssueId)]* *= None*
A unique id for this issue. May be omitted if no other entity (e.g.
exception, CDP message, etc.) is referencing this issue.
@@ -939,7 +939,7 @@ Runs the contrast check for the target page. Found issues are reported
using Audits.issueAdded event.
* **Parameters:**
- **report_aaa** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to report WCAG AAA level issues. Default is false.
+ **report_aaa** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to report WCAG AAA level issues. Default is false.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -975,13 +975,13 @@ applies to images.
* **Parameters:**
* **request_id** ([`RequestId`](network.md#nodriver.cdp.network.RequestId)) – Identifier of the network request to get content for.
* **encoding** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – The encoding to use.
- * **quality** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* The quality of the encoding (0-1). (defaults to 1)
- * **size_only** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to only return the size information (defaults to false).
+ * **quality** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* The quality of the encoding (0-1). (defaults to 1)
+ * **size_only** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to only return the size information (defaults to false).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Tuple`](https://docs.python.org/3/library/typing.html#typing.Tuple)[[`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)], [`int`](https://docs.python.org/3/library/functions.html#int), [`int`](https://docs.python.org/3/library/functions.html#int)]]
* **Returns:**
A tuple with the following items:
- 1. **body** - *(Optional)* The encoded body as a base64 string. Omitted if sizeOnly is true. (Encoded as a base64 string when passed over JSON)
+ 1. **body** - *(Optional)* The encoded body as a base64 string. Omitted if sizeOnly is true. (Encoded as a base64 string when passed over JSON)
2. **originalSize** - Size before re-encoding.
3. **encodedSize** - Size after re-encoding.
@@ -993,4 +993,4 @@ you use the event’s attributes.
### *class* IssueAdded(issue)
-#### issue*: [`InspectorIssue`](#nodriver.cdp.audits.InspectorIssue)*
+#### issue *: [`InspectorIssue`](#nodriver.cdp.audits.InspectorIssue)*
diff --git a/docs/_build/markdown/nodriver/cdp/autofill.md b/docs/_build/markdown/nodriver/cdp/autofill.md
index 558ec50..11acad1 100644
--- a/docs/_build/markdown/nodriver/cdp/autofill.md
+++ b/docs/_build/markdown/nodriver/cdp/autofill.md
@@ -18,33 +18,33 @@ arguments to other commands.
### *class* CreditCard(number, name, expiry_month, expiry_year, cvc)
-#### number*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### number *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
16-digit credit card number.
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Name of the credit card owner.
-#### expiry_month*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### expiry_month *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
2-digit expiry month.
-#### expiry_year*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### expiry_year *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
4-digit expiry year.
-#### cvc*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### cvc *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
3-digit card verification code.
### *class* AddressField(name, value)
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
address field name, for example GIVEN_NAME.
-#### value*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### value *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
address field value, for example Jon Doe.
@@ -52,11 +52,11 @@ address field value, for example Jon Doe.
A list of address fields.
-#### fields*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AddressField`](#nodriver.cdp.autofill.AddressField)]*
+#### fields *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AddressField`](#nodriver.cdp.autofill.AddressField)]*
### *class* Address(fields)
-#### fields*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AddressField`](#nodriver.cdp.autofill.AddressField)]*
+#### fields *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AddressField`](#nodriver.cdp.autofill.AddressField)]*
fields and values defining an address.
@@ -70,7 +70,7 @@ should allow the receiver to render:
Jon Doe
Munich 81456
-#### address_fields*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AddressFields`](#nodriver.cdp.autofill.AddressFields)]*
+#### address_fields *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AddressFields`](#nodriver.cdp.autofill.AddressFields)]*
A two dimension array containing the representation of values from an address profile.
@@ -84,35 +84,35 @@ Specified whether a filled field was done so by using the html autocomplete attr
### *class* FilledField(html_type, id_, name, value, autofill_type, filling_strategy, frame_id, field_id)
-#### html_type*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### html_type *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The type of the field, e.g text, password etc.
-#### id_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### id_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
the html id
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
the html name
-#### value*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### value *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
the field value
-#### autofill_type*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### autofill_type *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The actual field type, e.g FAMILY_NAME
-#### filling_strategy*: [`FillingStrategy`](#nodriver.cdp.autofill.FillingStrategy)*
+#### filling_strategy *: [`FillingStrategy`](#nodriver.cdp.autofill.FillingStrategy)*
The filling strategy
-#### frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
The frame the field belongs to
-#### field_id*: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
+#### field_id *: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
The form field’s DOM node
@@ -157,7 +157,7 @@ If the field and related form cannot be autofilled, returns an error.
* **Parameters:**
* **field_id** ([`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)) – Identifies a field that serves as an anchor for autofill.
- * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* Identifies the frame that field belongs to.
+ * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* Identifies the frame that field belongs to.
* **card** ([`CreditCard`](#nodriver.cdp.autofill.CreditCard)) – Credit card information to fill out the form. Credit card data is not saved.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -172,11 +172,11 @@ you use the event’s attributes.
Emitted when an address form is filled.
-#### filled_fields*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FilledField`](#nodriver.cdp.autofill.FilledField)]*
+#### filled_fields *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FilledField`](#nodriver.cdp.autofill.FilledField)]*
Information about the fields that were filled
-#### address_ui*: [`AddressUI`](#nodriver.cdp.autofill.AddressUI)*
+#### address_ui *: [`AddressUI`](#nodriver.cdp.autofill.AddressUI)*
An UI representation of the address used to fill the form.
Consists of a 2D array where each child represents an address/profile line.
diff --git a/docs/_build/markdown/nodriver/cdp/background_service.md b/docs/_build/markdown/nodriver/cdp/background_service.md
index d2cf584..121658c 100644
--- a/docs/_build/markdown/nodriver/cdp/background_service.md
+++ b/docs/_build/markdown/nodriver/cdp/background_service.md
@@ -38,41 +38,41 @@ API.
A key-value pair for additional event information to pass along.
-#### key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### value*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### value *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* BackgroundServiceEvent(timestamp, origin, service_worker_registration_id, service, event_name, instance_id, event_metadata, storage_key)
-#### timestamp*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### timestamp *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
Timestamp of the event (in seconds).
-#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The origin this event belongs to.
-#### service_worker_registration_id*: [`RegistrationID`](service_worker.md#nodriver.cdp.service_worker.RegistrationID)*
+#### service_worker_registration_id *: [`RegistrationID`](service_worker.md#nodriver.cdp.service_worker.RegistrationID)*
The Service Worker ID that initiated the event.
-#### service*: [`ServiceName`](#nodriver.cdp.background_service.ServiceName)*
+#### service *: [`ServiceName`](#nodriver.cdp.background_service.ServiceName)*
The Background Service this event belongs to.
-#### event_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### event_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
A description of the event.
-#### instance_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### instance_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
An identifier that groups related events together.
-#### event_metadata*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`EventMetadata`](#nodriver.cdp.background_service.EventMetadata)]*
+#### event_metadata *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`EventMetadata`](#nodriver.cdp.background_service.EventMetadata)]*
A list of event-specific information.
-#### storage_key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### storage_key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Storage key this event belongs to.
@@ -134,13 +134,13 @@ you use the event’s attributes.
Called when the recording state for the service has been updated.
-#### is_recording*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_recording *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### service*: [`ServiceName`](#nodriver.cdp.background_service.ServiceName)*
+#### service *: [`ServiceName`](#nodriver.cdp.background_service.ServiceName)*
### *class* BackgroundServiceEventReceived(background_service_event)
Called with all existing backgroundServiceEvents when enabled, and all new
events afterwards if enabled and recording.
-#### background_service_event*: [`BackgroundServiceEvent`](#nodriver.cdp.background_service.BackgroundServiceEvent)*
+#### background_service_event *: [`BackgroundServiceEvent`](#nodriver.cdp.background_service.BackgroundServiceEvent)*
diff --git a/docs/_build/markdown/nodriver/cdp/bluetooth_emulation.md b/docs/_build/markdown/nodriver/cdp/bluetooth_emulation.md
index 079b7a4..b21d471 100644
--- a/docs/_build/markdown/nodriver/cdp/bluetooth_emulation.md
+++ b/docs/_build/markdown/nodriver/cdp/bluetooth_emulation.md
@@ -31,13 +31,13 @@ Indicates the various states of Central.
Stores the manufacturer data
-#### key*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### key *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Company identifier
[https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml](https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml)
[https://usb.org/developers](https://usb.org/developers)
-#### data*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### data *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Manufacturer-specific data (Encoded as a base64 string when passed over JSON)
@@ -45,19 +45,19 @@ Manufacturer-specific data (Encoded as a base64 string when passed over JSON)
Stores the byte data of the advertisement packet sent by a Bluetooth device.
-#### name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### uuids*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]* *= None*
+#### uuids *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]* *= None*
-#### appearance*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### appearance *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
Stores the external appearance description of the device.
-#### tx_power*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### tx_power *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
Stores the transmission power of a broadcasting device.
-#### manufacturer_data*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ManufacturerData`](#nodriver.cdp.bluetooth_emulation.ManufacturerData)]]* *= None*
+#### manufacturer_data *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ManufacturerData`](#nodriver.cdp.bluetooth_emulation.ManufacturerData)]]* *= None*
Key is the company identifier and the value is an array of bytes of
manufacturer specific data.
@@ -66,11 +66,11 @@ manufacturer specific data.
Stores the advertisement packet information that is sent by a Bluetooth device.
-#### device_address*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### device_address *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### rssi*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### rssi *: [`int`](https://docs.python.org/3/library/functions.html#int)*
-#### scan_record*: [`ScanRecord`](#nodriver.cdp.bluetooth_emulation.ScanRecord)*
+#### scan_record *: [`ScanRecord`](#nodriver.cdp.bluetooth_emulation.ScanRecord)*
## Commands
diff --git a/docs/_build/markdown/nodriver/cdp/browser.md b/docs/_build/markdown/nodriver/cdp/browser.md
index 8ec994f..72dba5e 100644
--- a/docs/_build/markdown/nodriver/cdp/browser.md
+++ b/docs/_build/markdown/nodriver/cdp/browser.md
@@ -34,23 +34,23 @@ The state of the browser window.
Browser window bounds information
-#### left*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### left *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
The offset from the left edge of the screen to the window in pixels.
-#### top*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### top *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
The offset from the top edge of the screen to the window in pixels.
-#### width*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### width *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
The window width in pixels.
-#### height*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### height *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
The window height in pixels.
-#### window_state*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`WindowState`](#nodriver.cdp.browser.WindowState)]* *= None*
+#### window_state *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`WindowState`](#nodriver.cdp.browser.WindowState)]* *= None*
The window state. Default to normal.
@@ -129,32 +129,32 @@ The window state. Default to normal.
Definition of PermissionDescriptor defined in the Permissions API:
[https://w3c.github.io/permissions/#dom-permissiondescriptor](https://w3c.github.io/permissions/#dom-permissiondescriptor).
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Name of permission.
See [https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl](https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl) for valid permission names.
-#### sysex*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### sysex *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
For “midi” permission, may also specify sysex control.
-#### user_visible_only*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### user_visible_only *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
For “push” permission, may specify userVisibleOnly.
Note that userVisibleOnly = true is the only currently supported type.
-#### allow_without_sanitization*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### allow_without_sanitization *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
For “clipboard” permission, may specify allowWithoutSanitization.
-#### allow_without_gesture*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### allow_without_gesture *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
true.
* **Type:**
For “fullscreen” permission, must specify allowWithoutGesture
-#### pan_tilt_zoom*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### pan_tilt_zoom *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
For “camera” permission, may specify panTiltZoom.
@@ -170,15 +170,15 @@ Browser command ids used by executeBrowserCommand.
Chrome histogram bucket.
-#### low*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### low *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Minimum value (inclusive).
-#### high*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### high *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Maximum value (exclusive).
-#### count*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### count *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Number of samples.
@@ -186,19 +186,19 @@ Number of samples.
Chrome histogram.
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Name.
-#### sum_*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### sum_ *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Sum of sample values.
-#### count*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### count *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Total number of samples.
-#### buckets*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Bucket`](#nodriver.cdp.browser.Bucket)]*
+#### buckets *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Bucket`](#nodriver.cdp.browser.Bucket)]*
Buckets.
@@ -231,7 +231,7 @@ Cancel a download if in progress
* **Parameters:**
* **guid** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Global unique identifier of the download.
- * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to perform the action in. When omitted, default browser context is used.
+ * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to perform the action in. When omitted, default browser context is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -291,7 +291,7 @@ Get a Chrome histogram by name.
* **Parameters:**
* **name** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Requested histogram name.
- * **delta** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, retrieve delta since last delta call.
+ * **delta** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, retrieve delta since last delta call.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Histogram`](#nodriver.cdp.browser.Histogram)]
* **Returns:**
@@ -304,8 +304,8 @@ Get Chrome histograms.
**EXPERIMENTAL**
* **Parameters:**
- * **query** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.
- * **delta** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, retrieve delta since last delta call.
+ * **query** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.
+ * **delta** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, retrieve delta since last delta call.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Histogram`](#nodriver.cdp.browser.Histogram)]]
* **Returns:**
@@ -345,7 +345,7 @@ Get the browser window that contains the devtools target.
**EXPERIMENTAL**
* **Parameters:**
- **target_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TargetID`](target.md#nodriver.cdp.target.TargetID)]) – *(Optional)* Devtools agent host id. If called as a part of the session, associated targetId is used.
+ **target_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TargetID`](target.md#nodriver.cdp.target.TargetID)]) – *(Optional)* Devtools agent host id. If called as a part of the session, associated targetId is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Tuple`](https://docs.python.org/3/library/typing.html#typing.Tuple)[[`WindowID`](#nodriver.cdp.browser.WindowID), [`Bounds`](#nodriver.cdp.browser.Bounds)]]
* **Returns:**
@@ -361,8 +361,8 @@ Grant specific permissions to the given origin and reject all others.
* **Parameters:**
* **permissions** ([`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`PermissionType`](#nodriver.cdp.browser.PermissionType)]) –
- * **origin** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Origin the permission applies to, all origins if not specified.
- * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to override permissions. When omitted, default browser context is used.
+ * **origin** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Origin the permission applies to, all origins if not specified.
+ * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to override permissions. When omitted, default browser context is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -371,7 +371,7 @@ Grant specific permissions to the given origin and reject all others.
Reset all permission management for all origins.
* **Parameters:**
- **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to reset permissions. When omitted, default browser context is used.
+ **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to reset permissions. When omitted, default browser context is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -382,8 +382,8 @@ Set dock tile details, platform-specific.
**EXPERIMENTAL**
* **Parameters:**
- * **badge_label** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)*
- * **image** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Png encoded image. (Encoded as a base64 string when passed over JSON)
+ * **badge_label** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)*
+ * **image** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Png encoded image. (Encoded as a base64 string when passed over JSON)
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -395,9 +395,9 @@ Set the behavior when downloading a file.
* **Parameters:**
* **behavior** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). `allowAndName` allows download and names files according to their download guids.
- * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to set download behavior. When omitted, default browser context is used.
- * **download_path** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The default path to save downloaded files to. This is required if behavior is set to ‘allow’ or ‘allowAndName’.
- * **events_enabled** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to emit download events (defaults to false).
+ * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* BrowserContext to set download behavior. When omitted, default browser context is used.
+ * **download_path** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The default path to save downloaded files to. This is required if behavior is set to ‘allow’ or ‘allowAndName’.
+ * **events_enabled** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to emit download events (defaults to false).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -410,8 +410,8 @@ Set permission settings for given origin.
* **Parameters:**
* **permission** ([`PermissionDescriptor`](#nodriver.cdp.browser.PermissionDescriptor)) – Descriptor of permission to override.
* **setting** ([`PermissionSetting`](#nodriver.cdp.browser.PermissionSetting)) – Setting of the permission.
- * **origin** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Origin the permission applies to, all origins if not specified.
- * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Context to override. When omitted, default browser context is used.
+ * **origin** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Origin the permission applies to, all origins if not specified.
+ * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Context to override. When omitted, default browser context is used.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -439,19 +439,19 @@ you use the event’s attributes.
Fired when page is about to start a download.
-#### frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
Id of the frame that caused the download to begin.
-#### guid*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### guid *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Global unique identifier of the download.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL of the resource being downloaded.
-#### suggested_filename*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### suggested_filename *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Suggested file name of the resource (the actual name of the file saved on disk may differ).
@@ -461,18 +461,18 @@ Suggested file name of the resource (the actual name of the file saved on disk m
Fired when download makes progress. Last call has `done` == true.
-#### guid*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### guid *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Global unique identifier of the download.
-#### total_bytes*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### total_bytes *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Total expected bytes to download.
-#### received_bytes*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### received_bytes *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Total bytes received.
-#### state*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### state *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Download status.
diff --git a/docs/_build/markdown/nodriver/cdp/cache_storage.md b/docs/_build/markdown/nodriver/cdp/cache_storage.md
index f63dce9..e6abca8 100644
--- a/docs/_build/markdown/nodriver/cdp/cache_storage.md
+++ b/docs/_build/markdown/nodriver/cdp/cache_storage.md
@@ -38,35 +38,35 @@ type of HTTP response cached
Data entry.
-#### request_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### request_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Request URL.
-#### request_method*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### request_method *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Request method.
-#### request_headers*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Header`](#nodriver.cdp.cache_storage.Header)]*
+#### request_headers *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Header`](#nodriver.cdp.cache_storage.Header)]*
Request headers
-#### response_time*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### response_time *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Number of seconds since epoch.
-#### response_status*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### response_status *: [`int`](https://docs.python.org/3/library/functions.html#int)*
HTTP response status code.
-#### response_status_text*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### response_status_text *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
HTTP response status text.
-#### response_type*: [`CachedResponseType`](#nodriver.cdp.cache_storage.CachedResponseType)*
+#### response_type *: [`CachedResponseType`](#nodriver.cdp.cache_storage.CachedResponseType)*
HTTP response type
-#### response_headers*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Header`](#nodriver.cdp.cache_storage.Header)]*
+#### response_headers *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Header`](#nodriver.cdp.cache_storage.Header)]*
Response headers
@@ -74,37 +74,37 @@ Response headers
Cache identifier.
-#### cache_id*: [`CacheId`](#nodriver.cdp.cache_storage.CacheId)*
+#### cache_id *: [`CacheId`](#nodriver.cdp.cache_storage.CacheId)*
An opaque unique id of the cache.
-#### security_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### security_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Security origin of the cache.
-#### storage_key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### storage_key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Storage key of the cache.
-#### cache_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### cache_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The name of the cache.
-#### storage_bucket*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StorageBucket`](storage.md#nodriver.cdp.storage.StorageBucket)]* *= None*
+#### storage_bucket *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StorageBucket`](storage.md#nodriver.cdp.storage.StorageBucket)]* *= None*
Storage bucket of the cache.
### *class* Header(name, value)
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### value*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### value *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* CachedResponse(body)
Cached response
-#### body*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### body *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Entry content, base64-encoded. (Encoded as a base64 string when passed over JSON)
@@ -143,9 +143,9 @@ Deletes a cache entry.
Requests cache names.
* **Parameters:**
- * **security_origin** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* At least and at most one of securityOrigin, storageKey, storageBucket must be specified. Security origin.
- * **storage_key** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Storage key.
- * **storage_bucket** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StorageBucket`](storage.md#nodriver.cdp.storage.StorageBucket)]) – *(Optional)* Storage bucket. If not specified, it uses the default bucket.
+ * **security_origin** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* At least and at most one of securityOrigin, storageKey, storageBucket must be specified. Security origin.
+ * **storage_key** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Storage key.
+ * **storage_bucket** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StorageBucket`](storage.md#nodriver.cdp.storage.StorageBucket)]) – *(Optional)* Storage bucket. If not specified, it uses the default bucket.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Cache`](#nodriver.cdp.cache_storage.Cache)]]
* **Returns:**
@@ -170,9 +170,9 @@ Requests data from cache.
* **Parameters:**
* **cache_id** ([`CacheId`](#nodriver.cdp.cache_storage.CacheId)) – ID of cache to get entries from.
- * **skip_count** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Number of records to skip.
- * **page_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Number of records to fetch.
- * **path_filter** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If present, only return the entries containing this substring in the path
+ * **skip_count** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Number of records to skip.
+ * **page_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Number of records to fetch.
+ * **path_filter** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If present, only return the entries containing this substring in the path
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Tuple`](https://docs.python.org/3/library/typing.html#typing.Tuple)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`DataEntry`](#nodriver.cdp.cache_storage.DataEntry)], [`float`](https://docs.python.org/3/library/functions.html#float)]]
* **Returns:**
diff --git a/docs/_build/markdown/nodriver/cdp/cast.md b/docs/_build/markdown/nodriver/cdp/cast.md
index b2834ae..ec9bfbc 100644
--- a/docs/_build/markdown/nodriver/cdp/cast.md
+++ b/docs/_build/markdown/nodriver/cdp/cast.md
@@ -19,11 +19,11 @@ arguments to other commands.
### *class* Sink(name, id_, session=None)
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### id_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### id_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### session*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### session *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Text describing the current session. Present only if there is an active
session on the sink.
@@ -55,7 +55,7 @@ Also starts observing for issue messages. When an issue is added or removed,
an `issueUpdated` event is fired.
* **Parameters:**
- **presentation_url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)*
+ **presentation_url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)*
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -107,11 +107,11 @@ you use the event’s attributes.
This is fired whenever the list of available sinks changes. A sink is a
device or a software surface that you can cast to.
-#### sinks*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Sink`](#nodriver.cdp.cast.Sink)]*
+#### sinks *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Sink`](#nodriver.cdp.cast.Sink)]*
### *class* IssueUpdated(issue_message)
This is fired whenever the outstanding issue/error message changes.
`issueMessage` is empty if there is no issue.
-#### issue_message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### issue_message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
diff --git a/docs/_build/markdown/nodriver/cdp/console.md b/docs/_build/markdown/nodriver/cdp/console.md
index 7bfbf2c..126e8b6 100644
--- a/docs/_build/markdown/nodriver/cdp/console.md
+++ b/docs/_build/markdown/nodriver/cdp/console.md
@@ -18,27 +18,27 @@ arguments to other commands.
Console message.
-#### source*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### source *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message source.
-#### level*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### level *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message severity.
-#### text*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### text *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message text.
-#### url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
URL of the message origin.
-#### line*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### line *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
Line number in the resource that generated this message (1-based).
-#### column*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### column *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
Column number in the resource that generated this message (1-based).
@@ -85,6 +85,6 @@ you use the event’s attributes.
Issued when new console message is added.
-#### message*: [`ConsoleMessage`](#nodriver.cdp.console.ConsoleMessage)*
+#### message *: [`ConsoleMessage`](#nodriver.cdp.console.ConsoleMessage)*
Console message that has been added.
diff --git a/docs/_build/markdown/nodriver/cdp/css.md b/docs/_build/markdown/nodriver/cdp/css.md
index f73fc7c..c21ad31 100644
--- a/docs/_build/markdown/nodriver/cdp/css.md
+++ b/docs/_build/markdown/nodriver/cdp/css.md
@@ -41,15 +41,15 @@ inspector” rules), “regular” for regular stylesheets.
CSS rule collection for a single pseudo style.
-#### pseudo_type*: [`PseudoType`](dom.md#nodriver.cdp.dom.PseudoType)*
+#### pseudo_type *: [`PseudoType`](dom.md#nodriver.cdp.dom.PseudoType)*
Pseudo element type.
-#### matches*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`RuleMatch`](#nodriver.cdp.css.RuleMatch)]*
+#### matches *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`RuleMatch`](#nodriver.cdp.css.RuleMatch)]*
Matches of CSS rules applicable to the pseudo style.
-#### pseudo_identifier*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### pseudo_identifier *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Pseudo element custom ident.
@@ -57,11 +57,11 @@ Pseudo element custom ident.
Inherited CSS rule collection from ancestor node.
-#### matched_css_rules*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`RuleMatch`](#nodriver.cdp.css.RuleMatch)]*
+#### matched_css_rules *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`RuleMatch`](#nodriver.cdp.css.RuleMatch)]*
Matches of CSS rules matching the ancestor node in the style inheritance chain.
-#### inline_style*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CSSStyle`](#nodriver.cdp.css.CSSStyle)]* *= None*
+#### inline_style *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CSSStyle`](#nodriver.cdp.css.CSSStyle)]* *= None*
The ancestor node’s inline style, if any, in the style inheritance chain.
@@ -69,7 +69,7 @@ The ancestor node’s inline style, if any, in the style inheritance chain.
Inherited pseudo element matches from pseudos of an ancestor node.
-#### pseudo_elements*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`PseudoElementMatches`](#nodriver.cdp.css.PseudoElementMatches)]*
+#### pseudo_elements *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`PseudoElementMatches`](#nodriver.cdp.css.PseudoElementMatches)]*
Matches of pseudo styles from the pseudos of an ancestor node.
@@ -77,11 +77,11 @@ Matches of pseudo styles from the pseudos of an ancestor node.
Match data for a CSS rule.
-#### rule*: [`CSSRule`](#nodriver.cdp.css.CSSRule)*
+#### rule *: [`CSSRule`](#nodriver.cdp.css.CSSRule)*
CSS rule in the match.
-#### matching_selectors*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
+#### matching_selectors *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
Matching selector indices in the rule’s selectorList selectors (0-based).
@@ -89,15 +89,15 @@ Matching selector indices in the rule’s selectorList selectors (0-based).
Data for a simple selector (these are delimited by commas in a selector list).
-#### text*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### text *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Value text.
-#### range_*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceRange`](#nodriver.cdp.css.SourceRange)]* *= None*
+#### range_ *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SourceRange`](#nodriver.cdp.css.SourceRange)]* *= None*
Value range in the underlying resource (if available).
-#### specificity*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Specificity`](#nodriver.cdp.css.Specificity)]* *= None*
+#### specificity *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Specificity`](#nodriver.cdp.css.Specificity)]* *= None*
Specificity of the selector.
@@ -106,16 +106,16 @@ Specificity of the selector.
Specificity:
[https://drafts.csswg.org/selectors/#specificity-rules](https://drafts.csswg.org/selectors/#specificity-rules)
-#### a*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### a *: [`int`](https://docs.python.org/3/library/functions.html#int)*
The a component, which represents the number of ID selectors.
-#### b*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### b *: [`int`](https://docs.python.org/3/library/functions.html#int)*
The b component, which represents the number of class selectors, attributes selectors, and
pseudo-classes.
-#### c*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### c *: [`int`](https://docs.python.org/3/library/functions.html#int)*
The c component, which represents the number of type selectors and pseudo-elements.
@@ -123,11 +123,11 @@ The c component, which represents the number of type selectors and pseudo-elemen
Selector list data.
-#### selectors*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Value`](#nodriver.cdp.css.Value)]*
+#### selectors *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Value`](#nodriver.cdp.css.Value)]*
Selectors in the list.
-#### text*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### text *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Rule selector text.
@@ -135,82 +135,82 @@ Rule selector text.
CSS stylesheet metainformation.
-#### style_sheet_id*: [`StyleSheetId`](#nodriver.cdp.css.StyleSheetId)*
+#### style_sheet_id *: [`StyleSheetId`](#nodriver.cdp.css.StyleSheetId)*
The stylesheet identifier.
-#### frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
Owner frame identifier.
-#### source_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### source_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Stylesheet resource URL. Empty if this is a constructed stylesheet created using
new CSSStyleSheet() (but non-empty if this is a constructed stylesheet imported
as a CSS module script).
-#### origin*: [`StyleSheetOrigin`](#nodriver.cdp.css.StyleSheetOrigin)*
+#### origin *: [`StyleSheetOrigin`](#nodriver.cdp.css.StyleSheetOrigin)*
Stylesheet origin.
-#### title*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### title *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Stylesheet title.
-#### disabled*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### disabled *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Denotes whether the stylesheet is disabled.
-#### is_inline*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_inline *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
document.written STYLE tags.
-#### is_mutable*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_mutable *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether this stylesheet is mutable. Inline stylesheets become mutable
after they have been modified via CSSOM API.
``.
@@ -1334,15 +1334,15 @@ Field type for a signed exchange related error.
Information about a signed exchange response.
-#### message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Error message.
-#### signature_index*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### signature_index *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
The index of the signature which caused the error.
-#### error_field*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SignedExchangeErrorField`](#nodriver.cdp.network.SignedExchangeErrorField)]* *= None*
+#### error_field *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SignedExchangeErrorField`](#nodriver.cdp.network.SignedExchangeErrorField)]* *= None*
The field which caused the error.
@@ -1350,19 +1350,19 @@ The field which caused the error.
Information about a signed exchange response.
-#### outer_response*: [`Response`](#nodriver.cdp.network.Response)*
+#### outer_response *: [`Response`](#nodriver.cdp.network.Response)*
The outer response of signed HTTP exchange which was received from network.
-#### header*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SignedExchangeHeader`](#nodriver.cdp.network.SignedExchangeHeader)]* *= None*
+#### header *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SignedExchangeHeader`](#nodriver.cdp.network.SignedExchangeHeader)]* *= None*
Information about the signed exchange header.
-#### security_details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SecurityDetails`](#nodriver.cdp.network.SecurityDetails)]* *= None*
+#### security_details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`SecurityDetails`](#nodriver.cdp.network.SecurityDetails)]* *= None*
Security details for the signed exchange header.
-#### errors*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SignedExchangeError`](#nodriver.cdp.network.SignedExchangeError)]]* *= None*
+#### errors *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SignedExchangeError`](#nodriver.cdp.network.SignedExchangeError)]]* *= None*
Errors occurred while handling the signed exchange.
@@ -1402,7 +1402,7 @@ List of content encodings supported by the backend.
### *class* ConnectTiming(request_time)
-#### request_time*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### request_time *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Timing’s requestTime is a baseline in seconds, while the other numbers are ticks in
milliseconds relatively to this requestTime. Matches ResourceTiming’s requestTime for
@@ -1410,11 +1410,11 @@ the same request (but not for redirected requests).
### *class* ClientSecurityState(initiator_is_secure_context, initiator_ip_address_space, private_network_request_policy)
-#### initiator_is_secure_context*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### initiator_is_secure_context *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### initiator_ip_address_space*: [`IPAddressSpace`](#nodriver.cdp.network.IPAddressSpace)*
+#### initiator_ip_address_space *: [`IPAddressSpace`](#nodriver.cdp.network.IPAddressSpace)*
-#### private_network_request_policy*: [`PrivateNetworkRequestPolicy`](#nodriver.cdp.network.PrivateNetworkRequestPolicy)*
+#### private_network_request_policy *: [`PrivateNetworkRequestPolicy`](#nodriver.cdp.network.PrivateNetworkRequestPolicy)*
### *class* CrossOriginOpenerPolicyValue(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -1434,13 +1434,13 @@ the same request (but not for redirected requests).
### *class* CrossOriginOpenerPolicyStatus(value, report_only_value, reporting_endpoint=None, report_only_reporting_endpoint=None)
-#### value*: [`CrossOriginOpenerPolicyValue`](#nodriver.cdp.network.CrossOriginOpenerPolicyValue)*
+#### value *: [`CrossOriginOpenerPolicyValue`](#nodriver.cdp.network.CrossOriginOpenerPolicyValue)*
-#### report_only_value*: [`CrossOriginOpenerPolicyValue`](#nodriver.cdp.network.CrossOriginOpenerPolicyValue)*
+#### report_only_value *: [`CrossOriginOpenerPolicyValue`](#nodriver.cdp.network.CrossOriginOpenerPolicyValue)*
-#### reporting_endpoint*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### reporting_endpoint *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### report_only_reporting_endpoint*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### report_only_reporting_endpoint *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* CrossOriginEmbedderPolicyValue(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -1452,13 +1452,13 @@ the same request (but not for redirected requests).
### *class* CrossOriginEmbedderPolicyStatus(value, report_only_value, reporting_endpoint=None, report_only_reporting_endpoint=None)
-#### value*: [`CrossOriginEmbedderPolicyValue`](#nodriver.cdp.network.CrossOriginEmbedderPolicyValue)*
+#### value *: [`CrossOriginEmbedderPolicyValue`](#nodriver.cdp.network.CrossOriginEmbedderPolicyValue)*
-#### report_only_value*: [`CrossOriginEmbedderPolicyValue`](#nodriver.cdp.network.CrossOriginEmbedderPolicyValue)*
+#### report_only_value *: [`CrossOriginEmbedderPolicyValue`](#nodriver.cdp.network.CrossOriginEmbedderPolicyValue)*
-#### reporting_endpoint*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### reporting_endpoint *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### report_only_reporting_endpoint*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### report_only_reporting_endpoint *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* ContentSecurityPolicySource(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -1468,19 +1468,19 @@ the same request (but not for redirected requests).
### *class* ContentSecurityPolicyStatus(effective_directives, is_enforced, source)
-#### effective_directives*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### effective_directives *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### is_enforced*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_enforced *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### source*: [`ContentSecurityPolicySource`](#nodriver.cdp.network.ContentSecurityPolicySource)*
+#### source *: [`ContentSecurityPolicySource`](#nodriver.cdp.network.ContentSecurityPolicySource)*
### *class* SecurityIsolationStatus(coop=None, coep=None, csp=None)
-#### coop*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CrossOriginOpenerPolicyStatus`](#nodriver.cdp.network.CrossOriginOpenerPolicyStatus)]* *= None*
+#### coop *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CrossOriginOpenerPolicyStatus`](#nodriver.cdp.network.CrossOriginOpenerPolicyStatus)]* *= None*
-#### coep*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CrossOriginEmbedderPolicyStatus`](#nodriver.cdp.network.CrossOriginEmbedderPolicyStatus)]* *= None*
+#### coep *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CrossOriginEmbedderPolicyStatus`](#nodriver.cdp.network.CrossOriginEmbedderPolicyStatus)]* *= None*
-#### csp*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ContentSecurityPolicyStatus`](#nodriver.cdp.network.ContentSecurityPolicyStatus)]]* *= None*
+#### csp *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ContentSecurityPolicyStatus`](#nodriver.cdp.network.ContentSecurityPolicyStatus)]]* *= None*
### *class* ReportStatus(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -1500,43 +1500,43 @@ The status of a Reporting API report.
An object representing a report generated by the Reporting API.
-#### id_*: [`ReportId`](#nodriver.cdp.network.ReportId)*
+#### id_ *: [`ReportId`](#nodriver.cdp.network.ReportId)*
-#### initiator_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### initiator_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The URL of the document that triggered the report.
-#### destination*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### destination *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The name of the endpoint group that should be used to deliver the report.
-#### type_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### type_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The type of the report (specifies the set of data that is contained in the report body).
-#### timestamp*: [`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)*
+#### timestamp *: [`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)*
When the report was generated.
-#### depth*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### depth *: [`int`](https://docs.python.org/3/library/functions.html#int)*
How many uploads deep the related request was.
-#### completed_attempts*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### completed_attempts *: [`int`](https://docs.python.org/3/library/functions.html#int)*
The number of delivery attempts made so far, not including an active attempt.
-#### body*: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict)*
+#### body *: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict)*
-#### status*: [`ReportStatus`](#nodriver.cdp.network.ReportStatus)*
+#### status *: [`ReportStatus`](#nodriver.cdp.network.ReportStatus)*
### *class* ReportingApiEndpoint(url, group_name)
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The URL of the endpoint to which reports may be delivered.
-#### group_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### group_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Name of the endpoint group.
@@ -1544,21 +1544,21 @@ Name of the endpoint group.
An object providing the result of a network resource load.
-#### success*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### success *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### net_error*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### net_error *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
Optional values used for error reporting.
-#### net_error_name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### net_error_name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### http_status_code*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### http_status_code *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
-#### stream*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamHandle`](io.md#nodriver.cdp.io.StreamHandle)]* *= None*
+#### stream *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamHandle`](io.md#nodriver.cdp.io.StreamHandle)]* *= None*
If successful, one of the following two fields holds the result.
-#### headers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Headers`](#nodriver.cdp.network.Headers)]* *= None*
+#### headers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Headers`](#nodriver.cdp.network.Headers)]* *= None*
Response headers.
@@ -1567,9 +1567,9 @@ Response headers.
An options object that may be extended later to better support CORS,
CORB and streaming.
-#### disable_cache*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### disable_cache *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### include_credentials*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### include_credentials *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
## Commands
@@ -1665,13 +1665,13 @@ Deprecated since version 1.3.
* **Parameters:**
* **interception_id** ([`InterceptionId`](#nodriver.cdp.network.InterceptionId)) –
- * **error_reason** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ErrorReason`](#nodriver.cdp.network.ErrorReason)]) – *(Optional)* If set this causes the request to fail with the given reason. Passing ``Aborted``` for requests marked with ```isNavigationRequest`` also cancels the navigation. Must not be set in response to an authChallenge.
- * **raw_response** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set the requests completes using with the provided base64 encoded raw response, including HTTP status line and headers etc… Must not be set in response to an authChallenge. (Encoded as a base64 string when passed over JSON)
- * **url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set the request url will be modified in a way that’s not observable by page. Must not be set in response to an authChallenge.
- * **method** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set this allows the request method to be overridden. Must not be set in response to an authChallenge.
- * **post_data** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set this allows postData to be set. Must not be set in response to an authChallenge.
- * **headers** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Headers`](#nodriver.cdp.network.Headers)]) – *(Optional)* If set this allows the request headers to be changed. Must not be set in response to an authChallenge.
- * **auth_challenge_response** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AuthChallengeResponse`](#nodriver.cdp.network.AuthChallengeResponse)]) – *(Optional)* Response to a requestIntercepted with an authChallenge. Must not be set otherwise.
+ * **error_reason** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ErrorReason`](#nodriver.cdp.network.ErrorReason)]) – *(Optional)* If set this causes the request to fail with the given reason. Passing ``Aborted``` for requests marked with ```isNavigationRequest`` also cancels the navigation. Must not be set in response to an authChallenge.
+ * **raw_response** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set the requests completes using with the provided base64 encoded raw response, including HTTP status line and headers etc… Must not be set in response to an authChallenge. (Encoded as a base64 string when passed over JSON)
+ * **url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set the request url will be modified in a way that’s not observable by page. Must not be set in response to an authChallenge.
+ * **method** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set this allows the request method to be overridden. Must not be set in response to an authChallenge.
+ * **post_data** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If set this allows postData to be set. Must not be set in response to an authChallenge.
+ * **headers** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Headers`](#nodriver.cdp.network.Headers)]) – *(Optional)* If set this allows the request headers to be changed. Must not be set in response to an authChallenge.
+ * **auth_challenge_response** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AuthChallengeResponse`](#nodriver.cdp.network.AuthChallengeResponse)]) – *(Optional)* Response to a requestIntercepted with an authChallenge. Must not be set otherwise.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -1684,10 +1684,10 @@ Deletes browser cookies with matching name and url or domain/path/partitionKey p
* **Parameters:**
* **name** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Name of the cookies to remove.
- * **url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If specified, deletes all the cookies with the given name where domain and path match provided URL.
- * **domain** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If specified, deletes only cookies with the exact domain.
- * **path** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If specified, deletes only cookies with the exact path.
- * **partition_key** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePartitionKey`](#nodriver.cdp.network.CookiePartitionKey)]) – **(EXPERIMENTAL)** *(Optional)* If specified, deletes only cookies with the the given name and partitionKey where all partition key attributes match the cookie partition key attribute.
+ * **url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If specified, deletes all the cookies with the given name where domain and path match provided URL.
+ * **domain** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If specified, deletes only cookies with the exact domain.
+ * **path** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* If specified, deletes only cookies with the exact path.
+ * **partition_key** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePartitionKey`](#nodriver.cdp.network.CookiePartitionKey)]) – **(EXPERIMENTAL)** *(Optional)* If specified, deletes only cookies with the the given name and partitionKey where all partition key attributes match the cookie partition key attribute.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -1707,10 +1707,10 @@ Activates emulation of network conditions.
* **latency** ([`float`](https://docs.python.org/3/library/functions.html#float)) – Minimum latency from request sent to response headers received (ms).
* **download_throughput** ([`float`](https://docs.python.org/3/library/functions.html#float)) – Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
* **upload_throughput** ([`float`](https://docs.python.org/3/library/functions.html#float)) – Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
- * **connection_type** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ConnectionType`](#nodriver.cdp.network.ConnectionType)]) – *(Optional)* Connection type if known.
- * **packet_loss** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – **(EXPERIMENTAL)** *(Optional)* WebRTC packet loss (percent, 0-100). 0 disables packet loss emulation, 100 drops all the packets.
- * **packet_queue_length** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* WebRTC packet queue length (packet). 0 removes any queue length limitations.
- * **packet_reordering** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* WebRTC packetReordering feature.
+ * **connection_type** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ConnectionType`](#nodriver.cdp.network.ConnectionType)]) – *(Optional)* Connection type if known.
+ * **packet_loss** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – **(EXPERIMENTAL)** *(Optional)* WebRTC packet loss (percent, 0-100). 0 disables packet loss emulation, 100 drops all the packets.
+ * **packet_queue_length** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* WebRTC packet queue length (packet). 0 removes any queue length limitations.
+ * **packet_reordering** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* WebRTC packetReordering feature.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -1719,9 +1719,9 @@ Activates emulation of network conditions.
Enables network tracking, network events will now be delivered to the client.
* **Parameters:**
- * **max_total_buffer_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* Buffer size in bytes to use when preserving network payloads (XHRs, etc).
- * **max_resource_buffer_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).
- * **max_post_data_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Longest post body size (in bytes) that would be included in requestWillBeSent notification
+ * **max_total_buffer_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* Buffer size in bytes to use when preserving network payloads (XHRs, etc).
+ * **max_resource_buffer_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).
+ * **max_post_data_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Longest post body size (in bytes) that would be included in requestWillBeSent notification
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -1772,7 +1772,7 @@ Returns all browser cookies for the current URL. Depending on the backend suppor
detailed cookie information in the `cookies` field.
* **Parameters:**
- **urls** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]) – *(Optional)* The list of URLs for which applicable cookies will be fetched. If not specified, it’s assumed to be set to the list containing the URLs of the page and all of its subframes.
+ **urls** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]) – *(Optional)* The list of URLs for which applicable cookies will be fetched. If not specified, it’s assumed to be set to the list containing the URLs of the page and all of its subframes.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Cookie`](#nodriver.cdp.network.Cookie)]]
* **Returns:**
@@ -1824,7 +1824,7 @@ Returns information about the COEP/COOP isolation status.
**EXPERIMENTAL**
* **Parameters:**
- **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* If no frameId is provided, the status of the target is provided.
+ **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* If no frameId is provided, the status of the target is provided.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`SecurityIsolationStatus`](#nodriver.cdp.network.SecurityIsolationStatus)]
* **Returns:**
@@ -1836,7 +1836,7 @@ Fetches the resource and returns the content.
**EXPERIMENTAL**
* **Parameters:**
- * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* Frame id to get the resource for. Mandatory for frame targets, and should be omitted for worker targets.
+ * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]) – *(Optional)* Frame id to get the resource for. Mandatory for frame targets, and should be omitted for worker targets.
* **url** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – URL of the resource to get content for.
* **options** ([`LoadNetworkResourceOptions`](#nodriver.cdp.network.LoadNetworkResourceOptions)) – Options for the request.
* **Return type:**
@@ -1865,8 +1865,8 @@ Searches for given string in response content.
* **Parameters:**
* **request_id** ([`RequestId`](#nodriver.cdp.network.RequestId)) – Identifier of the network response to search.
* **query** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – String to search for.
- * **case_sensitive** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, search is case sensitive.
- * **is_regex** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, treats string parameter as regex.
+ * **case_sensitive** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, search is case sensitive.
+ * **is_regex** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, treats string parameter as regex.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SearchMatch`](debugger.md#nodriver.cdp.debugger.SearchMatch)]]
* **Returns:**
@@ -1930,18 +1930,18 @@ Sets a cookie with the given cookie data; may overwrite equivalent cookies if th
* **Parameters:**
* **name** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Cookie name.
* **value** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Cookie value.
- * **url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
- * **domain** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Cookie domain.
- * **path** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Cookie path.
- * **secure** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* True if cookie is secure.
- * **http_only** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* True if cookie is http-only.
- * **same_site** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieSameSite`](#nodriver.cdp.network.CookieSameSite)]) – *(Optional)* Cookie SameSite type.
- * **expires** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)]) – *(Optional)* Cookie expiration date, session cookie if not set
- * **priority** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePriority`](#nodriver.cdp.network.CookiePriority)]) – **(EXPERIMENTAL)** *(Optional)* Cookie Priority type.
- * **same_party** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* True if cookie is SameParty.
- * **source_scheme** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieSourceScheme`](#nodriver.cdp.network.CookieSourceScheme)]) – **(EXPERIMENTAL)** *(Optional)* Cookie source scheme type.
- * **source_port** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.
- * **partition_key** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePartitionKey`](#nodriver.cdp.network.CookiePartitionKey)]) – **(EXPERIMENTAL)** *(Optional)* Cookie partition key. If not set, the cookie will be set as not partitioned.
+ * **url** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
+ * **domain** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Cookie domain.
+ * **path** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Cookie path.
+ * **secure** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* True if cookie is secure.
+ * **http_only** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* True if cookie is http-only.
+ * **same_site** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieSameSite`](#nodriver.cdp.network.CookieSameSite)]) – *(Optional)* Cookie SameSite type.
+ * **expires** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)]) – *(Optional)* Cookie expiration date, session cookie if not set
+ * **priority** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePriority`](#nodriver.cdp.network.CookiePriority)]) – **(EXPERIMENTAL)** *(Optional)* Cookie Priority type.
+ * **same_party** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* True if cookie is SameParty.
+ * **source_scheme** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookieSourceScheme`](#nodriver.cdp.network.CookieSourceScheme)]) – **(EXPERIMENTAL)** *(Optional)* Cookie source scheme type.
+ * **source_port** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – **(EXPERIMENTAL)** *(Optional)* Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.
+ * **partition_key** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePartitionKey`](#nodriver.cdp.network.CookiePartitionKey)]) – **(EXPERIMENTAL)** *(Optional)* Cookie partition key. If not set, the cookie will be set as not partitioned.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`bool`](https://docs.python.org/3/library/functions.html#bool)]
* **Returns:**
@@ -1989,9 +1989,9 @@ Allows overriding user agent with the given string.
* **Parameters:**
* **user_agent** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – User agent to use.
- * **accept_language** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Browser language to emulate.
- * **platform** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The platform navigator.platform should return.
- * **user_agent_metadata** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UserAgentMetadata`](emulation.md#nodriver.cdp.emulation.UserAgentMetadata)]) – **(EXPERIMENTAL)** *(Optional)* To be sent in Sec-CH-UA-\* headers and returned in navigator.userAgentData
+ * **accept_language** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Browser language to emulate.
+ * **platform** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The platform navigator.platform should return.
+ * **user_agent_metadata** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UserAgentMetadata`](emulation.md#nodriver.cdp.emulation.UserAgentMetadata)]) – **(EXPERIMENTAL)** *(Optional)* To be sent in Sec-CH-UA-\* headers and returned in navigator.userAgentData
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -2034,23 +2034,23 @@ you use the event’s attributes.
Fired when data chunk was received over the network.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### data_length*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### data_length *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Data chunk length.
-#### encoded_data_length*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### encoded_data_length *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Actual bytes received (might be less than dataLength for compressed encodings).
-#### data*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### data *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
Data that was received. (Encoded as a base64 string when passed over JSON)
@@ -2058,23 +2058,23 @@ Data that was received. (Encoded as a base64 string when passed over JSON)
Fired when EventSource message is received.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### event_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### event_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message type.
-#### event_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### event_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message identifier.
-#### data*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### data *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message content.
@@ -2082,19 +2082,19 @@ Message content.
Fired when HTTP request has failed to load.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### type_*: [`ResourceType`](#nodriver.cdp.network.ResourceType)*
+#### type_ *: [`ResourceType`](#nodriver.cdp.network.ResourceType)*
Resource type.
-#### error_text*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### error_text *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
//cs.chromium.org/chromium/src/net/base/net_error_list.h
@@ -2103,15 +2103,15 @@ Resource type.
* **Type:**
https
-#### canceled*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
+#### canceled *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
True if loading was canceled.
-#### blocked_reason*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BlockedReason`](#nodriver.cdp.network.BlockedReason)]*
+#### blocked_reason *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BlockedReason`](#nodriver.cdp.network.BlockedReason)]*
The reason why loading was blocked, if any.
-#### cors_error_status*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CorsErrorStatus`](#nodriver.cdp.network.CorsErrorStatus)]*
+#### cors_error_status *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CorsErrorStatus`](#nodriver.cdp.network.CorsErrorStatus)]*
The reason why loading was blocked by CORS, if any.
@@ -2119,15 +2119,15 @@ The reason why loading was blocked by CORS, if any.
Fired when HTTP request has finished loading.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### encoded_data_length*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### encoded_data_length *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Total number of bytes received for this request.
@@ -2142,56 +2142,56 @@ Deprecated, use Fetch.requestPaused instead.
#### Deprecated
Deprecated since version 1.3.
-#### interception_id*: [`InterceptionId`](#nodriver.cdp.network.InterceptionId)*
+#### interception_id *: [`InterceptionId`](#nodriver.cdp.network.InterceptionId)*
Each request the page makes will have a unique id, however if any redirects are encountered
while processing that fetch, they will be reported with the same id as the original fetch.
Likewise if HTTP authentication is needed then the same fetch id will be used.
-#### request*: [`Request`](#nodriver.cdp.network.Request)*
+#### request *: [`Request`](#nodriver.cdp.network.Request)*
-#### frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
The id of the frame that initiated the request.
-#### resource_type*: [`ResourceType`](#nodriver.cdp.network.ResourceType)*
+#### resource_type *: [`ResourceType`](#nodriver.cdp.network.ResourceType)*
How the requested resource will be used.
-#### is_navigation_request*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_navigation_request *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether this is a navigation request, which can abort the navigation completely.
-#### is_download*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
+#### is_download *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
Set if the request is a navigation that will result in a download.
Only present after response is received from the server (i.e. HeadersReceived stage).
-#### redirect_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### redirect_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
Redirect location, only sent if a redirect was intercepted.
-#### auth_challenge*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AuthChallenge`](#nodriver.cdp.network.AuthChallenge)]*
+#### auth_challenge *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AuthChallenge`](#nodriver.cdp.network.AuthChallenge)]*
Details of the Authorization Challenge encountered. If this is set then
continueInterceptedRequest must contain an authChallengeResponse.
-#### response_error_reason*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ErrorReason`](#nodriver.cdp.network.ErrorReason)]*
+#### response_error_reason *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ErrorReason`](#nodriver.cdp.network.ErrorReason)]*
Response error if intercepted at response stage or if redirect occurred while intercepting
request.
-#### response_status_code*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
+#### response_status_code *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
Response code if intercepted at response stage or if redirect occurred while intercepting
request or auth retry occurred.
-#### response_headers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Headers`](#nodriver.cdp.network.Headers)]*
+#### response_headers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Headers`](#nodriver.cdp.network.Headers)]*
Response headers if intercepted at the response stage or if redirect occurred while
intercepting request or auth retry occurred.
-#### request_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](#nodriver.cdp.network.RequestId)]*
+#### request_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](#nodriver.cdp.network.RequestId)]*
If the intercepted request had a corresponding requestWillBeSent event fired for it, then
this requestId will be the same as the requestId present in the requestWillBeSent event.
@@ -2200,7 +2200,7 @@ this requestId will be the same as the requestId present in the requestWillBeSen
Fired if request ended up loading from cache.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
@@ -2208,53 +2208,53 @@ Request identifier.
Fired when page is about to send HTTP request.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### loader_id*: [`LoaderId`](#nodriver.cdp.network.LoaderId)*
+#### loader_id *: [`LoaderId`](#nodriver.cdp.network.LoaderId)*
Loader identifier. Empty string if the request is fetched from worker.
-#### document_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### document_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL of the document this request is loaded for.
-#### request*: [`Request`](#nodriver.cdp.network.Request)*
+#### request *: [`Request`](#nodriver.cdp.network.Request)*
Request data.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### wall_time*: [`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)*
+#### wall_time *: [`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)*
Timestamp.
-#### initiator*: [`Initiator`](#nodriver.cdp.network.Initiator)*
+#### initiator *: [`Initiator`](#nodriver.cdp.network.Initiator)*
Request initiator.
-#### redirect_has_extra_info*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### redirect_has_extra_info *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
In the case that redirectResponse is populated, this flag indicates whether
requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
for the request which was just redirected.
-#### redirect_response*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Response`](#nodriver.cdp.network.Response)]*
+#### redirect_response *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Response`](#nodriver.cdp.network.Response)]*
Redirect response data.
-#### type_*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ResourceType`](#nodriver.cdp.network.ResourceType)]*
+#### type_ *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ResourceType`](#nodriver.cdp.network.ResourceType)]*
Type of this resource.
-#### frame_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]*
+#### frame_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]*
Frame identifier.
-#### has_user_gesture*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
+#### has_user_gesture *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
Whether the request is initiated by a user gesture. Defaults to false.
@@ -2264,15 +2264,15 @@ Whether the request is initiated by a user gesture. Defaults to false.
Fired when resource loading priority is changed
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### new_priority*: [`ResourcePriority`](#nodriver.cdp.network.ResourcePriority)*
+#### new_priority *: [`ResourcePriority`](#nodriver.cdp.network.ResourcePriority)*
New priority
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
@@ -2282,11 +2282,11 @@ Timestamp.
Fired when a signed exchange was received over the network
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### info*: [`SignedExchangeInfo`](#nodriver.cdp.network.SignedExchangeInfo)*
+#### info *: [`SignedExchangeInfo`](#nodriver.cdp.network.SignedExchangeInfo)*
Information about the signed exchange response.
@@ -2294,32 +2294,32 @@ Information about the signed exchange response.
Fired when HTTP response is available.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### loader_id*: [`LoaderId`](#nodriver.cdp.network.LoaderId)*
+#### loader_id *: [`LoaderId`](#nodriver.cdp.network.LoaderId)*
Loader identifier. Empty string if the request is fetched from worker.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### type_*: [`ResourceType`](#nodriver.cdp.network.ResourceType)*
+#### type_ *: [`ResourceType`](#nodriver.cdp.network.ResourceType)*
Resource type.
-#### response*: [`Response`](#nodriver.cdp.network.Response)*
+#### response *: [`Response`](#nodriver.cdp.network.Response)*
Response data.
-#### has_extra_info*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### has_extra_info *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
or were emitted for this request.
-#### frame_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]*
+#### frame_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](page.md#nodriver.cdp.page.FrameId)]*
Frame identifier.
@@ -2327,11 +2327,11 @@ Frame identifier.
Fired when WebSocket is closed.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
@@ -2339,15 +2339,15 @@ Timestamp.
Fired upon WebSocket creation.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
WebSocket request URL.
-#### initiator*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Initiator`](#nodriver.cdp.network.Initiator)]*
+#### initiator *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Initiator`](#nodriver.cdp.network.Initiator)]*
Request initiator.
@@ -2355,15 +2355,15 @@ Request initiator.
Fired when WebSocket message error occurs.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### error_message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### error_message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
WebSocket error message.
@@ -2371,15 +2371,15 @@ WebSocket error message.
Fired when WebSocket message is received.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### response*: [`WebSocketFrame`](#nodriver.cdp.network.WebSocketFrame)*
+#### response *: [`WebSocketFrame`](#nodriver.cdp.network.WebSocketFrame)*
WebSocket response data.
@@ -2387,15 +2387,15 @@ WebSocket response data.
Fired when WebSocket message is sent.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### response*: [`WebSocketFrame`](#nodriver.cdp.network.WebSocketFrame)*
+#### response *: [`WebSocketFrame`](#nodriver.cdp.network.WebSocketFrame)*
WebSocket response data.
@@ -2403,15 +2403,15 @@ WebSocket response data.
Fired when WebSocket handshake response becomes available.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### response*: [`WebSocketResponse`](#nodriver.cdp.network.WebSocketResponse)*
+#### response *: [`WebSocketResponse`](#nodriver.cdp.network.WebSocketResponse)*
WebSocket response data.
@@ -2419,19 +2419,19 @@ WebSocket response data.
Fired when WebSocket is about to initiate handshake.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### wall_time*: [`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)*
+#### wall_time *: [`TimeSinceEpoch`](#nodriver.cdp.network.TimeSinceEpoch)*
UTC Timestamp.
-#### request*: [`WebSocketRequest`](#nodriver.cdp.network.WebSocketRequest)*
+#### request *: [`WebSocketRequest`](#nodriver.cdp.network.WebSocketRequest)*
WebSocket request data.
@@ -2439,19 +2439,19 @@ WebSocket request data.
Fired upon WebTransport creation.
-#### transport_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### transport_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
WebTransport identifier.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
WebTransport request URL.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
-#### initiator*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Initiator`](#nodriver.cdp.network.Initiator)]*
+#### initiator *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Initiator`](#nodriver.cdp.network.Initiator)]*
Request initiator.
@@ -2459,11 +2459,11 @@ Request initiator.
Fired when WebTransport handshake is finished.
-#### transport_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### transport_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
WebTransport identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
@@ -2471,11 +2471,11 @@ Timestamp.
Fired when WebTransport is disposed.
-#### transport_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### transport_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
WebTransport identifier.
-#### timestamp*: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
+#### timestamp *: [`MonotonicTime`](#nodriver.cdp.network.MonotonicTime)*
Timestamp.
@@ -2488,28 +2488,28 @@ network stack. Not every requestWillBeSent event will have an additional
requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent
or requestWillBeSentExtraInfo will be fired first for the same request.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier. Used to match this information to an existing requestWillBeSent event.
-#### associated_cookies*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AssociatedCookie`](#nodriver.cdp.network.AssociatedCookie)]*
+#### associated_cookies *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AssociatedCookie`](#nodriver.cdp.network.AssociatedCookie)]*
A list of cookies potentially associated to the requested URL. This includes both cookies sent with
the request and the ones not sent; the latter are distinguished by having blockedReasons field set.
-#### headers*: [`Headers`](#nodriver.cdp.network.Headers)*
+#### headers *: [`Headers`](#nodriver.cdp.network.Headers)*
Raw request headers as they will be sent over the wire.
-#### connect_timing*: [`ConnectTiming`](#nodriver.cdp.network.ConnectTiming)*
+#### connect_timing *: [`ConnectTiming`](#nodriver.cdp.network.ConnectTiming)*
Connection timing information for the request.
-#### client_security_state*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ClientSecurityState`](#nodriver.cdp.network.ClientSecurityState)]*
+#### client_security_state *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ClientSecurityState`](#nodriver.cdp.network.ClientSecurityState)]*
The client security state set for the request.
-#### site_has_cookie_in_other_partition*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
+#### site_has_cookie_in_other_partition *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
Whether the site has partitioned cookies stored in a partition different than the current one.
@@ -2521,46 +2521,46 @@ Fired when additional information about a responseReceived event is available fr
stack. Not every responseReceived event will have an additional responseReceivedExtraInfo for
it, and responseReceivedExtraInfo may be fired before or after responseReceived.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier. Used to match this information to another responseReceived event.
-#### blocked_cookies*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BlockedSetCookieWithReason`](#nodriver.cdp.network.BlockedSetCookieWithReason)]*
+#### blocked_cookies *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BlockedSetCookieWithReason`](#nodriver.cdp.network.BlockedSetCookieWithReason)]*
A list of cookies which were not stored from the response along with the corresponding
reasons for blocking. The cookies here may not be valid due to syntax errors, which
are represented by the invalid cookie line string instead of a proper cookie.
-#### headers*: [`Headers`](#nodriver.cdp.network.Headers)*
+#### headers *: [`Headers`](#nodriver.cdp.network.Headers)*
Raw response headers as they were received over the wire.
-#### resource_ip_address_space*: [`IPAddressSpace`](#nodriver.cdp.network.IPAddressSpace)*
+#### resource_ip_address_space *: [`IPAddressSpace`](#nodriver.cdp.network.IPAddressSpace)*
The IP address space of the resource. The address space can only be determined once the transport
established the connection, so we can’t send it in `requestWillBeSentExtraInfo`.
-#### status_code*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### status_code *: [`int`](https://docs.python.org/3/library/functions.html#int)*
The status code of the response. This is useful in cases the request failed and no responseReceived
event is triggered, which is the case for, e.g., CORS errors. This is also the correct status code
for cached requests, where the status in responseReceived is a 200 and this will be 304.
-#### headers_text*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### headers_text *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
Raw response header text as it was received over the wire. The raw text may not always be
available, such as in the case of HTTP/2 or QUIC.
-#### cookie_partition_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePartitionKey`](#nodriver.cdp.network.CookiePartitionKey)]*
+#### cookie_partition_key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`CookiePartitionKey`](#nodriver.cdp.network.CookiePartitionKey)]*
The cookie partition key that will be used to store partitioned cookies set in this response.
Only sent when partitioned cookies are enabled.
-#### cookie_partition_key_opaque*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
+#### cookie_partition_key_opaque *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]*
True if partitioned cookies are enabled, but the partition key is not serializable to string.
-#### exempted_cookies*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ExemptedSetCookieWithReason`](#nodriver.cdp.network.ExemptedSetCookieWithReason)]]*
+#### exempted_cookies *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ExemptedSetCookieWithReason`](#nodriver.cdp.network.ExemptedSetCookieWithReason)]]*
A list of cookies which should have been blocked by 3PCD but are exempted and stored from
the response with the corresponding reason.
@@ -2573,11 +2573,11 @@ Fired when 103 Early Hints headers is received in addition to the common respons
Not every responseReceived event will have an responseReceivedEarlyHints fired.
Only one responseReceivedEarlyHints may be fired for eached responseReceived event.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier. Used to match this information to another responseReceived event.
-#### headers*: [`Headers`](#nodriver.cdp.network.Headers)*
+#### headers *: [`Headers`](#nodriver.cdp.network.Headers)*
Raw response headers as they were received over the wire.
@@ -2590,26 +2590,26 @@ the type of the operation and whether the operation succeeded or
failed, the event is fired before the corresponding request was sent
or after the response was received.
-#### status*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### status *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Detailed success or error status of the operation.
‘AlreadyExists’ also signifies a successful operation, as the result
of the operation already exists und thus, the operation was abort
preemptively (e.g. a cache hit).
-#### type_*: [`TrustTokenOperationType`](#nodriver.cdp.network.TrustTokenOperationType)*
+#### type_ *: [`TrustTokenOperationType`](#nodriver.cdp.network.TrustTokenOperationType)*
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
-#### top_level_origin*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### top_level_origin *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
Top level origin. The context in which the operation was attempted.
-#### issuer_origin*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### issuer_origin *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
Origin of the issuer in case of a “Issuance” or “Redemption” operation.
-#### issued_token_count*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
+#### issued_token_count *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
The number of obtained Trust Tokens on a successful “Issuance” operation.
@@ -2626,11 +2626,11 @@ Fired once security policy has been updated.
Fired once when parsing the .wbn file has succeeded.
The event contains the information about the web bundle contents.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier. Used to match this information to another event.
-#### urls*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### urls *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
A list of URLs of resources in the subresource Web Bundle.
@@ -2640,11 +2640,11 @@ A list of URLs of resources in the subresource Web Bundle.
Fired once when parsing the .wbn file has failed.
-#### request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier. Used to match this information to another event.
-#### error_message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### error_message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Error message
@@ -2655,15 +2655,15 @@ Error message
Fired when handling requests for resources within a .wbn file.
Note: this will only be fired for resources that are requested by the webpage.
-#### inner_request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### inner_request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier of the subresource request
-#### inner_request_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### inner_request_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL of the subresource resource.
-#### bundle_request_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](#nodriver.cdp.network.RequestId)]*
+#### bundle_request_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](#nodriver.cdp.network.RequestId)]*
Bundle request identifier. Used to match this information to another event.
This made be absent in case when the instrumentation was enabled only
@@ -2675,19 +2675,19 @@ after webbundle was parsed.
Fired when request for resources within a .wbn file failed.
-#### inner_request_id*: [`RequestId`](#nodriver.cdp.network.RequestId)*
+#### inner_request_id *: [`RequestId`](#nodriver.cdp.network.RequestId)*
Request identifier of the subresource request
-#### inner_request_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### inner_request_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL of the subresource resource.
-#### error_message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### error_message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Error message
-#### bundle_request_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](#nodriver.cdp.network.RequestId)]*
+#### bundle_request_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RequestId`](#nodriver.cdp.network.RequestId)]*
Bundle request identifier. Used to match this information to another event.
This made be absent in case when the instrumentation was enabled only
@@ -2700,20 +2700,20 @@ after webbundle was parsed.
Is sent whenever a new report is added.
And after ‘enableReportingApi’ for all existing reports.
-#### report*: [`ReportingApiReport`](#nodriver.cdp.network.ReportingApiReport)*
+#### report *: [`ReportingApiReport`](#nodriver.cdp.network.ReportingApiReport)*
### *class* ReportingApiReportUpdated(report)
**EXPERIMENTAL**
-#### report*: [`ReportingApiReport`](#nodriver.cdp.network.ReportingApiReport)*
+#### report *: [`ReportingApiReport`](#nodriver.cdp.network.ReportingApiReport)*
### *class* ReportingApiEndpointsChangedForOrigin(origin, endpoints)
**EXPERIMENTAL**
-#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Origin of the document(s) which configured the endpoints.
-#### endpoints*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ReportingApiEndpoint`](#nodriver.cdp.network.ReportingApiEndpoint)]*
+#### endpoints *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ReportingApiEndpoint`](#nodriver.cdp.network.ReportingApiEndpoint)]*
diff --git a/docs/_build/markdown/nodriver/cdp/overlay.md b/docs/_build/markdown/nodriver/cdp/overlay.md
index 79a270d..85565bc 100644
--- a/docs/_build/markdown/nodriver/cdp/overlay.md
+++ b/docs/_build/markdown/nodriver/cdp/overlay.md
@@ -20,11 +20,11 @@ arguments to other commands.
Configuration data for drawing the source order of an elements children.
-#### parent_outline_color*: [`RGBA`](dom.md#nodriver.cdp.dom.RGBA)*
+#### parent_outline_color *: [`RGBA`](dom.md#nodriver.cdp.dom.RGBA)*
the color to outline the given element in.
-#### child_outline_color*: [`RGBA`](dom.md#nodriver.cdp.dom.RGBA)*
+#### child_outline_color *: [`RGBA`](dom.md#nodriver.cdp.dom.RGBA)*
the color to outline the child elements in.
@@ -32,140 +32,140 @@ the color to outline the child elements in.
Configuration data for the highlighting of Grid elements.
-#### show_grid_extension_lines*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_grid_extension_lines *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether the extension lines from grid cells to the rulers should be shown (default
-#### show_positive_line_numbers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_positive_line_numbers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Show Positive line number labels (default
-#### show_negative_line_numbers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_negative_line_numbers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Show Negative line number labels (default
-#### show_area_names*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_area_names *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Show area name labels (default
-#### show_line_names*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_line_names *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Show line name labels (default
-#### show_track_sizes*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_track_sizes *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Show track size labels (default
-#### grid_border_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### grid_border_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The grid container border highlight color (default
-#### cell_border_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### cell_border_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent). Deprecated, please use rowLineColor and columnLineColor instead.
* **Type:**
The cell border color (default
-#### row_line_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### row_line_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The row line color (default
-#### column_line_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### column_line_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The column line color (default
-#### grid_border_dash*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### grid_border_dash *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether the grid border is dashed (default
-#### cell_border_dash*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### cell_border_dash *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false). Deprecated, please us rowLineDash and columnLineDash instead.
* **Type:**
Whether the cell border is dashed (default
-#### row_line_dash*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### row_line_dash *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether row lines are dashed (default
-#### column_line_dash*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### column_line_dash *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether column lines are dashed (default
-#### row_gap_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### row_gap_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The row gap highlight fill color (default
-#### row_hatch_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### row_hatch_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The row gap hatching fill color (default
-#### column_gap_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### column_gap_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The column gap highlight fill color (default
-#### column_hatch_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### column_hatch_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The column gap hatching fill color (default
-#### area_border_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### area_border_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The named grid areas border color (Default
-#### grid_background_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### grid_background_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
@@ -176,35 +176,35 @@ transparent).
Configuration data for the highlighting of Flex container elements.
-#### container_border*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### container_border *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
The style of the container border
-#### line_separator*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### line_separator *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
The style of the separator between lines
-#### item_separator*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### item_separator *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
The style of the separator between items
-#### main_distributed_space*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
+#### main_distributed_space *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
Style of content-distribution space on the main axis (justify-content).
-#### cross_distributed_space*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
+#### cross_distributed_space *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
Style of content-distribution space on the cross axis (align-content).
-#### row_gap_space*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
+#### row_gap_space *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
Style of empty space caused by row gaps (gap/row-gap).
-#### column_gap_space*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
+#### column_gap_space *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
Style of empty space caused by columns gaps (gap/column-gap).
-#### cross_alignment*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### cross_alignment *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
Style of the self-alignment line (align-items).
@@ -212,15 +212,15 @@ Style of the self-alignment line (align-items).
Configuration data for the highlighting of Flex item elements.
-#### base_size_box*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
+#### base_size_box *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BoxStyle`](#nodriver.cdp.overlay.BoxStyle)]* *= None*
Style of the box representing the item’s base size
-#### base_size_border*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### base_size_border *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
Style of the border around the box representing the item’s base size
-#### flexibility_arrow*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### flexibility_arrow *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
Style of the arrow representing if the item grew or shrank
@@ -228,14 +228,14 @@ Style of the arrow representing if the item grew or shrank
Style information for drawing a line.
-#### color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent)
* **Type:**
The color of the line (default
-#### pattern*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### pattern *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
solid)
@@ -246,14 +246,14 @@ solid)
Style information for drawing a box.
-#### fill_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### fill_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent)
* **Type:**
The background color for the box (default
-#### hatch_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### hatch_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent)
@@ -272,133 +272,133 @@ transparent)
Configuration data for the highlighting of page elements.
-#### show_info*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_info *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether the node info tooltip should be shown (default
-#### show_styles*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_styles *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether the node styles in the tooltip (default
-#### show_rulers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_rulers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether the rulers should be shown (default
-#### show_accessibility_info*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_accessibility_info *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
true).
* **Type:**
Whether the a11y info should be shown (default
-#### show_extension_lines*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### show_extension_lines *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
false).
* **Type:**
Whether the extension lines from node to the rulers should be shown (default
-#### content_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### content_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The content box highlight fill color (default
-#### padding_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### padding_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The padding highlight fill color (default
-#### border_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### border_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The border highlight fill color (default
-#### margin_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### margin_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The margin highlight fill color (default
-#### event_target_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### event_target_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The event target element highlight fill color (default
-#### shape_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### shape_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The shape outside fill color (default
-#### shape_margin_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### shape_margin_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The shape margin fill color (default
-#### css_grid_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### css_grid_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The grid layout color (default
-#### color_format*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ColorFormat`](#nodriver.cdp.overlay.ColorFormat)]* *= None*
+#### color_format *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ColorFormat`](#nodriver.cdp.overlay.ColorFormat)]* *= None*
hex).
* **Type:**
The color format used to format color styles (default
-#### grid_highlight_config*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`GridHighlightConfig`](#nodriver.cdp.overlay.GridHighlightConfig)]* *= None*
+#### grid_highlight_config *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`GridHighlightConfig`](#nodriver.cdp.overlay.GridHighlightConfig)]* *= None*
all transparent).
* **Type:**
The grid layout highlight configuration (default
-#### flex_container_highlight_config*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FlexContainerHighlightConfig`](#nodriver.cdp.overlay.FlexContainerHighlightConfig)]* *= None*
+#### flex_container_highlight_config *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FlexContainerHighlightConfig`](#nodriver.cdp.overlay.FlexContainerHighlightConfig)]* *= None*
all transparent).
* **Type:**
The flex container highlight configuration (default
-#### flex_item_highlight_config*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FlexItemHighlightConfig`](#nodriver.cdp.overlay.FlexItemHighlightConfig)]* *= None*
+#### flex_item_highlight_config *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FlexItemHighlightConfig`](#nodriver.cdp.overlay.FlexItemHighlightConfig)]* *= None*
all transparent).
* **Type:**
The flex item highlight configuration (default
-#### contrast_algorithm*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ContrastAlgorithm`](#nodriver.cdp.overlay.ContrastAlgorithm)]* *= None*
+#### contrast_algorithm *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ContrastAlgorithm`](#nodriver.cdp.overlay.ContrastAlgorithm)]* *= None*
aa).
* **Type:**
The contrast algorithm to use for the contrast ratio (default
-#### container_query_container_highlight_config*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ContainerQueryContainerHighlightConfig`](#nodriver.cdp.overlay.ContainerQueryContainerHighlightConfig)]* *= None*
+#### container_query_container_highlight_config *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ContainerQueryContainerHighlightConfig`](#nodriver.cdp.overlay.ContainerQueryContainerHighlightConfig)]* *= None*
all transparent).
@@ -419,48 +419,48 @@ all transparent).
Configurations for Persistent Grid Highlight
-#### grid_highlight_config*: [`GridHighlightConfig`](#nodriver.cdp.overlay.GridHighlightConfig)*
+#### grid_highlight_config *: [`GridHighlightConfig`](#nodriver.cdp.overlay.GridHighlightConfig)*
A descriptor for the highlight appearance.
-#### node_id*: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
+#### node_id *: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
Identifier of the node to highlight.
### *class* FlexNodeHighlightConfig(flex_container_highlight_config, node_id)
-#### flex_container_highlight_config*: [`FlexContainerHighlightConfig`](#nodriver.cdp.overlay.FlexContainerHighlightConfig)*
+#### flex_container_highlight_config *: [`FlexContainerHighlightConfig`](#nodriver.cdp.overlay.FlexContainerHighlightConfig)*
A descriptor for the highlight appearance of flex containers.
-#### node_id*: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
+#### node_id *: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
Identifier of the node to highlight.
### *class* ScrollSnapContainerHighlightConfig(snapport_border=None, snap_area_border=None, scroll_margin_color=None, scroll_padding_color=None)
-#### snapport_border*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### snapport_border *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
transparent)
* **Type:**
The style of the snapport border (default
-#### snap_area_border*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### snap_area_border *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
transparent)
* **Type:**
The style of the snap area border (default
-#### scroll_margin_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### scroll_margin_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The margin highlight fill color (default
-#### scroll_padding_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### scroll_padding_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
@@ -469,11 +469,11 @@ transparent).
### *class* ScrollSnapHighlightConfig(scroll_snap_container_highlight_config, node_id)
-#### scroll_snap_container_highlight_config*: [`ScrollSnapContainerHighlightConfig`](#nodriver.cdp.overlay.ScrollSnapContainerHighlightConfig)*
+#### scroll_snap_container_highlight_config *: [`ScrollSnapContainerHighlightConfig`](#nodriver.cdp.overlay.ScrollSnapContainerHighlightConfig)*
A descriptor for the highlight appearance of scroll snap containers.
-#### node_id*: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
+#### node_id *: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
Identifier of the node to highlight.
@@ -481,18 +481,18 @@ Identifier of the node to highlight.
Configuration for dual screen hinge
-#### rect*: [`Rect`](dom.md#nodriver.cdp.dom.Rect)*
+#### rect *: [`Rect`](dom.md#nodriver.cdp.dom.Rect)*
A rectangle represent hinge
-#### content_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### content_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
a dark color).
* **Type:**
The content box highlight fill color (default
-#### outline_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### outline_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
@@ -503,65 +503,65 @@ transparent).
Configuration for Window Controls Overlay
-#### show_css*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### show_css *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether the title bar CSS should be shown when emulating the Window Controls Overlay.
-#### selected_platform*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### selected_platform *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Selected platforms to show the overlay.
-#### theme_color*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### theme_color *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The theme color defined in app manifest.
### *class* ContainerQueryHighlightConfig(container_query_container_highlight_config, node_id)
-#### container_query_container_highlight_config*: [`ContainerQueryContainerHighlightConfig`](#nodriver.cdp.overlay.ContainerQueryContainerHighlightConfig)*
+#### container_query_container_highlight_config *: [`ContainerQueryContainerHighlightConfig`](#nodriver.cdp.overlay.ContainerQueryContainerHighlightConfig)*
A descriptor for the highlight appearance of container query containers.
-#### node_id*: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
+#### node_id *: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
Identifier of the container node to highlight.
### *class* ContainerQueryContainerHighlightConfig(container_border=None, descendant_border=None)
-#### container_border*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### container_border *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
The style of the container border.
-#### descendant_border*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
+#### descendant_border *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LineStyle`](#nodriver.cdp.overlay.LineStyle)]* *= None*
The style of the descendants’ borders.
### *class* IsolatedElementHighlightConfig(isolation_mode_highlight_config, node_id)
-#### isolation_mode_highlight_config*: [`IsolationModeHighlightConfig`](#nodriver.cdp.overlay.IsolationModeHighlightConfig)*
+#### isolation_mode_highlight_config *: [`IsolationModeHighlightConfig`](#nodriver.cdp.overlay.IsolationModeHighlightConfig)*
A descriptor for the highlight appearance of an element in isolation mode.
-#### node_id*: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
+#### node_id *: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
Identifier of the isolated element to highlight.
### *class* IsolationModeHighlightConfig(resizer_color=None, resizer_handle_color=None, mask_color=None)
-#### resizer_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### resizer_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The fill color of the resizers (default
-#### resizer_handle_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### resizer_handle_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
* **Type:**
The fill color for resizer handles (default
-#### mask_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
+#### mask_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]* *= None*
transparent).
@@ -622,10 +622,10 @@ For testing.
* **Parameters:**
* **node_id** ([`NodeId`](dom.md#nodriver.cdp.dom.NodeId)) – Id of the node to get highlight object for.
- * **include_distance** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to include distance info.
- * **include_style** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to include style info.
- * **color_format** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ColorFormat`](#nodriver.cdp.overlay.ColorFormat)]) – *(Optional)* The color format to get config with (default: hex).
- * **show_accessibility_info** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to show accessibility info (default: true).
+ * **include_distance** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to include distance info.
+ * **include_style** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to include style info.
+ * **color_format** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ColorFormat`](#nodriver.cdp.overlay.ColorFormat)]) – *(Optional)* The color format to get config with (default: hex).
+ * **show_accessibility_info** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to show accessibility info (default: true).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`dict`](https://docs.python.org/3/library/stdtypes.html#dict)]
* **Returns:**
@@ -661,8 +661,8 @@ Deprecated since version 1.3.
* **Parameters:**
* **frame_id** ([`FrameId`](page.md#nodriver.cdp.page.FrameId)) – Identifier of the frame to highlight.
- * **content_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The content box highlight fill color (default: transparent).
- * **content_outline_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The content box highlight outline color (default: transparent).
+ * **content_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The content box highlight fill color (default: transparent).
+ * **content_outline_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The content box highlight outline color (default: transparent).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -676,10 +676,10 @@ objectId must be specified.
* **Parameters:**
* **highlight_config** ([`HighlightConfig`](#nodriver.cdp.overlay.HighlightConfig)) – A descriptor for the highlight appearance.
- * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to highlight.
- * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to highlight.
- * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node to be highlighted.
- * **selector** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Selectors to highlight relevant nodes.
+ * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to highlight.
+ * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to highlight.
+ * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node to be highlighted.
+ * **selector** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Selectors to highlight relevant nodes.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -689,8 +689,8 @@ Highlights given quad. Coordinates are absolute with respect to the main frame v
* **Parameters:**
* **quad** ([`Quad`](dom.md#nodriver.cdp.dom.Quad)) – Quad to highlight
- * **color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight fill color (default: transparent).
- * **outline_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight outline color (default: transparent).
+ * **color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight fill color (default: transparent).
+ * **outline_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight outline color (default: transparent).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -703,8 +703,8 @@ Highlights given rectangle. Coordinates are absolute with respect to the main fr
* **y** ([`int`](https://docs.python.org/3/library/functions.html#int)) – Y coordinate
* **width** ([`int`](https://docs.python.org/3/library/functions.html#int)) – Rectangle width
* **height** ([`int`](https://docs.python.org/3/library/functions.html#int)) – Rectangle height
- * **color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight fill color (default: transparent).
- * **outline_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight outline color (default: transparent).
+ * **color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight fill color (default: transparent).
+ * **outline_color** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RGBA`](dom.md#nodriver.cdp.dom.RGBA)]) – *(Optional)* The highlight outline color (default: transparent).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -715,9 +715,9 @@ JavaScript object wrapper. Either nodeId or objectId must be specified.
* **Parameters:**
* **source_order_config** ([`SourceOrderConfig`](#nodriver.cdp.overlay.SourceOrderConfig)) – A descriptor for the appearance of the overlay drawing.
- * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to highlight.
- * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to highlight.
- * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node to be highlighted.
+ * **node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`NodeId`](dom.md#nodriver.cdp.dom.NodeId)]) – *(Optional)* Identifier of the node to highlight.
+ * **backend_node_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]) – *(Optional)* Identifier of the backend node to highlight.
+ * **object_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`RemoteObjectId`](runtime.md#nodriver.cdp.runtime.RemoteObjectId)]) – *(Optional)* JavaScript object id of the node to be highlighted.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -728,14 +728,14 @@ Backend then generates ‘inspectNodeRequested’ event upon element selection.
* **Parameters:**
* **mode** ([`InspectMode`](#nodriver.cdp.overlay.InspectMode)) – Set an inspection mode.
- * **highlight_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`HighlightConfig`](#nodriver.cdp.overlay.HighlightConfig)]) – *(Optional)* A descriptor for the highlight appearance of hovered-over nodes. May be omitted if ``enabled == false``.
+ * **highlight_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`HighlightConfig`](#nodriver.cdp.overlay.HighlightConfig)]) – *(Optional)* A descriptor for the highlight appearance of hovered-over nodes. May be omitted if ``enabled == false``.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
### set_paused_in_debugger_message(message=None)
* **Parameters:**
- **message** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The message to display, also triggers resume and step over controls.
+ **message** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The message to display, also triggers resume and step over controls.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -794,7 +794,7 @@ Highlight multiple elements with the CSS Grid overlay.
Add a dual screen device hinge
* **Parameters:**
- **hinge_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`HingeConfig`](#nodriver.cdp.overlay.HingeConfig)]) – *(Optional)* hinge data, null means hideHinge
+ **hinge_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`HingeConfig`](#nodriver.cdp.overlay.HingeConfig)]) – *(Optional)* hinge data, null means hideHinge
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -885,7 +885,7 @@ Deprecated since version 1.3.
Show Window Controls Overlay for PWA
* **Parameters:**
- **window_controls_overlay_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`WindowControlsOverlayConfig`](#nodriver.cdp.overlay.WindowControlsOverlayConfig)]) – *(Optional)* Window Controls Overlay data, null means hide Window Controls Overlay
+ **window_controls_overlay_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`WindowControlsOverlayConfig`](#nodriver.cdp.overlay.WindowControlsOverlayConfig)]) – *(Optional)* Window Controls Overlay data, null means hide Window Controls Overlay
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -900,7 +900,7 @@ you use the event’s attributes.
Fired when the node should be inspected. This happens after call to `setInspectMode` or when
user manually inspects an element.
-#### backend_node_id*: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
+#### backend_node_id *: [`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)*
Id of the node to inspect.
@@ -908,13 +908,13 @@ Id of the node to inspect.
Fired when the node should be highlighted. This happens after call to `setInspectMode`.
-#### node_id*: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
+#### node_id *: [`NodeId`](dom.md#nodriver.cdp.dom.NodeId)*
### *class* ScreenshotRequested(viewport)
Fired when user asks to capture screenshot of some area on the page.
-#### viewport*: [`Viewport`](page.md#nodriver.cdp.page.Viewport)*
+#### viewport *: [`Viewport`](page.md#nodriver.cdp.page.Viewport)*
Viewport to capture, in device independent pixels (dip).
diff --git a/docs/_build/markdown/nodriver/cdp/page.md b/docs/_build/markdown/nodriver/cdp/page.md
index 0e3877a..543f122 100644
--- a/docs/_build/markdown/nodriver/cdp/page.md
+++ b/docs/_build/markdown/nodriver/cdp/page.md
@@ -40,21 +40,21 @@ Indicates whether a frame has been identified as an ad.
Indicates whether a frame has been identified as an ad and why.
-#### ad_frame_type*: [`AdFrameType`](#nodriver.cdp.page.AdFrameType)*
+#### ad_frame_type *: [`AdFrameType`](#nodriver.cdp.page.AdFrameType)*
-#### explanations*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AdFrameExplanation`](#nodriver.cdp.page.AdFrameExplanation)]]* *= None*
+#### explanations *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AdFrameExplanation`](#nodriver.cdp.page.AdFrameExplanation)]]* *= None*
### *class* AdScriptId(script_id, debugger_id)
Identifies the bottom-most script which caused the frame to be labelled
as an ad.
-#### script_id*: [`ScriptId`](runtime.md#nodriver.cdp.runtime.ScriptId)*
+#### script_id *: [`ScriptId`](runtime.md#nodriver.cdp.runtime.ScriptId)*
Script Id of the bottom-most script which caused the frame to be labelled
as an ad.
-#### debugger_id*: [`UniqueDebuggerId`](runtime.md#nodriver.cdp.runtime.UniqueDebuggerId)*
+#### debugger_id *: [`UniqueDebuggerId`](runtime.md#nodriver.cdp.runtime.UniqueDebuggerId)*
Id of adScriptId’s debugger.
@@ -297,17 +297,17 @@ Reason for a permissions policy feature to be disabled.
### *class* PermissionsPolicyBlockLocator(frame_id, block_reason)
-#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
-#### block_reason*: [`PermissionsPolicyBlockReason`](#nodriver.cdp.page.PermissionsPolicyBlockReason)*
+#### block_reason *: [`PermissionsPolicyBlockReason`](#nodriver.cdp.page.PermissionsPolicyBlockReason)*
### *class* PermissionsPolicyFeatureState(feature, allowed, locator=None)
-#### feature*: [`PermissionsPolicyFeature`](#nodriver.cdp.page.PermissionsPolicyFeature)*
+#### feature *: [`PermissionsPolicyFeature`](#nodriver.cdp.page.PermissionsPolicyFeature)*
-#### allowed*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### allowed *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### locator*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`PermissionsPolicyBlockLocator`](#nodriver.cdp.page.PermissionsPolicyBlockLocator)]* *= None*
+#### locator *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`PermissionsPolicyBlockLocator`](#nodriver.cdp.page.PermissionsPolicyBlockLocator)]* *= None*
### *class* OriginTrialTokenStatus(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -358,54 +358,54 @@ Status for an Origin Trial.
### *class* OriginTrialToken(origin, match_sub_domains, trial_name, expiry_time, is_third_party, usage_restriction)
-#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### match_sub_domains*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### match_sub_domains *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### trial_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### trial_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### expiry_time*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### expiry_time *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
-#### is_third_party*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_third_party *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### usage_restriction*: [`OriginTrialUsageRestriction`](#nodriver.cdp.page.OriginTrialUsageRestriction)*
+#### usage_restriction *: [`OriginTrialUsageRestriction`](#nodriver.cdp.page.OriginTrialUsageRestriction)*
### *class* OriginTrialTokenWithStatus(raw_token_text, status, parsed_token=None)
-#### raw_token_text*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### raw_token_text *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### status*: [`OriginTrialTokenStatus`](#nodriver.cdp.page.OriginTrialTokenStatus)*
+#### status *: [`OriginTrialTokenStatus`](#nodriver.cdp.page.OriginTrialTokenStatus)*
-#### parsed_token*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`OriginTrialToken`](#nodriver.cdp.page.OriginTrialToken)]* *= None*
+#### parsed_token *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`OriginTrialToken`](#nodriver.cdp.page.OriginTrialToken)]* *= None*
`parsedToken` is present only when the token is extractable and
parsable.
### *class* OriginTrial(trial_name, status, tokens_with_status)
-#### trial_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### trial_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### status*: [`OriginTrialStatus`](#nodriver.cdp.page.OriginTrialStatus)*
+#### status *: [`OriginTrialStatus`](#nodriver.cdp.page.OriginTrialStatus)*
-#### tokens_with_status*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`OriginTrialTokenWithStatus`](#nodriver.cdp.page.OriginTrialTokenWithStatus)]*
+#### tokens_with_status *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`OriginTrialTokenWithStatus`](#nodriver.cdp.page.OriginTrialTokenWithStatus)]*
### *class* Frame(id_, loader_id, url, domain_and_registry, security_origin, mime_type, secure_context_type, cross_origin_isolated_context_type, gated_api_features, parent_id=None, name=None, url_fragment=None, unreachable_url=None, ad_frame_status=None)
Information about the Frame on the page.
-#### id_*: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### id_ *: [`FrameId`](#nodriver.cdp.page.FrameId)*
Frame unique identifier.
-#### loader_id*: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
+#### loader_id *: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
Identifier of the loader associated with this frame.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Frame document’s URL without fragment.
-#### domain_and_registry*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### domain_and_registry *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Frame document’s registered domain, taking the public suffixes list into account.
Extracted from the Frame’s url.
@@ -413,43 +413,43 @@ Example URLs: [http://www.google.com/file.html](http://www.google.com/file.html)
> [http://a.b.co.uk/file.html](http://a.b.co.uk/file.html) -> “b.co.uk”
-#### security_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### security_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Frame document’s security origin.
-#### mime_type*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### mime_type *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Frame document’s mimeType as determined by the browser.
-#### secure_context_type*: [`SecureContextType`](#nodriver.cdp.page.SecureContextType)*
+#### secure_context_type *: [`SecureContextType`](#nodriver.cdp.page.SecureContextType)*
Indicates whether the main document is a secure context and explains why that is the case.
-#### cross_origin_isolated_context_type*: [`CrossOriginIsolatedContextType`](#nodriver.cdp.page.CrossOriginIsolatedContextType)*
+#### cross_origin_isolated_context_type *: [`CrossOriginIsolatedContextType`](#nodriver.cdp.page.CrossOriginIsolatedContextType)*
Indicates whether this is a cross origin isolated context.
-#### gated_api_features*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`GatedAPIFeatures`](#nodriver.cdp.page.GatedAPIFeatures)]*
+#### gated_api_features *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`GatedAPIFeatures`](#nodriver.cdp.page.GatedAPIFeatures)]*
Indicated which gated APIs / features are available.
-#### parent_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](#nodriver.cdp.page.FrameId)]* *= None*
+#### parent_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](#nodriver.cdp.page.FrameId)]* *= None*
Parent frame identifier.
-#### name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Frame’s name as specified in the tag.
-#### url_fragment*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### url_fragment *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Frame document’s URL fragment including the ‘#’.
-#### unreachable_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### unreachable_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.
-#### ad_frame_status*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AdFrameStatus`](#nodriver.cdp.page.AdFrameStatus)]* *= None*
+#### ad_frame_status *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AdFrameStatus`](#nodriver.cdp.page.AdFrameStatus)]* *= None*
Indicates whether this frame was tagged as an ad and why.
@@ -457,31 +457,31 @@ Indicates whether this frame was tagged as an ad and why.
Information about the Resource on the page.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Resource URL.
-#### type_*: [`ResourceType`](network.md#nodriver.cdp.network.ResourceType)*
+#### type_ *: [`ResourceType`](network.md#nodriver.cdp.network.ResourceType)*
Type of this resource.
-#### mime_type*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### mime_type *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Resource mimeType as determined by the browser.
-#### last_modified*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)]* *= None*
+#### last_modified *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)]* *= None*
last-modified timestamp as reported by server.
-#### content_size*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### content_size *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
Resource content size.
-#### failed*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### failed *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
True if the resource failed to load.
-#### canceled*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### canceled *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
True if the resource was canceled during loading.
@@ -489,15 +489,15 @@ True if the resource was canceled during loading.
Information about the Frame hierarchy along with their cached resources.
-#### frame*: [`Frame`](#nodriver.cdp.page.Frame)*
+#### frame *: [`Frame`](#nodriver.cdp.page.Frame)*
Frame information for this tree item.
-#### resources*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FrameResource`](#nodriver.cdp.page.FrameResource)]*
+#### resources *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FrameResource`](#nodriver.cdp.page.FrameResource)]*
Information about frame resources.
-#### child_frames*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FrameResourceTree`](#nodriver.cdp.page.FrameResourceTree)]]* *= None*
+#### child_frames *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FrameResourceTree`](#nodriver.cdp.page.FrameResourceTree)]]* *= None*
Child frames.
@@ -505,11 +505,11 @@ Child frames.
Information about the Frame hierarchy.
-#### frame*: [`Frame`](#nodriver.cdp.page.Frame)*
+#### frame *: [`Frame`](#nodriver.cdp.page.Frame)*
Frame information for this tree item.
-#### child_frames*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FrameTree`](#nodriver.cdp.page.FrameTree)]]* *= None*
+#### child_frames *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FrameTree`](#nodriver.cdp.page.FrameTree)]]* *= None*
Child frames.
@@ -551,23 +551,23 @@ Transition type.
Navigation history entry.
-#### id_*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### id_ *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Unique id of the navigation history entry.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL of the navigation history entry.
-#### user_typed_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### user_typed_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL that the user typed in the url bar.
-#### title*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### title *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Title of the navigation history entry.
-#### transition_type*: [`TransitionType`](#nodriver.cdp.page.TransitionType)*
+#### transition_type *: [`TransitionType`](#nodriver.cdp.page.TransitionType)*
Transition type.
@@ -575,31 +575,31 @@ Transition type.
Screencast frame metadata.
-#### offset_top*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### offset_top *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Top offset in DIP.
-#### page_scale_factor*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### page_scale_factor *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Page scale factor.
-#### device_width*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### device_width *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Device screen width in DIP.
-#### device_height*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### device_height *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Device screen height in DIP.
-#### scroll_offset_x*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### scroll_offset_x *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Position of horizontal scroll in CSS pixels.
-#### scroll_offset_y*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### scroll_offset_y *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Position of vertical scroll in CSS pixels.
-#### timestamp*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)]* *= None*
+#### timestamp *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)]* *= None*
Frame swap timestamp.
@@ -619,19 +619,19 @@ Javascript dialog type.
Error while paring app manifest.
-#### message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Error message.
-#### critical*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### critical *: [`int`](https://docs.python.org/3/library/functions.html#int)*
If critical, this is a non-recoverable parse error.
-#### line*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### line *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Error line.
-#### column*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### column *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Error column.
@@ -639,7 +639,7 @@ Error column.
Parsed app manifest properties.
-#### scope*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### scope *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Computed scope value
@@ -647,19 +647,19 @@ Computed scope value
Layout viewport position and dimensions.
-#### page_x*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### page_x *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Horizontal offset relative to the document (CSS pixels).
-#### page_y*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### page_y *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Vertical offset relative to the document (CSS pixels).
-#### client_width*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### client_width *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Width (CSS pixels), excludes scrollbar if present.
-#### client_height*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### client_height *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Height (CSS pixels), excludes scrollbar if present.
@@ -667,35 +667,35 @@ Height (CSS pixels), excludes scrollbar if present.
Visual viewport position, dimensions, and scale.
-#### offset_x*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### offset_x *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Horizontal offset relative to the layout viewport (CSS pixels).
-#### offset_y*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### offset_y *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Vertical offset relative to the layout viewport (CSS pixels).
-#### page_x*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### page_x *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Horizontal offset relative to the document (CSS pixels).
-#### page_y*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### page_y *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Vertical offset relative to the document (CSS pixels).
-#### client_width*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### client_width *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Width (CSS pixels), excludes scrollbar if present.
-#### client_height*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### client_height *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Height (CSS pixels), excludes scrollbar if present.
-#### scale*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### scale *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Scale relative to the ideal viewport (size at width=device-width).
-#### zoom*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### zoom *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
Page zoom factor (CSS to device independent pixels ratio).
@@ -703,23 +703,23 @@ Page zoom factor (CSS to device independent pixels ratio).
Viewport for capturing screenshot.
-#### x*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### x *: [`float`](https://docs.python.org/3/library/functions.html#float)*
X offset in device independent pixels (dip).
-#### y*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### y *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Y offset in device independent pixels (dip).
-#### width*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### width *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Rectangle width in device independent pixels (dip).
-#### height*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### height *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Rectangle height in device independent pixels (dip).
-#### scale*: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### scale *: [`float`](https://docs.python.org/3/library/functions.html#float)*
Page scale factor.
@@ -727,31 +727,31 @@ Page scale factor.
Generic font families collection.
-#### standard*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### standard *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The standard font-family.
-#### fixed*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### fixed *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The fixed font-family.
-#### serif*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### serif *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The serif font-family.
-#### sans_serif*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### sans_serif *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The sansSerif font-family.
-#### cursive*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### cursive *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The cursive font-family.
-#### fantasy*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### fantasy *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The fantasy font-family.
-#### math*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### math *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The math font-family.
@@ -759,11 +759,11 @@ The math font-family.
Font families collection for a script.
-#### script*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### script *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Name of the script which these font families are defined for.
-#### font_families*: [`FontFamilies`](#nodriver.cdp.page.FontFamilies)*
+#### font_families *: [`FontFamilies`](#nodriver.cdp.page.FontFamilies)*
Generic font families collection for the script.
@@ -771,11 +771,11 @@ Generic font families collection for the script.
Default font sizes.
-#### standard*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### standard *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
Default standard font size.
-#### fixed*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### fixed *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
Default fixed font size.
@@ -813,14 +813,14 @@ Default fixed font size.
### *class* InstallabilityErrorArgument(name, value)
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
‘minimum-icon-size-in-pixels’).
* **Type:**
Argument name (e.g. name
-#### value*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### value *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
‘64’).
@@ -831,11 +831,11 @@ Default fixed font size.
The installability error
-#### error_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### error_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The error id (e.g. ‘manifest-missing-suitable-icon’).
-#### error_arguments*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`InstallabilityErrorArgument`](#nodriver.cdp.page.InstallabilityErrorArgument)]*
+#### error_arguments *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`InstallabilityErrorArgument`](#nodriver.cdp.page.InstallabilityErrorArgument)]*
‘64’}).
@@ -868,35 +868,35 @@ The referring-policy used for the navigation.
Per-script compilation cache parameters for `Page.produceCompilationCache`
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The URL of the script to produce a compilation cache entry for.
-#### eager*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### eager *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
A hint to the backend whether eager compilation is recommended.
(the actual compilation mode used is upon backend discretion).
### *class* FileFilter(name=None, accepts=None)
-#### name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### accepts*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]* *= None*
+#### accepts *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]* *= None*
### *class* FileHandler(action, name, launch_type, icons=None, accepts=None)
-#### action*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### action *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### launch_type*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### launch_type *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Won’t repeat the enums, using string for easy comparison. Same as the
other enums below.
-#### icons*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ImageResource`](#nodriver.cdp.page.ImageResource)]]* *= None*
+#### icons *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ImageResource`](#nodriver.cdp.page.ImageResource)]]* *= None*
-#### accepts*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FileFilter`](#nodriver.cdp.page.FileFilter)]]* *= None*
+#### accepts *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FileFilter`](#nodriver.cdp.page.FileFilter)]]* *= None*
Mimic a map, name is the key, accepts is the value.
@@ -904,99 +904,99 @@ Mimic a map, name is the key, accepts is the value.
The image definition used in both icon and screenshot.
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The src field in the definition, but changing to url in favor of
consistency.
-#### sizes*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### sizes *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### type_*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### type_ *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* LaunchHandler(client_mode)
-#### client_mode*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### client_mode *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* ProtocolHandler(protocol, url)
-#### protocol*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### protocol *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* RelatedApplication(url, id_=None)
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### id_*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### id_ *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* ScopeExtension(origin, has_origin_wildcard)
-#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Instead of using tuple, this field always returns the serialized string
for easy understanding and comparison.
-#### has_origin_wildcard*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### has_origin_wildcard *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
### *class* Screenshot(image, form_factor, label=None)
-#### image*: [`ImageResource`](#nodriver.cdp.page.ImageResource)*
+#### image *: [`ImageResource`](#nodriver.cdp.page.ImageResource)*
-#### form_factor*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### form_factor *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### label*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### label *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* ShareTarget(action, method, enctype, title=None, text=None, url=None, files=None)
-#### action*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### action *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### method*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### method *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### enctype*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### enctype *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### title*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### title *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Embed the ShareTargetParams
-#### text*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### text *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### files*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FileFilter`](#nodriver.cdp.page.FileFilter)]]* *= None*
+#### files *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FileFilter`](#nodriver.cdp.page.FileFilter)]]* *= None*
### *class* Shortcut(name, url)
-#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* WebAppManifest(background_color=None, description=None, dir_=None, display=None, display_overrides=None, file_handlers=None, icons=None, id_=None, lang=None, launch_handler=None, name=None, orientation=None, prefer_related_applications=None, protocol_handlers=None, related_applications=None, scope=None, scope_extensions=None, screenshots=None, share_target=None, short_name=None, shortcuts=None, start_url=None, theme_color=None)
-#### background_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### background_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### description*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### description *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The extra description provided by the manifest.
-#### dir_*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### dir_ *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### display*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### display *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### display_overrides*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]* *= None*
+#### display_overrides *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]* *= None*
The overrided display mode controlled by the user.
-#### file_handlers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FileHandler`](#nodriver.cdp.page.FileHandler)]]* *= None*
+#### file_handlers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`FileHandler`](#nodriver.cdp.page.FileHandler)]]* *= None*
The handlers to open files.
-#### icons*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ImageResource`](#nodriver.cdp.page.ImageResource)]]* *= None*
+#### icons *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ImageResource`](#nodriver.cdp.page.ImageResource)]]* *= None*
-#### id_*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### id_ *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### lang*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### lang *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### launch_handler*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LaunchHandler`](#nodriver.cdp.page.LaunchHandler)]* *= None*
+#### launch_handler *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LaunchHandler`](#nodriver.cdp.page.LaunchHandler)]* *= None*
This field is non-standard and part of a Chrome
experiment. See:
@@ -1005,38 +1005,38 @@ experiment. See:
* **Type:**
TODO(crbug.com/1231886)
-#### name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### orientation*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### orientation *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### prefer_related_applications*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### prefer_related_applications *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
-#### protocol_handlers*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ProtocolHandler`](#nodriver.cdp.page.ProtocolHandler)]]* *= None*
+#### protocol_handlers *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ProtocolHandler`](#nodriver.cdp.page.ProtocolHandler)]]* *= None*
The handlers to open protocols.
-#### related_applications*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`RelatedApplication`](#nodriver.cdp.page.RelatedApplication)]]* *= None*
+#### related_applications *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`RelatedApplication`](#nodriver.cdp.page.RelatedApplication)]]* *= None*
-#### scope*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### scope *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### scope_extensions*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ScopeExtension`](#nodriver.cdp.page.ScopeExtension)]]* *= None*
+#### scope_extensions *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ScopeExtension`](#nodriver.cdp.page.ScopeExtension)]]* *= None*
Non-standard, see
[https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md](https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md)
-#### screenshots*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Screenshot`](#nodriver.cdp.page.Screenshot)]]* *= None*
+#### screenshots *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Screenshot`](#nodriver.cdp.page.Screenshot)]]* *= None*
The screenshots used by chromium.
-#### share_target*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ShareTarget`](#nodriver.cdp.page.ShareTarget)]* *= None*
+#### share_target *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ShareTarget`](#nodriver.cdp.page.ShareTarget)]* *= None*
-#### short_name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### short_name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### shortcuts*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Shortcut`](#nodriver.cdp.page.Shortcut)]]* *= None*
+#### shortcuts *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`Shortcut`](#nodriver.cdp.page.Shortcut)]]* *= None*
-#### start_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### start_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### theme_color*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### theme_color *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* AutoResponseMode(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -1352,51 +1352,51 @@ Types of not restored reasons for back-forward cache.
### *class* BackForwardCacheBlockingDetails(line_number, column_number, url=None, function=None)
-#### line_number*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### line_number *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Line number in the script (0-based).
-#### column_number*: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### column_number *: [`int`](https://docs.python.org/3/library/functions.html#int)*
Column number in the script (0-based).
-#### url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Url of the file where blockage happened. Optional because of tests.
-#### function*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### function *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Function name where blockage happened. Optional because of anonymous functions and tests.
### *class* BackForwardCacheNotRestoredExplanation(type_, reason, context=None, details=None)
-#### type_*: [`BackForwardCacheNotRestoredReasonType`](#nodriver.cdp.page.BackForwardCacheNotRestoredReasonType)*
+#### type_ *: [`BackForwardCacheNotRestoredReasonType`](#nodriver.cdp.page.BackForwardCacheNotRestoredReasonType)*
Type of the reason
-#### reason*: [`BackForwardCacheNotRestoredReason`](#nodriver.cdp.page.BackForwardCacheNotRestoredReason)*
+#### reason *: [`BackForwardCacheNotRestoredReason`](#nodriver.cdp.page.BackForwardCacheNotRestoredReason)*
Not restored reason
-#### context*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### context *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Context associated with the reason. The meaning of this context is
dependent on the reason:
- EmbedderExtensionSentMessageToCachedFrame: the extension ID.
-#### details*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheBlockingDetails`](#nodriver.cdp.page.BackForwardCacheBlockingDetails)]]* *= None*
+#### details *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheBlockingDetails`](#nodriver.cdp.page.BackForwardCacheBlockingDetails)]]* *= None*
### *class* BackForwardCacheNotRestoredExplanationTree(url, explanations, children)
-#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
URL of each frame
-#### explanations*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheNotRestoredExplanation`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanation)]*
+#### explanations *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheNotRestoredExplanation`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanation)]*
Not restored reasons of each frame
-#### children*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheNotRestoredExplanationTree`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanationTree)]*
+#### children *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheNotRestoredExplanationTree`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanationTree)]*
Array of children frame
@@ -1449,9 +1449,9 @@ Evaluates given script in every frame upon creation (before loading frame’s sc
* **Parameters:**
* **source** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) –
- * **world_name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(EXPERIMENTAL)** *(Optional)* If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.
- * **include_command_line_api** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Specifies whether command line API should be available to the script, defaults to false.
- * **run_immediately** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* If true, runs the script immediately on existing execution contexts or worlds. Default: false.
+ * **world_name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(EXPERIMENTAL)** *(Optional)* If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.
+ * **include_command_line_api** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Specifies whether command line API should be available to the script, defaults to false.
+ * **run_immediately** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* If true, runs the script immediately on existing execution contexts or worlds. Default: false.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`ScriptIdentifier`](#nodriver.cdp.page.ScriptIdentifier)]
* **Returns:**
@@ -1469,12 +1469,12 @@ Brings page to front (activates tab).
Capture page screenshot.
* **Parameters:**
- * **format** – *(Optional)* Image compression format (defaults to png).
- * **quality** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Compression quality from range [0..100] (jpeg only).
- * **clip** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Viewport`](#nodriver.cdp.page.Viewport)]) – *(Optional)* Capture the screenshot of a given region only.
- * **from_surface** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Capture the screenshot from the surface, rather than the view. Defaults to true.
- * **capture_beyond_viewport** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Capture the screenshot beyond the viewport. Defaults to false.
- * **optimize_for_speed** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Optimize image encoding for speed, not for resulting size (defaults to false)
+ * **format** – *(Optional)* Image compression format (defaults to png).
+ * **quality** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Compression quality from range [0..100] (jpeg only).
+ * **clip** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Viewport`](#nodriver.cdp.page.Viewport)]) – *(Optional)* Capture the screenshot of a given region only.
+ * **from_surface** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Capture the screenshot from the surface, rather than the view. Defaults to true.
+ * **capture_beyond_viewport** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Capture the screenshot beyond the viewport. Defaults to false.
+ * **optimize_for_speed** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Optimize image encoding for speed, not for resulting size (defaults to false)
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`str`](https://docs.python.org/3/library/stdtypes.html#str)]
* **Returns:**
@@ -1488,7 +1488,7 @@ iframes, shadow DOM, external resources, and element-inline styles.
**EXPERIMENTAL**
* **Parameters:**
- **format** – *(Optional)* Format (defaults to mhtml).
+ **format** – *(Optional)* Format (defaults to mhtml).
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`str`](https://docs.python.org/3/library/stdtypes.html#str)]
* **Returns:**
@@ -1562,8 +1562,8 @@ Creates an isolated world for the given frame.
* **Parameters:**
* **frame_id** ([`FrameId`](#nodriver.cdp.page.FrameId)) – Id of the frame in which the isolated world should be created.
- * **world_name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* An optional name which is reported in the Execution Context.
- * **grant_univeral_access** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.
+ * **world_name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* An optional name which is reported in the Execution Context.
+ * **grant_univeral_access** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`ExecutionContextId`](runtime.md#nodriver.cdp.runtime.ExecutionContextId)]
* **Returns:**
@@ -1609,7 +1609,7 @@ Generates a report for testing.
* **Parameters:**
* **message** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Message to be displayed in the report.
- * **group** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Specifies the endpoint group to deliver the report to.
+ * **group** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Specifies the endpoint group to deliver the report to.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -1622,7 +1622,7 @@ Generates a report for testing.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AdScriptId`](#nodriver.cdp.page.AdScriptId)]]
* **Returns:**
- *(Optional)* Identifies the bottom-most script which caused the frame to be labelled as an ad. Only sent if frame is labelled as an ad and id is available.
+ *(Optional)* Identifies the bottom-most script which caused the frame to be labelled as an ad. Only sent if frame is labelled as an ad and id is available.
### get_app_id()
@@ -1635,8 +1635,8 @@ Only returns values if the feature flag ‘WebAppEnableManifestId’ is enabled
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Tuple`](https://docs.python.org/3/library/typing.html#typing.Tuple)[[`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)], [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]]
* **Returns:**
A tuple with the following items:
- 1. **appId** - *(Optional)* App id, either from manifest’s id attribute or computed from start_url
- 2. **recommendedId** - *(Optional)* Recommendation for manifest’s id attribute to match current id computed from start_url
+ 1. **appId** - *(Optional)* App id, either from manifest’s id attribute or computed from start_url
+ 2. **recommendedId** - *(Optional)* Recommendation for manifest’s id attribute to match current id computed from start_url
### get_app_manifest(manifest_id=None)
@@ -1649,15 +1649,15 @@ Gets the processed manifest for this current document.
If there is not a loaded page, this API errors out immediately.
* **Parameters:**
- **manifest_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)*
+ **manifest_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)*
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Tuple`](https://docs.python.org/3/library/typing.html#typing.Tuple)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AppManifestError`](#nodriver.cdp.page.AppManifestError)], [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)], [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`AppManifestParsedProperties`](#nodriver.cdp.page.AppManifestParsedProperties)], [`WebAppManifest`](#nodriver.cdp.page.WebAppManifest)]]
* **Returns:**
A tuple with the following items:
1. **url** - Manifest location.
2. **errors** -
- 3. **data** - *(Optional)* Manifest content.
- 4. **parsed** - *(Optional)* Parsed manifest properties. Deprecated, use manifest instead.
+ 3. **data** - *(Optional)* Manifest content.
+ 4. **parsed** - *(Optional)* Parsed manifest properties. Deprecated, use manifest instead.
5. **manifest** -
### get_frame_tree()
@@ -1776,7 +1776,7 @@ Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or o
* **Parameters:**
* **accept** ([`bool`](https://docs.python.org/3/library/functions.html#bool)) – Whether to accept or dismiss the dialog.
- * **prompt_text** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.
+ * **prompt_text** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`None`](https://docs.python.org/3/library/constants.html#None)]
@@ -1786,17 +1786,17 @@ Navigates current page to the given URL.
* **Parameters:**
* **url** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – URL to navigate the page to.
- * **referrer** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Referrer URL.
- * **transition_type** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TransitionType`](#nodriver.cdp.page.TransitionType)]) – *(Optional)* Intended transition type.
- * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](#nodriver.cdp.page.FrameId)]) – *(Optional)* Frame id to navigate, if not specified navigates the top frame.
- * **referrer_policy** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ReferrerPolicy`](#nodriver.cdp.page.ReferrerPolicy)]) – **(EXPERIMENTAL)** *(Optional)* Referrer-policy used for the navigation.
+ * **referrer** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Referrer URL.
+ * **transition_type** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TransitionType`](#nodriver.cdp.page.TransitionType)]) – *(Optional)* Intended transition type.
+ * **frame_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`FrameId`](#nodriver.cdp.page.FrameId)]) – *(Optional)* Frame id to navigate, if not specified navigates the top frame.
+ * **referrer_policy** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ReferrerPolicy`](#nodriver.cdp.page.ReferrerPolicy)]) – **(EXPERIMENTAL)** *(Optional)* Referrer-policy used for the navigation.
* **Return type:**
[`Generator`](https://docs.python.org/3/library/typing.html#typing.Generator)[[`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Dict`](https://docs.python.org/3/library/typing.html#typing.Dict)[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any)], [`Tuple`](https://docs.python.org/3/library/typing.html#typing.Tuple)[[`FrameId`](#nodriver.cdp.page.FrameId), [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`LoaderId`](network.md#nodriver.cdp.network.LoaderId)], [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]]]
* **Returns:**
A tuple with the following items:
1. **frameId** - Frame id that has navigated (or failed to navigate)
- 2. **loaderId** - *(Optional)* Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change.
- 3. **errorText** - *(Optional)* User friendly error message, present if and only if navigation has failed.
+ 2. **loaderId** - *(Optional)* Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change.
+ 3. **errorText** - *(Optional)* User friendly error message, present if and only if navigation has failed.
### navigate_to_history_entry(entry_id)
@@ -1812,29 +1812,29 @@ Navigates current page to the given history entry.
Print page as PDF.
* **Parameters:**
- * **landscape** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Paper orientation. Defaults to false.
- * **display_header_footer** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Display header and footer. Defaults to false.
- * **print_background** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Print background graphics. Defaults to false.
- * **scale** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Scale of the webpage rendering. Defaults to 1.
- * **paper_width** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Paper width in inches. Defaults to 8.5 inches.
- * **paper_height** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Paper height in inches. Defaults to 11 inches.
- * **margin_top** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Top margin in inches. Defaults to 1cm (~0.4 inches).
- * **margin_bottom** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Bottom margin in inches. Defaults to 1cm (~0.4 inches).
- * **margin_left** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Left margin in inches. Defaults to 1cm (~0.4 inches).
- * **margin_right** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Right margin in inches. Defaults to 1cm (~0.4 inches).
- * **page_ranges** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Paper ranges to print, one based, e.g., ‘1-5, 8, 11-13’. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.
- * **header_template** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - ``date```: formatted print date - ```title```: document title - ```url```: document location - ```pageNumber```: current page number - ```totalPages```: total pages in the document For example, ```