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

Author: eNcacz

cdp/accessibility.py

@@ -17,7 +17,7 @@
 
 
 class AXNodeId(str):
-    '''
+    r'''
     Unique accessibility node identifier.
     '''
     def to_json(self) -> str:
@@ -32,7 +32,7 @@ def __repr__(self):
 
 
 class AXValueType(enum.Enum):
-    '''
+    r'''
     Enum of possible property types.
     '''
     BOOLEAN = "boolean"
@@ -62,7 +62,7 @@ def from_json(cls, json: str) -> AXValueType:
 
 
 class AXValueSourceType(enum.Enum):
-    '''
+    r'''
     Enum of possible property sources.
     '''
     ATTRIBUTE = "attribute"
@@ -81,7 +81,7 @@ def from_json(cls, json: str) -> AXValueSourceType:
 
 
 class AXValueNativeSourceType(enum.Enum):
-    '''
+    r'''
     Enum of possible native property sources (as a subtype of a particular AXValueSourceType).
     '''
     DESCRIPTION = "description"
@@ -105,7 +105,7 @@ def from_json(cls, json: str) -> AXValueNativeSourceType:
 
 @dataclass
 class AXValueSource:
-    '''
+    r'''
     A single source for a computed AX property.
     '''
     #: What type of source this is.
@@ -224,7 +224,7 @@ def from_json(cls, json: T_JSON_DICT) -> AXProperty:
 
 @dataclass
 class AXValue:
-    '''
+    r'''
     A single computed AX property.
     '''
     #: The type of this value.
@@ -261,7 +261,7 @@ def from_json(cls, json: T_JSON_DICT) -> AXValue:
 
 
 class AXPropertyName(enum.Enum):
-    '''
+    r'''
     Values of AXProperty name:
     - from 'busy' to 'roledescription': states which apply to every AX node
     - from 'live' to 'root': attributes which apply to nodes in live regions
@@ -319,7 +319,7 @@ def from_json(cls, json: str) -> AXPropertyName:
 
 @dataclass
 class AXNode:
-    '''
+    r'''
     A node in the accessibility tree.
     '''
     #: Unique identifier for this node.
@@ -403,7 +403,7 @@ def from_json(cls, json: T_JSON_DICT) -> AXNode:
 
 
 def disable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Disables the accessibility domain.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -413,7 +413,7 @@ def disable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
 
 
 def enable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,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.
     '''
@@ -429,7 +429,7 @@ def get_partial_ax_tree(
         object_id: typing.Optional[runtime.RemoteObjectId] = None,
         fetch_relatives: typing.Optional[bool] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[AXNode]]:
-    '''
+    r'''
     Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
 
     **EXPERIMENTAL**
@@ -462,7 +462,7 @@ def get_full_ax_tree(
         max_depth: typing.Optional[int] = None,
         frame_id: typing.Optional[page.FrameId] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[AXNode]]:
-    '''
+    r'''
     Fetches the entire accessibility tree for the root Document
 
     **EXPERIMENTAL**
@@ -490,7 +490,7 @@ def get_full_ax_tree(
 def get_root_ax_node(
         frame_id: typing.Optional[page.FrameId] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,AXNode]:
-    '''
+    r'''
     Fetches the root node.
     Requires ``enable()`` to have been called previously.
 
@@ -515,7 +515,7 @@ def get_ax_node_and_ancestors(
         backend_node_id: typing.Optional[dom.BackendNodeId] = None,
         object_id: typing.Optional[runtime.RemoteObjectId] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[AXNode]]:
-    '''
+    r'''
     Fetches a node and all ancestors up to and including the root.
     Requires ``enable()`` to have been called previously.
 
@@ -545,7 +545,7 @@ def get_child_ax_nodes(
         id_: AXNodeId,
         frame_id: typing.Optional[page.FrameId] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[AXNode]]:
-    '''
+    r'''
     Fetches a particular accessibility node by AXNodeId.
     Requires ``enable()`` to have been called previously.
 
@@ -574,7 +574,7 @@ def query_ax_tree(
         accessible_name: typing.Optional[str] = None,
         role: typing.Optional[str] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,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
@@ -612,7 +612,7 @@ def query_ax_tree(
 @event_class('Accessibility.loadComplete')
 @dataclass
 class LoadComplete:
-    '''
+    r'''
     **EXPERIMENTAL**
 
     The loadComplete event mirrors the load complete event sent by the browser to assistive
@@ -631,7 +631,7 @@ def from_json(cls, json: T_JSON_DICT) -> LoadComplete:
 @event_class('Accessibility.nodesUpdated')
 @dataclass
 class NodesUpdated:
-    '''
+    r'''
     **EXPERIMENTAL**
 
     The nodesUpdated event is sent every time a previously requested node has changed the in tree.

cdp/animation.py

@@ -17,7 +17,7 @@
 
 @dataclass
 class Animation:
-    '''
+    r'''
     Animation instance.
     '''
     #: ``Animation``'s id.
@@ -85,7 +85,7 @@ def from_json(cls, json: T_JSON_DICT) -> Animation:
 
 @dataclass
 class AnimationEffect:
-    '''
+    r'''
     AnimationEffect instance
     '''
     #: ``AnimationEffect``'s delay.
@@ -152,7 +152,7 @@ def from_json(cls, json: T_JSON_DICT) -> AnimationEffect:
 
 @dataclass
 class KeyframesRule:
-    '''
+    r'''
     Keyframes Rule
     '''
     #: List of animation keyframes.
@@ -178,7 +178,7 @@ def from_json(cls, json: T_JSON_DICT) -> KeyframesRule:
 
 @dataclass
 class KeyframeStyle:
-    '''
+    r'''
     Keyframe Style
     '''
     #: Keyframe's time offset.
@@ -202,7 +202,7 @@ def from_json(cls, json: T_JSON_DICT) -> KeyframeStyle:
 
 
 def disable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Disables animation domain notifications.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -212,7 +212,7 @@ def disable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
 
 
 def enable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Enables animation domain notifications.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -224,7 +224,7 @@ def enable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
 def get_current_time(
         id_: str
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,float]:
-    '''
+    r'''
     Returns the current time of the an animation.
 
     :param id_: Id of animation.
@@ -241,7 +241,7 @@ def get_current_time(
 
 
 def get_playback_rate() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,float]:
-    '''
+    r'''
     Gets the playback rate of the document timeline.
 
     :returns: Playback rate for animations on page.
@@ -256,7 +256,7 @@ def get_playback_rate() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,float]:
 def release_animations(
         animations: typing.List[str]
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Releases a set of animations to no longer be manipulated.
 
     :param animations: List of animation ids to seek.
@@ -273,7 +273,7 @@ def release_animations(
 def resolve_animation(
         animation_id: str
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,runtime.RemoteObject]:
-    '''
+    r'''
     Gets the remote object of the Animation.
 
     :param animation_id: Animation id.
@@ -293,7 +293,7 @@ def seek_animations(
         animations: typing.List[str],
         current_time: float
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Seek a set of animations to a particular time within each animation.
 
     :param animations: List of animation ids to seek.
@@ -313,7 +313,7 @@ def set_paused(
         animations: typing.List[str],
         paused: bool
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Sets the paused state of a set of animations.
 
     :param animations: Animations to set the pause state of.
@@ -332,7 +332,7 @@ def set_paused(
 def set_playback_rate(
         playback_rate: float
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Sets the playback rate of the document timeline.
 
     :param playback_rate: Playback rate for animations on page
@@ -351,7 +351,7 @@ def set_timing(
         duration: float,
         delay: float
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
-    '''
+    r'''
     Sets the timing of an animation node.
 
     :param animation_id: Animation id.
@@ -372,7 +372,7 @@ def set_timing(
 @event_class('Animation.animationCanceled')
 @dataclass
 class AnimationCanceled:
-    '''
+    r'''
     Event for when an animation has been cancelled.
     '''
     #: Id of the animation that was cancelled.
@@ -388,7 +388,7 @@ def from_json(cls, json: T_JSON_DICT) -> AnimationCanceled:
 @event_class('Animation.animationCreated')
 @dataclass
 class AnimationCreated:
-    '''
+    r'''
     Event for each animation that has been created.
     '''
     #: Id of the animation that was created.
@@ -404,7 +404,7 @@ def from_json(cls, json: T_JSON_DICT) -> AnimationCreated:
 @event_class('Animation.animationStarted')
 @dataclass
 class AnimationStarted:
-    '''
+    r'''
     Event for animation that has been started.
     '''
     #: Animation that was started.