You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

659 lines
20 KiB
Python

# DO NOT EDIT THIS FILE!
#
# This file is generated from the CDP specification. If you need to make
# changes, edit the generator and regenerate all of the modules.
#
# CDP domain: Emulation
from __future__ import annotations
from .util import event_class, T_JSON_DICT
from dataclasses import dataclass
import enum
import typing
from . import dom
from . import network
from . import page
@dataclass
class ScreenOrientation:
'''
Screen orientation.
'''
#: Orientation type.
type_: str
#: Orientation angle.
angle: int
def to_json(self):
json = dict()
json['type'] = self.type_
json['angle'] = self.angle
return json
@classmethod
def from_json(cls, json):
return cls(
type_=str(json['type']),
angle=int(json['angle']),
)
@dataclass
class MediaFeature:
name: str
value: str
def to_json(self):
json = dict()
json['name'] = self.name
json['value'] = self.value
return json
@classmethod
def from_json(cls, json):
return cls(
name=str(json['name']),
value=str(json['value']),
)
class VirtualTimePolicy(enum.Enum):
'''
advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to
allow the next delayed task (if any) to run; pause: The virtual time base may not advance;
pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending
resource fetches.
'''
ADVANCE = "advance"
PAUSE = "pause"
PAUSE_IF_NETWORK_FETCHES_PENDING = "pauseIfNetworkFetchesPending"
def to_json(self):
return self.value
@classmethod
def from_json(cls, json):
return cls(json)
@dataclass
class UserAgentBrandVersion:
'''
Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
'''
brand: str
version: str
def to_json(self):
json = dict()
json['brand'] = self.brand
json['version'] = self.version
return json
@classmethod
def from_json(cls, json):
return cls(
brand=str(json['brand']),
version=str(json['version']),
)
@dataclass
class UserAgentMetadata:
'''
Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
'''
brands: typing.List[UserAgentBrandVersion]
full_version: str
platform: str
platform_version: str
architecture: str
model: str
mobile: bool
def to_json(self):
json = dict()
json['brands'] = [i.to_json() for i in self.brands]
json['fullVersion'] = self.full_version
json['platform'] = self.platform
json['platformVersion'] = self.platform_version
json['architecture'] = self.architecture
json['model'] = self.model
json['mobile'] = self.mobile
return json
@classmethod
def from_json(cls, json):
return cls(
brands=[UserAgentBrandVersion.from_json(i) for i in json['brands']],
full_version=str(json['fullVersion']),
platform=str(json['platform']),
platform_version=str(json['platformVersion']),
architecture=str(json['architecture']),
model=str(json['model']),
mobile=bool(json['mobile']),
)
def can_emulate() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,bool]:
'''
Tells whether emulation is supported.
:returns: True if emulation is supported.
'''
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.canEmulate',
}
json = yield cmd_dict
return bool(json['result'])
def clear_device_metrics_override() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Clears the overridden device metrics.
'''
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.clearDeviceMetricsOverride',
}
json = yield cmd_dict
def clear_geolocation_override() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Clears the overridden Geolocation Position and Error.
'''
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.clearGeolocationOverride',
}
json = yield cmd_dict
def reset_page_scale_factor() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Requests that page scale factor is reset to initial values.
**EXPERIMENTAL**
'''
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.resetPageScaleFactor',
}
json = yield cmd_dict
def set_focus_emulation_enabled(
enabled: bool
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Enables or disables simulating a focused and active page.
**EXPERIMENTAL**
:param enabled: Whether to enable to disable focus emulation.
'''
params: T_JSON_DICT = dict()
params['enabled'] = enabled
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setFocusEmulationEnabled',
'params': params,
}
json = yield cmd_dict
def set_cpu_throttling_rate(
rate: float
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Enables CPU throttling to emulate slow CPUs.
**EXPERIMENTAL**
:param rate: Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).
'''
params: T_JSON_DICT = dict()
params['rate'] = rate
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setCPUThrottlingRate',
'params': params,
}
json = yield cmd_dict
def set_default_background_color_override(
color: typing.Optional[dom.RGBA] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Sets or clears an override of the default background color of the frame. This override is used
if the content does not specify one.
:param color: *(Optional)* RGBA of the default background color. If not specified, any existing override will be cleared.
'''
params: T_JSON_DICT = dict()
if color is not None:
params['color'] = color.to_json()
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setDefaultBackgroundColorOverride',
'params': params,
}
json = yield cmd_dict
def set_device_metrics_override(
width: int,
height: int,
device_scale_factor: float,
mobile: bool,
scale: typing.Optional[float] = None,
screen_width: typing.Optional[int] = None,
screen_height: typing.Optional[int] = None,
position_x: typing.Optional[int] = None,
position_y: typing.Optional[int] = None,
dont_set_visible_size: typing.Optional[bool] = None,
screen_orientation: typing.Optional[ScreenOrientation] = None,
viewport: typing.Optional[page.Viewport] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
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).
:param width: Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
:param height: Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
:param device_scale_factor: Overriding device scale factor value. 0 disables the override.
:param mobile: Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.
:param scale: **(EXPERIMENTAL)** *(Optional)* Scale to apply to resulting view image.
:param screen_width: **(EXPERIMENTAL)** *(Optional)* Overriding screen width value in pixels (minimum 0, maximum 10000000).
:param screen_height: **(EXPERIMENTAL)** *(Optional)* Overriding screen height value in pixels (minimum 0, maximum 10000000).
:param position_x: **(EXPERIMENTAL)** *(Optional)* Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
:param position_y: **(EXPERIMENTAL)** *(Optional)* Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
:param dont_set_visible_size: **(EXPERIMENTAL)** *(Optional)* Do not set visible view size, rely upon explicit setVisibleSize call.
:param screen_orientation: *(Optional)* Screen orientation override.
:param viewport: **(EXPERIMENTAL)** *(Optional)* If set, the visible area of the page will be overridden to this viewport. This viewport change is not observed by the page, e.g. viewport-relative elements do not change positions.
'''
params: T_JSON_DICT = dict()
params['width'] = width
params['height'] = height
params['deviceScaleFactor'] = device_scale_factor
params['mobile'] = mobile
if scale is not None:
params['scale'] = scale
if screen_width is not None:
params['screenWidth'] = screen_width
if screen_height is not None:
params['screenHeight'] = screen_height
if position_x is not None:
params['positionX'] = position_x
if position_y is not None:
params['positionY'] = position_y
if dont_set_visible_size is not None:
params['dontSetVisibleSize'] = dont_set_visible_size
if screen_orientation is not None:
params['screenOrientation'] = screen_orientation.to_json()
if viewport is not None:
params['viewport'] = viewport.to_json()
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setDeviceMetricsOverride',
'params': params,
}
json = yield cmd_dict
def set_scrollbars_hidden(
hidden: bool
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
**EXPERIMENTAL**
:param hidden: Whether scrollbars should be always hidden.
'''
params: T_JSON_DICT = dict()
params['hidden'] = hidden
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setScrollbarsHidden',
'params': params,
}
json = yield cmd_dict
def set_document_cookie_disabled(
disabled: bool
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
**EXPERIMENTAL**
:param disabled: Whether document.coookie API should be disabled.
'''
params: T_JSON_DICT = dict()
params['disabled'] = disabled
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setDocumentCookieDisabled',
'params': params,
}
json = yield cmd_dict
def set_emit_touch_events_for_mouse(
enabled: bool,
configuration: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
**EXPERIMENTAL**
:param enabled: Whether touch emulation based on mouse input should be enabled.
:param configuration: *(Optional)* Touch/gesture events configuration. Default: current platform.
'''
params: T_JSON_DICT = dict()
params['enabled'] = enabled
if configuration is not None:
params['configuration'] = configuration
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setEmitTouchEventsForMouse',
'params': params,
}
json = yield cmd_dict
def set_emulated_media(
media: typing.Optional[str] = None,
features: typing.Optional[typing.List[MediaFeature]] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Emulates the given media type or media feature for CSS media queries.
:param media: *(Optional)* Media type to emulate. Empty string disables the override.
:param features: *(Optional)* Media features to emulate.
'''
params: T_JSON_DICT = dict()
if media is not None:
params['media'] = media
if features is not None:
params['features'] = [i.to_json() for i in features]
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setEmulatedMedia',
'params': params,
}
json = yield cmd_dict
def set_emulated_vision_deficiency(
type_: str
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Emulates the given vision deficiency.
**EXPERIMENTAL**
:param type_: Vision deficiency to emulate.
'''
params: T_JSON_DICT = dict()
params['type'] = type_
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setEmulatedVisionDeficiency',
'params': params,
}
json = yield cmd_dict
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]:
'''
Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
unavailable.
:param latitude: *(Optional)* Mock latitude
:param longitude: *(Optional)* Mock longitude
:param accuracy: *(Optional)* Mock accuracy
'''
params: T_JSON_DICT = dict()
if latitude is not None:
params['latitude'] = latitude
if longitude is not None:
params['longitude'] = longitude
if accuracy is not None:
params['accuracy'] = accuracy
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setGeolocationOverride',
'params': params,
}
json = yield cmd_dict
def set_navigator_overrides(
platform: str
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Overrides value returned by the javascript navigator object.
**EXPERIMENTAL**
:param platform: The platform navigator.platform should return.
'''
params: T_JSON_DICT = dict()
params['platform'] = platform
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setNavigatorOverrides',
'params': params,
}
json = yield cmd_dict
def set_page_scale_factor(
page_scale_factor: float
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Sets a specified page scale factor.
**EXPERIMENTAL**
:param page_scale_factor: Page scale factor.
'''
params: T_JSON_DICT = dict()
params['pageScaleFactor'] = page_scale_factor
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setPageScaleFactor',
'params': params,
}
json = yield cmd_dict
def set_script_execution_disabled(
value: bool
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Switches script execution in the page.
:param value: Whether script execution should be disabled in the page.
'''
params: T_JSON_DICT = dict()
params['value'] = value
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setScriptExecutionDisabled',
'params': params,
}
json = yield cmd_dict
def set_touch_emulation_enabled(
enabled: bool,
max_touch_points: typing.Optional[int] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Enables touch on platforms which do not support them.
:param enabled: Whether the touch event emulation should be enabled.
:param max_touch_points: *(Optional)* Maximum touch points supported. Defaults to one.
'''
params: T_JSON_DICT = dict()
params['enabled'] = enabled
if max_touch_points is not None:
params['maxTouchPoints'] = max_touch_points
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setTouchEmulationEnabled',
'params': params,
}
json = yield cmd_dict
def set_virtual_time_policy(
policy: VirtualTimePolicy,
budget: typing.Optional[float] = None,
max_virtual_time_task_starvation_count: typing.Optional[int] = None,
wait_for_navigation: typing.Optional[bool] = None,
initial_virtual_time: typing.Optional[network.TimeSinceEpoch] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,float]:
'''
Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets
the current virtual time policy. Note this supersedes any previous time budget.
**EXPERIMENTAL**
:param policy:
:param budget: *(Optional)* If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.
:param max_virtual_time_task_starvation_count: *(Optional)* If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.
:param wait_for_navigation: *(Optional)* If set the virtual time policy change should be deferred until any frame starts navigating. Note any previous deferred policy change is superseded.
:param initial_virtual_time: *(Optional)* If set, base::Time::Now will be overridden to initially return this value.
:returns: Absolute timestamp at which virtual time was first enabled (up time in milliseconds).
'''
params: T_JSON_DICT = dict()
params['policy'] = policy.to_json()
if budget is not None:
params['budget'] = budget
if max_virtual_time_task_starvation_count is not None:
params['maxVirtualTimeTaskStarvationCount'] = max_virtual_time_task_starvation_count
if wait_for_navigation is not None:
params['waitForNavigation'] = wait_for_navigation
if initial_virtual_time is not None:
params['initialVirtualTime'] = initial_virtual_time.to_json()
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setVirtualTimePolicy',
'params': params,
}
json = yield cmd_dict
return float(json['virtualTimeTicksBase'])
def set_locale_override(
locale: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Overrides default host system locale with the specified one.
**EXPERIMENTAL**
:param locale: *(Optional)* ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and restores default host system locale.
'''
params: T_JSON_DICT = dict()
if locale is not None:
params['locale'] = locale
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setLocaleOverride',
'params': params,
}
json = yield cmd_dict
def set_timezone_override(
timezone_id: str
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Overrides default host system timezone with the specified one.
**EXPERIMENTAL**
:param timezone_id: The timezone identifier. If empty, disables the override and restores default host system timezone.
'''
params: T_JSON_DICT = dict()
params['timezoneId'] = timezone_id
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setTimezoneOverride',
'params': params,
}
json = yield cmd_dict
def set_visible_size(
width: int,
height: int
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
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.
**EXPERIMENTAL**
:param width: Frame width (DIP).
:param height: Frame height (DIP).
'''
params: T_JSON_DICT = dict()
params['width'] = width
params['height'] = height
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setVisibleSize',
'params': params,
}
json = yield cmd_dict
def set_user_agent_override(
user_agent: str,
accept_language: typing.Optional[str] = None,
platform: typing.Optional[str] = None,
user_agent_metadata: typing.Optional[UserAgentMetadata] = None
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
'''
Allows overriding user agent with the given string.
:param user_agent: User agent to use.
:param accept_language: *(Optional)* Browser langugage to emulate.
:param platform: *(Optional)* The platform navigator.platform should return.
:param user_agent_metadata: **(EXPERIMENTAL)** *(Optional)* To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
'''
params: T_JSON_DICT = dict()
params['userAgent'] = user_agent
if accept_language is not None:
params['acceptLanguage'] = accept_language
if platform is not None:
params['platform'] = platform
if user_agent_metadata is not None:
params['userAgentMetadata'] = user_agent_metadata.to_json()
cmd_dict: T_JSON_DICT = {
'method': 'Emulation.setUserAgentOverride',
'params': params,
}
json = yield cmd_dict
@event_class('Emulation.virtualTimeBudgetExpired')
@dataclass
class VirtualTimeBudgetExpired:
'''
**EXPERIMENTAL**
Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
'''
@classmethod
def from_json(cls, json: T_JSON_DICT) -> VirtualTimeBudgetExpired:
return cls(
)