Merge remote-tracking branch 'origin/docs_updates'

Author: mehaase

cdp/accessibility.py

@@ -417,12 +417,14 @@ def get_partial_ax_tree(
         fetch_relatives: typing.Optional[bool] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List['AXNode']]:
     '''
+    **EXPERIMENTAL**
+
     Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
 
-    :param node_id: Identifier of the node to get the partial accessibility tree for.
-    :param backend_node_id: Identifier of the backend node to get the partial accessibility tree for.
-    :param object_id: JavaScript object id of the node wrapper to get the partial accessibility tree for.
-    :param fetch_relatives: Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
+    :param node_id: *(Optional)* Identifier of the node to get the partial accessibility tree for.
+    :param backend_node_id: *(Optional)* Identifier of the backend node to get the partial accessibility tree for.
+    :param object_id: *(Optional)* JavaScript object id of the node wrapper to get the partial accessibility tree for.
+    :param fetch_relatives: *(Optional)* Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
     :returns: The ``Accessibility.AXNode`` for this DOM node, if it exists, plus its ancestors, siblings and
     children, if requested.
     '''
@@ -445,6 +447,8 @@ def get_partial_ax_tree(
 
 def get_full_ax_tree() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List['AXNode']]:
     '''
+    **EXPERIMENTAL**
+
     Fetches the entire accessibility tree
 
     :returns: 

cdp/audits.py

@@ -28,12 +28,13 @@ def get_encoded_response(
 
     :param request_id: Identifier of the network request to get content for.
     :param encoding: The encoding to use.
-    :param quality: The quality of the encoding (0-1). (defaults to 1)
-    :param size_only: Whether to only return the size information (defaults to false).
-    :returns: a tuple with the following items:
-        0. body: (Optional) The encoded body as a base64 string. Omitted if sizeOnly is true.
-        1. originalSize: Size before re-encoding.
-        2. encodedSize: Size after re-encoding.
+    :param quality: *(Optional)* The quality of the encoding (0-1). (defaults to 1)
+    :param size_only: *(Optional)* Whether to only return the size information (defaults to false).
+    :returns: A tuple with the following items:
+
+        1. **body** -  *(Optional)* The encoded body as a base64 string. Omitted if sizeOnly is true.
+        2. **originalSize** -  Size before re-encoding.
+        3. **encodedSize** -  Size after re-encoding.
     '''
     params: T_JSON_DICT = dict()
     params['requestId'] = request_id.to_json()

cdp/browser.py

@@ -191,11 +191,13 @@ def grant_permissions(
         browser_context_id: typing.Optional['target.BrowserContextID'] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    **EXPERIMENTAL**
+
     Grant specific permissions to the given origin and reject all others.
 
     :param origin:
     :param permissions:
-    :param browser_context_id: BrowserContext to override permissions. When omitted, default browser context is used.
+    :param browser_context_id: *(Optional)* BrowserContext to override permissions. When omitted, default browser context is used.
     '''
     params: T_JSON_DICT = dict()
     params['origin'] = origin
@@ -213,9 +215,11 @@ def reset_permissions(
         browser_context_id: typing.Optional['target.BrowserContextID'] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    **EXPERIMENTAL**
+
     Reset all permission management for all origins.
 
-    :param browser_context_id: BrowserContext to reset permissions. When omitted, default browser context is used.
+    :param browser_context_id: *(Optional)* BrowserContext to reset permissions. When omitted, default browser context is used.
     '''
     params: T_JSON_DICT = dict()
     if browser_context_id is not None:
@@ -239,6 +243,8 @@ def close() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
 
 def crash() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    **EXPERIMENTAL**
+
     Crashes browser on the main thread.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -249,6 +255,8 @@ def crash() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
 
 def crash_gpu_process() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    **EXPERIMENTAL**
+
     Crashes GPU process.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -261,12 +269,13 @@ def get_version() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[str,
     '''
     Returns version information.
 
-    :returns: a tuple with the following items:
-        0. protocolVersion: Protocol version.
-        1. product: Product name.
-        2. revision: Product revision.
-        3. userAgent: User-Agent.
-        4. jsVersion: V8 version.
+    :returns: A tuple with the following items:
+
+        1. **protocolVersion** -  Protocol version.
+        2. **product** -  Product name.
+        3. **revision** -  Product revision.
+        4. **userAgent** -  User-Agent.
+        5. **jsVersion** -  V8 version.
     '''
     cmd_dict: T_JSON_DICT = {
         'method': 'Browser.getVersion',
@@ -283,6 +292,8 @@ def get_version() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[str,
 
 def get_browser_command_line() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[str]]:
     '''
+    **EXPERIMENTAL**
+
     Returns the command line switches for the browser process if, and only if
     --enable-automation is on the commandline.
 
@@ -300,10 +311,12 @@ def get_histograms(
         delta: typing.Optional[bool] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List['Histogram']]:
     '''
+    **EXPERIMENTAL**
+
     Get Chrome histograms.
 
-    :param query: Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.
-    :param delta: If true, retrieve delta since last call.
+    :param query: *(Optional)* Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.
+    :param delta: *(Optional)* If true, retrieve delta since last call.
     :returns: Histograms.
     '''
     params: T_JSON_DICT = dict()
@@ -324,10 +337,12 @@ def get_histogram(
         delta: typing.Optional[bool] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,'Histogram']:
     '''
+    **EXPERIMENTAL**
+
     Get a Chrome histogram by name.
 
     :param name: Requested histogram name.
-    :param delta: If true, retrieve delta since last call.
+    :param delta: *(Optional)* If true, retrieve delta since last call.
     :returns: Histogram.
     '''
     params: T_JSON_DICT = dict()
@@ -346,6 +361,8 @@ def get_window_bounds(
         window_id: 'WindowID'
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,'Bounds']:
     '''
+    **EXPERIMENTAL**
+
     Get position and size of the browser window.
 
     :param window_id: Browser window id.
@@ -366,12 +383,15 @@ def get_window_for_target(
         target_id: typing.Optional['target.TargetID'] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple['WindowID', 'Bounds']]:
     '''
+    **EXPERIMENTAL**
+
     Get the browser window that contains the devtools target.
 
-    :param target_id: Devtools agent host id. If called as a part of the session, associated targetId is used.
-    :returns: a tuple with the following items:
-        0. windowId: Browser window id.
-        1. bounds: Bounds information of the window. When window state is 'minimized', the restored window
+    :param target_id: *(Optional)* Devtools agent host id. If called as a part of the session, associated targetId is used.
+    :returns: A tuple with the following items:
+
+        1. **windowId** -  Browser window id.
+        2. **bounds** -  Bounds information of the window. When window state is 'minimized', the restored window
         position and size are returned.
     '''
     params: T_JSON_DICT = dict()
@@ -393,6 +413,8 @@ def set_window_bounds(
         bounds: 'Bounds'
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    **EXPERIMENTAL**
+
     Set position and/or size of the browser window.
 
     :param window_id: Browser window id.
@@ -413,10 +435,12 @@ def set_dock_tile(
         image: typing.Optional[str] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    **EXPERIMENTAL**
+
     Set dock tile details, platform-specific.
 
-    :param badge_label:
-    :param image: Png encoded image.
+    :param badge_label: *(Optional)*
+    :param image: *(Optional)* Png encoded image.
     '''
     params: T_JSON_DICT = dict()
     if badge_label is not None:

cdp/cache_storage.py

@@ -266,10 +266,11 @@ def request_entries(
     :param cache_id: ID of cache to get entries from.
     :param skip_count: Number of records to skip.
     :param page_size: Number of records to fetch.
-    :param path_filter: If present, only return the entries containing this substring in the path
-    :returns: a tuple with the following items:
-        0. cacheDataEntries: Array of object store data entries.
-        1. returnCount: Count of returned entries from this storage. If pathFilter is empty, it
+    :param path_filter: *(Optional)* If present, only return the entries containing this substring in the path
+    :returns: A tuple with the following items:
+
+        1. **cacheDataEntries** -  Array of object store data entries.
+        2. **returnCount** -  Count of returned entries from this storage. If pathFilter is empty, it
         is the count of all entries from this storage.
     '''
     params: T_JSON_DICT = dict()

cdp/cast.py

@@ -51,7 +51,7 @@ def enable(
     Also starts observing for issue messages. When an issue is added or removed,
     an |issueUpdated| event is fired.
 
-    :param presentation_url:
+    :param presentation_url: *(Optional)*
     '''
     params: T_JSON_DICT = dict()
     if presentation_url is not None:

cdp/css.py

@@ -937,14 +937,15 @@ def get_background_colors(
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[typing.Optional[typing.List[str]], typing.Optional[str], typing.Optional[str]]]:
     '''
     :param node_id: Id of the node to get background colors for.
-    :returns: a tuple with the following items:
-        0. backgroundColors: (Optional) The range of background colors behind this element, if it contains any visible text. If no
+    :returns: A tuple with the following items:
+
+        1. **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).
-        1. computedFontSize: (Optional) The computed font size for this node, as a CSS computed value string (e.g. '12px').
-        2. computedFontWeight: (Optional) The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
+        2. **computedFontSize** -  *(Optional)* The computed font size for this node, as a CSS computed value string (e.g. '12px').
+        3. **computedFontWeight** -  *(Optional)* The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
         '100').
     '''
     params: T_JSON_DICT = dict()
@@ -988,9 +989,10 @@ def get_inline_styles_for_node(
     attributes) for a DOM node identified by `nodeId`.
 
     :param node_id:
-    :returns: a tuple with the following items:
-        0. inlineStyle: (Optional) Inline style for the specified DOM node.
-        1. attributesStyle: (Optional) Attribute-defined element style (e.g. resulting from "width=20 height=100%").
+    :returns: A tuple with the following items:
+
+        1. **inlineStyle** -  *(Optional)* Inline style for the specified DOM node.
+        2. **attributesStyle** -  *(Optional)* Attribute-defined element style (e.g. resulting from "width=20 height=100%").
     '''
     params: T_JSON_DICT = dict()
     params['nodeId'] = node_id.to_json()
@@ -1012,13 +1014,14 @@ def get_matched_styles_for_node(
     Returns requested styles for a DOM node identified by `nodeId`.
 
     :param node_id:
-    :returns: a tuple with the following items:
-        0. inlineStyle: (Optional) Inline style for the specified DOM node.
-        1. attributesStyle: (Optional) Attribute-defined element style (e.g. resulting from "width=20 height=100%").
-        2. matchedCSSRules: (Optional) CSS rules matching this node, from all applicable stylesheets.
-        3. pseudoElements: (Optional) Pseudo style matches for this node.
-        4. inherited: (Optional) A chain of inherited styles (from the immediate node parent up to the DOM tree root).
-        5. cssKeyframesRules: (Optional) A list of CSS keyframed animations matching this node.
+    :returns: A tuple with the following items:
+
+        1. **inlineStyle** -  *(Optional)* Inline style for the specified DOM node.
+        2. **attributesStyle** -  *(Optional)* Attribute-defined element style (e.g. resulting from "width=20 height=100%").
+        3. **matchedCSSRules** -  *(Optional)* CSS rules matching this node, from all applicable stylesheets.
+        4. **pseudoElements** -  *(Optional)* Pseudo style matches for this node.
+        5. **inherited** -  *(Optional)* A chain of inherited styles (from the immediate node parent up to the DOM tree root).
+        6. **cssKeyframesRules** -  *(Optional)* A list of CSS keyframed animations matching this node.
     '''
     params: T_JSON_DICT = dict()
     params['nodeId'] = node_id.to_json()
@@ -1197,7 +1200,7 @@ def set_style_sheet_text(
 
     :param style_sheet_id:
     :param text:
-    :returns: (Optional) URL of source map associated with script (if any).
+    :returns: *(Optional)* URL of source map associated with script (if any).
     '''
     params: T_JSON_DICT = dict()
     params['styleSheetId'] = style_sheet_id.to_json()

cdp/database.py

@@ -116,10 +116,11 @@ def execute_sql(
     '''
     :param database_id:
     :param query:
-    :returns: a tuple with the following items:
-        0. columnNames: 
-        1. values: 
-        2. sqlError: 
+    :returns: A tuple with the following items:
+
+        1. **columnNames** -  
+        2. **values** -  
+        3. **sqlError** -  
     '''
     params: T_JSON_DICT = dict()
     params['databaseId'] = database_id.to_json()