# 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: Browser
|
from __future__ import annotations
|
from .util import event_class, T_JSON_DICT
|
from dataclasses import dataclass
|
import enum
|
import typing
|
from . import target
|
|
|
class BrowserContextID(str):
|
def to_json(self) -> str:
|
return self
|
|
@classmethod
|
def from_json(cls, json: str) -> BrowserContextID:
|
return cls(json)
|
|
def __repr__(self):
|
return 'BrowserContextID({})'.format(super().__repr__())
|
|
|
class WindowID(int):
|
def to_json(self) -> int:
|
return self
|
|
@classmethod
|
def from_json(cls, json: int) -> WindowID:
|
return cls(json)
|
|
def __repr__(self):
|
return 'WindowID({})'.format(super().__repr__())
|
|
|
class WindowState(enum.Enum):
|
'''
|
The state of the browser window.
|
'''
|
NORMAL = "normal"
|
MINIMIZED = "minimized"
|
MAXIMIZED = "maximized"
|
FULLSCREEN = "fullscreen"
|
|
def to_json(self):
|
return self.value
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(json)
|
|
|
@dataclass
|
class Bounds:
|
'''
|
Browser window bounds information
|
'''
|
#: The offset from the left edge of the screen to the window in pixels.
|
left: typing.Optional[int] = None
|
|
#: The offset from the top edge of the screen to the window in pixels.
|
top: typing.Optional[int] = None
|
|
#: The window width in pixels.
|
width: typing.Optional[int] = None
|
|
#: The window height in pixels.
|
height: typing.Optional[int] = None
|
|
#: The window state. Default to normal.
|
window_state: typing.Optional[WindowState] = None
|
|
def to_json(self):
|
json = dict()
|
if self.left is not None:
|
json['left'] = self.left
|
if self.top is not None:
|
json['top'] = self.top
|
if self.width is not None:
|
json['width'] = self.width
|
if self.height is not None:
|
json['height'] = self.height
|
if self.window_state is not None:
|
json['windowState'] = self.window_state.to_json()
|
return json
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(
|
left=int(json['left']) if 'left' in json else None,
|
top=int(json['top']) if 'top' in json else None,
|
width=int(json['width']) if 'width' in json else None,
|
height=int(json['height']) if 'height' in json else None,
|
window_state=WindowState.from_json(json['windowState']) if 'windowState' in json else None,
|
)
|
|
|
class PermissionType(enum.Enum):
|
ACCESSIBILITY_EVENTS = "accessibilityEvents"
|
AUDIO_CAPTURE = "audioCapture"
|
BACKGROUND_SYNC = "backgroundSync"
|
BACKGROUND_FETCH = "backgroundFetch"
|
CLIPBOARD_READ_WRITE = "clipboardReadWrite"
|
CLIPBOARD_SANITIZED_WRITE = "clipboardSanitizedWrite"
|
DURABLE_STORAGE = "durableStorage"
|
FLASH = "flash"
|
GEOLOCATION = "geolocation"
|
MIDI = "midi"
|
MIDI_SYSEX = "midiSysex"
|
NFC = "nfc"
|
NOTIFICATIONS = "notifications"
|
PAYMENT_HANDLER = "paymentHandler"
|
PERIODIC_BACKGROUND_SYNC = "periodicBackgroundSync"
|
PROTECTED_MEDIA_IDENTIFIER = "protectedMediaIdentifier"
|
SENSORS = "sensors"
|
VIDEO_CAPTURE = "videoCapture"
|
IDLE_DETECTION = "idleDetection"
|
WAKE_LOCK_SCREEN = "wakeLockScreen"
|
WAKE_LOCK_SYSTEM = "wakeLockSystem"
|
|
def to_json(self):
|
return self.value
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(json)
|
|
|
class PermissionSetting(enum.Enum):
|
GRANTED = "granted"
|
DENIED = "denied"
|
PROMPT = "prompt"
|
|
def to_json(self):
|
return self.value
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(json)
|
|
|
@dataclass
|
class PermissionDescriptor:
|
'''
|
Definition of PermissionDescriptor defined in the Permissions API:
|
https://w3c.github.io/permissions/#dictdef-permissiondescriptor.
|
'''
|
#: Name of permission.
|
#: See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
|
name: str
|
|
#: For "midi" permission, may also specify sysex control.
|
sysex: typing.Optional[bool] = None
|
|
#: For "push" permission, may specify userVisibleOnly.
|
#: Note that userVisibleOnly = true is the only currently supported type.
|
user_visible_only: typing.Optional[bool] = None
|
|
#: For "wake-lock" permission, must specify type as either "screen" or "system".
|
type_: typing.Optional[str] = None
|
|
#: For "clipboard" permission, may specify allowWithoutSanitization.
|
allow_without_sanitization: typing.Optional[bool] = None
|
|
def to_json(self):
|
json = dict()
|
json['name'] = self.name
|
if self.sysex is not None:
|
json['sysex'] = self.sysex
|
if self.user_visible_only is not None:
|
json['userVisibleOnly'] = self.user_visible_only
|
if self.type_ is not None:
|
json['type'] = self.type_
|
if self.allow_without_sanitization is not None:
|
json['allowWithoutSanitization'] = self.allow_without_sanitization
|
return json
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(
|
name=str(json['name']),
|
sysex=bool(json['sysex']) if 'sysex' in json else None,
|
user_visible_only=bool(json['userVisibleOnly']) if 'userVisibleOnly' in json else None,
|
type_=str(json['type']) if 'type' in json else None,
|
allow_without_sanitization=bool(json['allowWithoutSanitization']) if 'allowWithoutSanitization' in json else None,
|
)
|
|
|
@dataclass
|
class Bucket:
|
'''
|
Chrome histogram bucket.
|
'''
|
#: Minimum value (inclusive).
|
low: int
|
|
#: Maximum value (exclusive).
|
high: int
|
|
#: Number of samples.
|
count: int
|
|
def to_json(self):
|
json = dict()
|
json['low'] = self.low
|
json['high'] = self.high
|
json['count'] = self.count
|
return json
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(
|
low=int(json['low']),
|
high=int(json['high']),
|
count=int(json['count']),
|
)
|
|
|
@dataclass
|
class Histogram:
|
'''
|
Chrome histogram.
|
'''
|
#: Name.
|
name: str
|
|
#: Sum of sample values.
|
sum_: int
|
|
#: Total number of samples.
|
count: int
|
|
#: Buckets.
|
buckets: typing.List[Bucket]
|
|
def to_json(self):
|
json = dict()
|
json['name'] = self.name
|
json['sum'] = self.sum_
|
json['count'] = self.count
|
json['buckets'] = [i.to_json() for i in self.buckets]
|
return json
|
|
@classmethod
|
def from_json(cls, json):
|
return cls(
|
name=str(json['name']),
|
sum_=int(json['sum']),
|
count=int(json['count']),
|
buckets=[Bucket.from_json(i) for i in json['buckets']],
|
)
|
|
|
def set_permission(
|
permission: PermissionDescriptor,
|
setting: PermissionSetting,
|
origin: typing.Optional[str] = None,
|
browser_context_id: typing.Optional[BrowserContextID] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Set permission settings for given origin.
|
|
**EXPERIMENTAL**
|
|
:param permission: Descriptor of permission to override.
|
:param setting: Setting of the permission.
|
:param origin: *(Optional)* Origin the permission applies to, all origins if not specified.
|
:param browser_context_id: *(Optional)* Context to override. When omitted, default browser context is used.
|
'''
|
params: T_JSON_DICT = dict()
|
params['permission'] = permission.to_json()
|
params['setting'] = setting.to_json()
|
if origin is not None:
|
params['origin'] = origin
|
if browser_context_id is not None:
|
params['browserContextId'] = browser_context_id.to_json()
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.setPermission',
|
'params': params,
|
}
|
json = yield cmd_dict
|
|
|
def grant_permissions(
|
permissions: typing.List[PermissionType],
|
origin: typing.Optional[str] = None,
|
browser_context_id: typing.Optional[BrowserContextID] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Grant specific permissions to the given origin and reject all others.
|
|
**EXPERIMENTAL**
|
|
:param permissions:
|
:param origin: *(Optional)* Origin the permission applies to, all origins if not specified.
|
:param browser_context_id: *(Optional)* BrowserContext to override permissions. When omitted, default browser context is used.
|
'''
|
params: T_JSON_DICT = dict()
|
params['permissions'] = [i.to_json() for i in permissions]
|
if origin is not None:
|
params['origin'] = origin
|
if browser_context_id is not None:
|
params['browserContextId'] = browser_context_id.to_json()
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.grantPermissions',
|
'params': params,
|
}
|
json = yield cmd_dict
|
|
|
def reset_permissions(
|
browser_context_id: typing.Optional[BrowserContextID] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Reset all permission management for all origins.
|
|
**EXPERIMENTAL**
|
|
: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:
|
params['browserContextId'] = browser_context_id.to_json()
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.resetPermissions',
|
'params': params,
|
}
|
json = yield cmd_dict
|
|
|
def set_download_behavior(
|
behavior: str,
|
browser_context_id: typing.Optional[BrowserContextID] = None,
|
download_path: typing.Optional[str] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Set the behavior when downloading a file.
|
|
**EXPERIMENTAL**
|
|
:param behavior: Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). ``allowAndName`` allows download and names files according to their dowmload guids.
|
:param browser_context_id: *(Optional)* BrowserContext to set download behavior. When omitted, default browser context is used.
|
:param download_path: *(Optional)* The default path to save downloaded files to. This is requred if behavior is set to 'allow' or 'allowAndName'.
|
'''
|
params: T_JSON_DICT = dict()
|
params['behavior'] = behavior
|
if browser_context_id is not None:
|
params['browserContextId'] = browser_context_id.to_json()
|
if download_path is not None:
|
params['downloadPath'] = download_path
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.setDownloadBehavior',
|
'params': params,
|
}
|
json = yield cmd_dict
|
|
|
def close() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Close browser gracefully.
|
'''
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.close',
|
}
|
json = yield cmd_dict
|
|
|
def crash() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Crashes browser on the main thread.
|
|
**EXPERIMENTAL**
|
'''
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.crash',
|
}
|
json = yield cmd_dict
|
|
|
def crash_gpu_process() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Crashes GPU process.
|
|
**EXPERIMENTAL**
|
'''
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.crashGpuProcess',
|
}
|
json = yield cmd_dict
|
|
|
def get_version() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[str, str, str, str, 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.
|
'''
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.getVersion',
|
}
|
json = yield cmd_dict
|
return (
|
str(json['protocolVersion']),
|
str(json['product']),
|
str(json['revision']),
|
str(json['userAgent']),
|
str(json['jsVersion'])
|
)
|
|
|
def get_browser_command_line() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[str]]:
|
'''
|
Returns the command line switches for the browser process if, and only if
|
--enable-automation is on the commandline.
|
|
**EXPERIMENTAL**
|
|
:returns: Commandline parameters
|
'''
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.getBrowserCommandLine',
|
}
|
json = yield cmd_dict
|
return [str(i) for i in json['arguments']]
|
|
|
def get_histograms(
|
query: typing.Optional[str] = None,
|
delta: typing.Optional[bool] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[Histogram]]:
|
'''
|
Get Chrome histograms.
|
|
**EXPERIMENTAL**
|
|
: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()
|
if query is not None:
|
params['query'] = query
|
if delta is not None:
|
params['delta'] = delta
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.getHistograms',
|
'params': params,
|
}
|
json = yield cmd_dict
|
return [Histogram.from_json(i) for i in json['histograms']]
|
|
|
def get_histogram(
|
name: str,
|
delta: typing.Optional[bool] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,Histogram]:
|
'''
|
Get a Chrome histogram by name.
|
|
**EXPERIMENTAL**
|
|
:param name: Requested histogram name.
|
:param delta: *(Optional)* If true, retrieve delta since last call.
|
:returns: Histogram.
|
'''
|
params: T_JSON_DICT = dict()
|
params['name'] = name
|
if delta is not None:
|
params['delta'] = delta
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.getHistogram',
|
'params': params,
|
}
|
json = yield cmd_dict
|
return Histogram.from_json(json['histogram'])
|
|
|
def get_window_bounds(
|
window_id: WindowID
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,Bounds]:
|
'''
|
Get position and size of the browser window.
|
|
**EXPERIMENTAL**
|
|
:param window_id: Browser window id.
|
:returns: Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.
|
'''
|
params: T_JSON_DICT = dict()
|
params['windowId'] = window_id.to_json()
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.getWindowBounds',
|
'params': params,
|
}
|
json = yield cmd_dict
|
return Bounds.from_json(json['bounds'])
|
|
|
def get_window_for_target(
|
target_id: typing.Optional[target.TargetID] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[WindowID, Bounds]]:
|
'''
|
Get the browser window that contains the devtools target.
|
|
**EXPERIMENTAL**
|
|
: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:
|
|
0. **windowId** - Browser window id.
|
1. **bounds** - Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.
|
'''
|
params: T_JSON_DICT = dict()
|
if target_id is not None:
|
params['targetId'] = target_id.to_json()
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.getWindowForTarget',
|
'params': params,
|
}
|
json = yield cmd_dict
|
return (
|
WindowID.from_json(json['windowId']),
|
Bounds.from_json(json['bounds'])
|
)
|
|
|
def set_window_bounds(
|
window_id: WindowID,
|
bounds: Bounds
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Set position and/or size of the browser window.
|
|
**EXPERIMENTAL**
|
|
:param window_id: Browser window id.
|
:param bounds: New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
|
'''
|
params: T_JSON_DICT = dict()
|
params['windowId'] = window_id.to_json()
|
params['bounds'] = bounds.to_json()
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.setWindowBounds',
|
'params': params,
|
}
|
json = yield cmd_dict
|
|
|
def set_dock_tile(
|
badge_label: typing.Optional[str] = None,
|
image: typing.Optional[str] = None
|
) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
|
'''
|
Set dock tile details, platform-specific.
|
|
**EXPERIMENTAL**
|
|
:param badge_label: *(Optional)*
|
:param image: *(Optional)* Png encoded image.
|
'''
|
params: T_JSON_DICT = dict()
|
if badge_label is not None:
|
params['badgeLabel'] = badge_label
|
if image is not None:
|
params['image'] = image
|
cmd_dict: T_JSON_DICT = {
|
'method': 'Browser.setDockTile',
|
'params': params,
|
}
|
json = yield cmd_dict
|
