self._target = target
self.__count__ = itertools.count(0)
self._owner = _owner
-
self.websocket_url: str = websocket_url
self.websocket = None
self.mapper = {}
@@ -472,7 +471,6 @@ Source code for nodriver.core.connection
self.enabled_domains = []
self._last_result = []
self.listener: Listener = None
-
self.__dict__.update(**kwargs)
@property
@@ -513,10 +511,8 @@ Source code for nodriver.core.connection
page.add_handler(cdp.network.RequestWillBeSent, lambda event: print('network event => %s' % event.request))
-
the next time you make network traffic you will see your console print like crazy.
-
:param event_type_or_domain:
:type event_type_or_domain:
:param handler:
@@ -572,7 +568,6 @@ Source code for nodriver.core.connection
"""
closes the websocket connection. should not be called manually by users.
"""
-
if self.websocket and not self.websocket.closed:
if self.listener and self.listener.running:
self.listener.cancel()
@@ -586,9 +581,8 @@ Source code for nodriver.core.connection
async def wait(self, t: Union[int, float] = None):
"""
- waits until the event listener
- reports idle (which is when no new events had been received in .5 seconds
- or, 1 second when in interactive mode)
+ 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.
:param t:
:type t:
@@ -596,20 +590,23 @@ Source code for nodriver.core.connection
:rtype:
"""
await self.update_target()
-
+ loop = asyncio.get_running_loop()
+ start_time = loop.time()
try:
-
- await asyncio.wait_for(self.listener.idle.wait(), timeout=t)
+ if isinstance(t, (int, float)):
+ await asyncio.wait_for(self.listener.idle.wait(), timeout=t)
+ while (loop.time() - start_time) < t:
+ await asyncio.sleep(0.1)
+ else:
+ await self.listener.idle.wait()
except asyncio.TimeoutError:
- if t is not None:
+ if isinstance(t, (int, float)):
# explicit time is given, which is now passed
# so bail out early
return
except AttributeError:
# no listener created yet
pass
- if t is not None:
- await self.sleep(t)
def __getattr__(self, item):
""":meta private:"""
@@ -669,7 +666,6 @@ Source code for nodriver.core.connection
self.__count__ = itertools.count(0)
tx.id = next(self.__count__)
self.mapper.update({tx.id: tx})
-
if not _is_update:
await self._register_handlers()
await self.websocket.send(tx.message)
@@ -678,7 +674,6 @@ Source code for nodriver.core.connection
except ProtocolException as e:
e.message += f"\ncommand:{tx.method}\nparams:{tx.params}"
raise e
-
except Exception:
await self.aclose()
@@ -689,14 +684,12 @@ Source code for nodriver.core.connection
"""
seen = []
-
# save a copy of current enabled domains in a variable
# domains will be removed from this variable
# if it is still needed according to the set handlers
# so at the end this variable will hold the domains that
# are not represented by handlers, and can be removed
enabled_domains = self.enabled_domains.copy()
-
for event_type in self.handlers.copy():
domain_mod = None
if len(self.handlers[event_type]) == 0:
@@ -735,7 +728,6 @@ Source code for nodriver.core.connection
# we started with a copy of self.enabled_domains and removed a domain from this
# temp variable when we registered it or saw handlers for it.
# items still present at this point are unused and need removal
-
self.enabled_domains.remove(ed)
@@ -796,43 +788,45 @@ Source code for nodriver.core.connection
except asyncio.TimeoutError:
self.idle.set()
# breathe
- await asyncio.sleep(self.time_before_considered_idle / 10)
+ # await asyncio.sleep(self.time_before_considered_idle / 10)
continue
- except (Exception,):
+ except (Exception,) as e:
# break on any other exception
# which is mostly socket is closed or does not exist
# or is not allowed
+
+ logger.debug(
+ "connection listener exception while reading websocket:\n%s", e
+ )
break
- # async for msg in self.connection.websocket:
if not self.running:
+ # if we have been cancelled or otherwise stopped running
+ # break this loop
break
+
+ # since we are at this point, we are not "idle" anymore.
self.idle.clear()
+
message = json.loads(msg)
if "id" in message:
# response to our command
if message["id"] in self.connection.mapper:
- tx = self.connection.mapper[message["id"]]
+ # get the corresponding Transaction
+ tx = self.connection.mapper.pop(message["id"])
+ logger.debug("got answer for %s", tx)
+ # complete the transaction, which is a Future object
+ # and thus will return to anyone awaiting it.
tx(**message)
else:
# probably an event
try:
event = cdp.util.parse_json_event(message)
- # self.history.append(event)
event_tx = EventTransaction(event)
- # getattr(globals(), event.__class__.__module__)
if not self.connection.mapper:
self.connection.__count__ = itertools.count(0)
event_tx.id = next(self.connection.__count__)
self.connection.mapper[event_tx.id] = event_tx
- # while len(self.connection.mapper) > self.max_history:
- # for k,v in self.connection.mapper.copy().items():
- # # only remove old events
- # if type(v) is not Transaction:
- # self.connection.mapper.pop(k)
-
- # while len(self.history) >= self.max_history:
- # self.history.popleft()
except Exception as e:
logger.info(
"%s: %s during parsing of json from event : %s"
@@ -848,17 +842,14 @@ Source code for nodriver.core.connection
callbacks = self.connection.handlers[type(event)]
else:
continue
-
if not len(callbacks):
continue
-
for callback in callbacks:
try:
if iscoroutinefunction(callback) or iscoroutine(callback):
await callback(event)
else:
callback(event)
-
except Exception as e:
logger.warning(
"exception in callback %s for event %s => %s",
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
index a646355..0c122db 100644
--- a/docs/_build/html/genindex.html
+++ b/docs/_build/html/genindex.html
@@ -5563,6 +5563,8 @@ M
- MOUSE (GestureSourceType attribute)
- mouse_click() (Element method)
+
+ - mouse_drag() (Element method)
- mouse_move() (Element method)
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
index 0475f4d..59a16a4 100644
--- a/docs/_build/html/index.html
+++ b/docs/_build/html/index.html
@@ -451,6 +451,7 @@ Main objectsElement.get_position()
Element.mouse_click()Element.mouse_move()Element.mouse_drag()Element.scroll_into_view()Element.clear_input()Element.send_keys()
-
async save_to_dom()[source]#
-saves a screenshot of this element only
+
saves element to dom
:return:
:rtype:
@@ -438,7 +438,8 @@
+removes the element from dom
+
-
@@ -568,7 +569,7 @@
-
-async mouse_click(button='left', buttons=1, modifiers=0, _until_event=None)[source]#
+async mouse_click(button='left', buttons=1, modifiers=0, hold=False, _until_event=None)[source]#
native click (on element) . note: this likely does not work atm, use click() instead
- Parameters:
@@ -593,6 +594,29 @@
hover/mouseover effect, this would trigger it
+
+-
+async mouse_drag(destination, relative=False, steps=1)[source]#
+drag an element to another element or target coordinates. dragging of elements should be supported by the site of course
+
+- Parameters:
+
+destination (Element or coordinate as x,y tuple) – another element where to drag to, or a tuple (x,y) of ints representing coordinate
relative (bool) – when True, treats coordinate as relative. for example (-100, 200) will move left 100px and down 200px
steps (int) – move in <steps> points, this could make it look more “natural” (default 1),
+but also a lot slower.
+for very smooth action use 50-100
+- Returns:
+-
+
+- Return type:
+-
+
+
+
+
Element.get_position()Element.mouse_click()Element.mouse_move()Element.mouse_drag()Element.scroll_into_view()Element.clear_input()Element.send_keys()`.
@@ -1225,15 +1225,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.
@@ -1241,19 +1241,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 exchagne.
@@ -1293,7 +1293,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
@@ -1301,11 +1301,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)
@@ -1323,13 +1323,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)
@@ -1341,13 +1341,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)
@@ -1357,19 +1357,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)
@@ -1389,43 +1389,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.
@@ -1433,21 +1433,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.
@@ -1456,9 +1456,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
@@ -1554,13 +1554,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)]
@@ -1573,9 +1573,9 @@ Deletes browser cookies with matching name and url or domain/path pair.
* **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.
+ * **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.
* **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)]
@@ -1595,7 +1595,7 @@ 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.
+ * **connection_type** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ConnectionType`](#nodriver.cdp.network.ConnectionType)]) – *(Optional)* Connection type if known.
* **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)]
@@ -1604,9 +1604,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)]
@@ -1657,7 +1657,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:**
@@ -1709,7 +1709,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:**
@@ -1721,7 +1721,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:**
@@ -1750,8 +1750,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:**
@@ -1815,18 +1815,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)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(EXPERIMENTAL)** *(Optional)* Cookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. 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)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(EXPERIMENTAL)** *(Optional)* Cookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. 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:**
@@ -1874,9 +1874,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)]
@@ -1919,23 +1919,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)
@@ -1943,23 +1943,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.
@@ -1967,31 +1967,31 @@ 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)*
User friendly error message.
-#### 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.
@@ -1999,15 +1999,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.
@@ -2022,56 +2022,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.
@@ -2080,7 +2080,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.
@@ -2088,53 +2088,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.
@@ -2144,15 +2144,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.
@@ -2162,11 +2162,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.
@@ -2174,32 +2174,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.
@@ -2207,11 +2207,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.
@@ -2219,15 +2219,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.
@@ -2235,15 +2235,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.
@@ -2251,15 +2251,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.
@@ -2267,15 +2267,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.
@@ -2283,15 +2283,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.
@@ -2299,19 +2299,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.
@@ -2319,19 +2319,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.
@@ -2339,11 +2339,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.
@@ -2351,11 +2351,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.
@@ -2368,28 +2368,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)[[`BlockedCookieWithReason`](#nodriver.cdp.network.BlockedCookieWithReason)]*
+#### associated_cookies*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BlockedCookieWithReason`](#nodriver.cdp.network.BlockedCookieWithReason)]*
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 blockedReason 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.
@@ -2401,42 +2401,42 @@ 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)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### cookie_partition_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
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 serializeable to string.
@@ -2449,26 +2449,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.
@@ -2479,11 +2479,11 @@ The number of obtained Trust Tokens on a successful “Issuance” operation.
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.
@@ -2493,11 +2493,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
@@ -2508,15 +2508,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
@@ -2528,19 +2528,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
@@ -2553,20 +2553,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/page.md b/docs/_build/markdown/nodriver/cdp/page.md
index ea9127c..bed4132 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.
@@ -277,17 +277,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)
@@ -338,54 +338,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.
@@ -393,43 +393,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.
@@ -437,31 +437,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.
@@ -469,15 +469,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.
@@ -485,11 +485,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.
@@ -531,23 +531,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.
@@ -555,31 +555,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.
@@ -599,19 +599,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 criticial, 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.
@@ -619,7 +619,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
@@ -627,19 +627,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.
@@ -647,35 +647,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).
@@ -683,23 +683,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.
@@ -707,31 +707,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.
@@ -739,11 +739,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.
@@ -751,11 +751,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.
@@ -789,14 +789,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’).
@@ -807,11 +807,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’}).
@@ -844,11 +844,11 @@ 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).
@@ -1151,51 +1151,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
@@ -1248,9 +1248,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:**
@@ -1268,12 +1268,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:**
@@ -1287,7 +1287,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:**
@@ -1361,8 +1361,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:**
@@ -1408,7 +1408,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)]
@@ -1421,7 +1421,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()
@@ -1434,8 +1434,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()
@@ -1445,8 +1445,8 @@ Only returns values if the feature flag ‘WebAppEnableManifestId’ is enabled
A tuple with the following items:
1. **url** - Manifest location.
2. **errors** -
- 3. **data** - *(Optional)* Manifest content.
- 4. **parsed** - *(Optional)* Parsed manifest properties
+ 3. **data** - *(Optional)* Manifest content.
+ 4. **parsed** - *(Optional)* Parsed manifest properties
### get_frame_tree()
@@ -1564,7 +1564,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)]
@@ -1574,17 +1574,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)
@@ -1600,29 +1600,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, `````` would generate span containing the title.
- * **footer_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 footer. Should use the same format as the ```headerTemplate```.
- * **prefer_css_page_size** ([`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 to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.
- * **transfer_mode** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(EXPERIMENTAL)** *(Optional)* return as stream
- * **generate_tagged_pdf** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.
- * **generate_document_outline** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Whether or not to embed the document outline into the PDF.
+ * **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, `````` would generate span containing the title.
+ * **footer_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 footer. Should use the same format as the ```headerTemplate```.
+ * **prefer_css_page_size** ([`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 to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.
+ * **transfer_mode** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(EXPERIMENTAL)** *(Optional)* return as stream
+ * **generate_tagged_pdf** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.
+ * **generate_document_outline** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – **(EXPERIMENTAL)** *(Optional)* Whether or not to embed the document outline into the PDF.
* **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), [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamHandle`](io.md#nodriver.cdp.io.StreamHandle)]]]
* **Returns:**
A tuple with the following items:
1. **data** - Base64-encoded pdf data. Empty if \`\` returnAsStream\` is specified. (Encoded as a base64 string when passed over JSON)
- 2. **stream** - *(Optional)* A handle of the stream that holds resulting PDF data.
+ 2. **stream** - *(Optional)* A handle of the stream that holds resulting PDF data.
### produce_compilation_cache(scripts)
@@ -1645,8 +1645,8 @@ See also: `Page.compilationCacheProduced`.
Reloads given page optionally ignoring the cache.
* **Parameters:**
- * **ignore_cache** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, browser cache is ignored (as if the user pressed Shift+refresh).
- * **script_to_evaluate_on_load** ([`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 script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.
+ * **ignore_cache** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If true, browser cache is ignored (as if the user pressed Shift+refresh).
+ * **script_to_evaluate_on_load** ([`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 script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.
* **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)]
@@ -1704,8 +1704,8 @@ Searches for given string in resource content.
* **frame_id** ([`FrameId`](#nodriver.cdp.page.FrameId)) – Frame id for resource to search in.
* **url** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – URL of the resource to search in.
* **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:**
@@ -1747,14 +1747,14 @@ Deprecated since version 1.3.
* **height** ([`int`](https://docs.python.org/3/library/functions.html#int)) – Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
* **device_scale_factor** ([`float`](https://docs.python.org/3/library/functions.html#float)) – Overriding device scale factor value. 0 disables the override.
* **mobile** ([`bool`](https://docs.python.org/3/library/functions.html#bool)) – Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.
- * **scale** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Scale to apply to resulting view image.
- * **screen_width** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding screen width value in pixels (minimum 0, maximum 10000000).
- * **screen_height** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding screen height value in pixels (minimum 0, maximum 10000000).
- * **position_x** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
- * **position_y** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
- * **dont_set_visible_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Do not set visible view size, rely upon explicit setVisibleSize call.
- * **screen_orientation** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ScreenOrientation`](emulation.md#nodriver.cdp.emulation.ScreenOrientation)]) – *(Optional)* Screen orientation override.
- * **viewport** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Viewport`](#nodriver.cdp.page.Viewport)]) – *(Optional)* The viewport dimensions and scale. If not set, the override is cleared.
+ * **scale** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Scale to apply to resulting view image.
+ * **screen_width** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding screen width value in pixels (minimum 0, maximum 10000000).
+ * **screen_height** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding screen height value in pixels (minimum 0, maximum 10000000).
+ * **position_x** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
+ * **position_y** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
+ * **dont_set_visible_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Do not set visible view size, rely upon explicit setVisibleSize call.
+ * **screen_orientation** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`ScreenOrientation`](emulation.md#nodriver.cdp.emulation.ScreenOrientation)]) – *(Optional)* Screen orientation override.
+ * **viewport** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Viewport`](#nodriver.cdp.page.Viewport)]) – *(Optional)* The viewport dimensions and scale. If not set, the override is cleared.
* **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)]
@@ -1801,7 +1801,7 @@ Deprecated since version 1.3.
* **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).
- * **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’
+ * **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’
* **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)]
@@ -1816,7 +1816,7 @@ Set generic font families.
* **Parameters:**
* **font_families** ([`FontFamilies`](#nodriver.cdp.page.FontFamilies)) – Specifies font families to set. If a font family is not specified, it won’t be changed.
- * **for_scripts** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ScriptFontFamilies`](#nodriver.cdp.page.ScriptFontFamilies)]]) – *(Optional)* Specifies font families to set for individual scripts.
+ * **for_scripts** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`ScriptFontFamilies`](#nodriver.cdp.page.ScriptFontFamilies)]]) – *(Optional)* Specifies font families to set for individual scripts.
* **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)]
@@ -1840,9 +1840,9 @@ unavailable.
Deprecated since version 1.3.
* **Parameters:**
- * **latitude** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Mock latitude
- * **longitude** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Mock longitude
- * **accuracy** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Mock accuracy
+ * **latitude** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Mock latitude
+ * **longitude** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Mock longitude
+ * **accuracy** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* Mock accuracy
* **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)]
@@ -1921,7 +1921,7 @@ Deprecated since version 1.3.
* **Parameters:**
* **enabled** ([`bool`](https://docs.python.org/3/library/functions.html#bool)) – Whether the touch event emulation should be enabled.
- * **configuration** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Touch/gesture events configuration. Default: current platform.
+ * **configuration** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Touch/gesture events configuration. Default: current platform.
* **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)]
@@ -1948,11 +1948,11 @@ Starts sending each frame using the `screencastFrame` event.
**EXPERIMENTAL**
* **Parameters:**
- * **format** – *(Optional)* Image compression format.
- * **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].
- * **max_width** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Maximum screenshot width.
- * **max_height** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Maximum screenshot height.
- * **every_nth_frame** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Send every n-th frame.
+ * **format** – *(Optional)* Image compression format.
+ * **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].
+ * **max_width** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Maximum screenshot width.
+ * **max_height** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Maximum screenshot height.
+ * **every_nth_frame** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]) – *(Optional)* Send every n-th frame.
* **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)]
@@ -1989,21 +1989,21 @@ you use the event’s attributes.
### *class* DomContentEventFired(timestamp)
-#### timestamp *: [`MonotonicTime`](network.md#nodriver.cdp.network.MonotonicTime)*
+#### timestamp*: [`MonotonicTime`](network.md#nodriver.cdp.network.MonotonicTime)*
### *class* FileChooserOpened(frame_id, mode, backend_node_id)
Emitted only when `page.interceptFileChooser` is enabled.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame containing input node.
-#### mode *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### mode*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Input mode.
-#### backend_node_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]*
+#### backend_node_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackendNodeId`](dom.md#nodriver.cdp.dom.BackendNodeId)]*
Input node id. Only present for file choosers opened via an `` element.
@@ -2011,15 +2011,15 @@ Input node id. Only present for file choosers opened via an `
Fired when frame has been attached to its parent.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that has been attached.
-#### parent_frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### parent_frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Parent frame identifier.
-#### stack *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StackTrace`](runtime.md#nodriver.cdp.runtime.StackTrace)]*
+#### stack*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StackTrace`](runtime.md#nodriver.cdp.runtime.StackTrace)]*
JavaScript stack trace of when frame was attached, only set if frame initiated from script.
@@ -2030,7 +2030,7 @@ Fired when frame no longer has a scheduled navigation.
#### Deprecated
Deprecated since version 1.3.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that has cleared its scheduled navigation.
@@ -2038,21 +2038,21 @@ Id of the frame that has cleared its scheduled navigation.
Fired when frame has been detached from its parent.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that has been detached.
-#### reason *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### reason*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* FrameNavigated(frame, type_)
Fired once navigation of the frame has completed. Frame is now associated with the new loader.
-#### frame *: [`Frame`](#nodriver.cdp.page.Frame)*
+#### frame*: [`Frame`](#nodriver.cdp.page.Frame)*
Frame object.
-#### type_ *: [`NavigationType`](#nodriver.cdp.page.NavigationType)*
+#### type_*: [`NavigationType`](#nodriver.cdp.page.NavigationType)*
### *class* DocumentOpened(frame)
@@ -2060,7 +2060,7 @@ Frame object.
Fired when opening document to write to.
-#### frame *: [`Frame`](#nodriver.cdp.page.Frame)*
+#### frame*: [`Frame`](#nodriver.cdp.page.Frame)*
Frame object.
@@ -2075,19 +2075,19 @@ Frame object.
Fired when a renderer-initiated navigation is requested.
Navigation may still be cancelled after the event is issued.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that is being navigated.
-#### reason *: [`ClientNavigationReason`](#nodriver.cdp.page.ClientNavigationReason)*
+#### reason*: [`ClientNavigationReason`](#nodriver.cdp.page.ClientNavigationReason)*
The reason for the navigation.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The destination URL for the requested navigation.
-#### disposition *: [`ClientNavigationDisposition`](#nodriver.cdp.page.ClientNavigationDisposition)*
+#### disposition*: [`ClientNavigationDisposition`](#nodriver.cdp.page.ClientNavigationDisposition)*
The disposition for the navigation.
@@ -2098,20 +2098,20 @@ Fired when frame schedules a potential navigation.
#### Deprecated
Deprecated since version 1.3.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that has scheduled a navigation.
-#### delay *: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### delay*: [`float`](https://docs.python.org/3/library/functions.html#float)*
Delay (in seconds) until the navigation is scheduled to begin. The navigation is not
guaranteed to start.
-#### reason *: [`ClientNavigationReason`](#nodriver.cdp.page.ClientNavigationReason)*
+#### reason*: [`ClientNavigationReason`](#nodriver.cdp.page.ClientNavigationReason)*
The reason for the navigation.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The destination URL for the scheduled navigation.
@@ -2121,7 +2121,7 @@ The destination URL for the scheduled navigation.
Fired when frame has started loading.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that has started loading.
@@ -2131,7 +2131,7 @@ Id of the frame that has started loading.
Fired when frame has stopped loading.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that has stopped loading.
@@ -2145,19 +2145,19 @@ Deprecated. Use Browser.downloadWillBegin instead.
#### Deprecated
Deprecated since version 1.3.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame that caused 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).
@@ -2171,19 +2171,19 @@ Deprecated. Use Browser.downloadProgress instead.
#### Deprecated
Deprecated since version 1.3.
-#### 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.
@@ -2200,11 +2200,11 @@ Fired when interstitial page was shown
Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
closed.
-#### result *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### result*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether dialog was confirmed.
-#### user_input *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### user_input*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
User input in case of prompt.
@@ -2213,25 +2213,25 @@ User input in case of prompt.
Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
open.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Frame url.
-#### message *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### message*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Message that will be displayed by the dialog.
-#### type_ *: [`DialogType`](#nodriver.cdp.page.DialogType)*
+#### type_*: [`DialogType`](#nodriver.cdp.page.DialogType)*
Dialog type.
-#### has_browser_handler *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### has_browser_handler*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
True iff browser is capable showing or acting on the given dialog. When browser has no
dialog handler for given target, calling alert while Page domain is engaged will stall
the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
-#### default_prompt *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### default_prompt*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
Default dialog prompt.
@@ -2239,17 +2239,17 @@ Default dialog prompt.
Fired for top level page lifecycle events such as navigation, load, paint, etc.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame.
-#### loader_id *: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
+#### loader_id*: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
Loader identifier. Empty string if the request is fetched from worker.
-#### name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### timestamp *: [`MonotonicTime`](network.md#nodriver.cdp.network.MonotonicTime)*
+#### timestamp*: [`MonotonicTime`](network.md#nodriver.cdp.network.MonotonicTime)*
### *class* BackForwardCacheNotUsed(loader_id, frame_id, not_restored_explanations, not_restored_explanations_tree)
@@ -2260,25 +2260,25 @@ not assume any ordering with the Page.frameNavigated event. This event is fired
main-frame history navigation where the document changes (non-same-document navigations),
when bfcache navigation fails.
-#### loader_id *: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
+#### loader_id*: [`LoaderId`](network.md#nodriver.cdp.network.LoaderId)*
The loader id for the associated navgation.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
The frame id of the associated frame.
-#### not_restored_explanations *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheNotRestoredExplanation`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanation)]*
+#### not_restored_explanations*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`BackForwardCacheNotRestoredExplanation`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanation)]*
Array of reasons why the page could not be cached. This must not be empty.
-#### not_restored_explanations_tree *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackForwardCacheNotRestoredExplanationTree`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanationTree)]*
+#### not_restored_explanations_tree*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BackForwardCacheNotRestoredExplanationTree`](#nodriver.cdp.page.BackForwardCacheNotRestoredExplanationTree)]*
Tree structure of reasons why the page could not be cached for each frame.
### *class* LoadEventFired(timestamp)
-#### timestamp *: [`MonotonicTime`](network.md#nodriver.cdp.network.MonotonicTime)*
+#### timestamp*: [`MonotonicTime`](network.md#nodriver.cdp.network.MonotonicTime)*
### *class* NavigatedWithinDocument(frame_id, url)
@@ -2286,11 +2286,11 @@ Tree structure of reasons why the page could not be cached for each frame.
Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
-#### frame_id *: [`FrameId`](#nodriver.cdp.page.FrameId)*
+#### frame_id*: [`FrameId`](#nodriver.cdp.page.FrameId)*
Id of the frame.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Frame’s new url.
@@ -2300,15 +2300,15 @@ Frame’s new url.
Compressed image data requested by the `startScreencast`.
-#### data *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### data*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Base64-encoded compressed image. (Encoded as a base64 string when passed over JSON)
-#### metadata *: [`ScreencastFrameMetadata`](#nodriver.cdp.page.ScreencastFrameMetadata)*
+#### metadata*: [`ScreencastFrameMetadata`](#nodriver.cdp.page.ScreencastFrameMetadata)*
Screencast frame metadata.
-#### session_id *: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### session_id*: [`int`](https://docs.python.org/3/library/functions.html#int)*
Frame number.
@@ -2318,7 +2318,7 @@ Frame number.
Fired when the page with currently enabled screencast was shown or hidden .
-#### visible *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### visible*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
True if the page is visible.
@@ -2327,19 +2327,19 @@ True if the page is visible.
Fired when a new window is going to be opened, via window.open(), link click, form submission,
etc.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The URL for the new window.
-#### window_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### window_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Window name.
-#### window_features *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### window_features*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
An array of enabled window features.
-#### user_gesture *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### user_gesture*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Whether or not it was triggered by user gesture.
@@ -2350,8 +2350,8 @@ Whether or not it was triggered by user gesture.
Issued for every compilation cache generated. Is only available
if Page.setGenerateCompilationCache is enabled.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### data *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### data*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Base64-encoded data (Encoded as a base64 string when passed over JSON)
diff --git a/docs/_build/markdown/nodriver/cdp/storage.md b/docs/_build/markdown/nodriver/cdp/storage.md
index dc033c1..43fc698 100644
--- a/docs/_build/markdown/nodriver/cdp/storage.md
+++ b/docs/_build/markdown/nodriver/cdp/storage.md
@@ -52,11 +52,11 @@ Enum of possible storage types.
Usage for a storage type.
-#### storage_type *: [`StorageType`](#nodriver.cdp.storage.StorageType)*
+#### storage_type*: [`StorageType`](#nodriver.cdp.storage.StorageType)*
Name of storage type.
-#### usage *: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### usage*: [`float`](https://docs.python.org/3/library/functions.html#float)*
Storage usage (bytes).
@@ -65,9 +65,9 @@ Storage usage (bytes).
Pair of issuer origin and number of available (signed, but not used) Trust
Tokens from that issuer.
-#### issuer_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### issuer_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### count *: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### count*: [`float`](https://docs.python.org/3/library/functions.html#float)*
### *class* InterestGroupAccessType(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -95,37 +95,37 @@ Enum of interest group access types.
Ad advertising element inside an interest group.
-#### render_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### render_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### metadata *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### metadata*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* InterestGroupDetails(owner_origin, name, expiration_time, joining_origin, trusted_bidding_signals_keys, ads, ad_components, bidding_logic_url=None, bidding_wasm_helper_url=None, update_url=None, trusted_bidding_signals_url=None, user_bidding_signals=None)
The full details of an interest group.
-#### owner_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### owner_origin*: [`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)*
-#### expiration_time *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### expiration_time*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
-#### joining_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### joining_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### trusted_bidding_signals_keys *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### trusted_bidding_signals_keys*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
-#### ads *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`InterestGroupAd`](#nodriver.cdp.storage.InterestGroupAd)]*
+#### ads*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`InterestGroupAd`](#nodriver.cdp.storage.InterestGroupAd)]*
-#### ad_components *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`InterestGroupAd`](#nodriver.cdp.storage.InterestGroupAd)]*
+#### ad_components*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`InterestGroupAd`](#nodriver.cdp.storage.InterestGroupAd)]*
-#### bidding_logic_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### bidding_logic_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### bidding_wasm_helper_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### bidding_wasm_helper_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### update_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### update_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### trusted_bidding_signals_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### trusted_bidding_signals_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### user_bidding_signals *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### user_bidding_signals*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* SharedStorageAccessType(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -167,37 +167,37 @@ Enum of shared storage access types.
Struct for a single key-value pair in an origin’s shared storage.
-#### 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* SharedStorageMetadata(creation_time, length, remaining_budget)
Details for an origin’s shared storage.
-#### creation_time *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### creation_time*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
-#### length *: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### length*: [`int`](https://docs.python.org/3/library/functions.html#int)*
-#### remaining_budget *: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### remaining_budget*: [`float`](https://docs.python.org/3/library/functions.html#float)*
### *class* SharedStorageReportingMetadata(event_type, reporting_url)
Pair of reporting metadata details for a candidate URL for `selectURL()`.
-#### event_type *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### event_type*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### reporting_url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### reporting_url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* SharedStorageUrlWithMetadata(url, reporting_metadata)
Bundles a candidate URL with its reporting metadata.
-#### url *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### url*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Spec of candidate URL.
-#### reporting_metadata *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SharedStorageReportingMetadata`](#nodriver.cdp.storage.SharedStorageReportingMetadata)]*
+#### reporting_metadata*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SharedStorageReportingMetadata`](#nodriver.cdp.storage.SharedStorageReportingMetadata)]*
Any associated reporting metadata.
@@ -206,29 +206,29 @@ Any associated reporting metadata.
Bundles the parameters for shared storage access events whose
presence/absence can vary according to SharedStorageAccessType.
-#### script_source_url *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### script_source_url*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Spec of the module script URL.
Present only for SharedStorageAccessType.documentAddModule.
-#### operation_name *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### operation_name*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Name of the registered operation to be run.
Present only for SharedStorageAccessType.documentRun and
SharedStorageAccessType.documentSelectURL.
-#### serialized_data *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### serialized_data*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The operation’s serialized data in bytes (converted to a string).
Present only for SharedStorageAccessType.documentRun and
SharedStorageAccessType.documentSelectURL.
-#### urls_with_metadata *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SharedStorageUrlWithMetadata`](#nodriver.cdp.storage.SharedStorageUrlWithMetadata)]]* *= None*
+#### urls_with_metadata*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`SharedStorageUrlWithMetadata`](#nodriver.cdp.storage.SharedStorageUrlWithMetadata)]]* *= None*
Array of candidate URLs’ specs, along with any associated metadata.
Present only for SharedStorageAccessType.documentSelectURL.
-#### key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Key for a specific entry in an origin’s shared storage.
Present only for SharedStorageAccessType.documentSet,
@@ -239,7 +239,7 @@ SharedStorageAccessType.workletAppend,
SharedStorageAccessType.workletDelete, and
SharedStorageAccessType.workletGet.
-#### value *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### value*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Value for a specific entry in an origin’s shared storage.
Present only for SharedStorageAccessType.documentSet,
@@ -247,7 +247,7 @@ SharedStorageAccessType.documentAppend,
SharedStorageAccessType.workletSet, and
SharedStorageAccessType.workletAppend.
-#### ignore_if_present *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### ignore_if_present*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Whether or not to set an entry for a key if that key is already present.
Present only for SharedStorageAccessType.documentSet and
@@ -261,27 +261,27 @@ SharedStorageAccessType.workletSet.
### *class* StorageBucket(storage_key, name=None)
-#### storage_key *: [`SerializedStorageKey`](#nodriver.cdp.storage.SerializedStorageKey)*
+#### storage_key*: [`SerializedStorageKey`](#nodriver.cdp.storage.SerializedStorageKey)*
-#### 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*
If not specified, it is the default bucket of the storageKey.
### *class* StorageBucketInfo(bucket, id_, expiration, quota, persistent, durability)
-#### bucket *: [`StorageBucket`](#nodriver.cdp.storage.StorageBucket)*
+#### bucket*: [`StorageBucket`](#nodriver.cdp.storage.StorageBucket)*
-#### id_ *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### id_*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### expiration *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### expiration*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
-#### quota *: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### quota*: [`float`](https://docs.python.org/3/library/functions.html#float)*
Storage quota (bytes).
-#### persistent *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### persistent*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### durability *: [`StorageBucketsDurability`](#nodriver.cdp.storage.StorageBucketsDurability)*
+#### durability*: [`StorageBucketsDurability`](#nodriver.cdp.storage.StorageBucketsDurability)*
### *class* AttributionReportingSourceType(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -297,48 +297,48 @@ Storage quota (bytes).
### *class* AttributionReportingFilterDataEntry(key, values)
-#### key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### values *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### values*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
### *class* AttributionReportingFilterConfig(filter_values, lookback_window=None)
-#### filter_values *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterDataEntry`](#nodriver.cdp.storage.AttributionReportingFilterDataEntry)]*
+#### filter_values*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterDataEntry`](#nodriver.cdp.storage.AttributionReportingFilterDataEntry)]*
-#### lookback_window *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
+#### lookback_window*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`int`](https://docs.python.org/3/library/functions.html#int)]* *= None*
duration in seconds
### *class* AttributionReportingFilterPair(filters, not_filters)
-#### filters *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterConfig`](#nodriver.cdp.storage.AttributionReportingFilterConfig)]*
+#### filters*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterConfig`](#nodriver.cdp.storage.AttributionReportingFilterConfig)]*
-#### not_filters *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterConfig`](#nodriver.cdp.storage.AttributionReportingFilterConfig)]*
+#### not_filters*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterConfig`](#nodriver.cdp.storage.AttributionReportingFilterConfig)]*
### *class* AttributionReportingAggregationKeysEntry(key, value)
-#### key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### value *: [`UnsignedInt128AsBase16`](#nodriver.cdp.storage.UnsignedInt128AsBase16)*
+#### value*: [`UnsignedInt128AsBase16`](#nodriver.cdp.storage.UnsignedInt128AsBase16)*
### *class* AttributionReportingEventReportWindows(start, ends)
-#### start *: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### start*: [`int`](https://docs.python.org/3/library/functions.html#int)*
duration in seconds
-#### ends *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
+#### ends*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`int`](https://docs.python.org/3/library/functions.html#int)]*
duration in seconds
### *class* AttributionReportingTriggerSpec(trigger_data, event_report_windows)
-#### trigger_data *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
+#### trigger_data*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
number instead of integer because not all uint32 can be represented by
int
-#### event_report_windows *: [`AttributionReportingEventReportWindows`](#nodriver.cdp.storage.AttributionReportingEventReportWindows)*
+#### event_report_windows*: [`AttributionReportingEventReportWindows`](#nodriver.cdp.storage.AttributionReportingEventReportWindows)*
### *class* AttributionReportingTriggerDataMatching(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -348,37 +348,37 @@ int
### *class* AttributionReportingSourceRegistration(time, expiry, trigger_specs, aggregatable_report_window, type_, source_origin, reporting_origin, destination_sites, event_id, priority, filter_data, aggregation_keys, trigger_data_matching, debug_key=None)
-#### time *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### time*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
-#### expiry *: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### expiry*: [`int`](https://docs.python.org/3/library/functions.html#int)*
duration in seconds
-#### trigger_specs *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingTriggerSpec`](#nodriver.cdp.storage.AttributionReportingTriggerSpec)]*
+#### trigger_specs*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingTriggerSpec`](#nodriver.cdp.storage.AttributionReportingTriggerSpec)]*
-#### aggregatable_report_window *: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### aggregatable_report_window*: [`int`](https://docs.python.org/3/library/functions.html#int)*
duration in seconds
-#### type_ *: [`AttributionReportingSourceType`](#nodriver.cdp.storage.AttributionReportingSourceType)*
+#### type_*: [`AttributionReportingSourceType`](#nodriver.cdp.storage.AttributionReportingSourceType)*
-#### source_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### source_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### reporting_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### reporting_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### destination_sites *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### destination_sites*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
-#### event_id *: [`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)*
+#### event_id*: [`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)*
-#### priority *: [`SignedInt64AsBase10`](#nodriver.cdp.storage.SignedInt64AsBase10)*
+#### priority*: [`SignedInt64AsBase10`](#nodriver.cdp.storage.SignedInt64AsBase10)*
-#### filter_data *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterDataEntry`](#nodriver.cdp.storage.AttributionReportingFilterDataEntry)]*
+#### filter_data*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingFilterDataEntry`](#nodriver.cdp.storage.AttributionReportingFilterDataEntry)]*
-#### aggregation_keys *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregationKeysEntry`](#nodriver.cdp.storage.AttributionReportingAggregationKeysEntry)]*
+#### aggregation_keys*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregationKeysEntry`](#nodriver.cdp.storage.AttributionReportingAggregationKeysEntry)]*
-#### trigger_data_matching *: [`AttributionReportingTriggerDataMatching`](#nodriver.cdp.storage.AttributionReportingTriggerDataMatching)*
+#### trigger_data_matching*: [`AttributionReportingTriggerDataMatching`](#nodriver.cdp.storage.AttributionReportingTriggerDataMatching)*
-#### debug_key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
+#### debug_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
### *class* AttributionReportingSourceRegistrationResult(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -414,58 +414,58 @@ duration in seconds
### *class* AttributionReportingAggregatableValueEntry(key, value)
-#### key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### value *: [`float`](https://docs.python.org/3/library/functions.html#float)*
+#### value*: [`float`](https://docs.python.org/3/library/functions.html#float)*
number instead of integer because not all uint32 can be represented by
int
### *class* AttributionReportingEventTriggerData(data, priority, filters, dedup_key=None)
-#### data *: [`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)*
+#### data*: [`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)*
-#### priority *: [`SignedInt64AsBase10`](#nodriver.cdp.storage.SignedInt64AsBase10)*
+#### priority*: [`SignedInt64AsBase10`](#nodriver.cdp.storage.SignedInt64AsBase10)*
-#### filters *: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
+#### filters*: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
-#### dedup_key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
+#### dedup_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
### *class* AttributionReportingAggregatableTriggerData(key_piece, source_keys, filters)
-#### key_piece *: [`UnsignedInt128AsBase16`](#nodriver.cdp.storage.UnsignedInt128AsBase16)*
+#### key_piece*: [`UnsignedInt128AsBase16`](#nodriver.cdp.storage.UnsignedInt128AsBase16)*
-#### source_keys *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
+#### source_keys*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]*
-#### filters *: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
+#### filters*: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
### *class* AttributionReportingAggregatableDedupKey(filters, dedup_key=None)
-#### filters *: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
+#### filters*: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
-#### dedup_key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
+#### dedup_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
### *class* AttributionReportingTriggerRegistration(filters, aggregatable_dedup_keys, event_trigger_data, aggregatable_trigger_data, aggregatable_values, debug_reporting, source_registration_time_config, debug_key=None, aggregation_coordinator_origin=None, trigger_context_id=None)
-#### filters *: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
+#### filters*: [`AttributionReportingFilterPair`](#nodriver.cdp.storage.AttributionReportingFilterPair)*
-#### aggregatable_dedup_keys *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregatableDedupKey`](#nodriver.cdp.storage.AttributionReportingAggregatableDedupKey)]*
+#### aggregatable_dedup_keys*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregatableDedupKey`](#nodriver.cdp.storage.AttributionReportingAggregatableDedupKey)]*
-#### event_trigger_data *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingEventTriggerData`](#nodriver.cdp.storage.AttributionReportingEventTriggerData)]*
+#### event_trigger_data*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingEventTriggerData`](#nodriver.cdp.storage.AttributionReportingEventTriggerData)]*
-#### aggregatable_trigger_data *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregatableTriggerData`](#nodriver.cdp.storage.AttributionReportingAggregatableTriggerData)]*
+#### aggregatable_trigger_data*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregatableTriggerData`](#nodriver.cdp.storage.AttributionReportingAggregatableTriggerData)]*
-#### aggregatable_values *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregatableValueEntry`](#nodriver.cdp.storage.AttributionReportingAggregatableValueEntry)]*
+#### aggregatable_values*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`AttributionReportingAggregatableValueEntry`](#nodriver.cdp.storage.AttributionReportingAggregatableValueEntry)]*
-#### debug_reporting *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### debug_reporting*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### source_registration_time_config *: [`AttributionReportingSourceRegistrationTimeConfig`](#nodriver.cdp.storage.AttributionReportingSourceRegistrationTimeConfig)*
+#### source_registration_time_config*: [`AttributionReportingSourceRegistrationTimeConfig`](#nodriver.cdp.storage.AttributionReportingSourceRegistrationTimeConfig)*
-#### debug_key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
+#### debug_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`UnsignedInt64AsBase10`](#nodriver.cdp.storage.UnsignedInt64AsBase10)]* *= None*
-#### aggregation_coordinator_origin *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### aggregation_coordinator_origin*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
-#### trigger_context_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### trigger_context_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
### *class* AttributionReportingEventLevelResult(value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
@@ -553,7 +553,7 @@ to. For more information, see
Clears cookies.
* **Parameters:**
- **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](browser.md#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Browser context to use when called on the browser endpoint.
+ **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](browser.md#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Browser context to use when called on the browser endpoint.
* **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)]
@@ -630,7 +630,7 @@ Deletes the Storage Bucket with the given storage key and bucket name.
Returns all browser cookies.
* **Parameters:**
- **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](browser.md#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Browser context to use when called on the browser endpoint.
+ **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](browser.md#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Browser context to use when called on the browser endpoint.
* **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`](network.md#nodriver.cdp.network.Cookie)]]
* **Returns:**
@@ -717,7 +717,7 @@ Override quota for the specified origin
* **Parameters:**
* **origin** ([`str`](https://docs.python.org/3/library/stdtypes.html#str)) – Security origin.
- * **quota_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).
+ * **quota_size** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).
* **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)]
@@ -770,7 +770,7 @@ Sets given cookies.
* **Parameters:**
* **cookies** ([`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`CookieParam`](network.md#nodriver.cdp.network.CookieParam)]) – Cookies to be set.
- * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](browser.md#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Browser context to use when called on the browser endpoint.
+ * **browser_context_id** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`BrowserContextID`](browser.md#nodriver.cdp.browser.BrowserContextID)]) – *(Optional)* Browser context to use when called on the browser endpoint.
* **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)]
@@ -795,7 +795,7 @@ Sets entry with `key` and `value` for a given origin’s shared storage.
* **owner_origin** ([`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)) –
- * **ignore_if_present** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If ``ignoreIfPresent``` is included and true, then only sets the entry if ```key`` doesn’t already exist.
+ * **ignore_if_present** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If ``ignoreIfPresent``` is included and true, then only sets the entry if ```key`` doesn’t already exist.
* **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)]
@@ -904,19 +904,19 @@ you use the event’s attributes.
A cache’s contents have been modified.
-#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Origin to update.
-#### 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 to update.
-#### bucket_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### bucket_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Storage bucket to update.
-#### cache_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### cache_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Name of cache in origin.
@@ -924,15 +924,15 @@ Name of cache in origin.
A cache has been added/deleted.
-#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Origin to update.
-#### 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 to update.
-#### bucket_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### bucket_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Storage bucket to update.
@@ -940,23 +940,23 @@ Storage bucket to update.
The origin’s IndexedDB object store has been modified.
-#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Origin to update.
-#### 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 to update.
-#### bucket_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### bucket_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Storage bucket to update.
-#### database_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### database_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Database to update.
-#### object_store_name *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### object_store_name*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
ObjectStore to update.
@@ -964,15 +964,15 @@ ObjectStore to update.
The origin’s IndexedDB database list has been modified.
-#### origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Origin to update.
-#### 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 to update.
-#### bucket_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### bucket_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Storage bucket to update.
@@ -980,62 +980,62 @@ Storage bucket to update.
One of the interest groups was accessed by the associated page.
-#### access_time *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### access_time*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
-#### type_ *: [`InterestGroupAccessType`](#nodriver.cdp.storage.InterestGroupAccessType)*
+#### type_*: [`InterestGroupAccessType`](#nodriver.cdp.storage.InterestGroupAccessType)*
-#### owner_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### owner_origin*: [`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)*
### *class* SharedStorageAccessed(access_time, type_, main_frame_id, owner_origin, params)
Shared storage was accessed by the associated page.
The following parameters are included in all events.
-#### access_time *: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
+#### access_time*: [`TimeSinceEpoch`](network.md#nodriver.cdp.network.TimeSinceEpoch)*
Time of the access.
-#### type_ *: [`SharedStorageAccessType`](#nodriver.cdp.storage.SharedStorageAccessType)*
+#### type_*: [`SharedStorageAccessType`](#nodriver.cdp.storage.SharedStorageAccessType)*
Enum value indicating the Shared Storage API method invoked.
-#### main_frame_id *: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
+#### main_frame_id*: [`FrameId`](page.md#nodriver.cdp.page.FrameId)*
DevTools Frame Token for the primary frame tree’s root.
-#### owner_origin *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### owner_origin*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
Serialized origin for the context that invoked the Shared Storage API.
-#### params *: [`SharedStorageAccessParams`](#nodriver.cdp.storage.SharedStorageAccessParams)*
+#### params*: [`SharedStorageAccessParams`](#nodriver.cdp.storage.SharedStorageAccessParams)*
The sub-parameters warapped by `params` are all optional and their
presence/absence depends on `type`.
### *class* StorageBucketCreatedOrUpdated(bucket_info)
-#### bucket_info *: [`StorageBucketInfo`](#nodriver.cdp.storage.StorageBucketInfo)*
+#### bucket_info*: [`StorageBucketInfo`](#nodriver.cdp.storage.StorageBucketInfo)*
### *class* StorageBucketDeleted(bucket_id)
-#### bucket_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### bucket_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
### *class* AttributionReportingSourceRegistered(registration, result)
**EXPERIMENTAL**
-#### registration *: [`AttributionReportingSourceRegistration`](#nodriver.cdp.storage.AttributionReportingSourceRegistration)*
+#### registration*: [`AttributionReportingSourceRegistration`](#nodriver.cdp.storage.AttributionReportingSourceRegistration)*
-#### result *: [`AttributionReportingSourceRegistrationResult`](#nodriver.cdp.storage.AttributionReportingSourceRegistrationResult)*
+#### result*: [`AttributionReportingSourceRegistrationResult`](#nodriver.cdp.storage.AttributionReportingSourceRegistrationResult)*
### *class* AttributionReportingTriggerRegistered(registration, event_level, aggregatable)
**EXPERIMENTAL**
-#### registration *: [`AttributionReportingTriggerRegistration`](#nodriver.cdp.storage.AttributionReportingTriggerRegistration)*
+#### registration*: [`AttributionReportingTriggerRegistration`](#nodriver.cdp.storage.AttributionReportingTriggerRegistration)*
-#### event_level *: [`AttributionReportingEventLevelResult`](#nodriver.cdp.storage.AttributionReportingEventLevelResult)*
+#### event_level*: [`AttributionReportingEventLevelResult`](#nodriver.cdp.storage.AttributionReportingEventLevelResult)*
-#### aggregatable *: [`AttributionReportingAggregatableResult`](#nodriver.cdp.storage.AttributionReportingAggregatableResult)*
+#### aggregatable*: [`AttributionReportingAggregatableResult`](#nodriver.cdp.storage.AttributionReportingAggregatableResult)*
diff --git a/docs/_build/markdown/nodriver/cdp/tracing.md b/docs/_build/markdown/nodriver/cdp/tracing.md
index 52639e1..3271f9d 100644
--- a/docs/_build/markdown/nodriver/cdp/tracing.md
+++ b/docs/_build/markdown/nodriver/cdp/tracing.md
@@ -20,40 +20,40 @@ Configuration for memory dump. Used only when “memory-infra” category is ena
### *class* TraceConfig(record_mode=None, trace_buffer_size_in_kb=None, enable_sampling=None, enable_systrace=None, enable_argument_filter=None, included_categories=None, excluded_categories=None, synthetic_delays=None, memory_dump_config=None)
-#### record_mode *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### record_mode*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Controls how the trace buffer stores data.
-#### trace_buffer_size_in_kb *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
+#### trace_buffer_size_in_kb*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]* *= None*
Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value
of 200 MB would be used.
-#### enable_sampling *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### enable_sampling*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Turns on JavaScript stack sampling.
-#### enable_systrace *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### enable_systrace*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Turns on system tracing.
-#### enable_argument_filter *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### enable_argument_filter*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Turns on argument filter.
-#### included_categories *: [`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*
+#### included_categories*: [`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*
Included category filters.
-#### excluded_categories *: [`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*
+#### excluded_categories*: [`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*
Excluded category filters.
-#### synthetic_delays *: [`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*
+#### synthetic_delays*: [`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*
Configuration to synthesize the delays in tracing.
-#### memory_dump_config *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MemoryDumpConfig`](#nodriver.cdp.tracing.MemoryDumpConfig)]* *= None*
+#### memory_dump_config*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MemoryDumpConfig`](#nodriver.cdp.tracing.MemoryDumpConfig)]* *= None*
Configuration for memory dump triggers. Used only when “memory-infra” category is enabled.
@@ -141,8 +141,8 @@ Record a clock sync marker in the trace.
Request a global memory dump.
* **Parameters:**
- * **deterministic** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Enables more deterministic results by forcing garbage collection
- * **level_of_detail** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MemoryDumpLevelOfDetail`](#nodriver.cdp.tracing.MemoryDumpLevelOfDetail)]) – *(Optional)* Specifies level of details in memory dump. Defaults to “detailed”.
+ * **deterministic** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Enables more deterministic results by forcing garbage collection
+ * **level_of_detail** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`MemoryDumpLevelOfDetail`](#nodriver.cdp.tracing.MemoryDumpLevelOfDetail)]) – *(Optional)* Specifies level of details in memory dump. Defaults to “detailed”.
* **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), [`bool`](https://docs.python.org/3/library/functions.html#bool)]]
* **Returns:**
@@ -155,15 +155,15 @@ Request a global memory dump.
Start trace events collection.
* **Parameters:**
- * **categories** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(DEPRECATED)** *(Optional)* Category/tag filter
- * **options** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(DEPRECATED)** *(Optional)* Tracing options
- * **buffer_usage_reporting_interval** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
- * **transfer_mode** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ``ReportEvents```).
- * **stream_format** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamFormat`](#nodriver.cdp.tracing.StreamFormat)]) – *(Optional)* Trace data format to use. This only applies when using ```ReturnAsStream``` transfer mode (defaults to ```json```).
- * **stream_compression** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamCompression`](#nodriver.cdp.tracing.StreamCompression)]) – *(Optional)* Compression format to use. This only applies when using ```ReturnAsStream``` transfer mode (defaults to ```none```)
- * **trace_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TraceConfig`](#nodriver.cdp.tracing.TraceConfig)]) – *(Optional)*
- * **perfetto_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters ```categories```, ```options```, ```traceConfig``` are ignored. (Encoded as a base64 string when passed over JSON)
- * **tracing_backend** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TracingBackend`](#nodriver.cdp.tracing.TracingBackend)]) – *(Optional)* Backend type (defaults to ```auto``)
+ * **categories** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(DEPRECATED)** *(Optional)* Category/tag filter
+ * **options** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – **(DEPRECATED)** *(Optional)* Tracing options
+ * **buffer_usage_reporting_interval** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]) – *(Optional)* If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
+ * **transfer_mode** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ``ReportEvents```).
+ * **stream_format** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamFormat`](#nodriver.cdp.tracing.StreamFormat)]) – *(Optional)* Trace data format to use. This only applies when using ```ReturnAsStream``` transfer mode (defaults to ```json```).
+ * **stream_compression** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamCompression`](#nodriver.cdp.tracing.StreamCompression)]) – *(Optional)* Compression format to use. This only applies when using ```ReturnAsStream``` transfer mode (defaults to ```none```)
+ * **trace_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TraceConfig`](#nodriver.cdp.tracing.TraceConfig)]) – *(Optional)*
+ * **perfetto_config** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]) – *(Optional)* Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters ```categories```, ```options```, ```traceConfig``` are ignored. (Encoded as a base64 string when passed over JSON)
+ * **tracing_backend** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`TracingBackend`](#nodriver.cdp.tracing.TracingBackend)]) – *(Optional)* Backend type (defaults to ```auto``)
* **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)]
@@ -175,16 +175,16 @@ you use the event’s attributes.
### *class* BufferUsage(percent_full, event_count, value)
-#### percent_full *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
+#### percent_full*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
A number in range [0..1] that indicates the used size of event buffer as a fraction of its
total size.
-#### event_count *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
+#### event_count*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
An approximate number of events in the trace log.
-#### value *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
+#### value*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`float`](https://docs.python.org/3/library/functions.html#float)]*
A number in range [0..1] that indicates the used size of event buffer as a fraction of its
total size.
@@ -194,26 +194,26 @@ total size.
Contains a bucket of collected trace events. When tracing is stopped collected events will be
sent as a sequence of dataCollected events followed by tracingComplete event.
-#### value *: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`dict`](https://docs.python.org/3/library/stdtypes.html#dict)]*
+#### value*: [`List`](https://docs.python.org/3/library/typing.html#typing.List)[[`dict`](https://docs.python.org/3/library/stdtypes.html#dict)]*
### *class* TracingComplete(data_loss_occurred, stream, trace_format, stream_compression)
Signals that tracing is stopped and there is no trace buffers pending flush, all data were
delivered via dataCollected events.
-#### data_loss_occurred *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### data_loss_occurred*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
Indicates whether some trace data is known to have been lost, e.g. because the trace ring
buffer wrapped around.
-#### stream *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamHandle`](io.md#nodriver.cdp.io.StreamHandle)]*
+#### stream*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamHandle`](io.md#nodriver.cdp.io.StreamHandle)]*
A handle of the stream that holds resulting trace data.
-#### trace_format *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamFormat`](#nodriver.cdp.tracing.StreamFormat)]*
+#### trace_format*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamFormat`](#nodriver.cdp.tracing.StreamFormat)]*
Trace data format of returned stream.
-#### stream_compression *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamCompression`](#nodriver.cdp.tracing.StreamCompression)]*
+#### stream_compression*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`StreamCompression`](#nodriver.cdp.tracing.StreamCompression)]*
Compression format of returned stream.
diff --git a/docs/_build/markdown/nodriver/cdp/web_authn.md b/docs/_build/markdown/nodriver/cdp/web_authn.md
index 7c96721..0b58f7b 100644
--- a/docs/_build/markdown/nodriver/cdp/web_authn.md
+++ b/docs/_build/markdown/nodriver/cdp/web_authn.md
@@ -45,63 +45,63 @@ arguments to other commands.
### *class* VirtualAuthenticatorOptions(protocol, transport, ctap2_version=None, has_resident_key=None, has_user_verification=None, has_large_blob=None, has_cred_blob=None, has_min_pin_length=None, has_prf=None, automatic_presence_simulation=None, is_user_verified=None, default_backup_eligibility=None, default_backup_state=None)
-#### protocol *: [`AuthenticatorProtocol`](#nodriver.cdp.web_authn.AuthenticatorProtocol)*
+#### protocol*: [`AuthenticatorProtocol`](#nodriver.cdp.web_authn.AuthenticatorProtocol)*
-#### transport *: [`AuthenticatorTransport`](#nodriver.cdp.web_authn.AuthenticatorTransport)*
+#### transport*: [`AuthenticatorTransport`](#nodriver.cdp.web_authn.AuthenticatorTransport)*
-#### ctap2_version *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Ctap2Version`](#nodriver.cdp.web_authn.Ctap2Version)]* *= None*
+#### ctap2_version*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`Ctap2Version`](#nodriver.cdp.web_authn.Ctap2Version)]* *= None*
Defaults to ctap2_0. Ignored if `protocol` == u2f.
-#### has_resident_key *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### has_resident_key*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Defaults to false.
-#### has_user_verification *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### has_user_verification*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Defaults to false.
-#### has_large_blob *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### has_large_blob*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
If set to true, the authenticator will support the largeBlob extension.
[https://w3c.github.io/webauthn#largeBlob](https://w3c.github.io/webauthn#largeBlob)
Defaults to false.
-#### has_cred_blob *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### has_cred_blob*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
If set to true, the authenticator will support the credBlob extension.
[https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension](https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension)
Defaults to false.
-#### has_min_pin_length *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### has_min_pin_length*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
If set to true, the authenticator will support the minPinLength extension.
[https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension](https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension)
Defaults to false.
-#### has_prf *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### has_prf*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
If set to true, the authenticator will support the prf extension.
[https://w3c.github.io/webauthn/#prf-extension](https://w3c.github.io/webauthn/#prf-extension)
Defaults to false.
-#### automatic_presence_simulation *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### automatic_presence_simulation*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
If set to true, tests of user presence will succeed immediately.
Otherwise, they will not be resolved. Defaults to true.
-#### is_user_verified *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### is_user_verified*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Sets whether User Verification succeeds or fails for an authenticator.
Defaults to false.
-#### default_backup_eligibility *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### default_backup_eligibility*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Credentials created by this authenticator will have the backup
eligibility (BE) flag set to this value. Defaults to false.
[https://w3c.github.io/webauthn/#sctn-credential-backup](https://w3c.github.io/webauthn/#sctn-credential-backup)
-#### default_backup_state *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
+#### default_backup_state*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]* *= None*
Credentials created by this authenticator will have the backup state
(BS) flag set to this value. Defaults to false.
@@ -109,31 +109,31 @@ Credentials created by this authenticator will have the backup state
### *class* Credential(credential_id, is_resident_credential, private_key, sign_count, rp_id=None, user_handle=None, large_blob=None)
-#### credential_id *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### credential_id*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
-#### is_resident_credential *: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
+#### is_resident_credential*: [`bool`](https://docs.python.org/3/library/functions.html#bool)*
-#### private_key *: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
+#### private_key*: [`str`](https://docs.python.org/3/library/stdtypes.html#str)*
The ECDSA P-256 private key in PKCS#8 format. (Encoded as a base64 string when passed over JSON)
-#### sign_count *: [`int`](https://docs.python.org/3/library/functions.html#int)*
+#### sign_count*: [`int`](https://docs.python.org/3/library/functions.html#int)*
Signature counter. This is incremented by one for each successful
assertion.
See [https://w3c.github.io/webauthn/#signature-counter](https://w3c.github.io/webauthn/#signature-counter)
-#### rp_id *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### rp_id*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
Relying Party ID the credential is scoped to. Must be set when adding a
credential.
-#### user_handle *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### user_handle*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
An opaque byte sequence with a maximum size of 64 bytes mapping the
credential to a specific user. (Encoded as a base64 string when passed over JSON)
-#### large_blob *: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
+#### large_blob*: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`str`](https://docs.python.org/3/library/stdtypes.html#str)]* *= None*
The large blob associated with the credential.
See [https://w3c.github.io/webauthn/#sctn-large-blob-extension](https://w3c.github.io/webauthn/#sctn-large-blob-extension) (Encoded as a base64 string when passed over JSON)
@@ -191,7 +191,7 @@ Enable the WebAuthn domain and start intercepting credential storage and
retrieval with a virtual authenticator.
* **Parameters:**
- **enable_ui** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to enable the WebAuthn user interface. Enabling the UI is recommended for debugging and demo purposes, as it is closer to the real experience. Disabling the UI is recommended for automated testing. Supported at the embedder’s discretion if UI is available. Defaults to false.
+ **enable_ui** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* Whether to enable the WebAuthn user interface. Enabling the UI is recommended for debugging and demo purposes, as it is closer to the real experience. Disabling the UI is recommended for automated testing. Supported at the embedder’s discretion if UI is available. 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)]
@@ -253,9 +253,9 @@ Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not pr
* **Parameters:**
* **authenticator_id** ([`AuthenticatorId`](#nodriver.cdp.web_authn.AuthenticatorId)) –
- * **is_bogus_signature** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If isBogusSignature is set, overrides the signature in the authenticator response to be zero. Defaults to false.
- * **is_bad_uv** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If isBadUV is set, overrides the UV bit in the flags in the authenticator response to be zero. Defaults to false.
- * **is_bad_up** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If isBadUP is set, overrides the UP bit in the flags in the authenticator response to be zero. Defaults to false.
+ * **is_bogus_signature** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If isBogusSignature is set, overrides the signature in the authenticator response to be zero. Defaults to false.
+ * **is_bad_uv** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If isBadUV is set, overrides the UV bit in the flags in the authenticator response to be zero. Defaults to false.
+ * **is_bad_up** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)[[`bool`](https://docs.python.org/3/library/functions.html#bool)]) – *(Optional)* If isBadUP is set, overrides the UP bit in the flags in the authenticator response to be zero. 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)]
@@ -280,14 +280,14 @@ you use the event’s attributes.
Triggered when a credential is added to an authenticator.
-#### authenticator_id *: [`AuthenticatorId`](#nodriver.cdp.web_authn.AuthenticatorId)*
+#### authenticator_id*: [`AuthenticatorId`](#nodriver.cdp.web_authn.AuthenticatorId)*
-#### credential *: [`Credential`](#nodriver.cdp.web_authn.Credential)*
+#### credential*: [`Credential`](#nodriver.cdp.web_authn.Credential)*
### *class* CredentialAsserted(authenticator_id, credential)
Triggered when a credential is used in a webauthn assertion.
-#### authenticator_id *: [`AuthenticatorId`](#nodriver.cdp.web_authn.AuthenticatorId)*
+#### authenticator_id*: [`AuthenticatorId`](#nodriver.cdp.web_authn.AuthenticatorId)*
-#### credential *: [`Credential`](#nodriver.cdp.web_authn.Credential)*
+#### credential*: [`Credential`](#nodriver.cdp.web_authn.Credential)*
diff --git a/example/demo.py b/example/demo.py
index 9a21dd5..bfcae2d 100644
--- a/example/demo.py
+++ b/example/demo.py
@@ -10,6 +10,7 @@
logger = logging.getLogger("demo")
logging.basicConfig(level=10)
+
try:
import nodriver as uc
except (ModuleNotFoundError, ImportError):
@@ -18,6 +19,7 @@
sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
import nodriver as uc
+
import time
_monitor = mss.mss().monitors[0]
diff --git a/example/imgur_upload_image.py b/example/imgur_upload_image.py
index e9a6d1a..3ac1ce4 100644
--- a/example/imgur_upload_image.py
+++ b/example/imgur_upload_image.py
@@ -1,4 +1,12 @@
-from nodriver import *
+
+try:
+ from nodriver import *
+except (ModuleNotFoundError, ImportError):
+ import sys, os
+
+ sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+ from nodriver import *
+
from pathlib import Path
# interesting, this is a typical site which runs completely on javascript, and that causes
diff --git a/example/make_twitter_account.py b/example/make_twitter_account.py
index d1ff22f..1769036 100644
--- a/example/make_twitter_account.py
+++ b/example/make_twitter_account.py
@@ -10,7 +10,15 @@
logging.basicConfig(level=30)
-import nodriver as uc
+try:
+ import nodriver as uc
+except (ModuleNotFoundError, ImportError):
+ import sys, os
+
+ sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+ import nodriver as uc
+
+
months = [
"january",
diff --git a/example/mouse_drag_boxes.py b/example/mouse_drag_boxes.py
index 98656da..816dcdd 100644
--- a/example/mouse_drag_boxes.py
+++ b/example/mouse_drag_boxes.py
@@ -1,5 +1,13 @@
-from nodriver import *
+
+
+try:
+ from nodriver import *
+except (ModuleNotFoundError, ImportError):
+ import sys, os
+
+ sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+ from nodriver import *
async def main():
diff --git a/generate_cdp.py b/generate_cdp.py
index 6ca5a3b..1f4635c 100644
--- a/generate_cdp.py
+++ b/generate_cdp.py
@@ -1016,7 +1016,7 @@ def generate_docs(docs_path, domains):
# Generate document for each domain
for domain in domains:
doc = docs_path / f"{domain.module}.rst"
- with doc.aopen("w") as f:
+ with doc.open("w") as f:
f.write(domain.generate_sphinx())
diff --git a/nodriver/core/connection.py b/nodriver/core/connection.py
index dfc3fff..ac860ef 100644
--- a/nodriver/core/connection.py
+++ b/nodriver/core/connection.py
@@ -551,7 +551,7 @@ async def listener_loop(self):
# response to our command
if message["id"] in self.connection.mapper:
# get the corresponding Transaction
- tx = self.connection.mapper[message["id"]]
+ tx = self.connection.mapper.pop(message["id"])
logger.debug("got answer for %s", tx)
# complete the transaction, which is a Future object
# and thus will return to anyone awaiting it.
diff --git a/pyproject.toml b/pyproject.toml
index 442f659..30207a5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "nodriver" # Required
-version = "0.29rc1" # Required
+version = "0.32" # Required
description = """
* Official successor of Undetected Chromedriver
* Can be made to work for for all chromium based browsers.