Skip to content

Commit ceef62e

Browse files
committed
Regenerate code and docs
1 parent 44d58a6 commit ceef62e

19 files changed

Lines changed: 109 additions & 109 deletions

cdp/audits.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ def get_encoded_response(
3030
:param size_only: *(Optional)* Whether to only return the size information (defaults to false).
3131
:returns: A tuple with the following items:
3232
33-
0. **body** *(Optional)* The encoded body as a base64 string. Omitted if sizeOnly is true.
34-
1. **originalSize** Size before re-encoding.
35-
2. **encodedSize** Size after re-encoding.
33+
0. **body** - *(Optional)* The encoded body as a base64 string. Omitted if sizeOnly is true.
34+
1. **originalSize** - Size before re-encoding.
35+
2. **encodedSize** - Size after re-encoding.
3636
'''
3737
params: T_JSON_DICT = dict()
3838
params['requestId'] = request_id.to_json()

cdp/browser.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -269,11 +269,11 @@ def get_version() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[str,
269269
270270
:returns: A tuple with the following items:
271271
272-
0. **protocolVersion** Protocol version.
273-
1. **product** Product name.
274-
2. **revision** Product revision.
275-
3. **userAgent** User-Agent.
276-
4. **jsVersion** V8 version.
272+
0. **protocolVersion** - Protocol version.
273+
1. **product** - Product name.
274+
2. **revision** - Product revision.
275+
3. **userAgent** - User-Agent.
276+
4. **jsVersion** - V8 version.
277277
'''
278278
cmd_dict: T_JSON_DICT = {
279279
'method': 'Browser.getVersion',
@@ -387,8 +387,8 @@ def get_window_for_target(
387387
:param target_id: *(Optional)* Devtools agent host id. If called as a part of the session, associated targetId is used.
388388
:returns: A tuple with the following items:
389389
390-
0. **windowId** Browser window id.
391-
1. **bounds** Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.
390+
0. **windowId** - Browser window id.
391+
1. **bounds** - Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.
392392
'''
393393
params: T_JSON_DICT = dict()
394394
if target_id is not None:

cdp/cache_storage.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,8 @@ def request_entries(
267267
:param path_filter: *(Optional)* If present, only return the entries containing this substring in the path
268268
:returns: A tuple with the following items:
269269
270-
0. **cacheDataEntries** Array of object store data entries.
271-
1. **returnCount** Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.
270+
0. **cacheDataEntries** - Array of object store data entries.
271+
1. **returnCount** - Count of returned entries from this storage. If pathFilter is empty, it is the count of all entries from this storage.
272272
'''
273273
params: T_JSON_DICT = dict()
274274
params['cacheId'] = cache_id.to_json()

cdp/css.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -937,9 +937,9 @@ def get_background_colors(
937937
:param node_id: Id of the node to get background colors for.
938938
:returns: A tuple with the following items:
939939
940-
0. **backgroundColors** *(Optional)* The range of background colors behind this element, if it contains any visible text. If no visible text is present, this will be undefined. In the case of a flat background color, this will consist of simply that color. In the case of a gradient, this will consist of each of the color stops. For anything more complicated, this will be an empty array. Images will be ignored (as if the image had failed to load).
941-
1. **computedFontSize** *(Optional)* The computed font size for this node, as a CSS computed value string (e.g. '12px').
942-
2. **computedFontWeight** *(Optional)* The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or '100').
940+
0. **backgroundColors** - *(Optional)* The range of background colors behind this element, if it contains any visible text. If no visible text is present, this will be undefined. In the case of a flat background color, this will consist of simply that color. In the case of a gradient, this will consist of each of the color stops. For anything more complicated, this will be an empty array. Images will be ignored (as if the image had failed to load).
941+
1. **computedFontSize** - *(Optional)* The computed font size for this node, as a CSS computed value string (e.g. '12px').
942+
2. **computedFontWeight** - *(Optional)* The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or '100').
943943
'''
944944
params: T_JSON_DICT = dict()
945945
params['nodeId'] = node_id.to_json()
@@ -984,8 +984,8 @@ def get_inline_styles_for_node(
984984
:param node_id:
985985
:returns: A tuple with the following items:
986986
987-
0. **inlineStyle** *(Optional)* Inline style for the specified DOM node.
988-
1. **attributesStyle** *(Optional)* Attribute-defined element style (e.g. resulting from "width=20 height=100%").
987+
0. **inlineStyle** - *(Optional)* Inline style for the specified DOM node.
988+
1. **attributesStyle** - *(Optional)* Attribute-defined element style (e.g. resulting from "width=20 height=100%").
989989
'''
990990
params: T_JSON_DICT = dict()
991991
params['nodeId'] = node_id.to_json()
@@ -1009,12 +1009,12 @@ def get_matched_styles_for_node(
10091009
:param node_id:
10101010
:returns: A tuple with the following items:
10111011
1012-
0. **inlineStyle** *(Optional)* Inline style for the specified DOM node.
1013-
1. **attributesStyle** *(Optional)* Attribute-defined element style (e.g. resulting from "width=20 height=100%").
1014-
2. **matchedCSSRules** *(Optional)* CSS rules matching this node, from all applicable stylesheets.
1015-
3. **pseudoElements** *(Optional)* Pseudo style matches for this node.
1016-
4. **inherited** *(Optional)* A chain of inherited styles (from the immediate node parent up to the DOM tree root).
1017-
5. **cssKeyframesRules** *(Optional)* A list of CSS keyframed animations matching this node.
1012+
0. **inlineStyle** - *(Optional)* Inline style for the specified DOM node.
1013+
1. **attributesStyle** - *(Optional)* Attribute-defined element style (e.g. resulting from "width=20 height=100%").
1014+
2. **matchedCSSRules** - *(Optional)* CSS rules matching this node, from all applicable stylesheets.
1015+
3. **pseudoElements** - *(Optional)* Pseudo style matches for this node.
1016+
4. **inherited** - *(Optional)* A chain of inherited styles (from the immediate node parent up to the DOM tree root).
1017+
5. **cssKeyframesRules** - *(Optional)* A list of CSS keyframed animations matching this node.
10181018
'''
10191019
params: T_JSON_DICT = dict()
10201020
params['nodeId'] = node_id.to_json()

cdp/database.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ def execute_sql(
116116
:param query:
117117
:returns: A tuple with the following items:
118118
119-
0. **columnNames**
120-
1. **values**
121-
2. **sqlError**
119+
0. **columnNames** -
120+
1. **values** -
121+
2. **sqlError** -
122122
'''
123123
params: T_JSON_DICT = dict()
124124
params['databaseId'] = database_id.to_json()

cdp/debugger.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,8 @@ def evaluate_on_call_frame(
334334
:param timeout: **(EXPERIMENTAL)** *(Optional)* Terminate execution after timing out (number of milliseconds).
335335
:returns: A tuple with the following items:
336336
337-
0. **result** Object wrapper for the evaluation result.
338-
1. **exceptionDetails** *(Optional)* Exception details.
337+
0. **result** - Object wrapper for the evaluation result.
338+
1. **exceptionDetails** - *(Optional)* Exception details.
339339
'''
340340
params: T_JSON_DICT = dict()
341341
params['callFrameId'] = call_frame_id.to_json()
@@ -488,9 +488,9 @@ def restart_frame(
488488
:param call_frame_id: Call frame identifier to evaluate on.
489489
:returns: A tuple with the following items:
490490
491-
0. **callFrames** New stack trace.
492-
1. **asyncStackTrace** *(Optional)* Async stack trace, if any.
493-
2. **asyncStackTraceId** *(Optional)* Async stack trace, if any.
491+
0. **callFrames** - New stack trace.
492+
1. **asyncStackTrace** - *(Optional)* Async stack trace, if any.
493+
2. **asyncStackTraceId** - *(Optional)* Async stack trace, if any.
494494
'''
495495
params: T_JSON_DICT = dict()
496496
params['callFrameId'] = call_frame_id.to_json()
@@ -620,8 +620,8 @@ def set_breakpoint(
620620
:param condition: *(Optional)* Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.
621621
:returns: A tuple with the following items:
622622
623-
0. **breakpointId** Id of the created breakpoint for further reference.
624-
1. **actualLocation** Location this breakpoint resolved into.
623+
0. **breakpointId** - Id of the created breakpoint for further reference.
624+
1. **actualLocation** - Location this breakpoint resolved into.
625625
'''
626626
params: T_JSON_DICT = dict()
627627
params['location'] = location.to_json()
@@ -679,8 +679,8 @@ def set_breakpoint_by_url(
679679
:param condition: *(Optional)* Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.
680680
:returns: A tuple with the following items:
681681
682-
0. **breakpointId** Id of the created breakpoint for further reference.
683-
1. **locations** List of the locations this breakpoint resolved into upon addition.
682+
0. **breakpointId** - Id of the created breakpoint for further reference.
683+
1. **locations** - List of the locations this breakpoint resolved into upon addition.
684684
'''
685685
params: T_JSON_DICT = dict()
686686
params['lineNumber'] = line_number
@@ -799,11 +799,11 @@ def set_script_source(
799799
:param dry_run: *(Optional)* If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code.
800800
:returns: A tuple with the following items:
801801
802-
0. **callFrames** *(Optional)* New stack trace in case editing has happened while VM was stopped.
803-
1. **stackChanged** *(Optional)* Whether current call stack was modified after applying the changes.
804-
2. **asyncStackTrace** *(Optional)* Async stack trace, if any.
805-
3. **asyncStackTraceId** *(Optional)* Async stack trace, if any.
806-
4. **exceptionDetails** *(Optional)* Exception details if any.
802+
0. **callFrames** - *(Optional)* New stack trace in case editing has happened while VM was stopped.
803+
1. **stackChanged** - *(Optional)* Whether current call stack was modified after applying the changes.
804+
2. **asyncStackTrace** - *(Optional)* Async stack trace, if any.
805+
3. **asyncStackTraceId** - *(Optional)* Async stack trace, if any.
806+
4. **exceptionDetails** - *(Optional)* Exception details if any.
807807
'''
808808
params: T_JSON_DICT = dict()
809809
params['scriptId'] = script_id.to_json()

cdp/dom.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -761,8 +761,8 @@ def get_node_for_location(
761761
:param include_user_agent_shadow_dom: *(Optional)* False to skip to the nearest non-UA shadow root ancestor (default: false).
762762
:returns: A tuple with the following items:
763763
764-
0. **backendNodeId** Resulting node.
765-
1. **nodeId** *(Optional)* Id of the node at given coordinates, only when enabled and requested document.
764+
0. **backendNodeId** - Resulting node.
765+
1. **nodeId** - *(Optional)* Id of the node at given coordinates, only when enabled and requested document.
766766
'''
767767
params: T_JSON_DICT = dict()
768768
params['x'] = x
@@ -939,8 +939,8 @@ def perform_search(
939939
:param include_user_agent_shadow_dom: *(Optional)* True to search in user agent shadow DOM.
940940
:returns: A tuple with the following items:
941941
942-
0. **searchId** Unique search session identifier.
943-
1. **resultCount** Number of search results.
942+
0. **searchId** - Unique search session identifier.
943+
1. **resultCount** - Number of search results.
944944
'''
945945
params: T_JSON_DICT = dict()
946946
params['query'] = query
@@ -1376,8 +1376,8 @@ def get_frame_owner(
13761376
:param frame_id:
13771377
:returns: A tuple with the following items:
13781378
1379-
0. **backendNodeId** Resulting node.
1380-
1. **nodeId** *(Optional)* Id of the node at given coordinates, only when enabled and requested document.
1379+
0. **backendNodeId** - Resulting node.
1380+
1. **nodeId** - *(Optional)* Id of the node at given coordinates, only when enabled and requested document.
13811381
'''
13821382
params: T_JSON_DICT = dict()
13831383
params['frameId'] = frame_id.to_json()

cdp/dom_snapshot.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -758,9 +758,9 @@ def get_snapshot(
758758
:param include_user_agent_shadow_tree: *(Optional)* Whether to include UA shadow tree in the snapshot (default false).
759759
:returns: A tuple with the following items:
760760
761-
0. **domNodes** The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
762-
1. **layoutTreeNodes** The nodes in the layout tree.
763-
2. **computedStyles** Whitelisted ComputedStyle properties for each node in the layout tree.
761+
0. **domNodes** - The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
762+
1. **layoutTreeNodes** - The nodes in the layout tree.
763+
2. **computedStyles** - Whitelisted ComputedStyle properties for each node in the layout tree.
764764
'''
765765
params: T_JSON_DICT = dict()
766766
params['computedStyleWhitelist'] = [i for i in computed_style_whitelist]
@@ -796,8 +796,8 @@ def capture_snapshot(
796796
:param include_dom_rects: *(Optional)* Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
797797
:returns: A tuple with the following items:
798798
799-
0. **documents** The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
800-
1. **strings** Shared string table that all string properties refer to with indexes.
799+
0. **documents** - The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
800+
1. **strings** - Shared string table that all string properties refer to with indexes.
801801
'''
802802
params: T_JSON_DICT = dict()
803803
params['computedStyles'] = [i for i in computed_styles]

cdp/fetch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,8 +325,8 @@ def get_response_body(
325325
:param request_id: Identifier for the intercepted request to get body for.
326326
:returns: A tuple with the following items:
327327
328-
0. **body** Response body.
329-
1. **base64Encoded** True, if content was sent as base64.
328+
0. **body** - Response body.
329+
1. **base64Encoded** - True, if content was sent as base64.
330330
'''
331331
params: T_JSON_DICT = dict()
332332
params['requestId'] = request_id.to_json()

cdp/headless_experimental.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ def begin_frame(
5757
:param screenshot: *(Optional)* If set, a screenshot of the frame will be captured and returned in the response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can fail, for example, during renderer initialization. In such a case, no screenshot data will be returned.
5858
:returns: A tuple with the following items:
5959
60-
0. **hasDamage** Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the display. Reported for diagnostic uses, may be removed in the future.
61-
1. **screenshotData** *(Optional)* Base64-encoded image data of the screenshot, if one was requested and successfully taken.
60+
0. **hasDamage** - Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the display. Reported for diagnostic uses, may be removed in the future.
61+
1. **screenshotData** - *(Optional)* Base64-encoded image data of the screenshot, if one was requested and successfully taken.
6262
'''
6363
params: T_JSON_DICT = dict()
6464
if frame_time_ticks is not None:

0 commit comments

Comments
 (0)