Skip to content

浏览器协议

Chrome DevTools 协议的浏览器域命令、事件和类型。

方法

pydoll.protocol.browser.methods

GetVersionResponse module-attribute 

GetVersionResponse = Response[GetVersionResult]

GetBrowserCommandLineResponse module-attribute 

GetBrowserCommandLineResponse = Response[GetBrowserCommandLineResult]

GetHistogramsResponse module-attribute 

GetHistogramsResponse = Response[GetHistogramsResult]

GetHistogramResponse module-attribute 

GetHistogramResponse = Response[GetHistogramResult]

GetWindowBoundsResponse module-attribute 

GetWindowBoundsResponse = Response[GetWindowBoundsResult]

GetWindowForTargetResponse module-attribute 

GetWindowForTargetResponse = Response[GetWindowForTargetResult]

AddPrivacySandboxCoordinatorKeyConfigCommand module-attribute 

AddPrivacySandboxCoordinatorKeyConfigCommand = Command[AddPrivacySandboxCoordinatorKeyConfigParams, EmptyResponse]

AddPrivacySandboxEnrollmentOverrideCommand module-attribute 

AddPrivacySandboxEnrollmentOverrideCommand = Command[AddPrivacySandboxEnrollmentOverrideParams, EmptyResponse]

CancelDownloadCommand module-attribute 

CancelDownloadCommand = Command[CancelDownloadParams, EmptyResponse]

CloseCommand module-attribute 

CloseCommand = Command[EmptyParams, EmptyResponse]

CrashCommand module-attribute 

CrashCommand = Command[EmptyParams, EmptyResponse]

CrashGpuProcessCommand module-attribute 

CrashGpuProcessCommand = Command[EmptyParams, EmptyResponse]

ExecuteBrowserCommandCommand module-attribute 

ExecuteBrowserCommandCommand = Command[ExecuteBrowserCommandParams, EmptyResponse]

GetBrowserCommandLineCommand module-attribute 

GetBrowserCommandLineCommand = Command[EmptyParams, GetBrowserCommandLineResponse]

GetHistogramCommand module-attribute 

GetHistogramCommand = Command[GetHistogramParams, GetHistogramResponse]

GetHistogramsCommand module-attribute 

GetHistogramsCommand = Command[GetHistogramsParams, GetHistogramsResponse]

GetVersionCommand module-attribute 

GetVersionCommand = Command[EmptyParams, GetVersionResponse]

GetWindowBoundsCommand module-attribute 

GetWindowBoundsCommand = Command[GetWindowBoundsParams, GetWindowBoundsResponse]

GetWindowForTargetCommand module-attribute 

GetWindowForTargetCommand = Command[GetWindowForTargetParams, GetWindowForTargetResponse]

GrantPermissionsCommand module-attribute 

GrantPermissionsCommand = Command[GrantPermissionsParams, EmptyResponse]

ResetPermissionsCommand module-attribute 

ResetPermissionsCommand = Command[ResetPermissionsParams, EmptyResponse]

SetContentsSizeCommand module-attribute 

SetContentsSizeCommand = Command[SetContentsSizeParams, EmptyResponse]

SetDockTileCommand module-attribute 

SetDockTileCommand = Command[SetDockTileParams, EmptyResponse]

SetDownloadBehaviorCommand module-attribute 

SetDownloadBehaviorCommand = Command[SetDownloadBehaviorParams, EmptyResponse]

SetPermissionCommand module-attribute 

SetPermissionCommand = Command[SetPermissionParams, EmptyResponse]

SetWindowBoundsCommand module-attribute 

SetWindowBoundsCommand = Command[SetWindowBoundsParams, EmptyResponse]

BrowserMethod

Bases: str, Enum

Browser domain method names.

ADD_PRIVACY_SANDBOX_COORDINATOR_KEY_CONFIG class-attribute instance-attribute 

ADD_PRIVACY_SANDBOX_COORDINATOR_KEY_CONFIG = 'Browser.addPrivacySandboxCoordinatorKeyConfig'

ADD_PRIVACY_SANDBOX_ENROLLMENT_OVERRIDE class-attribute instance-attribute 

ADD_PRIVACY_SANDBOX_ENROLLMENT_OVERRIDE = 'Browser.addPrivacySandboxEnrollmentOverride'

CANCEL_DOWNLOAD class-attribute instance-attribute 

CANCEL_DOWNLOAD = 'Browser.cancelDownload'

CLOSE class-attribute instance-attribute 

CLOSE = 'Browser.close'

CRASH class-attribute instance-attribute 

CRASH = 'Browser.crash'

CRASH_GPU_PROCESS class-attribute instance-attribute 

CRASH_GPU_PROCESS = 'Browser.crashGpuProcess'

EXECUTE_BROWSER_COMMAND class-attribute instance-attribute 

EXECUTE_BROWSER_COMMAND = 'Browser.executeBrowserCommand'

GET_BROWSER_COMMAND_LINE class-attribute instance-attribute 

GET_BROWSER_COMMAND_LINE = 'Browser.getBrowserCommandLine'

GET_HISTOGRAM class-attribute instance-attribute 

GET_HISTOGRAM = 'Browser.getHistogram'

GET_HISTOGRAMS class-attribute instance-attribute 

GET_HISTOGRAMS = 'Browser.getHistograms'

GET_VERSION class-attribute instance-attribute 

GET_VERSION = 'Browser.getVersion'

GET_WINDOW_BOUNDS class-attribute instance-attribute 

GET_WINDOW_BOUNDS = 'Browser.getWindowBounds'

GET_WINDOW_FOR_TARGET class-attribute instance-attribute 

GET_WINDOW_FOR_TARGET = 'Browser.getWindowForTarget'

GRANT_PERMISSIONS class-attribute instance-attribute 

GRANT_PERMISSIONS = 'Browser.grantPermissions'

RESET_PERMISSIONS class-attribute instance-attribute 

RESET_PERMISSIONS = 'Browser.resetPermissions'

SET_CONTENTS_SIZE class-attribute instance-attribute 

SET_CONTENTS_SIZE = 'Browser.setContentsSize'

SET_DOCK_TILE class-attribute instance-attribute 

SET_DOCK_TILE = 'Browser.setDockTile'

SET_DOWNLOAD_BEHAVIOR class-attribute instance-attribute 

SET_DOWNLOAD_BEHAVIOR = 'Browser.setDownloadBehavior'

SET_PERMISSION class-attribute instance-attribute 

SET_PERMISSION = 'Browser.setPermission'

SET_WINDOW_BOUNDS class-attribute instance-attribute 

SET_WINDOW_BOUNDS = 'Browser.setWindowBounds'

SetPermissionParams

Bases: TypedDict

Parameters for setting permission settings for given origin.

permission instance-attribute 

permission

setting instance-attribute 

setting

origin instance-attribute 

origin

browserContextId instance-attribute 

browserContextId

GrantPermissionsParams

Bases: TypedDict

Parameters for granting specific permissions to the given origin.

permissions instance-attribute 

permissions

origin instance-attribute 

origin

browserContextId instance-attribute 

browserContextId

ResetPermissionsParams

Bases: TypedDict

Parameters for resetting all permission management for all origins.

browserContextId instance-attribute 

browserContextId

SetDownloadBehaviorParams

Bases: TypedDict

Parameters for setting the behavior when downloading a file.

behavior instance-attribute 

behavior

browserContextId instance-attribute 

browserContextId

downloadPath instance-attribute 

downloadPath

eventsEnabled instance-attribute 

eventsEnabled

CancelDownloadParams

Bases: TypedDict

Parameters for cancelling a download if in progress.

guid instance-attribute 

guid

browserContextId instance-attribute 

browserContextId

GetHistogramsParams

Bases: TypedDict

Parameters for getting Chrome histograms.

query instance-attribute 

query

delta instance-attribute 

delta

GetHistogramParams

Bases: TypedDict

Parameters for getting a Chrome histogram by name.

name instance-attribute 

name

delta instance-attribute 

delta

GetWindowBoundsParams

Bases: TypedDict

Parameters for getting position and size of the browser window.

windowId instance-attribute 

windowId

GetWindowForTargetParams

Bases: TypedDict

Parameters for getting the browser window that contains the devtools target.

targetId instance-attribute 

targetId

SetWindowBoundsParams

Bases: TypedDict

Parameters for setting position and/or size of the browser window.

windowId instance-attribute 

windowId

bounds instance-attribute 

bounds

SetContentsSizeParams

Bases: TypedDict

Parameters for setting size of the browser contents.

windowId instance-attribute 

windowId

width instance-attribute 

width

height instance-attribute 

height

SetDockTileParams

Bases: TypedDict

Parameters for setting dock tile details, platform-specific.

badgeLabel instance-attribute 

badgeLabel

image instance-attribute 

image

ExecuteBrowserCommandParams

Bases: TypedDict

Parameters for invoking custom browser commands used by telemetry.

commandId instance-attribute 

commandId

AddPrivacySandboxEnrollmentOverrideParams

Bases: TypedDict

Parameters for allowing a site to use privacy sandbox features without enrollment.

url instance-attribute 

url

AddPrivacySandboxCoordinatorKeyConfigParams

Bases: TypedDict

Parameters for configuring encryption keys for privacy sandbox API.

api instance-attribute 

api

coordinatorOrigin instance-attribute 

coordinatorOrigin

keyConfig instance-attribute 

keyConfig

browserContextId instance-attribute 

browserContextId

GetVersionResult

Bases: TypedDict

Result for getVersion command.

protocolVersion instance-attribute 

protocolVersion

product instance-attribute 

product

revision instance-attribute 

revision

userAgent instance-attribute 

userAgent

jsVersion instance-attribute 

jsVersion

GetBrowserCommandLineResult

Bases: TypedDict

Result for getBrowserCommandLine command.

arguments instance-attribute 

arguments

GetHistogramsResult

Bases: TypedDict

Result for getHistograms command.

histograms instance-attribute 

histograms

GetHistogramResult

Bases: TypedDict

Result for getHistogram command.

histogram instance-attribute 

histogram

GetWindowBoundsResult

Bases: TypedDict

Result for getWindowBounds command.

bounds instance-attribute 

bounds

GetWindowForTargetResult

Bases: TypedDict

Result for getWindowForTarget command.

windowId instance-attribute 

windowId

bounds instance-attribute 

bounds

事件

pydoll.protocol.browser.events

DownloadProgressEvent module-attribute 

DownloadProgressEvent = CDPEvent[DownloadProgressEventParams]

DownloadWillBeginEvent module-attribute 

DownloadWillBeginEvent = CDPEvent[DownloadWillBeginEventParams]

BrowserEvent

Bases: str, Enum

Events from the Browser domain of the Chrome DevTools Protocol.

This enumeration contains the names of browser-related events that can be received from the Chrome DevTools Protocol. These events provide information about browser activities and state changes.

DOWNLOAD_PROGRESS class-attribute instance-attribute 

DOWNLOAD_PROGRESS = 'Browser.downloadProgress'

Fired when download makes progress. The last call has |done| == true.

PARAMETER DESCRIPTION
guid

Global unique identifier of the download.

TYPE: str

totalBytes

Total expected bytes to download.

TYPE: int

receivedBytes

Total bytes received.

TYPE: int

state

Download status. Allowed values: 'inProgress', 'completed', 'canceled'

TYPE: str

DOWNLOAD_WILL_BEGIN class-attribute instance-attribute 

DOWNLOAD_WILL_BEGIN = 'Browser.downloadWillBegin'

Fired when page is about to start a download.

PARAMETER DESCRIPTION
frameId

Id of the frame that caused the download to begin.

TYPE: str

guid

Global unique identifier of the download.

TYPE: str

url

URL of the resource being downloaded.

TYPE: str

suggestedFilename

Suggested file name of the resource (the actual name of the file saved on disk may differ).

TYPE: str

DownloadProgressEventParams

Bases: TypedDict

guid instance-attribute 

guid

totalBytes instance-attribute 

totalBytes

receivedBytes instance-attribute 

receivedBytes

state instance-attribute 

state

filePath instance-attribute 

filePath

DownloadWillBeginEventParams

Bases: TypedDict

frameId instance-attribute 

frameId

guid instance-attribute 

guid

url instance-attribute 

url

suggestedFilename instance-attribute 

suggestedFilename

类型

pydoll.protocol.browser.types

BrowserContextID module-attribute 

BrowserContextID = str

WindowID module-attribute 

WindowID = int

WindowState

Bases: str, Enum

The state of the browser window.

NORMAL class-attribute instance-attribute 

NORMAL = 'normal'

MINIMIZED class-attribute instance-attribute 

MINIMIZED = 'minimized'

MAXIMIZED class-attribute instance-attribute 

MAXIMIZED = 'maximized'

FULLSCREEN class-attribute instance-attribute 

FULLSCREEN = 'fullscreen'

DownloadBehavior

Bases: str, Enum

Download behavior options.

DENY class-attribute instance-attribute 

DENY = 'deny'

ALLOW class-attribute instance-attribute 

ALLOW = 'allow'

ALLOW_AND_NAME class-attribute instance-attribute 

ALLOW_AND_NAME = 'allowAndName'

DEFAULT class-attribute instance-attribute 

DEFAULT = 'default'

DownloadProgressState

Bases: str, Enum

Download progress state.

IN_PROGRESS class-attribute instance-attribute 

IN_PROGRESS = 'inProgress'

COMPLETED class-attribute instance-attribute 

COMPLETED = 'completed'

CANCELED class-attribute instance-attribute 

CANCELED = 'canceled'

Bounds

Bases: TypedDict

Browser window bounds information.

left instance-attribute 

left

top instance-attribute 

top

width instance-attribute 

width

height instance-attribute 

height

windowState instance-attribute 

windowState

PermissionType

Bases: str, Enum

Permission types.

AR class-attribute instance-attribute 

AR = 'ar'

AUDIO_CAPTURE class-attribute instance-attribute 

AUDIO_CAPTURE = 'audioCapture'

AUTOMATIC_FULLSCREEN class-attribute instance-attribute 

AUTOMATIC_FULLSCREEN = 'automaticFullscreen'

BACKGROUND_FETCH class-attribute instance-attribute 

BACKGROUND_FETCH = 'backgroundFetch'

BACKGROUND_SYNC class-attribute instance-attribute 

BACKGROUND_SYNC = 'backgroundSync'

CAMERA_PAN_TILT_ZOOM class-attribute instance-attribute 

CAMERA_PAN_TILT_ZOOM = 'cameraPanTiltZoom'

CAPTURED_SURFACE_CONTROL class-attribute instance-attribute 

CAPTURED_SURFACE_CONTROL = 'capturedSurfaceControl'

CLIPBOARD_READ_WRITE class-attribute instance-attribute 

CLIPBOARD_READ_WRITE = 'clipboardReadWrite'

CLIPBOARD_SANITIZED_WRITE class-attribute instance-attribute 

CLIPBOARD_SANITIZED_WRITE = 'clipboardSanitizedWrite'

DISPLAY_CAPTURE class-attribute instance-attribute 

DISPLAY_CAPTURE = 'displayCapture'

DURABLE_STORAGE class-attribute instance-attribute 

DURABLE_STORAGE = 'durableStorage'

GEOLOCATION class-attribute instance-attribute 

GEOLOCATION = 'geolocation'

HAND_TRACKING class-attribute instance-attribute 

HAND_TRACKING = 'handTracking'

IDLE_DETECTION class-attribute instance-attribute 

IDLE_DETECTION = 'idleDetection'

KEYBOARD_LOCK class-attribute instance-attribute 

KEYBOARD_LOCK = 'keyboardLock'

LOCAL_FONTS class-attribute instance-attribute 

LOCAL_FONTS = 'localFonts'

LOCAL_NETWORK_ACCESS class-attribute instance-attribute 

LOCAL_NETWORK_ACCESS = 'localNetworkAccess'

MIDI class-attribute instance-attribute 

MIDI = 'midi'

MIDI_SYSEX class-attribute instance-attribute 

MIDI_SYSEX = 'midiSysex'

NFC class-attribute instance-attribute 

NFC = 'nfc'

NOTIFICATIONS class-attribute instance-attribute 

NOTIFICATIONS = 'notifications'

PAYMENT_HANDLER class-attribute instance-attribute 

PAYMENT_HANDLER = 'paymentHandler'

PERIODIC_BACKGROUND_SYNC class-attribute instance-attribute 

PERIODIC_BACKGROUND_SYNC = 'periodicBackgroundSync'

POINTER_LOCK class-attribute instance-attribute 

POINTER_LOCK = 'pointerLock'

PROTECTED_MEDIA_IDENTIFIER class-attribute instance-attribute 

PROTECTED_MEDIA_IDENTIFIER = 'protectedMediaIdentifier'

SENSORS class-attribute instance-attribute 

SENSORS = 'sensors'

SMART_CARD class-attribute instance-attribute 

SMART_CARD = 'smartCard'

SPEAKER_SELECTION class-attribute instance-attribute 

SPEAKER_SELECTION = 'speakerSelection'

STORAGE_ACCESS class-attribute instance-attribute 

STORAGE_ACCESS = 'storageAccess'

TOP_LEVEL_STORAGE_ACCESS class-attribute instance-attribute 

TOP_LEVEL_STORAGE_ACCESS = 'topLevelStorageAccess'

VIDEO_CAPTURE class-attribute instance-attribute 

VIDEO_CAPTURE = 'videoCapture'

VR class-attribute instance-attribute 

VR = 'vr'

WAKE_LOCK_SCREEN class-attribute instance-attribute 

WAKE_LOCK_SCREEN = 'wakeLockScreen'

WAKE_LOCK_SYSTEM class-attribute instance-attribute 

WAKE_LOCK_SYSTEM = 'wakeLockSystem'

WEB_APP_INSTALLATION class-attribute instance-attribute 

WEB_APP_INSTALLATION = 'webAppInstallation'

WEB_PRINTING class-attribute instance-attribute 

WEB_PRINTING = 'webPrinting'

WINDOW_MANAGEMENT class-attribute instance-attribute 

WINDOW_MANAGEMENT = 'windowManagement'

PermissionSetting

Bases: str, Enum

Permission setting values.

GRANTED class-attribute instance-attribute 

GRANTED = 'granted'

DENIED class-attribute instance-attribute 

DENIED = 'denied'

PROMPT class-attribute instance-attribute 

PROMPT = 'prompt'

PermissionDescriptor

Bases: TypedDict

Definition of PermissionDescriptor defined in the Permissions API.

See https://w3c.github.io/permissions/#dom-permissiondescriptor.

name instance-attribute 

name

sysex instance-attribute 

sysex

userVisibleOnly instance-attribute 

userVisibleOnly

allowWithoutSanitization instance-attribute 

allowWithoutSanitization

allowWithoutGesture instance-attribute 

allowWithoutGesture

panTiltZoom instance-attribute 

panTiltZoom

BrowserCommandId

Bases: str, Enum

Browser command ids used by executeBrowserCommand.

OPEN_TAB_SEARCH = 'openTabSearch'

CLOSE_TAB_SEARCH = 'closeTabSearch'

OPEN_GLIC class-attribute instance-attribute 

OPEN_GLIC = 'openGlic'

Bucket

Bases: TypedDict

Chrome histogram bucket.

low instance-attribute 

low

high instance-attribute 

high

count instance-attribute 

count

Histogram

Bases: TypedDict

Chrome histogram.

name instance-attribute 

name

sum instance-attribute 

sum

count instance-attribute 

count

buckets instance-attribute 

buckets

PrivacySandboxAPI

Bases: str, Enum

Privacy Sandbox API types.

BIDDING_AND_AUCTION_SERVICES class-attribute instance-attribute 

BIDDING_AND_AUCTION_SERVICES = 'BiddingAndAuctionServices'

TRUSTED_KEY_VALUE class-attribute instance-attribute 

TRUSTED_KEY_VALUE = 'TrustedKeyValue'