browser

Bounds dataclass

Browser window bounds information

Source code in zendriver/cdp/browser.py

@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) -> T_JSON_DICT:
        json: T_JSON_DICT = 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: T_JSON_DICT) -> Bounds:
        return cls(
            left=int(json["left"]) if json.get("left", None) is not None else None,
            top=int(json["top"]) if json.get("top", None) is not None else None,
            width=int(json["width"]) if json.get("width", None) is not None else None,
            height=int(json["height"])
            if json.get("height", None) is not None
            else None,
            window_state=WindowState.from_json(json["windowState"])
            if json.get("windowState", None) is not None
            else None,
        )

height: typing.Optional[int] = None class-attribute instance-attribute

left: typing.Optional[int] = None class-attribute instance-attribute

top: typing.Optional[int] = None class-attribute instance-attribute

width: typing.Optional[int] = None class-attribute instance-attribute

window_state: typing.Optional[WindowState] = None class-attribute instance-attribute

__init__(left=None, top=None, width=None, height=None, window_state=None)

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Bounds:
    return cls(
        left=int(json["left"]) if json.get("left", None) is not None else None,
        top=int(json["top"]) if json.get("top", None) is not None else None,
        width=int(json["width"]) if json.get("width", None) is not None else None,
        height=int(json["height"])
        if json.get("height", None) is not None
        else None,
        window_state=WindowState.from_json(json["windowState"])
        if json.get("windowState", None) is not None
        else None,
    )

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = 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

BrowserCommandId

Bases: Enum

Browser command ids used by executeBrowserCommand.

Source code in zendriver/cdp/browser.py

class BrowserCommandId(enum.Enum):
    """
    Browser command ids used by executeBrowserCommand.
    """

    OPEN_TAB_SEARCH = "openTabSearch"
    CLOSE_TAB_SEARCH = "closeTabSearch"
    OPEN_GLIC = "openGlic"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> BrowserCommandId:
        return cls(json)

CLOSE_TAB_SEARCH = 'closeTabSearch' class-attribute instance-attribute

OPEN_GLIC = 'openGlic' class-attribute instance-attribute

OPEN_TAB_SEARCH = 'openTabSearch' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: str) -> BrowserCommandId:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> str:
    return self.value

BrowserContextID

Bases: str

Source code in zendriver/cdp/browser.py

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__())

__repr__()

Source code in zendriver/cdp/browser.py

def __repr__(self):
    return "BrowserContextID({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: str) -> BrowserContextID:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> str:
    return self

Bucket dataclass

Chrome histogram bucket.

Source code in zendriver/cdp/browser.py

@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) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["low"] = self.low
        json["high"] = self.high
        json["count"] = self.count
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Bucket:
        return cls(
            low=int(json["low"]),
            high=int(json["high"]),
            count=int(json["count"]),
        )

count: int instance-attribute

high: int instance-attribute

low: int instance-attribute

__init__(low, high, count)

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Bucket:
    return cls(
        low=int(json["low"]),
        high=int(json["high"]),
        count=int(json["count"]),
    )

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["low"] = self.low
    json["high"] = self.high
    json["count"] = self.count
    return json

DownloadProgress dataclass

EXPERIMENTAL

Fired when download makes progress. Last call has done == true.

Source code in zendriver/cdp/browser.py

@event_class("Browser.downloadProgress")
@dataclass
class DownloadProgress:
    """
    **EXPERIMENTAL**

    Fired when download makes progress. Last call has ``done`` == true.
    """

    #: Global unique identifier of the download.
    guid: str
    #: Total expected bytes to download.
    total_bytes: float
    #: Total bytes received.
    received_bytes: float
    #: Download status.
    state: str
    #: If download is "completed", provides the path of the downloaded file.
    #: Depending on the platform, it is not guaranteed to be set, nor the file
    #: is guaranteed to exist.
    file_path: typing.Optional[str]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DownloadProgress:
        return cls(
            guid=str(json["guid"]),
            total_bytes=float(json["totalBytes"]),
            received_bytes=float(json["receivedBytes"]),
            state=str(json["state"]),
            file_path=str(json["filePath"])
            if json.get("filePath", None) is not None
            else None,
        )

file_path: typing.Optional[str] instance-attribute

guid: str instance-attribute

received_bytes: float instance-attribute

state: str instance-attribute

total_bytes: float instance-attribute

__init__(guid, total_bytes, received_bytes, state, file_path)

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> DownloadProgress:
    return cls(
        guid=str(json["guid"]),
        total_bytes=float(json["totalBytes"]),
        received_bytes=float(json["receivedBytes"]),
        state=str(json["state"]),
        file_path=str(json["filePath"])
        if json.get("filePath", None) is not None
        else None,
    )

DownloadWillBegin dataclass

EXPERIMENTAL

Fired when page is about to start a download.

Source code in zendriver/cdp/browser.py

@event_class("Browser.downloadWillBegin")
@dataclass
class DownloadWillBegin:
    """
    **EXPERIMENTAL**

    Fired when page is about to start a download.
    """

    #: Id of the frame that caused the download to begin.
    frame_id: page.FrameId
    #: Global unique identifier of the download.
    guid: str
    #: URL of the resource being downloaded.
    url: str
    #: Suggested file name of the resource (the actual name of the file saved on disk may differ).
    suggested_filename: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DownloadWillBegin:
        return cls(
            frame_id=page.FrameId.from_json(json["frameId"]),
            guid=str(json["guid"]),
            url=str(json["url"]),
            suggested_filename=str(json["suggestedFilename"]),
        )

frame_id: page.FrameId instance-attribute

guid: str instance-attribute

suggested_filename: str instance-attribute

url: str instance-attribute

__init__(frame_id, guid, url, suggested_filename)

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> DownloadWillBegin:
    return cls(
        frame_id=page.FrameId.from_json(json["frameId"]),
        guid=str(json["guid"]),
        url=str(json["url"]),
        suggested_filename=str(json["suggestedFilename"]),
    )

Histogram dataclass

Chrome histogram.

Source code in zendriver/cdp/browser.py

@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) -> T_JSON_DICT:
        json: T_JSON_DICT = 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: T_JSON_DICT) -> Histogram:
        return cls(
            name=str(json["name"]),
            sum_=int(json["sum"]),
            count=int(json["count"]),
            buckets=[Bucket.from_json(i) for i in json["buckets"]],
        )

buckets: typing.List[Bucket] instance-attribute

count: int instance-attribute

name: str instance-attribute

sum_: int instance-attribute

__init__(name, sum_, count, buckets)

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Histogram:
    return cls(
        name=str(json["name"]),
        sum_=int(json["sum"]),
        count=int(json["count"]),
        buckets=[Bucket.from_json(i) for i in json["buckets"]],
    )

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = 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

PermissionDescriptor dataclass

Definition of PermissionDescriptor defined in the Permissions API: https://w3c.github.io/permissions/#dom-permissiondescriptor.

Source code in zendriver/cdp/browser.py

@dataclass
class PermissionDescriptor:
    """
    Definition of PermissionDescriptor defined in the Permissions API:
    https://w3c.github.io/permissions/#dom-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 "clipboard" permission, may specify allowWithoutSanitization.
    allow_without_sanitization: typing.Optional[bool] = None

    #: For "fullscreen" permission, must specify allowWithoutGesture:true.
    allow_without_gesture: typing.Optional[bool] = None

    #: For "camera" permission, may specify panTiltZoom.
    pan_tilt_zoom: typing.Optional[bool] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = 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.allow_without_sanitization is not None:
            json["allowWithoutSanitization"] = self.allow_without_sanitization
        if self.allow_without_gesture is not None:
            json["allowWithoutGesture"] = self.allow_without_gesture
        if self.pan_tilt_zoom is not None:
            json["panTiltZoom"] = self.pan_tilt_zoom
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> PermissionDescriptor:
        return cls(
            name=str(json["name"]),
            sysex=bool(json["sysex"]) if json.get("sysex", None) is not None else None,
            user_visible_only=bool(json["userVisibleOnly"])
            if json.get("userVisibleOnly", None) is not None
            else None,
            allow_without_sanitization=bool(json["allowWithoutSanitization"])
            if json.get("allowWithoutSanitization", None) is not None
            else None,
            allow_without_gesture=bool(json["allowWithoutGesture"])
            if json.get("allowWithoutGesture", None) is not None
            else None,
            pan_tilt_zoom=bool(json["panTiltZoom"])
            if json.get("panTiltZoom", None) is not None
            else None,
        )

allow_without_gesture: typing.Optional[bool] = None class-attribute instance-attribute

allow_without_sanitization: typing.Optional[bool] = None class-attribute instance-attribute

name: str instance-attribute

pan_tilt_zoom: typing.Optional[bool] = None class-attribute instance-attribute

sysex: typing.Optional[bool] = None class-attribute instance-attribute

user_visible_only: typing.Optional[bool] = None class-attribute instance-attribute

__init__(name, sysex=None, user_visible_only=None, allow_without_sanitization=None, allow_without_gesture=None, pan_tilt_zoom=None)

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> PermissionDescriptor:
    return cls(
        name=str(json["name"]),
        sysex=bool(json["sysex"]) if json.get("sysex", None) is not None else None,
        user_visible_only=bool(json["userVisibleOnly"])
        if json.get("userVisibleOnly", None) is not None
        else None,
        allow_without_sanitization=bool(json["allowWithoutSanitization"])
        if json.get("allowWithoutSanitization", None) is not None
        else None,
        allow_without_gesture=bool(json["allowWithoutGesture"])
        if json.get("allowWithoutGesture", None) is not None
        else None,
        pan_tilt_zoom=bool(json["panTiltZoom"])
        if json.get("panTiltZoom", None) is not None
        else None,
    )

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = 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.allow_without_sanitization is not None:
        json["allowWithoutSanitization"] = self.allow_without_sanitization
    if self.allow_without_gesture is not None:
        json["allowWithoutGesture"] = self.allow_without_gesture
    if self.pan_tilt_zoom is not None:
        json["panTiltZoom"] = self.pan_tilt_zoom
    return json

PermissionSetting

Bases: Enum

Source code in zendriver/cdp/browser.py

class PermissionSetting(enum.Enum):
    GRANTED = "granted"
    DENIED = "denied"
    PROMPT = "prompt"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> PermissionSetting:
        return cls(json)

DENIED = 'denied' class-attribute instance-attribute

GRANTED = 'granted' class-attribute instance-attribute

PROMPT = 'prompt' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: str) -> PermissionSetting:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> str:
    return self.value

PermissionType

Bases: Enum

Source code in zendriver/cdp/browser.py

class PermissionType(enum.Enum):
    AR = "ar"
    AUDIO_CAPTURE = "audioCapture"
    AUTOMATIC_FULLSCREEN = "automaticFullscreen"
    BACKGROUND_FETCH = "backgroundFetch"
    BACKGROUND_SYNC = "backgroundSync"
    CAMERA_PAN_TILT_ZOOM = "cameraPanTiltZoom"
    CAPTURED_SURFACE_CONTROL = "capturedSurfaceControl"
    CLIPBOARD_READ_WRITE = "clipboardReadWrite"
    CLIPBOARD_SANITIZED_WRITE = "clipboardSanitizedWrite"
    DISPLAY_CAPTURE = "displayCapture"
    DURABLE_STORAGE = "durableStorage"
    GEOLOCATION = "geolocation"
    HAND_TRACKING = "handTracking"
    IDLE_DETECTION = "idleDetection"
    KEYBOARD_LOCK = "keyboardLock"
    LOCAL_FONTS = "localFonts"
    LOCAL_NETWORK = "localNetwork"
    LOCAL_NETWORK_ACCESS = "localNetworkAccess"
    LOOPBACK_NETWORK = "loopbackNetwork"
    MIDI = "midi"
    MIDI_SYSEX = "midiSysex"
    NFC = "nfc"
    NOTIFICATIONS = "notifications"
    PAYMENT_HANDLER = "paymentHandler"
    PERIODIC_BACKGROUND_SYNC = "periodicBackgroundSync"
    POINTER_LOCK = "pointerLock"
    PROTECTED_MEDIA_IDENTIFIER = "protectedMediaIdentifier"
    SENSORS = "sensors"
    SMART_CARD = "smartCard"
    SPEAKER_SELECTION = "speakerSelection"
    STORAGE_ACCESS = "storageAccess"
    TOP_LEVEL_STORAGE_ACCESS = "topLevelStorageAccess"
    VIDEO_CAPTURE = "videoCapture"
    VR = "vr"
    WAKE_LOCK_SCREEN = "wakeLockScreen"
    WAKE_LOCK_SYSTEM = "wakeLockSystem"
    WEB_APP_INSTALLATION = "webAppInstallation"
    WEB_PRINTING = "webPrinting"
    WINDOW_MANAGEMENT = "windowManagement"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> PermissionType:
        return cls(json)

AR = 'ar' class-attribute instance-attribute

AUDIO_CAPTURE = 'audioCapture' class-attribute instance-attribute

AUTOMATIC_FULLSCREEN = 'automaticFullscreen' class-attribute instance-attribute

BACKGROUND_FETCH = 'backgroundFetch' class-attribute instance-attribute

BACKGROUND_SYNC = 'backgroundSync' class-attribute instance-attribute

CAMERA_PAN_TILT_ZOOM = 'cameraPanTiltZoom' class-attribute instance-attribute

CAPTURED_SURFACE_CONTROL = 'capturedSurfaceControl' class-attribute instance-attribute

CLIPBOARD_READ_WRITE = 'clipboardReadWrite' class-attribute instance-attribute

CLIPBOARD_SANITIZED_WRITE = 'clipboardSanitizedWrite' class-attribute instance-attribute

DISPLAY_CAPTURE = 'displayCapture' class-attribute instance-attribute

DURABLE_STORAGE = 'durableStorage' class-attribute instance-attribute

GEOLOCATION = 'geolocation' class-attribute instance-attribute

HAND_TRACKING = 'handTracking' class-attribute instance-attribute

IDLE_DETECTION = 'idleDetection' class-attribute instance-attribute

KEYBOARD_LOCK = 'keyboardLock' class-attribute instance-attribute

LOCAL_FONTS = 'localFonts' class-attribute instance-attribute

LOCAL_NETWORK = 'localNetwork' class-attribute instance-attribute

LOCAL_NETWORK_ACCESS = 'localNetworkAccess' class-attribute instance-attribute

LOOPBACK_NETWORK = 'loopbackNetwork' class-attribute instance-attribute

MIDI = 'midi' class-attribute instance-attribute

MIDI_SYSEX = 'midiSysex' class-attribute instance-attribute

NFC = 'nfc' class-attribute instance-attribute

NOTIFICATIONS = 'notifications' class-attribute instance-attribute

PAYMENT_HANDLER = 'paymentHandler' class-attribute instance-attribute

PERIODIC_BACKGROUND_SYNC = 'periodicBackgroundSync' class-attribute instance-attribute

POINTER_LOCK = 'pointerLock' class-attribute instance-attribute

PROTECTED_MEDIA_IDENTIFIER = 'protectedMediaIdentifier' class-attribute instance-attribute

SENSORS = 'sensors' class-attribute instance-attribute

SMART_CARD = 'smartCard' class-attribute instance-attribute

SPEAKER_SELECTION = 'speakerSelection' class-attribute instance-attribute

STORAGE_ACCESS = 'storageAccess' class-attribute instance-attribute

TOP_LEVEL_STORAGE_ACCESS = 'topLevelStorageAccess' class-attribute instance-attribute

VIDEO_CAPTURE = 'videoCapture' class-attribute instance-attribute

VR = 'vr' class-attribute instance-attribute

WAKE_LOCK_SCREEN = 'wakeLockScreen' class-attribute instance-attribute

WAKE_LOCK_SYSTEM = 'wakeLockSystem' class-attribute instance-attribute

WEB_APP_INSTALLATION = 'webAppInstallation' class-attribute instance-attribute

WEB_PRINTING = 'webPrinting' class-attribute instance-attribute

WINDOW_MANAGEMENT = 'windowManagement' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: str) -> PermissionType:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> str:
    return self.value

PrivacySandboxAPI

Bases: Enum

Source code in zendriver/cdp/browser.py

class PrivacySandboxAPI(enum.Enum):
    BIDDING_AND_AUCTION_SERVICES = "BiddingAndAuctionServices"
    TRUSTED_KEY_VALUE = "TrustedKeyValue"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> PrivacySandboxAPI:
        return cls(json)

BIDDING_AND_AUCTION_SERVICES = 'BiddingAndAuctionServices' class-attribute instance-attribute

TRUSTED_KEY_VALUE = 'TrustedKeyValue' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: str) -> PrivacySandboxAPI:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> str:
    return self.value

WindowID

Bases: int

Source code in zendriver/cdp/browser.py

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__())

__repr__()

Source code in zendriver/cdp/browser.py

def __repr__(self):
    return "WindowID({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: int) -> WindowID:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> int:
    return self

WindowState

Bases: Enum

The state of the browser window.

Source code in zendriver/cdp/browser.py

class WindowState(enum.Enum):
    """
    The state of the browser window.
    """

    NORMAL = "normal"
    MINIMIZED = "minimized"
    MAXIMIZED = "maximized"
    FULLSCREEN = "fullscreen"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> WindowState:
        return cls(json)

FULLSCREEN = 'fullscreen' class-attribute instance-attribute

MAXIMIZED = 'maximized' class-attribute instance-attribute

MINIMIZED = 'minimized' class-attribute instance-attribute

NORMAL = 'normal' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/browser.py

@classmethod
def from_json(cls, json: str) -> WindowState:
    return cls(json)

to_json()

Source code in zendriver/cdp/browser.py

def to_json(self) -> str:
    return self.value

add_privacy_sandbox_coordinator_key_config(api, coordinator_origin, key_config, browser_context_id=None)

Configures encryption keys used with a given privacy sandbox API to talk to a trusted coordinator. Since this is intended for test automation only, coordinatorOrigin must be a .test domain. No existing coordinator configuration for the origin may exist.

Parameters:

Name	Type	Description	Default
api	PrivacySandboxAPI		required
coordinator_origin	str		required
key_config	str		required
browser_context_id	Optional[BrowserContextID]	(Optional) BrowserContext to perform the action in. When omitted, default browser context is used.	None

Source code in zendriver/cdp/browser.py

def add_privacy_sandbox_coordinator_key_config(
    api: PrivacySandboxAPI,
    coordinator_origin: str,
    key_config: str,
    browser_context_id: typing.Optional[BrowserContextID] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Configures encryption keys used with a given privacy sandbox API to talk
    to a trusted coordinator.  Since this is intended for test automation only,
    coordinatorOrigin must be a .test domain. No existing coordinator
    configuration for the origin may exist.

    :param api:
    :param coordinator_origin:
    :param key_config:
    :param browser_context_id: *(Optional)* BrowserContext to perform the action in. When omitted, default browser context is used.
    """
    params: T_JSON_DICT = dict()
    params["api"] = api.to_json()
    params["coordinatorOrigin"] = coordinator_origin
    params["keyConfig"] = key_config
    if browser_context_id is not None:
        params["browserContextId"] = browser_context_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Browser.addPrivacySandboxCoordinatorKeyConfig",
        "params": params,
    }
    json = yield cmd_dict

add_privacy_sandbox_enrollment_override(url)

Allows a site to use privacy sandbox features that require enrollment without the site actually being enrolled. Only supported on page targets.

Parameters:

Name	Type	Description	Default
url	str		required

Source code in zendriver/cdp/browser.py

def add_privacy_sandbox_enrollment_override(
    url: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Allows a site to use privacy sandbox features that require enrollment
    without the site actually being enrolled. Only supported on page targets.

    :param url:
    """
    params: T_JSON_DICT = dict()
    params["url"] = url
    cmd_dict: T_JSON_DICT = {
        "method": "Browser.addPrivacySandboxEnrollmentOverride",
        "params": params,
    }
    json = yield cmd_dict

cancel_download(guid, browser_context_id=None)

Cancel a download if in progress

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
guid	str	Global unique identifier of the download.	required
browser_context_id	Optional[BrowserContextID]	(Optional) BrowserContext to perform the action in. When omitted, default browser context is used.	None

Source code in zendriver/cdp/browser.py

def cancel_download(
    guid: str, browser_context_id: typing.Optional[BrowserContextID] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Cancel a download if in progress

    **EXPERIMENTAL**

    :param guid: Global unique identifier of the download.
    :param browser_context_id: *(Optional)* BrowserContext to perform the action in. When omitted, default browser context is used.
    """
    params: T_JSON_DICT = dict()
    params["guid"] = guid
    if browser_context_id is not None:
        params["browserContextId"] = browser_context_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Browser.cancelDownload",
        "params": params,
    }
    json = yield cmd_dict

close()

Close browser gracefully.

Source code in zendriver/cdp/browser.py

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

crash()

Crashes browser on the main thread.

EXPERIMENTAL

Source code in zendriver/cdp/browser.py

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

crash_gpu_process()

Crashes GPU process.

EXPERIMENTAL

Source code in zendriver/cdp/browser.py

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

execute_browser_command(command_id)

Invoke custom browser commands used by telemetry.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
command_id	BrowserCommandId		required

Source code in zendriver/cdp/browser.py

def execute_browser_command(
    command_id: BrowserCommandId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Invoke custom browser commands used by telemetry.

    **EXPERIMENTAL**

    :param command_id:
    """
    params: T_JSON_DICT = dict()
    params["commandId"] = command_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Browser.executeBrowserCommand",
        "params": params,
    }
    json = yield cmd_dict

get_browser_command_line()

Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[str]]	Commandline parameters

Source code in zendriver/cdp/browser.py

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"]]

get_histogram(name, delta=None)

Get a Chrome histogram by name.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
name	str	Requested histogram name.	required
delta	Optional[bool]	(Optional) If true, retrieve delta since last delta call.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Histogram]	Histogram.

Source code in zendriver/cdp/browser.py

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 delta 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"])

get_histograms(query=None, delta=None)

Get Chrome histograms.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
query	Optional[str]	(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.	None
delta	Optional[bool]	(Optional) If true, retrieve delta since last delta call.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[Histogram]]	Histograms.

Source code in zendriver/cdp/browser.py

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 delta 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"]]

get_version()

Returns version information.

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[str, str, str, str, str]]	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.

Source code in zendriver/cdp/browser.py

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"]),
    )

get_window_bounds(window_id)

Get position and size of the browser window.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
window_id	WindowID	Browser window id.	required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Bounds]	Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.

Source code in zendriver/cdp/browser.py

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"])

get_window_for_target(target_id=None)

Get the browser window that contains the devtools target.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
target_id	Optional[TargetID]	(Optional) Devtools agent host id. If called as a part of the session, associated targetId is used.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[WindowID, Bounds]]	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.

Source code in zendriver/cdp/browser.py

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"]))

grant_permissions(permissions, origin=None, browser_context_id=None)

Grant specific permissions to the given origin and reject all others. Deprecated. Use setPermission instead.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
permissions	List[PermissionType]		required
origin	Optional[str]	(Optional) Origin the permission applies to, all origins if not specified.	None
browser_context_id	Optional[BrowserContextID]	(Optional) BrowserContext to override permissions. When omitted, default browser context is used.	None

Source code in zendriver/cdp/browser.py

@deprecated(version="1.3")
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. Deprecated. Use
    setPermission instead.

    .. deprecated:: 1.3

    **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

reset_permissions(browser_context_id=None)

Reset all permission management for all origins.

Parameters:

Name	Type	Description	Default
browser_context_id	Optional[BrowserContextID]	(Optional) BrowserContext to reset permissions. When omitted, default browser context is used.	None

Source code in zendriver/cdp/browser.py

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.

    :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

set_contents_size(window_id, width=None, height=None)

Set size of the browser contents resizing browser window as necessary.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
window_id	WindowID	Browser window id.	required
width	Optional[int]	(Optional) The window contents width in DIP. Assumes current width if omitted. Must be specified if 'height' is omitted.	None
height	Optional[int]	(Optional) The window contents height in DIP. Assumes current height if omitted. Must be specified if 'width' is omitted.	None

Source code in zendriver/cdp/browser.py

def set_contents_size(
    window_id: WindowID,
    width: typing.Optional[int] = None,
    height: typing.Optional[int] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Set size of the browser contents resizing browser window as necessary.

    **EXPERIMENTAL**

    :param window_id: Browser window id.
    :param width: *(Optional)* The window contents width in DIP. Assumes current width if omitted. Must be specified if 'height' is omitted.
    :param height: *(Optional)* The window contents height in DIP. Assumes current height if omitted. Must be specified if 'width' is omitted.
    """
    params: T_JSON_DICT = dict()
    params["windowId"] = window_id.to_json()
    if width is not None:
        params["width"] = width
    if height is not None:
        params["height"] = height
    cmd_dict: T_JSON_DICT = {
        "method": "Browser.setContentsSize",
        "params": params,
    }
    json = yield cmd_dict

set_dock_tile(badge_label=None, image=None)

Set dock tile details, platform-specific.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
badge_label	Optional[str]	(Optional)	None
image	Optional[str]	(Optional) Png encoded image. (Encoded as a base64 string when passed over JSON)	None

Source code in zendriver/cdp/browser.py

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. (Encoded as a base64 string when passed over JSON)
    """
    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

set_download_behavior(behavior, browser_context_id=None, download_path=None, events_enabled=None)

Set the behavior when downloading a file.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
behavior	str	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 download guids.	required
browser_context_id	Optional[BrowserContextID]	(Optional) BrowserContext to set download behavior. When omitted, default browser context is used.	None
download_path	Optional[str]	(Optional) The default path to save downloaded files to. This is required if behavior is set to 'allow' or 'allowAndName'.	None
events_enabled	Optional[bool]	(Optional) Whether to emit download events (defaults to false).	None

Source code in zendriver/cdp/browser.py

def set_download_behavior(
    behavior: str,
    browser_context_id: typing.Optional[BrowserContextID] = None,
    download_path: typing.Optional[str] = None,
    events_enabled: typing.Optional[bool] = 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 download 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 required if behavior is set to 'allow' or 'allowAndName'.
    :param events_enabled: *(Optional)* Whether to emit download events (defaults to false).
    """
    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
    if events_enabled is not None:
        params["eventsEnabled"] = events_enabled
    cmd_dict: T_JSON_DICT = {
        "method": "Browser.setDownloadBehavior",
        "params": params,
    }
    json = yield cmd_dict

set_permission(permission, setting, origin=None, embedded_origin=None, browser_context_id=None)

Set permission settings for given embedding and embedded origins.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
permission	PermissionDescriptor	Descriptor of permission to override.	required
setting	PermissionSetting	Setting of the permission.	required
origin	Optional[str]	(Optional) Embedding origin the permission applies to, all origins if not specified.	None
embedded_origin	Optional[str]	(Optional) Embedded origin the permission applies to. It is ignored unless the embedding origin is present and valid. If the embedding origin is provided but the embedded origin isn't, the embedding origin is used as the embedded origin.	None
browser_context_id	Optional[BrowserContextID]	(Optional) Context to override. When omitted, default browser context is used.	None

Source code in zendriver/cdp/browser.py

def set_permission(
    permission: PermissionDescriptor,
    setting: PermissionSetting,
    origin: typing.Optional[str] = None,
    embedded_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 embedding and embedded origins.

    **EXPERIMENTAL**

    :param permission: Descriptor of permission to override.
    :param setting: Setting of the permission.
    :param origin: *(Optional)* Embedding origin the permission applies to, all origins if not specified.
    :param embedded_origin: *(Optional)* Embedded origin the permission applies to. It is ignored unless the embedding origin is present and valid. If the embedding origin is provided but the embedded origin isn't, the embedding origin is used as the embedded origin.
    :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 embedded_origin is not None:
        params["embeddedOrigin"] = embedded_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

set_window_bounds(window_id, bounds)

Set position and/or size of the browser window.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
window_id	WindowID	Browser window id.	required
bounds	Bounds	New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.	required

Source code in zendriver/cdp/browser.py

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