Adding generation of deprecation warnings/docs.

Author: domderen

cdp/dom_snapshot.py

@@ -16,6 +16,7 @@
 from . import dom
 from . import dom_debugger
 from . import page
+from deprecated.sphinx import deprecated
 
 
 @dataclass
@@ -738,13 +739,16 @@ def enable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def get_snapshot(
         computed_style_whitelist: typing.List[str],
         include_event_listeners: typing.Optional[bool] = None,
         include_paint_order: typing.Optional[bool] = None,
         include_user_agent_shadow_tree: typing.Optional[bool] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[typing.List['DOMNode'], typing.List['LayoutTreeNode'], typing.List['ComputedStyle']]]:
     '''
+    .. deprecated:: 1.3
+
     Returns a document snapshot, including the full DOM tree of the root node (including iframes,
     template contents, and imported documents) in a flattened array, as well as layout and
     white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is

cdp/emulation.py

@@ -16,6 +16,7 @@
 from . import dom
 from . import network
 from . import page
+from deprecated.sphinx import deprecated
 
 
 @dataclass
@@ -311,10 +312,13 @@ def set_geolocation_override(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_navigator_overrides(
         platform: str
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Overrides value returned by the javascript navigator object.
 
     :param platform: The platform navigator.platform should return.
@@ -436,11 +440,14 @@ def set_timezone_override(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_visible_size(
         width: int,
         height: int
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Resizes the frame/viewport of the page. Note that this does not affect the frame's container
     (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported
     on Android.

cdp/network.py

@@ -18,6 +18,7 @@
 from . import page
 from . import runtime
 from . import security
+from deprecated.sphinx import deprecated
 
 
 class ResourceType(enum.Enum):
@@ -1423,8 +1424,11 @@ def from_json(cls, json: T_JSON_DICT) -> 'SignedExchangeInfo':
         )
 
 
+@deprecated(version="1.3")
 def can_clear_browser_cache() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,bool]:
     '''
+    .. deprecated:: 1.3
+
     Tells whether clearing browser cache is supported.
 
     :returns: True if browser cache can be cleared.
@@ -1436,8 +1440,11 @@ def can_clear_browser_cache() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,bool]:
     return bool(json['result'])
 
 
+@deprecated(version="1.3")
 def can_clear_browser_cookies() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,bool]:
     '''
+    .. deprecated:: 1.3
+
     Tells whether clearing browser cookies is supported.
 
     :returns: True if browser cookies can be cleared.
@@ -1449,8 +1456,11 @@ def can_clear_browser_cookies() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,bool
     return bool(json['result'])
 
 
+@deprecated(version="1.3")
 def can_emulate_network_conditions() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,bool]:
     '''
+    .. deprecated:: 1.3
+
     Tells whether emulation of network conditions is supported.
 
     :returns: True if emulation of network conditions is supported.
@@ -1482,6 +1492,7 @@ def clear_browser_cookies() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def continue_intercepted_request(
         interception_id: 'InterceptionId',
         error_reason: typing.Optional['ErrorReason'] = None,
@@ -1493,6 +1504,8 @@ def continue_intercepted_request(
         auth_challenge_response: typing.Optional['AuthChallengeResponse'] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Response to Network.requestIntercepted which either modifies the request to continue with any
     modifications, or blocks it, or completes it with the provided response bytes. If a network
     fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted
@@ -1973,10 +1986,13 @@ def set_extra_http_headers(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_request_interception(
         patterns: typing.List['RequestPattern']
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Sets the requests to intercept that match the provided patterns and optionally resource types.
     Deprecated, please use Fetch.enable instead.
 
@@ -2126,6 +2142,7 @@ def from_json(cls, json: T_JSON_DICT) -> 'LoadingFinished':
         )
 
 
+@deprecated(version="1.3")
 @event_class('Network.requestIntercepted')
 @dataclass
 class RequestIntercepted:

cdp/page.py

@@ -19,6 +19,7 @@
 from . import io
 from . import network
 from . import runtime
+from deprecated.sphinx import deprecated
 
 
 class FrameId(str):
@@ -627,10 +628,13 @@ def from_json(cls, json: str) -> 'ClientNavigationReason':
         return cls(json)
 
 
+@deprecated(version="1.3")
 def add_script_to_evaluate_on_load(
         script_source: str
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,'ScriptIdentifier']:
     '''
+    .. deprecated:: 1.3
+
     Deprecated, please use addScriptToEvaluateOnNewDocument instead.
 
     :param script_source:
@@ -732,8 +736,11 @@ def capture_snapshot(
     return str(json['data'])
 
 
+@deprecated(version="1.3")
 def clear_device_metrics_override() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Clears the overriden device metrics.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -742,8 +749,11 @@ def clear_device_metrics_override() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def clear_device_orientation_override() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Clears the overridden Device Orientation.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -752,8 +762,11 @@ def clear_device_orientation_override() -> typing.Generator[T_JSON_DICT,T_JSON_D
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def clear_geolocation_override() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Clears the overriden Geolocation Position and Error.
     '''
     cmd_dict: T_JSON_DICT = {
@@ -789,11 +802,14 @@ def create_isolated_world(
     return runtime.ExecutionContextId.from_json(json['executionContextId'])
 
 
+@deprecated(version="1.3")
 def delete_cookie(
         cookie_name: str,
         url: str
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Deletes browser cookie with given name, domain and path.
 
     :param cookie_name: Name of the cookie to remove.
@@ -862,8 +878,11 @@ def get_installability_errors() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typi
     return [str(i) for i in json['errors']]
 
 
+@deprecated(version="1.3")
 def get_cookies() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List['network.Cookie']]:
     '''
+    .. deprecated:: 1.3
+
     Returns all browser cookies. Depending on the backend support, will return detailed cookie
     information in the `cookies` field.
 
@@ -1160,10 +1179,13 @@ def reload(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def remove_script_to_evaluate_on_load(
         identifier: 'ScriptIdentifier'
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
 
     :param identifier:
@@ -1278,6 +1300,7 @@ def set_bypass_csp(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_device_metrics_override(
         width: int,
         height: int,
@@ -1293,6 +1316,8 @@ def set_device_metrics_override(
         viewport: typing.Optional['Viewport'] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
     window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
     query results).
@@ -1338,12 +1363,15 @@ def set_device_metrics_override(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_device_orientation_override(
         alpha: float,
         beta: float,
         gamma: float
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Overrides the Device Orientation.
 
     :param alpha: Mock alpha
@@ -1436,12 +1464,15 @@ def set_download_behavior(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_geolocation_override(
         latitude: typing.Optional[float] = None,
         longitude: typing.Optional[float] = None,
         accuracy: typing.Optional[float] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
     unavailable.
 
@@ -1480,11 +1511,14 @@ def set_lifecycle_events_enabled(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_touch_emulation_enabled(
         enabled: bool,
         configuration: typing.Optional[str] = None
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Toggles mouse event-based touch event emulation.
 
     :param enabled: Whether the touch event emulation should be enabled.
@@ -1763,6 +1797,7 @@ def from_json(cls, json: T_JSON_DICT) -> 'FrameAttached':
         )
 
 
+@deprecated(version="1.3")
 @event_class('Page.frameClearedScheduledNavigation')
 @dataclass
 class FrameClearedScheduledNavigation:
@@ -1846,6 +1881,7 @@ def from_json(cls, json: T_JSON_DICT) -> 'FrameRequestedNavigation':
         )
 
 
+@deprecated(version="1.3")
 @event_class('Page.frameScheduledNavigation')
 @dataclass
 class FrameScheduledNavigation:

cdp/security.py

@@ -14,6 +14,9 @@
 import typing
 
 
+from deprecated.sphinx import deprecated
+
+
 class CertificateId(int):
     '''
     An internal certificate ID value.
@@ -218,11 +221,14 @@ def set_ignore_certificate_errors(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def handle_certificate_error(
         event_id: int,
         action: 'CertificateErrorAction'
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Handles a certificate error that fired a certificateError event.
 
     :param event_id: The ID of the event.
@@ -238,10 +244,13 @@ def handle_certificate_error(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 def set_override_certificate_errors(
         override: bool
     ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
     '''
+    .. deprecated:: 1.3
+
     Enable/disable overriding certificate errors. If enabled, all certificate error events need to
     be handled by the DevTools client and should be answered with `handleCertificateError` commands.
 
@@ -256,6 +265,7 @@ def set_override_certificate_errors(
     json = yield cmd_dict
 
 
+@deprecated(version="1.3")
 @event_class('Security.certificateError')
 @dataclass
 class CertificateError: