Use r-string for doc strings to avoid issue with null bytes (\0) in fetch.continue_response documentation.

Author: eNcacz

generator/generate.py

@@ -108,7 +108,7 @@ def generate_command(module: types.ModuleType, module_name: str,
 
     # Copy docstring.
     if fn.__doc__:
-        doc = "    '''" + fn.__doc__ + "'''\n"
+        doc = "    r'''" + fn.__doc__ + "'''\n"
     else:
         doc = ''
 

generator/test_generate.py

@@ -12,7 +12,7 @@ async def query_selector(
                 node_id: NodeId,
                 selector: str
             ) -> NodeId:
-            '''
+            r'''
             Executes ``querySelector`` on a given node.
 
             :param node_id: Id of the node to query upon.
@@ -29,7 +29,7 @@ async def query_selector(
 def test_accessibility_disable():
     expected = dedent("""\
         async def disable() -> None:
-            '''
+            r'''
             Disables the accessibility domain.
             '''
             session = get_session_context('accessibility.disable')
@@ -48,7 +48,7 @@ async def get_partial_ax_tree(
                 object_id: typing.Optional[cdp.runtime.RemoteObjectId] = None,
                 fetch_relatives: typing.Optional[bool] = None
             ) -> typing.List[AXNode]:
-            '''
+            r'''
             Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
 
             **EXPERIMENTAL**
@@ -64,4 +64,4 @@ async def get_partial_ax_tree(
     """)
 
     assert expected == generate_command(cdp.accessibility, 'accessibility',
-        cdp.accessibility.get_partial_ax_tree)
+        cdp.accessibility.get_partial_ax_tree)

trio_cdp/generated/accessibility.py

@@ -26,15 +26,15 @@
 
 
 async def disable() -> None:
-    '''
+    r'''
     Disables the accessibility domain.
     '''
     session = get_session_context('accessibility.disable')
     return await session.execute(cdp.accessibility.disable())
 
 
 async def enable() -> None:
-    '''
+    r'''
     Enables the accessibility domain which causes ``AXNodeId``'s to remain consistent between method calls.
     This turns on accessibility for the page, which can impact performance until accessibility is disabled.
     '''
@@ -47,7 +47,7 @@ async def get_ax_node_and_ancestors(
         backend_node_id: typing.Optional[cdp.dom.BackendNodeId] = None,
         object_id: typing.Optional[cdp.runtime.RemoteObjectId] = None
     ) -> typing.List[AXNode]:
-    '''
+    r'''
     Fetches a node and all ancestors up to and including the root.
     Requires ``enable()`` to have been called previously.
 
@@ -66,7 +66,7 @@ async def get_child_ax_nodes(
         id_: AXNodeId,
         frame_id: typing.Optional[cdp.page.FrameId] = None
     ) -> typing.List[AXNode]:
-    '''
+    r'''
     Fetches a particular accessibility node by AXNodeId.
     Requires ``enable()`` to have been called previously.
 
@@ -85,7 +85,7 @@ async def get_full_ax_tree(
         max_depth: typing.Optional[int] = None,
         frame_id: typing.Optional[cdp.page.FrameId] = None
     ) -> typing.List[AXNode]:
-    '''
+    r'''
     Fetches the entire accessibility tree for the root Document
 
     **EXPERIMENTAL**
@@ -105,7 +105,7 @@ async def get_partial_ax_tree(
         object_id: typing.Optional[cdp.runtime.RemoteObjectId] = None,
         fetch_relatives: typing.Optional[bool] = None
     ) -> typing.List[AXNode]:
-    '''
+    r'''
     Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
 
     **EXPERIMENTAL**
@@ -123,7 +123,7 @@ async def get_partial_ax_tree(
 async def get_root_ax_node(
         frame_id: typing.Optional[cdp.page.FrameId] = None
     ) -> AXNode:
-    '''
+    r'''
     Fetches the root node.
     Requires ``enable()`` to have been called previously.
 
@@ -143,7 +143,7 @@ async def query_ax_tree(
         accessible_name: typing.Optional[str] = None,
         role: typing.Optional[str] = None
     ) -> typing.List[AXNode]:
-    '''
+    r'''
     Query a DOM node's accessibility subtree for accessible name and role.
     This command computes the name and role for all nodes in the subtree, including those that are
     ignored for accessibility, and returns those that mactch the specified name and role. If no DOM

trio_cdp/generated/animation.py

@@ -21,15 +21,15 @@
 
 
 async def disable() -> None:
-    '''
+    r'''
     Disables animation domain notifications.
     '''
     session = get_session_context('animation.disable')
     return await session.execute(cdp.animation.disable())
 
 
 async def enable() -> None:
-    '''
+    r'''
     Enables animation domain notifications.
     '''
     session = get_session_context('animation.enable')
@@ -39,7 +39,7 @@ async def enable() -> None:
 async def get_current_time(
         id_: str
     ) -> float:
-    '''
+    r'''
     Returns the current time of the an animation.
 
     :param id_: Id of animation.
@@ -50,7 +50,7 @@ async def get_current_time(
 
 
 async def get_playback_rate() -> float:
-    '''
+    r'''
     Gets the playback rate of the document timeline.
 
     :returns: Playback rate for animations on page.
@@ -62,7 +62,7 @@ async def get_playback_rate() -> float:
 async def release_animations(
         animations: typing.List[str]
     ) -> None:
-    '''
+    r'''
     Releases a set of animations to no longer be manipulated.
 
     :param animations: List of animation ids to seek.
@@ -74,7 +74,7 @@ async def release_animations(
 async def resolve_animation(
         animation_id: str
     ) -> cdp.runtime.RemoteObject:
-    '''
+    r'''
     Gets the remote object of the Animation.
 
     :param animation_id: Animation id.
@@ -88,7 +88,7 @@ async def seek_animations(
         animations: typing.List[str],
         current_time: float
     ) -> None:
-    '''
+    r'''
     Seek a set of animations to a particular time within each animation.
 
     :param animations: List of animation ids to seek.
@@ -102,7 +102,7 @@ async def set_paused(
         animations: typing.List[str],
         paused: bool
     ) -> None:
-    '''
+    r'''
     Sets the paused state of a set of animations.
 
     :param animations: Animations to set the pause state of.
@@ -115,7 +115,7 @@ async def set_paused(
 async def set_playback_rate(
         playback_rate: float
     ) -> None:
-    '''
+    r'''
     Sets the playback rate of the document timeline.
 
     :param playback_rate: Playback rate for animations on page
@@ -129,7 +129,7 @@ async def set_timing(
         duration: float,
         delay: float
     ) -> None:
-    '''
+    r'''
     Sets the timing of an animation node.
 
     :param animation_id: Animation id.

trio_cdp/generated/audits.py

@@ -55,7 +55,7 @@
 async def check_contrast(
         report_aaa: typing.Optional[bool] = None
     ) -> None:
-    '''
+    r'''
     Runs the contrast check for the target page. Found issues are reported
     using Audits.issueAdded event.
 
@@ -66,15 +66,15 @@ async def check_contrast(
 
 
 async def disable() -> None:
-    '''
+    r'''
     Disables issues domain, prevents further issues from being reported to the client.
     '''
     session = get_session_context('audits.disable')
     return await session.execute(cdp.audits.disable())
 
 
 async def enable() -> None:
-    '''
+    r'''
     Enables issues domain, sends the issues collected so far to the client by means of the
     ``issueAdded`` event.
     '''
@@ -88,7 +88,7 @@ async def get_encoded_response(
         quality: typing.Optional[float] = None,
         size_only: typing.Optional[bool] = None
     ) -> typing.Tuple[typing.Optional[str], int, int]:
-    '''
+    r'''
     Returns the response body and size if it were re-encoded with the specified settings. Only
     applies to images.
 

trio_cdp/generated/background_service.py

@@ -21,7 +21,7 @@
 async def clear_events(
         service: ServiceName
     ) -> None:
-    '''
+    r'''
     Clears all stored data for the service.
 
     :param service:
@@ -34,7 +34,7 @@ async def set_recording(
         should_record: bool,
         service: ServiceName
     ) -> None:
-    '''
+    r'''
     Set the recording state for the service.
 
     :param should_record:
@@ -47,7 +47,7 @@ async def set_recording(
 async def start_observing(
         service: ServiceName
     ) -> None:
-    '''
+    r'''
     Enables event updates for the service.
 
     :param service:
@@ -59,7 +59,7 @@ async def start_observing(
 async def stop_observing(
         service: ServiceName
     ) -> None:
-    '''
+    r'''
     Disables event updates for the service.
 
     :param service: