page

AdFrameExplanation

Bases: Enum

Source code in zendriver/cdp/page.py

class AdFrameExplanation(enum.Enum):
    PARENT_IS_AD = "ParentIsAd"
    CREATED_BY_AD_SCRIPT = "CreatedByAdScript"
    MATCHED_BLOCKING_RULE = "MatchedBlockingRule"

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

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

CREATED_BY_AD_SCRIPT = 'CreatedByAdScript' class-attribute instance-attribute

MATCHED_BLOCKING_RULE = 'MatchedBlockingRule' class-attribute instance-attribute

PARENT_IS_AD = 'ParentIsAd' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

AdFrameStatus dataclass

Indicates whether a frame has been identified as an ad and why.

Source code in zendriver/cdp/page.py

@dataclass
class AdFrameStatus:
    """
    Indicates whether a frame has been identified as an ad and why.
    """

    ad_frame_type: AdFrameType

    explanations: typing.Optional[typing.List[AdFrameExplanation]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["adFrameType"] = self.ad_frame_type.to_json()
        if self.explanations is not None:
            json["explanations"] = [i.to_json() for i in self.explanations]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> AdFrameStatus:
        return cls(
            ad_frame_type=AdFrameType.from_json(json["adFrameType"]),
            explanations=(
                [AdFrameExplanation.from_json(i) for i in json["explanations"]]
                if json.get("explanations", None) is not None
                else None
            ),
        )

ad_frame_type: AdFrameType instance-attribute

explanations: typing.Optional[typing.List[AdFrameExplanation]] = None class-attribute instance-attribute

__init__(ad_frame_type, explanations=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> AdFrameStatus:
    return cls(
        ad_frame_type=AdFrameType.from_json(json["adFrameType"]),
        explanations=(
            [AdFrameExplanation.from_json(i) for i in json["explanations"]]
            if json.get("explanations", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["adFrameType"] = self.ad_frame_type.to_json()
    if self.explanations is not None:
        json["explanations"] = [i.to_json() for i in self.explanations]
    return json

AdFrameType

Bases: Enum

Indicates whether a frame has been identified as an ad.

Source code in zendriver/cdp/page.py

class AdFrameType(enum.Enum):
    """
    Indicates whether a frame has been identified as an ad.
    """

    NONE = "none"
    CHILD = "child"
    ROOT = "root"

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

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

CHILD = 'child' class-attribute instance-attribute

NONE = 'none' class-attribute instance-attribute

ROOT = 'root' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

AdScriptId dataclass

Identifies the bottom-most script which caused the frame to be labelled as an ad.

Source code in zendriver/cdp/page.py

@dataclass
class AdScriptId:
    """
    Identifies the bottom-most script which caused the frame to be labelled
    as an ad.
    """

    #: Script Id of the bottom-most script which caused the frame to be labelled
    #: as an ad.
    script_id: runtime.ScriptId

    #: Id of adScriptId's debugger.
    debugger_id: runtime.UniqueDebuggerId

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["scriptId"] = self.script_id.to_json()
        json["debuggerId"] = self.debugger_id.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> AdScriptId:
        return cls(
            script_id=runtime.ScriptId.from_json(json["scriptId"]),
            debugger_id=runtime.UniqueDebuggerId.from_json(json["debuggerId"]),
        )

debugger_id: runtime.UniqueDebuggerId instance-attribute

script_id: runtime.ScriptId instance-attribute

__init__(script_id, debugger_id)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> AdScriptId:
    return cls(
        script_id=runtime.ScriptId.from_json(json["scriptId"]),
        debugger_id=runtime.UniqueDebuggerId.from_json(json["debuggerId"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["scriptId"] = self.script_id.to_json()
    json["debuggerId"] = self.debugger_id.to_json()
    return json

AppManifestError dataclass

Error while paring app manifest.

Source code in zendriver/cdp/page.py

@dataclass
class AppManifestError:
    """
    Error while paring app manifest.
    """

    #: Error message.
    message: str

    #: If critical, this is a non-recoverable parse error.
    critical: int

    #: Error line.
    line: int

    #: Error column.
    column: int

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["message"] = self.message
        json["critical"] = self.critical
        json["line"] = self.line
        json["column"] = self.column
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> AppManifestError:
        return cls(
            message=str(json["message"]),
            critical=int(json["critical"]),
            line=int(json["line"]),
            column=int(json["column"]),
        )

column: int instance-attribute

critical: int instance-attribute

line: int instance-attribute

message: str instance-attribute

__init__(message, critical, line, column)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> AppManifestError:
    return cls(
        message=str(json["message"]),
        critical=int(json["critical"]),
        line=int(json["line"]),
        column=int(json["column"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["message"] = self.message
    json["critical"] = self.critical
    json["line"] = self.line
    json["column"] = self.column
    return json

AppManifestParsedProperties dataclass

Parsed app manifest properties.

Source code in zendriver/cdp/page.py

@dataclass
class AppManifestParsedProperties:
    """
    Parsed app manifest properties.
    """

    #: Computed scope value
    scope: str

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

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> AppManifestParsedProperties:
        return cls(
            scope=str(json["scope"]),
        )

scope: str instance-attribute

__init__(scope)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> AppManifestParsedProperties:
    return cls(
        scope=str(json["scope"]),
    )

to_json()

Source code in zendriver/cdp/page.py

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

AutoResponseMode

Bases: Enum

Enum of possible auto-response for permission / prompt dialogs.

Source code in zendriver/cdp/page.py

class AutoResponseMode(enum.Enum):
    """
    Enum of possible auto-response for permission / prompt dialogs.
    """

    NONE = "none"
    AUTO_ACCEPT = "autoAccept"
    AUTO_REJECT = "autoReject"
    AUTO_OPT_OUT = "autoOptOut"

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

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

AUTO_ACCEPT = 'autoAccept' class-attribute instance-attribute

AUTO_OPT_OUT = 'autoOptOut' class-attribute instance-attribute

AUTO_REJECT = 'autoReject' class-attribute instance-attribute

NONE = 'none' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

BackForwardCacheBlockingDetails dataclass

Source code in zendriver/cdp/page.py

@dataclass
class BackForwardCacheBlockingDetails:
    #: Line number in the script (0-based).
    line_number: int

    #: Column number in the script (0-based).
    column_number: int

    #: Url of the file where blockage happened. Optional because of tests.
    url: typing.Optional[str] = None

    #: Function name where blockage happened. Optional because of anonymous functions and tests.
    function: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["lineNumber"] = self.line_number
        json["columnNumber"] = self.column_number
        if self.url is not None:
            json["url"] = self.url
        if self.function is not None:
            json["function"] = self.function
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheBlockingDetails:
        return cls(
            line_number=int(json["lineNumber"]),
            column_number=int(json["columnNumber"]),
            url=str(json["url"]) if json.get("url", None) is not None else None,
            function=(
                str(json["function"])
                if json.get("function", None) is not None
                else None
            ),
        )

column_number: int instance-attribute

function: typing.Optional[str] = None class-attribute instance-attribute

line_number: int instance-attribute

url: typing.Optional[str] = None class-attribute instance-attribute

__init__(line_number, column_number, url=None, function=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheBlockingDetails:
    return cls(
        line_number=int(json["lineNumber"]),
        column_number=int(json["columnNumber"]),
        url=str(json["url"]) if json.get("url", None) is not None else None,
        function=(
            str(json["function"])
            if json.get("function", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["lineNumber"] = self.line_number
    json["columnNumber"] = self.column_number
    if self.url is not None:
        json["url"] = self.url
    if self.function is not None:
        json["function"] = self.function
    return json

BackForwardCacheNotRestoredExplanation dataclass

Source code in zendriver/cdp/page.py

@dataclass
class BackForwardCacheNotRestoredExplanation:
    #: Type of the reason
    type_: BackForwardCacheNotRestoredReasonType

    #: Not restored reason
    reason: BackForwardCacheNotRestoredReason

    #: Context associated with the reason. The meaning of this context is
    #: dependent on the reason:
    #: - EmbedderExtensionSentMessageToCachedFrame: the extension ID.
    context: typing.Optional[str] = None

    details: typing.Optional[typing.List[BackForwardCacheBlockingDetails]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["type"] = self.type_.to_json()
        json["reason"] = self.reason.to_json()
        if self.context is not None:
            json["context"] = self.context
        if self.details is not None:
            json["details"] = [i.to_json() for i in self.details]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheNotRestoredExplanation:
        return cls(
            type_=BackForwardCacheNotRestoredReasonType.from_json(json["type"]),
            reason=BackForwardCacheNotRestoredReason.from_json(json["reason"]),
            context=(
                str(json["context"]) if json.get("context", None) is not None else None
            ),
            details=(
                [BackForwardCacheBlockingDetails.from_json(i) for i in json["details"]]
                if json.get("details", None) is not None
                else None
            ),
        )

context: typing.Optional[str] = None class-attribute instance-attribute

details: typing.Optional[typing.List[BackForwardCacheBlockingDetails]] = None class-attribute instance-attribute

reason: BackForwardCacheNotRestoredReason instance-attribute

type_: BackForwardCacheNotRestoredReasonType instance-attribute

__init__(type_, reason, context=None, details=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheNotRestoredExplanation:
    return cls(
        type_=BackForwardCacheNotRestoredReasonType.from_json(json["type"]),
        reason=BackForwardCacheNotRestoredReason.from_json(json["reason"]),
        context=(
            str(json["context"]) if json.get("context", None) is not None else None
        ),
        details=(
            [BackForwardCacheBlockingDetails.from_json(i) for i in json["details"]]
            if json.get("details", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["type"] = self.type_.to_json()
    json["reason"] = self.reason.to_json()
    if self.context is not None:
        json["context"] = self.context
    if self.details is not None:
        json["details"] = [i.to_json() for i in self.details]
    return json

BackForwardCacheNotRestoredExplanationTree dataclass

Source code in zendriver/cdp/page.py

@dataclass
class BackForwardCacheNotRestoredExplanationTree:
    #: URL of each frame
    url: str

    #: Not restored reasons of each frame
    explanations: typing.List[BackForwardCacheNotRestoredExplanation]

    #: Array of children frame
    children: typing.List[BackForwardCacheNotRestoredExplanationTree]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["url"] = self.url
        json["explanations"] = [i.to_json() for i in self.explanations]
        json["children"] = [i.to_json() for i in self.children]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheNotRestoredExplanationTree:
        return cls(
            url=str(json["url"]),
            explanations=[
                BackForwardCacheNotRestoredExplanation.from_json(i)
                for i in json["explanations"]
            ],
            children=[
                BackForwardCacheNotRestoredExplanationTree.from_json(i)
                for i in json["children"]
            ],
        )

children: typing.List[BackForwardCacheNotRestoredExplanationTree] instance-attribute

explanations: typing.List[BackForwardCacheNotRestoredExplanation] instance-attribute

url: str instance-attribute

__init__(url, explanations, children)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheNotRestoredExplanationTree:
    return cls(
        url=str(json["url"]),
        explanations=[
            BackForwardCacheNotRestoredExplanation.from_json(i)
            for i in json["explanations"]
        ],
        children=[
            BackForwardCacheNotRestoredExplanationTree.from_json(i)
            for i in json["children"]
        ],
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["url"] = self.url
    json["explanations"] = [i.to_json() for i in self.explanations]
    json["children"] = [i.to_json() for i in self.children]
    return json

BackForwardCacheNotRestoredReason

Bases: Enum

List of not restored reasons for back-forward cache.

Source code in zendriver/cdp/page.py

class BackForwardCacheNotRestoredReason(enum.Enum):
    """
    List of not restored reasons for back-forward cache.
    """

    NOT_PRIMARY_MAIN_FRAME = "NotPrimaryMainFrame"
    BACK_FORWARD_CACHE_DISABLED = "BackForwardCacheDisabled"
    RELATED_ACTIVE_CONTENTS_EXIST = "RelatedActiveContentsExist"
    HTTP_STATUS_NOT_OK = "HTTPStatusNotOK"
    SCHEME_NOT_HTTP_OR_HTTPS = "SchemeNotHTTPOrHTTPS"
    LOADING = "Loading"
    WAS_GRANTED_MEDIA_ACCESS = "WasGrantedMediaAccess"
    DISABLE_FOR_RENDER_FRAME_HOST_CALLED = "DisableForRenderFrameHostCalled"
    DOMAIN_NOT_ALLOWED = "DomainNotAllowed"
    HTTP_METHOD_NOT_GET = "HTTPMethodNotGET"
    SUBFRAME_IS_NAVIGATING = "SubframeIsNavigating"
    TIMEOUT = "Timeout"
    CACHE_LIMIT = "CacheLimit"
    JAVA_SCRIPT_EXECUTION = "JavaScriptExecution"
    RENDERER_PROCESS_KILLED = "RendererProcessKilled"
    RENDERER_PROCESS_CRASHED = "RendererProcessCrashed"
    SCHEDULER_TRACKED_FEATURE_USED = "SchedulerTrackedFeatureUsed"
    CONFLICTING_BROWSING_INSTANCE = "ConflictingBrowsingInstance"
    CACHE_FLUSHED = "CacheFlushed"
    SERVICE_WORKER_VERSION_ACTIVATION = "ServiceWorkerVersionActivation"
    SESSION_RESTORED = "SessionRestored"
    SERVICE_WORKER_POST_MESSAGE = "ServiceWorkerPostMessage"
    ENTERED_BACK_FORWARD_CACHE_BEFORE_SERVICE_WORKER_HOST_ADDED = (
        "EnteredBackForwardCacheBeforeServiceWorkerHostAdded"
    )
    RENDER_FRAME_HOST_REUSED_SAME_SITE = "RenderFrameHostReused_SameSite"
    RENDER_FRAME_HOST_REUSED_CROSS_SITE = "RenderFrameHostReused_CrossSite"
    SERVICE_WORKER_CLAIM = "ServiceWorkerClaim"
    IGNORE_EVENT_AND_EVICT = "IgnoreEventAndEvict"
    HAVE_INNER_CONTENTS = "HaveInnerContents"
    TIMEOUT_PUTTING_IN_CACHE = "TimeoutPuttingInCache"
    BACK_FORWARD_CACHE_DISABLED_BY_LOW_MEMORY = "BackForwardCacheDisabledByLowMemory"
    BACK_FORWARD_CACHE_DISABLED_BY_COMMAND_LINE = (
        "BackForwardCacheDisabledByCommandLine"
    )
    NETWORK_REQUEST_DATAPIPE_DRAINED_AS_BYTES_CONSUMER = (
        "NetworkRequestDatapipeDrainedAsBytesConsumer"
    )
    NETWORK_REQUEST_REDIRECTED = "NetworkRequestRedirected"
    NETWORK_REQUEST_TIMEOUT = "NetworkRequestTimeout"
    NETWORK_EXCEEDS_BUFFER_LIMIT = "NetworkExceedsBufferLimit"
    NAVIGATION_CANCELLED_WHILE_RESTORING = "NavigationCancelledWhileRestoring"
    NOT_MOST_RECENT_NAVIGATION_ENTRY = "NotMostRecentNavigationEntry"
    BACK_FORWARD_CACHE_DISABLED_FOR_PRERENDER = "BackForwardCacheDisabledForPrerender"
    USER_AGENT_OVERRIDE_DIFFERS = "UserAgentOverrideDiffers"
    FOREGROUND_CACHE_LIMIT = "ForegroundCacheLimit"
    BROWSING_INSTANCE_NOT_SWAPPED = "BrowsingInstanceNotSwapped"
    BACK_FORWARD_CACHE_DISABLED_FOR_DELEGATE = "BackForwardCacheDisabledForDelegate"
    UNLOAD_HANDLER_EXISTS_IN_MAIN_FRAME = "UnloadHandlerExistsInMainFrame"
    UNLOAD_HANDLER_EXISTS_IN_SUB_FRAME = "UnloadHandlerExistsInSubFrame"
    SERVICE_WORKER_UNREGISTRATION = "ServiceWorkerUnregistration"
    CACHE_CONTROL_NO_STORE = "CacheControlNoStore"
    CACHE_CONTROL_NO_STORE_COOKIE_MODIFIED = "CacheControlNoStoreCookieModified"
    CACHE_CONTROL_NO_STORE_HTTP_ONLY_COOKIE_MODIFIED = (
        "CacheControlNoStoreHTTPOnlyCookieModified"
    )
    NO_RESPONSE_HEAD = "NoResponseHead"
    UNKNOWN = "Unknown"
    ACTIVATION_NAVIGATIONS_DISALLOWED_FOR_BUG1234857 = (
        "ActivationNavigationsDisallowedForBug1234857"
    )
    ERROR_DOCUMENT = "ErrorDocument"
    FENCED_FRAMES_EMBEDDER = "FencedFramesEmbedder"
    COOKIE_DISABLED = "CookieDisabled"
    HTTP_AUTH_REQUIRED = "HTTPAuthRequired"
    COOKIE_FLUSHED = "CookieFlushed"
    BROADCAST_CHANNEL_ON_MESSAGE = "BroadcastChannelOnMessage"
    WEB_VIEW_SETTINGS_CHANGED = "WebViewSettingsChanged"
    WEB_VIEW_JAVA_SCRIPT_OBJECT_CHANGED = "WebViewJavaScriptObjectChanged"
    WEB_VIEW_MESSAGE_LISTENER_INJECTED = "WebViewMessageListenerInjected"
    WEB_VIEW_SAFE_BROWSING_ALLOWLIST_CHANGED = "WebViewSafeBrowsingAllowlistChanged"
    WEB_VIEW_DOCUMENT_START_JAVASCRIPT_CHANGED = "WebViewDocumentStartJavascriptChanged"
    WEB_SOCKET = "WebSocket"
    WEB_TRANSPORT = "WebTransport"
    WEB_RTC = "WebRTC"
    MAIN_RESOURCE_HAS_CACHE_CONTROL_NO_STORE = "MainResourceHasCacheControlNoStore"
    MAIN_RESOURCE_HAS_CACHE_CONTROL_NO_CACHE = "MainResourceHasCacheControlNoCache"
    SUBRESOURCE_HAS_CACHE_CONTROL_NO_STORE = "SubresourceHasCacheControlNoStore"
    SUBRESOURCE_HAS_CACHE_CONTROL_NO_CACHE = "SubresourceHasCacheControlNoCache"
    CONTAINS_PLUGINS = "ContainsPlugins"
    DOCUMENT_LOADED = "DocumentLoaded"
    OUTSTANDING_NETWORK_REQUEST_OTHERS = "OutstandingNetworkRequestOthers"
    REQUESTED_MIDI_PERMISSION = "RequestedMIDIPermission"
    REQUESTED_AUDIO_CAPTURE_PERMISSION = "RequestedAudioCapturePermission"
    REQUESTED_VIDEO_CAPTURE_PERMISSION = "RequestedVideoCapturePermission"
    REQUESTED_BACK_FORWARD_CACHE_BLOCKED_SENSORS = (
        "RequestedBackForwardCacheBlockedSensors"
    )
    REQUESTED_BACKGROUND_WORK_PERMISSION = "RequestedBackgroundWorkPermission"
    BROADCAST_CHANNEL = "BroadcastChannel"
    WEB_XR = "WebXR"
    SHARED_WORKER = "SharedWorker"
    WEB_LOCKS = "WebLocks"
    WEB_HID = "WebHID"
    WEB_SHARE = "WebShare"
    REQUESTED_STORAGE_ACCESS_GRANT = "RequestedStorageAccessGrant"
    WEB_NFC = "WebNfc"
    OUTSTANDING_NETWORK_REQUEST_FETCH = "OutstandingNetworkRequestFetch"
    OUTSTANDING_NETWORK_REQUEST_XHR = "OutstandingNetworkRequestXHR"
    APP_BANNER = "AppBanner"
    PRINTING = "Printing"
    WEB_DATABASE = "WebDatabase"
    PICTURE_IN_PICTURE = "PictureInPicture"
    PORTAL = "Portal"
    SPEECH_RECOGNIZER = "SpeechRecognizer"
    IDLE_MANAGER = "IdleManager"
    PAYMENT_MANAGER = "PaymentManager"
    SPEECH_SYNTHESIS = "SpeechSynthesis"
    KEYBOARD_LOCK = "KeyboardLock"
    WEB_OTP_SERVICE = "WebOTPService"
    OUTSTANDING_NETWORK_REQUEST_DIRECT_SOCKET = "OutstandingNetworkRequestDirectSocket"
    INJECTED_JAVASCRIPT = "InjectedJavascript"
    INJECTED_STYLE_SHEET = "InjectedStyleSheet"
    KEEPALIVE_REQUEST = "KeepaliveRequest"
    INDEXED_DB_EVENT = "IndexedDBEvent"
    DUMMY = "Dummy"
    JS_NETWORK_REQUEST_RECEIVED_CACHE_CONTROL_NO_STORE_RESOURCE = (
        "JsNetworkRequestReceivedCacheControlNoStoreResource"
    )
    WEB_RTC_STICKY = "WebRTCSticky"
    WEB_TRANSPORT_STICKY = "WebTransportSticky"
    WEB_SOCKET_STICKY = "WebSocketSticky"
    SMART_CARD = "SmartCard"
    LIVE_MEDIA_STREAM_TRACK = "LiveMediaStreamTrack"
    UNLOAD_HANDLER = "UnloadHandler"
    PARSER_ABORTED = "ParserAborted"
    CONTENT_SECURITY_HANDLER = "ContentSecurityHandler"
    CONTENT_WEB_AUTHENTICATION_API = "ContentWebAuthenticationAPI"
    CONTENT_FILE_CHOOSER = "ContentFileChooser"
    CONTENT_SERIAL = "ContentSerial"
    CONTENT_FILE_SYSTEM_ACCESS = "ContentFileSystemAccess"
    CONTENT_MEDIA_DEVICES_DISPATCHER_HOST = "ContentMediaDevicesDispatcherHost"
    CONTENT_WEB_BLUETOOTH = "ContentWebBluetooth"
    CONTENT_WEB_USB = "ContentWebUSB"
    CONTENT_MEDIA_SESSION_SERVICE = "ContentMediaSessionService"
    CONTENT_SCREEN_READER = "ContentScreenReader"
    EMBEDDER_POPUP_BLOCKER_TAB_HELPER = "EmbedderPopupBlockerTabHelper"
    EMBEDDER_SAFE_BROWSING_TRIGGERED_POPUP_BLOCKER = (
        "EmbedderSafeBrowsingTriggeredPopupBlocker"
    )
    EMBEDDER_SAFE_BROWSING_THREAT_DETAILS = "EmbedderSafeBrowsingThreatDetails"
    EMBEDDER_APP_BANNER_MANAGER = "EmbedderAppBannerManager"
    EMBEDDER_DOM_DISTILLER_VIEWER_SOURCE = "EmbedderDomDistillerViewerSource"
    EMBEDDER_DOM_DISTILLER_SELF_DELETING_REQUEST_DELEGATE = (
        "EmbedderDomDistillerSelfDeletingRequestDelegate"
    )
    EMBEDDER_OOM_INTERVENTION_TAB_HELPER = "EmbedderOomInterventionTabHelper"
    EMBEDDER_OFFLINE_PAGE = "EmbedderOfflinePage"
    EMBEDDER_CHROME_PASSWORD_MANAGER_CLIENT_BIND_CREDENTIAL_MANAGER = (
        "EmbedderChromePasswordManagerClientBindCredentialManager"
    )
    EMBEDDER_PERMISSION_REQUEST_MANAGER = "EmbedderPermissionRequestManager"
    EMBEDDER_MODAL_DIALOG = "EmbedderModalDialog"
    EMBEDDER_EXTENSIONS = "EmbedderExtensions"
    EMBEDDER_EXTENSION_MESSAGING = "EmbedderExtensionMessaging"
    EMBEDDER_EXTENSION_MESSAGING_FOR_OPEN_PORT = "EmbedderExtensionMessagingForOpenPort"
    EMBEDDER_EXTENSION_SENT_MESSAGE_TO_CACHED_FRAME = (
        "EmbedderExtensionSentMessageToCachedFrame"
    )
    REQUESTED_BY_WEB_VIEW_CLIENT = "RequestedByWebViewClient"

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

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

ACTIVATION_NAVIGATIONS_DISALLOWED_FOR_BUG1234857 = 'ActivationNavigationsDisallowedForBug1234857' class-attribute instance-attribute

APP_BANNER = 'AppBanner' class-attribute instance-attribute

BACK_FORWARD_CACHE_DISABLED = 'BackForwardCacheDisabled' class-attribute instance-attribute

BACK_FORWARD_CACHE_DISABLED_BY_COMMAND_LINE = 'BackForwardCacheDisabledByCommandLine' class-attribute instance-attribute

BACK_FORWARD_CACHE_DISABLED_BY_LOW_MEMORY = 'BackForwardCacheDisabledByLowMemory' class-attribute instance-attribute

BACK_FORWARD_CACHE_DISABLED_FOR_DELEGATE = 'BackForwardCacheDisabledForDelegate' class-attribute instance-attribute

BACK_FORWARD_CACHE_DISABLED_FOR_PRERENDER = 'BackForwardCacheDisabledForPrerender' class-attribute instance-attribute

BROADCAST_CHANNEL = 'BroadcastChannel' class-attribute instance-attribute

BROADCAST_CHANNEL_ON_MESSAGE = 'BroadcastChannelOnMessage' class-attribute instance-attribute

BROWSING_INSTANCE_NOT_SWAPPED = 'BrowsingInstanceNotSwapped' class-attribute instance-attribute

CACHE_CONTROL_NO_STORE = 'CacheControlNoStore' class-attribute instance-attribute

CACHE_CONTROL_NO_STORE_COOKIE_MODIFIED = 'CacheControlNoStoreCookieModified' class-attribute instance-attribute

CACHE_CONTROL_NO_STORE_HTTP_ONLY_COOKIE_MODIFIED = 'CacheControlNoStoreHTTPOnlyCookieModified' class-attribute instance-attribute

CACHE_FLUSHED = 'CacheFlushed' class-attribute instance-attribute

CACHE_LIMIT = 'CacheLimit' class-attribute instance-attribute

CONFLICTING_BROWSING_INSTANCE = 'ConflictingBrowsingInstance' class-attribute instance-attribute

CONTAINS_PLUGINS = 'ContainsPlugins' class-attribute instance-attribute

CONTENT_FILE_CHOOSER = 'ContentFileChooser' class-attribute instance-attribute

CONTENT_FILE_SYSTEM_ACCESS = 'ContentFileSystemAccess' class-attribute instance-attribute

CONTENT_MEDIA_DEVICES_DISPATCHER_HOST = 'ContentMediaDevicesDispatcherHost' class-attribute instance-attribute

CONTENT_MEDIA_SESSION_SERVICE = 'ContentMediaSessionService' class-attribute instance-attribute

CONTENT_SCREEN_READER = 'ContentScreenReader' class-attribute instance-attribute

CONTENT_SECURITY_HANDLER = 'ContentSecurityHandler' class-attribute instance-attribute

CONTENT_SERIAL = 'ContentSerial' class-attribute instance-attribute

CONTENT_WEB_AUTHENTICATION_API = 'ContentWebAuthenticationAPI' class-attribute instance-attribute

CONTENT_WEB_BLUETOOTH = 'ContentWebBluetooth' class-attribute instance-attribute

CONTENT_WEB_USB = 'ContentWebUSB' class-attribute instance-attribute

COOKIE_DISABLED = 'CookieDisabled' class-attribute instance-attribute

COOKIE_FLUSHED = 'CookieFlushed' class-attribute instance-attribute

DISABLE_FOR_RENDER_FRAME_HOST_CALLED = 'DisableForRenderFrameHostCalled' class-attribute instance-attribute

DOCUMENT_LOADED = 'DocumentLoaded' class-attribute instance-attribute

DOMAIN_NOT_ALLOWED = 'DomainNotAllowed' class-attribute instance-attribute

DUMMY = 'Dummy' class-attribute instance-attribute

EMBEDDER_APP_BANNER_MANAGER = 'EmbedderAppBannerManager' class-attribute instance-attribute

EMBEDDER_CHROME_PASSWORD_MANAGER_CLIENT_BIND_CREDENTIAL_MANAGER = 'EmbedderChromePasswordManagerClientBindCredentialManager' class-attribute instance-attribute

EMBEDDER_DOM_DISTILLER_SELF_DELETING_REQUEST_DELEGATE = 'EmbedderDomDistillerSelfDeletingRequestDelegate' class-attribute instance-attribute

EMBEDDER_DOM_DISTILLER_VIEWER_SOURCE = 'EmbedderDomDistillerViewerSource' class-attribute instance-attribute

EMBEDDER_EXTENSIONS = 'EmbedderExtensions' class-attribute instance-attribute

EMBEDDER_EXTENSION_MESSAGING = 'EmbedderExtensionMessaging' class-attribute instance-attribute

EMBEDDER_EXTENSION_MESSAGING_FOR_OPEN_PORT = 'EmbedderExtensionMessagingForOpenPort' class-attribute instance-attribute

EMBEDDER_EXTENSION_SENT_MESSAGE_TO_CACHED_FRAME = 'EmbedderExtensionSentMessageToCachedFrame' class-attribute instance-attribute

EMBEDDER_MODAL_DIALOG = 'EmbedderModalDialog' class-attribute instance-attribute

EMBEDDER_OFFLINE_PAGE = 'EmbedderOfflinePage' class-attribute instance-attribute

EMBEDDER_OOM_INTERVENTION_TAB_HELPER = 'EmbedderOomInterventionTabHelper' class-attribute instance-attribute

EMBEDDER_PERMISSION_REQUEST_MANAGER = 'EmbedderPermissionRequestManager' class-attribute instance-attribute

EMBEDDER_POPUP_BLOCKER_TAB_HELPER = 'EmbedderPopupBlockerTabHelper' class-attribute instance-attribute

EMBEDDER_SAFE_BROWSING_THREAT_DETAILS = 'EmbedderSafeBrowsingThreatDetails' class-attribute instance-attribute

EMBEDDER_SAFE_BROWSING_TRIGGERED_POPUP_BLOCKER = 'EmbedderSafeBrowsingTriggeredPopupBlocker' class-attribute instance-attribute

ENTERED_BACK_FORWARD_CACHE_BEFORE_SERVICE_WORKER_HOST_ADDED = 'EnteredBackForwardCacheBeforeServiceWorkerHostAdded' class-attribute instance-attribute

ERROR_DOCUMENT = 'ErrorDocument' class-attribute instance-attribute

FENCED_FRAMES_EMBEDDER = 'FencedFramesEmbedder' class-attribute instance-attribute

FOREGROUND_CACHE_LIMIT = 'ForegroundCacheLimit' class-attribute instance-attribute

HAVE_INNER_CONTENTS = 'HaveInnerContents' class-attribute instance-attribute

HTTP_AUTH_REQUIRED = 'HTTPAuthRequired' class-attribute instance-attribute

HTTP_METHOD_NOT_GET = 'HTTPMethodNotGET' class-attribute instance-attribute

HTTP_STATUS_NOT_OK = 'HTTPStatusNotOK' class-attribute instance-attribute

IDLE_MANAGER = 'IdleManager' class-attribute instance-attribute

IGNORE_EVENT_AND_EVICT = 'IgnoreEventAndEvict' class-attribute instance-attribute

INDEXED_DB_EVENT = 'IndexedDBEvent' class-attribute instance-attribute

INJECTED_JAVASCRIPT = 'InjectedJavascript' class-attribute instance-attribute

INJECTED_STYLE_SHEET = 'InjectedStyleSheet' class-attribute instance-attribute

JAVA_SCRIPT_EXECUTION = 'JavaScriptExecution' class-attribute instance-attribute

JS_NETWORK_REQUEST_RECEIVED_CACHE_CONTROL_NO_STORE_RESOURCE = 'JsNetworkRequestReceivedCacheControlNoStoreResource' class-attribute instance-attribute

KEEPALIVE_REQUEST = 'KeepaliveRequest' class-attribute instance-attribute

KEYBOARD_LOCK = 'KeyboardLock' class-attribute instance-attribute

LIVE_MEDIA_STREAM_TRACK = 'LiveMediaStreamTrack' class-attribute instance-attribute

LOADING = 'Loading' class-attribute instance-attribute

MAIN_RESOURCE_HAS_CACHE_CONTROL_NO_CACHE = 'MainResourceHasCacheControlNoCache' class-attribute instance-attribute

MAIN_RESOURCE_HAS_CACHE_CONTROL_NO_STORE = 'MainResourceHasCacheControlNoStore' class-attribute instance-attribute

NAVIGATION_CANCELLED_WHILE_RESTORING = 'NavigationCancelledWhileRestoring' class-attribute instance-attribute

NETWORK_EXCEEDS_BUFFER_LIMIT = 'NetworkExceedsBufferLimit' class-attribute instance-attribute

NETWORK_REQUEST_DATAPIPE_DRAINED_AS_BYTES_CONSUMER = 'NetworkRequestDatapipeDrainedAsBytesConsumer' class-attribute instance-attribute

NETWORK_REQUEST_REDIRECTED = 'NetworkRequestRedirected' class-attribute instance-attribute

NETWORK_REQUEST_TIMEOUT = 'NetworkRequestTimeout' class-attribute instance-attribute

NOT_MOST_RECENT_NAVIGATION_ENTRY = 'NotMostRecentNavigationEntry' class-attribute instance-attribute

NOT_PRIMARY_MAIN_FRAME = 'NotPrimaryMainFrame' class-attribute instance-attribute

NO_RESPONSE_HEAD = 'NoResponseHead' class-attribute instance-attribute

OUTSTANDING_NETWORK_REQUEST_DIRECT_SOCKET = 'OutstandingNetworkRequestDirectSocket' class-attribute instance-attribute

OUTSTANDING_NETWORK_REQUEST_FETCH = 'OutstandingNetworkRequestFetch' class-attribute instance-attribute

OUTSTANDING_NETWORK_REQUEST_OTHERS = 'OutstandingNetworkRequestOthers' class-attribute instance-attribute

OUTSTANDING_NETWORK_REQUEST_XHR = 'OutstandingNetworkRequestXHR' class-attribute instance-attribute

PARSER_ABORTED = 'ParserAborted' class-attribute instance-attribute

PAYMENT_MANAGER = 'PaymentManager' class-attribute instance-attribute

PICTURE_IN_PICTURE = 'PictureInPicture' class-attribute instance-attribute

PORTAL = 'Portal' class-attribute instance-attribute

PRINTING = 'Printing' class-attribute instance-attribute

RELATED_ACTIVE_CONTENTS_EXIST = 'RelatedActiveContentsExist' class-attribute instance-attribute

RENDERER_PROCESS_CRASHED = 'RendererProcessCrashed' class-attribute instance-attribute

RENDERER_PROCESS_KILLED = 'RendererProcessKilled' class-attribute instance-attribute

RENDER_FRAME_HOST_REUSED_CROSS_SITE = 'RenderFrameHostReused_CrossSite' class-attribute instance-attribute

RENDER_FRAME_HOST_REUSED_SAME_SITE = 'RenderFrameHostReused_SameSite' class-attribute instance-attribute

REQUESTED_AUDIO_CAPTURE_PERMISSION = 'RequestedAudioCapturePermission' class-attribute instance-attribute

REQUESTED_BACKGROUND_WORK_PERMISSION = 'RequestedBackgroundWorkPermission' class-attribute instance-attribute

REQUESTED_BACK_FORWARD_CACHE_BLOCKED_SENSORS = 'RequestedBackForwardCacheBlockedSensors' class-attribute instance-attribute

REQUESTED_BY_WEB_VIEW_CLIENT = 'RequestedByWebViewClient' class-attribute instance-attribute

REQUESTED_MIDI_PERMISSION = 'RequestedMIDIPermission' class-attribute instance-attribute

REQUESTED_STORAGE_ACCESS_GRANT = 'RequestedStorageAccessGrant' class-attribute instance-attribute

REQUESTED_VIDEO_CAPTURE_PERMISSION = 'RequestedVideoCapturePermission' class-attribute instance-attribute

SCHEDULER_TRACKED_FEATURE_USED = 'SchedulerTrackedFeatureUsed' class-attribute instance-attribute

SCHEME_NOT_HTTP_OR_HTTPS = 'SchemeNotHTTPOrHTTPS' class-attribute instance-attribute

SERVICE_WORKER_CLAIM = 'ServiceWorkerClaim' class-attribute instance-attribute

SERVICE_WORKER_POST_MESSAGE = 'ServiceWorkerPostMessage' class-attribute instance-attribute

SERVICE_WORKER_UNREGISTRATION = 'ServiceWorkerUnregistration' class-attribute instance-attribute

SERVICE_WORKER_VERSION_ACTIVATION = 'ServiceWorkerVersionActivation' class-attribute instance-attribute

SESSION_RESTORED = 'SessionRestored' class-attribute instance-attribute

SHARED_WORKER = 'SharedWorker' class-attribute instance-attribute

SMART_CARD = 'SmartCard' class-attribute instance-attribute

SPEECH_RECOGNIZER = 'SpeechRecognizer' class-attribute instance-attribute

SPEECH_SYNTHESIS = 'SpeechSynthesis' class-attribute instance-attribute

SUBFRAME_IS_NAVIGATING = 'SubframeIsNavigating' class-attribute instance-attribute

SUBRESOURCE_HAS_CACHE_CONTROL_NO_CACHE = 'SubresourceHasCacheControlNoCache' class-attribute instance-attribute

SUBRESOURCE_HAS_CACHE_CONTROL_NO_STORE = 'SubresourceHasCacheControlNoStore' class-attribute instance-attribute

TIMEOUT = 'Timeout' class-attribute instance-attribute

TIMEOUT_PUTTING_IN_CACHE = 'TimeoutPuttingInCache' class-attribute instance-attribute

UNKNOWN = 'Unknown' class-attribute instance-attribute

UNLOAD_HANDLER = 'UnloadHandler' class-attribute instance-attribute

UNLOAD_HANDLER_EXISTS_IN_MAIN_FRAME = 'UnloadHandlerExistsInMainFrame' class-attribute instance-attribute

UNLOAD_HANDLER_EXISTS_IN_SUB_FRAME = 'UnloadHandlerExistsInSubFrame' class-attribute instance-attribute

USER_AGENT_OVERRIDE_DIFFERS = 'UserAgentOverrideDiffers' class-attribute instance-attribute

WAS_GRANTED_MEDIA_ACCESS = 'WasGrantedMediaAccess' class-attribute instance-attribute

WEB_DATABASE = 'WebDatabase' class-attribute instance-attribute

WEB_HID = 'WebHID' class-attribute instance-attribute

WEB_LOCKS = 'WebLocks' class-attribute instance-attribute

WEB_NFC = 'WebNfc' class-attribute instance-attribute

WEB_OTP_SERVICE = 'WebOTPService' class-attribute instance-attribute

WEB_RTC = 'WebRTC' class-attribute instance-attribute

WEB_RTC_STICKY = 'WebRTCSticky' class-attribute instance-attribute

WEB_SHARE = 'WebShare' class-attribute instance-attribute

WEB_SOCKET = 'WebSocket' class-attribute instance-attribute

WEB_SOCKET_STICKY = 'WebSocketSticky' class-attribute instance-attribute

WEB_TRANSPORT = 'WebTransport' class-attribute instance-attribute

WEB_TRANSPORT_STICKY = 'WebTransportSticky' class-attribute instance-attribute

WEB_VIEW_DOCUMENT_START_JAVASCRIPT_CHANGED = 'WebViewDocumentStartJavascriptChanged' class-attribute instance-attribute

WEB_VIEW_JAVA_SCRIPT_OBJECT_CHANGED = 'WebViewJavaScriptObjectChanged' class-attribute instance-attribute

WEB_VIEW_MESSAGE_LISTENER_INJECTED = 'WebViewMessageListenerInjected' class-attribute instance-attribute

WEB_VIEW_SAFE_BROWSING_ALLOWLIST_CHANGED = 'WebViewSafeBrowsingAllowlistChanged' class-attribute instance-attribute

WEB_VIEW_SETTINGS_CHANGED = 'WebViewSettingsChanged' class-attribute instance-attribute

WEB_XR = 'WebXR' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

BackForwardCacheNotRestoredReasonType

Bases: Enum

Types of not restored reasons for back-forward cache.

Source code in zendriver/cdp/page.py

class BackForwardCacheNotRestoredReasonType(enum.Enum):
    """
    Types of not restored reasons for back-forward cache.
    """

    SUPPORT_PENDING = "SupportPending"
    PAGE_SUPPORT_NEEDED = "PageSupportNeeded"
    CIRCUMSTANTIAL = "Circumstantial"

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

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

CIRCUMSTANTIAL = 'Circumstantial' class-attribute instance-attribute

PAGE_SUPPORT_NEEDED = 'PageSupportNeeded' class-attribute instance-attribute

SUPPORT_PENDING = 'SupportPending' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

BackForwardCacheNotUsed dataclass

EXPERIMENTAL

Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do not assume any ordering with the Page.frameNavigated event. This event is fired only for main-frame history navigation where the document changes (non-same-document navigations), when bfcache navigation fails.

Source code in zendriver/cdp/page.py

@event_class("Page.backForwardCacheNotUsed")
@dataclass
class BackForwardCacheNotUsed:
    """
    **EXPERIMENTAL**

    Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do
    not assume any ordering with the Page.frameNavigated event. This event is fired only for
    main-frame history navigation where the document changes (non-same-document navigations),
    when bfcache navigation fails.
    """

    #: The loader id for the associated navigation.
    loader_id: network.LoaderId
    #: The frame id of the associated frame.
    frame_id: FrameId
    #: Array of reasons why the page could not be cached. This must not be empty.
    not_restored_explanations: typing.List[BackForwardCacheNotRestoredExplanation]
    #: Tree structure of reasons why the page could not be cached for each frame.
    not_restored_explanations_tree: typing.Optional[
        BackForwardCacheNotRestoredExplanationTree
    ]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheNotUsed:
        return cls(
            loader_id=network.LoaderId.from_json(json["loaderId"]),
            frame_id=FrameId.from_json(json["frameId"]),
            not_restored_explanations=[
                BackForwardCacheNotRestoredExplanation.from_json(i)
                for i in json["notRestoredExplanations"]
            ],
            not_restored_explanations_tree=(
                BackForwardCacheNotRestoredExplanationTree.from_json(
                    json["notRestoredExplanationsTree"]
                )
                if json.get("notRestoredExplanationsTree", None) is not None
                else None
            ),
        )

frame_id: FrameId instance-attribute

loader_id: network.LoaderId instance-attribute

not_restored_explanations: typing.List[BackForwardCacheNotRestoredExplanation] instance-attribute

not_restored_explanations_tree: typing.Optional[BackForwardCacheNotRestoredExplanationTree] instance-attribute

__init__(loader_id, frame_id, not_restored_explanations, not_restored_explanations_tree)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> BackForwardCacheNotUsed:
    return cls(
        loader_id=network.LoaderId.from_json(json["loaderId"]),
        frame_id=FrameId.from_json(json["frameId"]),
        not_restored_explanations=[
            BackForwardCacheNotRestoredExplanation.from_json(i)
            for i in json["notRestoredExplanations"]
        ],
        not_restored_explanations_tree=(
            BackForwardCacheNotRestoredExplanationTree.from_json(
                json["notRestoredExplanationsTree"]
            )
            if json.get("notRestoredExplanationsTree", None) is not None
            else None
        ),
    )

ClientNavigationDisposition

Bases: Enum

Source code in zendriver/cdp/page.py

class ClientNavigationDisposition(enum.Enum):
    CURRENT_TAB = "currentTab"
    NEW_TAB = "newTab"
    NEW_WINDOW = "newWindow"
    DOWNLOAD = "download"

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

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

CURRENT_TAB = 'currentTab' class-attribute instance-attribute

DOWNLOAD = 'download' class-attribute instance-attribute

NEW_TAB = 'newTab' class-attribute instance-attribute

NEW_WINDOW = 'newWindow' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

ClientNavigationReason

Bases: Enum

Source code in zendriver/cdp/page.py

class ClientNavigationReason(enum.Enum):
    FORM_SUBMISSION_GET = "formSubmissionGet"
    FORM_SUBMISSION_POST = "formSubmissionPost"
    HTTP_HEADER_REFRESH = "httpHeaderRefresh"
    SCRIPT_INITIATED = "scriptInitiated"
    META_TAG_REFRESH = "metaTagRefresh"
    PAGE_BLOCK_INTERSTITIAL = "pageBlockInterstitial"
    RELOAD = "reload"
    ANCHOR_CLICK = "anchorClick"

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

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

ANCHOR_CLICK = 'anchorClick' class-attribute instance-attribute

FORM_SUBMISSION_GET = 'formSubmissionGet' class-attribute instance-attribute

FORM_SUBMISSION_POST = 'formSubmissionPost' class-attribute instance-attribute

HTTP_HEADER_REFRESH = 'httpHeaderRefresh' class-attribute instance-attribute

META_TAG_REFRESH = 'metaTagRefresh' class-attribute instance-attribute

PAGE_BLOCK_INTERSTITIAL = 'pageBlockInterstitial' class-attribute instance-attribute

RELOAD = 'reload' class-attribute instance-attribute

SCRIPT_INITIATED = 'scriptInitiated' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

CompilationCacheParams dataclass

Per-script compilation cache parameters for Page.produceCompilationCache

Source code in zendriver/cdp/page.py

@dataclass
class CompilationCacheParams:
    """
    Per-script compilation cache parameters for ``Page.produceCompilationCache``
    """

    #: The URL of the script to produce a compilation cache entry for.
    url: str

    #: A hint to the backend whether eager compilation is recommended.
    #: (the actual compilation mode used is upon backend discretion).
    eager: typing.Optional[bool] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["url"] = self.url
        if self.eager is not None:
            json["eager"] = self.eager
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> CompilationCacheParams:
        return cls(
            url=str(json["url"]),
            eager=bool(json["eager"]) if json.get("eager", None) is not None else None,
        )

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

url: str instance-attribute

__init__(url, eager=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> CompilationCacheParams:
    return cls(
        url=str(json["url"]),
        eager=bool(json["eager"]) if json.get("eager", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["url"] = self.url
    if self.eager is not None:
        json["eager"] = self.eager
    return json

CompilationCacheProduced dataclass

EXPERIMENTAL

Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.

Source code in zendriver/cdp/page.py

@event_class("Page.compilationCacheProduced")
@dataclass
class CompilationCacheProduced:
    """
    **EXPERIMENTAL**

    Issued for every compilation cache generated. Is only available
    if Page.setGenerateCompilationCache is enabled.
    """

    url: str
    #: Base64-encoded data (Encoded as a base64 string when passed over JSON)
    data: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> CompilationCacheProduced:
        return cls(url=str(json["url"]), data=str(json["data"]))

data: str instance-attribute

url: str instance-attribute

__init__(url, data)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> CompilationCacheProduced:
    return cls(url=str(json["url"]), data=str(json["data"]))

CrossOriginIsolatedContextType

Bases: Enum

Indicates whether the frame is cross-origin isolated and why it is the case.

Source code in zendriver/cdp/page.py

class CrossOriginIsolatedContextType(enum.Enum):
    """
    Indicates whether the frame is cross-origin isolated and why it is the case.
    """

    ISOLATED = "Isolated"
    NOT_ISOLATED = "NotIsolated"
    NOT_ISOLATED_FEATURE_DISABLED = "NotIsolatedFeatureDisabled"

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

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

ISOLATED = 'Isolated' class-attribute instance-attribute

NOT_ISOLATED = 'NotIsolated' class-attribute instance-attribute

NOT_ISOLATED_FEATURE_DISABLED = 'NotIsolatedFeatureDisabled' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

DialogType

Bases: Enum

Javascript dialog type.

Source code in zendriver/cdp/page.py

class DialogType(enum.Enum):
    """
    Javascript dialog type.
    """

    ALERT = "alert"
    CONFIRM = "confirm"
    PROMPT = "prompt"
    BEFOREUNLOAD = "beforeunload"

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

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

ALERT = 'alert' class-attribute instance-attribute

BEFOREUNLOAD = 'beforeunload' class-attribute instance-attribute

CONFIRM = 'confirm' class-attribute instance-attribute

PROMPT = 'prompt' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

DocumentOpened dataclass

EXPERIMENTAL

Fired when opening document to write to.

Source code in zendriver/cdp/page.py

@event_class("Page.documentOpened")
@dataclass
class DocumentOpened:
    """
    **EXPERIMENTAL**

    Fired when opening document to write to.
    """

    #: Frame object.
    frame: Frame

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DocumentOpened:
        return cls(frame=Frame.from_json(json["frame"]))

frame: Frame instance-attribute

__init__(frame)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> DocumentOpened:
    return cls(frame=Frame.from_json(json["frame"]))

DomContentEventFired dataclass

Source code in zendriver/cdp/page.py

@event_class("Page.domContentEventFired")
@dataclass
class DomContentEventFired:
    timestamp: network.MonotonicTime

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DomContentEventFired:
        return cls(timestamp=network.MonotonicTime.from_json(json["timestamp"]))

timestamp: network.MonotonicTime instance-attribute

__init__(timestamp)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> DomContentEventFired:
    return cls(timestamp=network.MonotonicTime.from_json(json["timestamp"]))

DownloadProgress dataclass

EXPERIMENTAL

Fired when download makes progress. Last call has done == true. Deprecated. Use Browser.downloadProgress instead.

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
@event_class("Page.downloadProgress")
@dataclass
class DownloadProgress:
    """
    **EXPERIMENTAL**

    Fired when download makes progress. Last call has ``done`` == true.
    Deprecated. Use Browser.downloadProgress instead.
    """

    #: 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

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

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)

from_json(json) classmethod

Source code in zendriver/cdp/page.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"]),
    )

DownloadWillBegin dataclass

EXPERIMENTAL

Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
@event_class("Page.downloadWillBegin")
@dataclass
class DownloadWillBegin:
    """
    **EXPERIMENTAL**

    Fired when page is about to start a download.
    Deprecated. Use Browser.downloadWillBegin instead.
    """

    #: Id of the frame that caused download to begin.
    frame_id: 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=FrameId.from_json(json["frameId"]),
            guid=str(json["guid"]),
            url=str(json["url"]),
            suggested_filename=str(json["suggestedFilename"]),
        )

frame_id: 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/page.py

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

FileChooserOpened dataclass

Emitted only when page.interceptFileChooser is enabled.

Source code in zendriver/cdp/page.py

@event_class("Page.fileChooserOpened")
@dataclass
class FileChooserOpened:
    """
    Emitted only when ``page.interceptFileChooser`` is enabled.
    """

    #: Id of the frame containing input node.
    frame_id: FrameId
    #: Input mode.
    mode: str
    #: Input node id. Only present for file choosers opened via an ``<input type="file">`` element.
    backend_node_id: typing.Optional[dom.BackendNodeId]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FileChooserOpened:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]),
            mode=str(json["mode"]),
            backend_node_id=(
                dom.BackendNodeId.from_json(json["backendNodeId"])
                if json.get("backendNodeId", None) is not None
                else None
            ),
        )

backend_node_id: typing.Optional[dom.BackendNodeId] instance-attribute

frame_id: FrameId instance-attribute

mode: str instance-attribute

__init__(frame_id, mode, backend_node_id)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FileChooserOpened:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]),
        mode=str(json["mode"]),
        backend_node_id=(
            dom.BackendNodeId.from_json(json["backendNodeId"])
            if json.get("backendNodeId", None) is not None
            else None
        ),
    )

FileFilter dataclass

Source code in zendriver/cdp/page.py

@dataclass
class FileFilter:
    name: typing.Optional[str] = None

    accepts: typing.Optional[typing.List[str]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        if self.name is not None:
            json["name"] = self.name
        if self.accepts is not None:
            json["accepts"] = [i for i in self.accepts]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FileFilter:
        return cls(
            name=str(json["name"]) if json.get("name", None) is not None else None,
            accepts=(
                [str(i) for i in json["accepts"]]
                if json.get("accepts", None) is not None
                else None
            ),
        )

accepts: typing.Optional[typing.List[str]] = None class-attribute instance-attribute

name: typing.Optional[str] = None class-attribute instance-attribute

__init__(name=None, accepts=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FileFilter:
    return cls(
        name=str(json["name"]) if json.get("name", None) is not None else None,
        accepts=(
            [str(i) for i in json["accepts"]]
            if json.get("accepts", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    if self.name is not None:
        json["name"] = self.name
    if self.accepts is not None:
        json["accepts"] = [i for i in self.accepts]
    return json

FileHandler dataclass

Source code in zendriver/cdp/page.py

@dataclass
class FileHandler:
    action: str

    name: str

    #: Won't repeat the enums, using string for easy comparison. Same as the
    #: other enums below.
    launch_type: str

    icons: typing.Optional[typing.List[ImageResource]] = None

    #: Mimic a map, name is the key, accepts is the value.
    accepts: typing.Optional[typing.List[FileFilter]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["action"] = self.action
        json["name"] = self.name
        json["launchType"] = self.launch_type
        if self.icons is not None:
            json["icons"] = [i.to_json() for i in self.icons]
        if self.accepts is not None:
            json["accepts"] = [i.to_json() for i in self.accepts]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FileHandler:
        return cls(
            action=str(json["action"]),
            name=str(json["name"]),
            launch_type=str(json["launchType"]),
            icons=(
                [ImageResource.from_json(i) for i in json["icons"]]
                if json.get("icons", None) is not None
                else None
            ),
            accepts=(
                [FileFilter.from_json(i) for i in json["accepts"]]
                if json.get("accepts", None) is not None
                else None
            ),
        )

accepts: typing.Optional[typing.List[FileFilter]] = None class-attribute instance-attribute

action: str instance-attribute

icons: typing.Optional[typing.List[ImageResource]] = None class-attribute instance-attribute

launch_type: str instance-attribute

name: str instance-attribute

__init__(action, name, launch_type, icons=None, accepts=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FileHandler:
    return cls(
        action=str(json["action"]),
        name=str(json["name"]),
        launch_type=str(json["launchType"]),
        icons=(
            [ImageResource.from_json(i) for i in json["icons"]]
            if json.get("icons", None) is not None
            else None
        ),
        accepts=(
            [FileFilter.from_json(i) for i in json["accepts"]]
            if json.get("accepts", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["action"] = self.action
    json["name"] = self.name
    json["launchType"] = self.launch_type
    if self.icons is not None:
        json["icons"] = [i.to_json() for i in self.icons]
    if self.accepts is not None:
        json["accepts"] = [i.to_json() for i in self.accepts]
    return json

FontFamilies dataclass

Generic font families collection.

Source code in zendriver/cdp/page.py

@dataclass
class FontFamilies:
    """
    Generic font families collection.
    """

    #: The standard font-family.
    standard: typing.Optional[str] = None

    #: The fixed font-family.
    fixed: typing.Optional[str] = None

    #: The serif font-family.
    serif: typing.Optional[str] = None

    #: The sansSerif font-family.
    sans_serif: typing.Optional[str] = None

    #: The cursive font-family.
    cursive: typing.Optional[str] = None

    #: The fantasy font-family.
    fantasy: typing.Optional[str] = None

    #: The math font-family.
    math: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        if self.standard is not None:
            json["standard"] = self.standard
        if self.fixed is not None:
            json["fixed"] = self.fixed
        if self.serif is not None:
            json["serif"] = self.serif
        if self.sans_serif is not None:
            json["sansSerif"] = self.sans_serif
        if self.cursive is not None:
            json["cursive"] = self.cursive
        if self.fantasy is not None:
            json["fantasy"] = self.fantasy
        if self.math is not None:
            json["math"] = self.math
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FontFamilies:
        return cls(
            standard=(
                str(json["standard"])
                if json.get("standard", None) is not None
                else None
            ),
            fixed=str(json["fixed"]) if json.get("fixed", None) is not None else None,
            serif=str(json["serif"]) if json.get("serif", None) is not None else None,
            sans_serif=(
                str(json["sansSerif"])
                if json.get("sansSerif", None) is not None
                else None
            ),
            cursive=(
                str(json["cursive"]) if json.get("cursive", None) is not None else None
            ),
            fantasy=(
                str(json["fantasy"]) if json.get("fantasy", None) is not None else None
            ),
            math=str(json["math"]) if json.get("math", None) is not None else None,
        )

cursive: typing.Optional[str] = None class-attribute instance-attribute

fantasy: typing.Optional[str] = None class-attribute instance-attribute

fixed: typing.Optional[str] = None class-attribute instance-attribute

math: typing.Optional[str] = None class-attribute instance-attribute

sans_serif: typing.Optional[str] = None class-attribute instance-attribute

serif: typing.Optional[str] = None class-attribute instance-attribute

standard: typing.Optional[str] = None class-attribute instance-attribute

__init__(standard=None, fixed=None, serif=None, sans_serif=None, cursive=None, fantasy=None, math=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FontFamilies:
    return cls(
        standard=(
            str(json["standard"])
            if json.get("standard", None) is not None
            else None
        ),
        fixed=str(json["fixed"]) if json.get("fixed", None) is not None else None,
        serif=str(json["serif"]) if json.get("serif", None) is not None else None,
        sans_serif=(
            str(json["sansSerif"])
            if json.get("sansSerif", None) is not None
            else None
        ),
        cursive=(
            str(json["cursive"]) if json.get("cursive", None) is not None else None
        ),
        fantasy=(
            str(json["fantasy"]) if json.get("fantasy", None) is not None else None
        ),
        math=str(json["math"]) if json.get("math", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    if self.standard is not None:
        json["standard"] = self.standard
    if self.fixed is not None:
        json["fixed"] = self.fixed
    if self.serif is not None:
        json["serif"] = self.serif
    if self.sans_serif is not None:
        json["sansSerif"] = self.sans_serif
    if self.cursive is not None:
        json["cursive"] = self.cursive
    if self.fantasy is not None:
        json["fantasy"] = self.fantasy
    if self.math is not None:
        json["math"] = self.math
    return json

FontSizes dataclass

Default font sizes.

Source code in zendriver/cdp/page.py

@dataclass
class FontSizes:
    """
    Default font sizes.
    """

    #: Default standard font size.
    standard: typing.Optional[int] = None

    #: Default fixed font size.
    fixed: typing.Optional[int] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        if self.standard is not None:
            json["standard"] = self.standard
        if self.fixed is not None:
            json["fixed"] = self.fixed
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FontSizes:
        return cls(
            standard=(
                int(json["standard"])
                if json.get("standard", None) is not None
                else None
            ),
            fixed=int(json["fixed"]) if json.get("fixed", None) is not None else None,
        )

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

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

__init__(standard=None, fixed=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FontSizes:
    return cls(
        standard=(
            int(json["standard"])
            if json.get("standard", None) is not None
            else None
        ),
        fixed=int(json["fixed"]) if json.get("fixed", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    if self.standard is not None:
        json["standard"] = self.standard
    if self.fixed is not None:
        json["fixed"] = self.fixed
    return json

Frame dataclass

Information about the Frame on the page.

Source code in zendriver/cdp/page.py

@dataclass
class Frame:
    """
    Information about the Frame on the page.
    """

    #: Frame unique identifier.
    id_: FrameId

    #: Identifier of the loader associated with this frame.
    loader_id: network.LoaderId

    #: Frame document's URL without fragment.
    url: str

    #: Frame document's registered domain, taking the public suffixes list into account.
    #: Extracted from the Frame's url.
    #: Example URLs: http://www.google.com/file.html -> "google.com"
    #:               http://a.b.co.uk/file.html      -> "b.co.uk"
    domain_and_registry: str

    #: Frame document's security origin.
    security_origin: str

    #: Frame document's mimeType as determined by the browser.
    mime_type: str

    #: Indicates whether the main document is a secure context and explains why that is the case.
    secure_context_type: SecureContextType

    #: Indicates whether this is a cross origin isolated context.
    cross_origin_isolated_context_type: CrossOriginIsolatedContextType

    #: Indicated which gated APIs / features are available.
    gated_api_features: typing.List[GatedAPIFeatures]

    #: Parent frame identifier.
    parent_id: typing.Optional[FrameId] = None

    #: Frame's name as specified in the tag.
    name: typing.Optional[str] = None

    #: Frame document's URL fragment including the '#'.
    url_fragment: typing.Optional[str] = None

    #: If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.
    unreachable_url: typing.Optional[str] = None

    #: Indicates whether this frame was tagged as an ad and why.
    ad_frame_status: typing.Optional[AdFrameStatus] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["id"] = self.id_.to_json()
        json["loaderId"] = self.loader_id.to_json()
        json["url"] = self.url
        json["domainAndRegistry"] = self.domain_and_registry
        json["securityOrigin"] = self.security_origin
        json["mimeType"] = self.mime_type
        json["secureContextType"] = self.secure_context_type.to_json()
        json["crossOriginIsolatedContextType"] = (
            self.cross_origin_isolated_context_type.to_json()
        )
        json["gatedAPIFeatures"] = [i.to_json() for i in self.gated_api_features]
        if self.parent_id is not None:
            json["parentId"] = self.parent_id.to_json()
        if self.name is not None:
            json["name"] = self.name
        if self.url_fragment is not None:
            json["urlFragment"] = self.url_fragment
        if self.unreachable_url is not None:
            json["unreachableUrl"] = self.unreachable_url
        if self.ad_frame_status is not None:
            json["adFrameStatus"] = self.ad_frame_status.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Frame:
        return cls(
            id_=FrameId.from_json(json["id"]),
            loader_id=network.LoaderId.from_json(json["loaderId"]),
            url=str(json["url"]),
            domain_and_registry=str(json["domainAndRegistry"]),
            security_origin=str(json["securityOrigin"]),
            mime_type=str(json["mimeType"]),
            secure_context_type=SecureContextType.from_json(json["secureContextType"]),
            cross_origin_isolated_context_type=CrossOriginIsolatedContextType.from_json(
                json["crossOriginIsolatedContextType"]
            ),
            gated_api_features=[
                GatedAPIFeatures.from_json(i) for i in json["gatedAPIFeatures"]
            ],
            parent_id=(
                FrameId.from_json(json["parentId"])
                if json.get("parentId", None) is not None
                else None
            ),
            name=str(json["name"]) if json.get("name", None) is not None else None,
            url_fragment=(
                str(json["urlFragment"])
                if json.get("urlFragment", None) is not None
                else None
            ),
            unreachable_url=(
                str(json["unreachableUrl"])
                if json.get("unreachableUrl", None) is not None
                else None
            ),
            ad_frame_status=(
                AdFrameStatus.from_json(json["adFrameStatus"])
                if json.get("adFrameStatus", None) is not None
                else None
            ),
        )

ad_frame_status: typing.Optional[AdFrameStatus] = None class-attribute instance-attribute

cross_origin_isolated_context_type: CrossOriginIsolatedContextType instance-attribute

domain_and_registry: str instance-attribute

gated_api_features: typing.List[GatedAPIFeatures] instance-attribute

id_: FrameId instance-attribute

loader_id: network.LoaderId instance-attribute

mime_type: str instance-attribute

name: typing.Optional[str] = None class-attribute instance-attribute

parent_id: typing.Optional[FrameId] = None class-attribute instance-attribute

secure_context_type: SecureContextType instance-attribute

security_origin: str instance-attribute

unreachable_url: typing.Optional[str] = None class-attribute instance-attribute

url: str instance-attribute

url_fragment: typing.Optional[str] = None class-attribute instance-attribute

__init__(id_, loader_id, url, domain_and_registry, security_origin, mime_type, secure_context_type, cross_origin_isolated_context_type, gated_api_features, parent_id=None, name=None, url_fragment=None, unreachable_url=None, ad_frame_status=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Frame:
    return cls(
        id_=FrameId.from_json(json["id"]),
        loader_id=network.LoaderId.from_json(json["loaderId"]),
        url=str(json["url"]),
        domain_and_registry=str(json["domainAndRegistry"]),
        security_origin=str(json["securityOrigin"]),
        mime_type=str(json["mimeType"]),
        secure_context_type=SecureContextType.from_json(json["secureContextType"]),
        cross_origin_isolated_context_type=CrossOriginIsolatedContextType.from_json(
            json["crossOriginIsolatedContextType"]
        ),
        gated_api_features=[
            GatedAPIFeatures.from_json(i) for i in json["gatedAPIFeatures"]
        ],
        parent_id=(
            FrameId.from_json(json["parentId"])
            if json.get("parentId", None) is not None
            else None
        ),
        name=str(json["name"]) if json.get("name", None) is not None else None,
        url_fragment=(
            str(json["urlFragment"])
            if json.get("urlFragment", None) is not None
            else None
        ),
        unreachable_url=(
            str(json["unreachableUrl"])
            if json.get("unreachableUrl", None) is not None
            else None
        ),
        ad_frame_status=(
            AdFrameStatus.from_json(json["adFrameStatus"])
            if json.get("adFrameStatus", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["id"] = self.id_.to_json()
    json["loaderId"] = self.loader_id.to_json()
    json["url"] = self.url
    json["domainAndRegistry"] = self.domain_and_registry
    json["securityOrigin"] = self.security_origin
    json["mimeType"] = self.mime_type
    json["secureContextType"] = self.secure_context_type.to_json()
    json["crossOriginIsolatedContextType"] = (
        self.cross_origin_isolated_context_type.to_json()
    )
    json["gatedAPIFeatures"] = [i.to_json() for i in self.gated_api_features]
    if self.parent_id is not None:
        json["parentId"] = self.parent_id.to_json()
    if self.name is not None:
        json["name"] = self.name
    if self.url_fragment is not None:
        json["urlFragment"] = self.url_fragment
    if self.unreachable_url is not None:
        json["unreachableUrl"] = self.unreachable_url
    if self.ad_frame_status is not None:
        json["adFrameStatus"] = self.ad_frame_status.to_json()
    return json

FrameAttached dataclass

Fired when frame has been attached to its parent.

Source code in zendriver/cdp/page.py

@event_class("Page.frameAttached")
@dataclass
class FrameAttached:
    """
    Fired when frame has been attached to its parent.
    """

    #: Id of the frame that has been attached.
    frame_id: FrameId
    #: Parent frame identifier.
    parent_frame_id: FrameId
    #: JavaScript stack trace of when frame was attached, only set if frame initiated from script.
    stack: typing.Optional[runtime.StackTrace]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameAttached:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]),
            parent_frame_id=FrameId.from_json(json["parentFrameId"]),
            stack=(
                runtime.StackTrace.from_json(json["stack"])
                if json.get("stack", None) is not None
                else None
            ),
        )

frame_id: FrameId instance-attribute

parent_frame_id: FrameId instance-attribute

stack: typing.Optional[runtime.StackTrace] instance-attribute

__init__(frame_id, parent_frame_id, stack)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameAttached:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]),
        parent_frame_id=FrameId.from_json(json["parentFrameId"]),
        stack=(
            runtime.StackTrace.from_json(json["stack"])
            if json.get("stack", None) is not None
            else None
        ),
    )

FrameClearedScheduledNavigation dataclass

Fired when frame no longer has a scheduled navigation.

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
@event_class("Page.frameClearedScheduledNavigation")
@dataclass
class FrameClearedScheduledNavigation:
    """
    Fired when frame no longer has a scheduled navigation.
    """

    #: Id of the frame that has cleared its scheduled navigation.
    frame_id: FrameId

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameClearedScheduledNavigation:
        return cls(frame_id=FrameId.from_json(json["frameId"]))

frame_id: FrameId instance-attribute

__init__(frame_id)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameClearedScheduledNavigation:
    return cls(frame_id=FrameId.from_json(json["frameId"]))

FrameDetached dataclass

Fired when frame has been detached from its parent.

Source code in zendriver/cdp/page.py

@event_class("Page.frameDetached")
@dataclass
class FrameDetached:
    """
    Fired when frame has been detached from its parent.
    """

    #: Id of the frame that has been detached.
    frame_id: FrameId
    reason: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameDetached:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]), reason=str(json["reason"])
        )

frame_id: FrameId instance-attribute

reason: str instance-attribute

__init__(frame_id, reason)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameDetached:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]), reason=str(json["reason"])
    )

FrameId

Bases: str

Unique frame identifier.

Source code in zendriver/cdp/page.py

class FrameId(str):
    """
    Unique frame identifier.
    """

    def to_json(self) -> str:
        return self

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

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

__repr__()

Source code in zendriver/cdp/page.py

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

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> str:
    return self

FrameNavigated dataclass

Fired once navigation of the frame has completed. Frame is now associated with the new loader.

Source code in zendriver/cdp/page.py

@event_class("Page.frameNavigated")
@dataclass
class FrameNavigated:
    """
    Fired once navigation of the frame has completed. Frame is now associated with the new loader.
    """

    #: Frame object.
    frame: Frame
    type_: NavigationType

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameNavigated:
        return cls(
            frame=Frame.from_json(json["frame"]),
            type_=NavigationType.from_json(json["type"]),
        )

frame: Frame instance-attribute

type_: NavigationType instance-attribute

__init__(frame, type_)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameNavigated:
    return cls(
        frame=Frame.from_json(json["frame"]),
        type_=NavigationType.from_json(json["type"]),
    )

FrameRequestedNavigation dataclass

EXPERIMENTAL

Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.

Source code in zendriver/cdp/page.py

@event_class("Page.frameRequestedNavigation")
@dataclass
class FrameRequestedNavigation:
    """
    **EXPERIMENTAL**

    Fired when a renderer-initiated navigation is requested.
    Navigation may still be cancelled after the event is issued.
    """

    #: Id of the frame that is being navigated.
    frame_id: FrameId
    #: The reason for the navigation.
    reason: ClientNavigationReason
    #: The destination URL for the requested navigation.
    url: str
    #: The disposition for the navigation.
    disposition: ClientNavigationDisposition

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameRequestedNavigation:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]),
            reason=ClientNavigationReason.from_json(json["reason"]),
            url=str(json["url"]),
            disposition=ClientNavigationDisposition.from_json(json["disposition"]),
        )

disposition: ClientNavigationDisposition instance-attribute

frame_id: FrameId instance-attribute

reason: ClientNavigationReason instance-attribute

url: str instance-attribute

__init__(frame_id, reason, url, disposition)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameRequestedNavigation:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]),
        reason=ClientNavigationReason.from_json(json["reason"]),
        url=str(json["url"]),
        disposition=ClientNavigationDisposition.from_json(json["disposition"]),
    )

FrameResized dataclass

EXPERIMENTAL

Source code in zendriver/cdp/page.py

@event_class("Page.frameResized")
@dataclass
class FrameResized:
    """
    **EXPERIMENTAL**


    """

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameResized:
        return cls()

__init__()

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameResized:
    return cls()

FrameResource dataclass

Information about the Resource on the page.

Source code in zendriver/cdp/page.py

@dataclass
class FrameResource:
    """
    Information about the Resource on the page.
    """

    #: Resource URL.
    url: str

    #: Type of this resource.
    type_: network.ResourceType

    #: Resource mimeType as determined by the browser.
    mime_type: str

    #: last-modified timestamp as reported by server.
    last_modified: typing.Optional[network.TimeSinceEpoch] = None

    #: Resource content size.
    content_size: typing.Optional[float] = None

    #: True if the resource failed to load.
    failed: typing.Optional[bool] = None

    #: True if the resource was canceled during loading.
    canceled: typing.Optional[bool] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["url"] = self.url
        json["type"] = self.type_.to_json()
        json["mimeType"] = self.mime_type
        if self.last_modified is not None:
            json["lastModified"] = self.last_modified.to_json()
        if self.content_size is not None:
            json["contentSize"] = self.content_size
        if self.failed is not None:
            json["failed"] = self.failed
        if self.canceled is not None:
            json["canceled"] = self.canceled
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameResource:
        return cls(
            url=str(json["url"]),
            type_=network.ResourceType.from_json(json["type"]),
            mime_type=str(json["mimeType"]),
            last_modified=(
                network.TimeSinceEpoch.from_json(json["lastModified"])
                if json.get("lastModified", None) is not None
                else None
            ),
            content_size=(
                float(json["contentSize"])
                if json.get("contentSize", None) is not None
                else None
            ),
            failed=(
                bool(json["failed"]) if json.get("failed", None) is not None else None
            ),
            canceled=(
                bool(json["canceled"])
                if json.get("canceled", None) is not None
                else None
            ),
        )

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

content_size: typing.Optional[float] = None class-attribute instance-attribute

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

last_modified: typing.Optional[network.TimeSinceEpoch] = None class-attribute instance-attribute

mime_type: str instance-attribute

type_: network.ResourceType instance-attribute

url: str instance-attribute

__init__(url, type_, mime_type, last_modified=None, content_size=None, failed=None, canceled=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameResource:
    return cls(
        url=str(json["url"]),
        type_=network.ResourceType.from_json(json["type"]),
        mime_type=str(json["mimeType"]),
        last_modified=(
            network.TimeSinceEpoch.from_json(json["lastModified"])
            if json.get("lastModified", None) is not None
            else None
        ),
        content_size=(
            float(json["contentSize"])
            if json.get("contentSize", None) is not None
            else None
        ),
        failed=(
            bool(json["failed"]) if json.get("failed", None) is not None else None
        ),
        canceled=(
            bool(json["canceled"])
            if json.get("canceled", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["url"] = self.url
    json["type"] = self.type_.to_json()
    json["mimeType"] = self.mime_type
    if self.last_modified is not None:
        json["lastModified"] = self.last_modified.to_json()
    if self.content_size is not None:
        json["contentSize"] = self.content_size
    if self.failed is not None:
        json["failed"] = self.failed
    if self.canceled is not None:
        json["canceled"] = self.canceled
    return json

FrameResourceTree dataclass

Information about the Frame hierarchy along with their cached resources.

Source code in zendriver/cdp/page.py

@dataclass
class FrameResourceTree:
    """
    Information about the Frame hierarchy along with their cached resources.
    """

    #: Frame information for this tree item.
    frame: Frame

    #: Information about frame resources.
    resources: typing.List[FrameResource]

    #: Child frames.
    child_frames: typing.Optional[typing.List[FrameResourceTree]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["frame"] = self.frame.to_json()
        json["resources"] = [i.to_json() for i in self.resources]
        if self.child_frames is not None:
            json["childFrames"] = [i.to_json() for i in self.child_frames]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameResourceTree:
        return cls(
            frame=Frame.from_json(json["frame"]),
            resources=[FrameResource.from_json(i) for i in json["resources"]],
            child_frames=(
                [FrameResourceTree.from_json(i) for i in json["childFrames"]]
                if json.get("childFrames", None) is not None
                else None
            ),
        )

child_frames: typing.Optional[typing.List[FrameResourceTree]] = None class-attribute instance-attribute

frame: Frame instance-attribute

resources: typing.List[FrameResource] instance-attribute

__init__(frame, resources, child_frames=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameResourceTree:
    return cls(
        frame=Frame.from_json(json["frame"]),
        resources=[FrameResource.from_json(i) for i in json["resources"]],
        child_frames=(
            [FrameResourceTree.from_json(i) for i in json["childFrames"]]
            if json.get("childFrames", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["frame"] = self.frame.to_json()
    json["resources"] = [i.to_json() for i in self.resources]
    if self.child_frames is not None:
        json["childFrames"] = [i.to_json() for i in self.child_frames]
    return json

FrameScheduledNavigation dataclass

Fired when frame schedules a potential navigation.

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
@event_class("Page.frameScheduledNavigation")
@dataclass
class FrameScheduledNavigation:
    """
    Fired when frame schedules a potential navigation.
    """

    #: Id of the frame that has scheduled a navigation.
    frame_id: FrameId
    #: Delay (in seconds) until the navigation is scheduled to begin. The navigation is not
    #: guaranteed to start.
    delay: float
    #: The reason for the navigation.
    reason: ClientNavigationReason
    #: The destination URL for the scheduled navigation.
    url: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameScheduledNavigation:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]),
            delay=float(json["delay"]),
            reason=ClientNavigationReason.from_json(json["reason"]),
            url=str(json["url"]),
        )

delay: float instance-attribute

frame_id: FrameId instance-attribute

reason: ClientNavigationReason instance-attribute

url: str instance-attribute

__init__(frame_id, delay, reason, url)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameScheduledNavigation:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]),
        delay=float(json["delay"]),
        reason=ClientNavigationReason.from_json(json["reason"]),
        url=str(json["url"]),
    )

FrameStartedLoading dataclass

EXPERIMENTAL

Fired when frame has started loading.

Source code in zendriver/cdp/page.py

@event_class("Page.frameStartedLoading")
@dataclass
class FrameStartedLoading:
    """
    **EXPERIMENTAL**

    Fired when frame has started loading.
    """

    #: Id of the frame that has started loading.
    frame_id: FrameId

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameStartedLoading:
        return cls(frame_id=FrameId.from_json(json["frameId"]))

frame_id: FrameId instance-attribute

__init__(frame_id)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameStartedLoading:
    return cls(frame_id=FrameId.from_json(json["frameId"]))

FrameStoppedLoading dataclass

EXPERIMENTAL

Fired when frame has stopped loading.

Source code in zendriver/cdp/page.py

@event_class("Page.frameStoppedLoading")
@dataclass
class FrameStoppedLoading:
    """
    **EXPERIMENTAL**

    Fired when frame has stopped loading.
    """

    #: Id of the frame that has stopped loading.
    frame_id: FrameId

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameStoppedLoading:
        return cls(frame_id=FrameId.from_json(json["frameId"]))

frame_id: FrameId instance-attribute

__init__(frame_id)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameStoppedLoading:
    return cls(frame_id=FrameId.from_json(json["frameId"]))

FrameTree dataclass

Information about the Frame hierarchy.

Source code in zendriver/cdp/page.py

@dataclass
class FrameTree:
    """
    Information about the Frame hierarchy.
    """

    #: Frame information for this tree item.
    frame: Frame

    #: Child frames.
    child_frames: typing.Optional[typing.List[FrameTree]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["frame"] = self.frame.to_json()
        if self.child_frames is not None:
            json["childFrames"] = [i.to_json() for i in self.child_frames]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> FrameTree:
        return cls(
            frame=Frame.from_json(json["frame"]),
            child_frames=(
                [FrameTree.from_json(i) for i in json["childFrames"]]
                if json.get("childFrames", None) is not None
                else None
            ),
        )

child_frames: typing.Optional[typing.List[FrameTree]] = None class-attribute instance-attribute

frame: Frame instance-attribute

__init__(frame, child_frames=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> FrameTree:
    return cls(
        frame=Frame.from_json(json["frame"]),
        child_frames=(
            [FrameTree.from_json(i) for i in json["childFrames"]]
            if json.get("childFrames", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["frame"] = self.frame.to_json()
    if self.child_frames is not None:
        json["childFrames"] = [i.to_json() for i in self.child_frames]
    return json

GatedAPIFeatures

Bases: Enum

Source code in zendriver/cdp/page.py

class GatedAPIFeatures(enum.Enum):
    SHARED_ARRAY_BUFFERS = "SharedArrayBuffers"
    SHARED_ARRAY_BUFFERS_TRANSFER_ALLOWED = "SharedArrayBuffersTransferAllowed"
    PERFORMANCE_MEASURE_MEMORY = "PerformanceMeasureMemory"
    PERFORMANCE_PROFILE = "PerformanceProfile"

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

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

PERFORMANCE_MEASURE_MEMORY = 'PerformanceMeasureMemory' class-attribute instance-attribute

PERFORMANCE_PROFILE = 'PerformanceProfile' class-attribute instance-attribute

SHARED_ARRAY_BUFFERS = 'SharedArrayBuffers' class-attribute instance-attribute

SHARED_ARRAY_BUFFERS_TRANSFER_ALLOWED = 'SharedArrayBuffersTransferAllowed' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

ImageResource dataclass

The image definition used in both icon and screenshot.

Source code in zendriver/cdp/page.py

@dataclass
class ImageResource:
    """
    The image definition used in both icon and screenshot.
    """

    #: The src field in the definition, but changing to url in favor of
    #: consistency.
    url: str

    sizes: typing.Optional[str] = None

    type_: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["url"] = self.url
        if self.sizes is not None:
            json["sizes"] = self.sizes
        if self.type_ is not None:
            json["type"] = self.type_
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ImageResource:
        return cls(
            url=str(json["url"]),
            sizes=str(json["sizes"]) if json.get("sizes", None) is not None else None,
            type_=str(json["type"]) if json.get("type", None) is not None else None,
        )

sizes: typing.Optional[str] = None class-attribute instance-attribute

type_: typing.Optional[str] = None class-attribute instance-attribute

url: str instance-attribute

__init__(url, sizes=None, type_=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ImageResource:
    return cls(
        url=str(json["url"]),
        sizes=str(json["sizes"]) if json.get("sizes", None) is not None else None,
        type_=str(json["type"]) if json.get("type", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["url"] = self.url
    if self.sizes is not None:
        json["sizes"] = self.sizes
    if self.type_ is not None:
        json["type"] = self.type_
    return json

InstallabilityError dataclass

The installability error

Source code in zendriver/cdp/page.py

@dataclass
class InstallabilityError:
    """
    The installability error
    """

    #: The error id (e.g. 'manifest-missing-suitable-icon').
    error_id: str

    #: The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).
    error_arguments: typing.List[InstallabilityErrorArgument]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["errorId"] = self.error_id
        json["errorArguments"] = [i.to_json() for i in self.error_arguments]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InstallabilityError:
        return cls(
            error_id=str(json["errorId"]),
            error_arguments=[
                InstallabilityErrorArgument.from_json(i) for i in json["errorArguments"]
            ],
        )

error_arguments: typing.List[InstallabilityErrorArgument] instance-attribute

error_id: str instance-attribute

__init__(error_id, error_arguments)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InstallabilityError:
    return cls(
        error_id=str(json["errorId"]),
        error_arguments=[
            InstallabilityErrorArgument.from_json(i) for i in json["errorArguments"]
        ],
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["errorId"] = self.error_id
    json["errorArguments"] = [i.to_json() for i in self.error_arguments]
    return json

InstallabilityErrorArgument dataclass

Source code in zendriver/cdp/page.py

@dataclass
class InstallabilityErrorArgument:
    #: Argument name (e.g. name:'minimum-icon-size-in-pixels').
    name: str

    #: Argument value (e.g. value:'64').
    value: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["value"] = self.value
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InstallabilityErrorArgument:
        return cls(
            name=str(json["name"]),
            value=str(json["value"]),
        )

name: str instance-attribute

value: str instance-attribute

__init__(name, value)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InstallabilityErrorArgument:
    return cls(
        name=str(json["name"]),
        value=str(json["value"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["value"] = self.value
    return json

InterstitialHidden dataclass

Fired when interstitial page was hidden

Source code in zendriver/cdp/page.py

@event_class("Page.interstitialHidden")
@dataclass
class InterstitialHidden:
    """
    Fired when interstitial page was hidden
    """

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InterstitialHidden:
        return cls()

__init__()

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InterstitialHidden:
    return cls()

InterstitialShown dataclass

Fired when interstitial page was shown

Source code in zendriver/cdp/page.py

@event_class("Page.interstitialShown")
@dataclass
class InterstitialShown:
    """
    Fired when interstitial page was shown
    """

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> InterstitialShown:
        return cls()

__init__()

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> InterstitialShown:
    return cls()

JavascriptDialogClosed dataclass

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.

Source code in zendriver/cdp/page.py

@event_class("Page.javascriptDialogClosed")
@dataclass
class JavascriptDialogClosed:
    """
    Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
    closed.
    """

    #: Whether dialog was confirmed.
    result: bool
    #: User input in case of prompt.
    user_input: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> JavascriptDialogClosed:
        return cls(result=bool(json["result"]), user_input=str(json["userInput"]))

result: bool instance-attribute

user_input: str instance-attribute

__init__(result, user_input)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> JavascriptDialogClosed:
    return cls(result=bool(json["result"]), user_input=str(json["userInput"]))

JavascriptDialogOpening dataclass

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.

Source code in zendriver/cdp/page.py

@event_class("Page.javascriptDialogOpening")
@dataclass
class JavascriptDialogOpening:
    """
    Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
    open.
    """

    #: Frame url.
    url: str
    #: Message that will be displayed by the dialog.
    message: str
    #: Dialog type.
    type_: DialogType
    #: True iff browser is capable showing or acting on the given dialog. When browser has no
    #: dialog handler for given target, calling alert while Page domain is engaged will stall
    #: the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
    has_browser_handler: bool
    #: Default dialog prompt.
    default_prompt: typing.Optional[str]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> JavascriptDialogOpening:
        return cls(
            url=str(json["url"]),
            message=str(json["message"]),
            type_=DialogType.from_json(json["type"]),
            has_browser_handler=bool(json["hasBrowserHandler"]),
            default_prompt=(
                str(json["defaultPrompt"])
                if json.get("defaultPrompt", None) is not None
                else None
            ),
        )

default_prompt: typing.Optional[str] instance-attribute

has_browser_handler: bool instance-attribute

message: str instance-attribute

type_: DialogType instance-attribute

url: str instance-attribute

__init__(url, message, type_, has_browser_handler, default_prompt)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> JavascriptDialogOpening:
    return cls(
        url=str(json["url"]),
        message=str(json["message"]),
        type_=DialogType.from_json(json["type"]),
        has_browser_handler=bool(json["hasBrowserHandler"]),
        default_prompt=(
            str(json["defaultPrompt"])
            if json.get("defaultPrompt", None) is not None
            else None
        ),
    )

LaunchHandler dataclass

Source code in zendriver/cdp/page.py

@dataclass
class LaunchHandler:
    client_mode: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["clientMode"] = self.client_mode
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LaunchHandler:
        return cls(
            client_mode=str(json["clientMode"]),
        )

client_mode: str instance-attribute

__init__(client_mode)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> LaunchHandler:
    return cls(
        client_mode=str(json["clientMode"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["clientMode"] = self.client_mode
    return json

LayoutViewport dataclass

Layout viewport position and dimensions.

Source code in zendriver/cdp/page.py

@dataclass
class LayoutViewport:
    """
    Layout viewport position and dimensions.
    """

    #: Horizontal offset relative to the document (CSS pixels).
    page_x: int

    #: Vertical offset relative to the document (CSS pixels).
    page_y: int

    #: Width (CSS pixels), excludes scrollbar if present.
    client_width: int

    #: Height (CSS pixels), excludes scrollbar if present.
    client_height: int

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["pageX"] = self.page_x
        json["pageY"] = self.page_y
        json["clientWidth"] = self.client_width
        json["clientHeight"] = self.client_height
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LayoutViewport:
        return cls(
            page_x=int(json["pageX"]),
            page_y=int(json["pageY"]),
            client_width=int(json["clientWidth"]),
            client_height=int(json["clientHeight"]),
        )

client_height: int instance-attribute

client_width: int instance-attribute

page_x: int instance-attribute

page_y: int instance-attribute

__init__(page_x, page_y, client_width, client_height)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> LayoutViewport:
    return cls(
        page_x=int(json["pageX"]),
        page_y=int(json["pageY"]),
        client_width=int(json["clientWidth"]),
        client_height=int(json["clientHeight"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["pageX"] = self.page_x
    json["pageY"] = self.page_y
    json["clientWidth"] = self.client_width
    json["clientHeight"] = self.client_height
    return json

LifecycleEvent dataclass

Fired for top level page lifecycle events such as navigation, load, paint, etc.

Source code in zendriver/cdp/page.py

@event_class("Page.lifecycleEvent")
@dataclass
class LifecycleEvent:
    """
    Fired for top level page lifecycle events such as navigation, load, paint, etc.
    """

    #: Id of the frame.
    frame_id: FrameId
    #: Loader identifier. Empty string if the request is fetched from worker.
    loader_id: network.LoaderId
    name: str
    timestamp: network.MonotonicTime

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LifecycleEvent:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]),
            loader_id=network.LoaderId.from_json(json["loaderId"]),
            name=str(json["name"]),
            timestamp=network.MonotonicTime.from_json(json["timestamp"]),
        )

frame_id: FrameId instance-attribute

loader_id: network.LoaderId instance-attribute

name: str instance-attribute

timestamp: network.MonotonicTime instance-attribute

__init__(frame_id, loader_id, name, timestamp)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> LifecycleEvent:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]),
        loader_id=network.LoaderId.from_json(json["loaderId"]),
        name=str(json["name"]),
        timestamp=network.MonotonicTime.from_json(json["timestamp"]),
    )

LoadEventFired dataclass

Source code in zendriver/cdp/page.py

@event_class("Page.loadEventFired")
@dataclass
class LoadEventFired:
    timestamp: network.MonotonicTime

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LoadEventFired:
        return cls(timestamp=network.MonotonicTime.from_json(json["timestamp"]))

timestamp: network.MonotonicTime instance-attribute

__init__(timestamp)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> LoadEventFired:
    return cls(timestamp=network.MonotonicTime.from_json(json["timestamp"]))

NavigatedWithinDocument dataclass

EXPERIMENTAL

Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.

Source code in zendriver/cdp/page.py

@event_class("Page.navigatedWithinDocument")
@dataclass
class NavigatedWithinDocument:
    """
    **EXPERIMENTAL**

    Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
    """

    #: Id of the frame.
    frame_id: FrameId
    #: Frame's new url.
    url: str

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

frame_id: FrameId instance-attribute

url: str instance-attribute

__init__(frame_id, url)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

NavigationEntry dataclass

Navigation history entry.

Source code in zendriver/cdp/page.py

@dataclass
class NavigationEntry:
    """
    Navigation history entry.
    """

    #: Unique id of the navigation history entry.
    id_: int

    #: URL of the navigation history entry.
    url: str

    #: URL that the user typed in the url bar.
    user_typed_url: str

    #: Title of the navigation history entry.
    title: str

    #: Transition type.
    transition_type: TransitionType

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["id"] = self.id_
        json["url"] = self.url
        json["userTypedURL"] = self.user_typed_url
        json["title"] = self.title
        json["transitionType"] = self.transition_type.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> NavigationEntry:
        return cls(
            id_=int(json["id"]),
            url=str(json["url"]),
            user_typed_url=str(json["userTypedURL"]),
            title=str(json["title"]),
            transition_type=TransitionType.from_json(json["transitionType"]),
        )

id_: int instance-attribute

title: str instance-attribute

transition_type: TransitionType instance-attribute

url: str instance-attribute

user_typed_url: str instance-attribute

__init__(id_, url, user_typed_url, title, transition_type)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> NavigationEntry:
    return cls(
        id_=int(json["id"]),
        url=str(json["url"]),
        user_typed_url=str(json["userTypedURL"]),
        title=str(json["title"]),
        transition_type=TransitionType.from_json(json["transitionType"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["id"] = self.id_
    json["url"] = self.url
    json["userTypedURL"] = self.user_typed_url
    json["title"] = self.title
    json["transitionType"] = self.transition_type.to_json()
    return json

NavigationType

Bases: Enum

The type of a frameNavigated event.

Source code in zendriver/cdp/page.py

class NavigationType(enum.Enum):
    """
    The type of a frameNavigated event.
    """

    NAVIGATION = "Navigation"
    BACK_FORWARD_CACHE_RESTORE = "BackForwardCacheRestore"

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

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

BACK_FORWARD_CACHE_RESTORE = 'BackForwardCacheRestore' class-attribute instance-attribute

NAVIGATION = 'Navigation' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

OriginTrial dataclass

Source code in zendriver/cdp/page.py

@dataclass
class OriginTrial:
    trial_name: str

    status: OriginTrialStatus

    tokens_with_status: typing.List[OriginTrialTokenWithStatus]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["trialName"] = self.trial_name
        json["status"] = self.status.to_json()
        json["tokensWithStatus"] = [i.to_json() for i in self.tokens_with_status]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> OriginTrial:
        return cls(
            trial_name=str(json["trialName"]),
            status=OriginTrialStatus.from_json(json["status"]),
            tokens_with_status=[
                OriginTrialTokenWithStatus.from_json(i)
                for i in json["tokensWithStatus"]
            ],
        )

status: OriginTrialStatus instance-attribute

tokens_with_status: typing.List[OriginTrialTokenWithStatus] instance-attribute

trial_name: str instance-attribute

__init__(trial_name, status, tokens_with_status)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> OriginTrial:
    return cls(
        trial_name=str(json["trialName"]),
        status=OriginTrialStatus.from_json(json["status"]),
        tokens_with_status=[
            OriginTrialTokenWithStatus.from_json(i)
            for i in json["tokensWithStatus"]
        ],
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["trialName"] = self.trial_name
    json["status"] = self.status.to_json()
    json["tokensWithStatus"] = [i.to_json() for i in self.tokens_with_status]
    return json

OriginTrialStatus

Bases: Enum

Status for an Origin Trial.

Source code in zendriver/cdp/page.py

class OriginTrialStatus(enum.Enum):
    """
    Status for an Origin Trial.
    """

    ENABLED = "Enabled"
    VALID_TOKEN_NOT_PROVIDED = "ValidTokenNotProvided"
    OS_NOT_SUPPORTED = "OSNotSupported"
    TRIAL_NOT_ALLOWED = "TrialNotAllowed"

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

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

ENABLED = 'Enabled' class-attribute instance-attribute

OS_NOT_SUPPORTED = 'OSNotSupported' class-attribute instance-attribute

TRIAL_NOT_ALLOWED = 'TrialNotAllowed' class-attribute instance-attribute

VALID_TOKEN_NOT_PROVIDED = 'ValidTokenNotProvided' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

OriginTrialToken dataclass

Source code in zendriver/cdp/page.py

@dataclass
class OriginTrialToken:
    origin: str

    match_sub_domains: bool

    trial_name: str

    expiry_time: network.TimeSinceEpoch

    is_third_party: bool

    usage_restriction: OriginTrialUsageRestriction

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["origin"] = self.origin
        json["matchSubDomains"] = self.match_sub_domains
        json["trialName"] = self.trial_name
        json["expiryTime"] = self.expiry_time.to_json()
        json["isThirdParty"] = self.is_third_party
        json["usageRestriction"] = self.usage_restriction.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> OriginTrialToken:
        return cls(
            origin=str(json["origin"]),
            match_sub_domains=bool(json["matchSubDomains"]),
            trial_name=str(json["trialName"]),
            expiry_time=network.TimeSinceEpoch.from_json(json["expiryTime"]),
            is_third_party=bool(json["isThirdParty"]),
            usage_restriction=OriginTrialUsageRestriction.from_json(
                json["usageRestriction"]
            ),
        )

expiry_time: network.TimeSinceEpoch instance-attribute

is_third_party: bool instance-attribute

match_sub_domains: bool instance-attribute

origin: str instance-attribute

trial_name: str instance-attribute

usage_restriction: OriginTrialUsageRestriction instance-attribute

__init__(origin, match_sub_domains, trial_name, expiry_time, is_third_party, usage_restriction)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> OriginTrialToken:
    return cls(
        origin=str(json["origin"]),
        match_sub_domains=bool(json["matchSubDomains"]),
        trial_name=str(json["trialName"]),
        expiry_time=network.TimeSinceEpoch.from_json(json["expiryTime"]),
        is_third_party=bool(json["isThirdParty"]),
        usage_restriction=OriginTrialUsageRestriction.from_json(
            json["usageRestriction"]
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["origin"] = self.origin
    json["matchSubDomains"] = self.match_sub_domains
    json["trialName"] = self.trial_name
    json["expiryTime"] = self.expiry_time.to_json()
    json["isThirdParty"] = self.is_third_party
    json["usageRestriction"] = self.usage_restriction.to_json()
    return json

OriginTrialTokenStatus

Bases: Enum

Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token.

Source code in zendriver/cdp/page.py

class OriginTrialTokenStatus(enum.Enum):
    """
    Origin Trial(https://www.chromium.org/blink/origin-trials) support.
    Status for an Origin Trial token.
    """

    SUCCESS = "Success"
    NOT_SUPPORTED = "NotSupported"
    INSECURE = "Insecure"
    EXPIRED = "Expired"
    WRONG_ORIGIN = "WrongOrigin"
    INVALID_SIGNATURE = "InvalidSignature"
    MALFORMED = "Malformed"
    WRONG_VERSION = "WrongVersion"
    FEATURE_DISABLED = "FeatureDisabled"
    TOKEN_DISABLED = "TokenDisabled"
    FEATURE_DISABLED_FOR_USER = "FeatureDisabledForUser"
    UNKNOWN_TRIAL = "UnknownTrial"

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

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

EXPIRED = 'Expired' class-attribute instance-attribute

FEATURE_DISABLED = 'FeatureDisabled' class-attribute instance-attribute

FEATURE_DISABLED_FOR_USER = 'FeatureDisabledForUser' class-attribute instance-attribute

INSECURE = 'Insecure' class-attribute instance-attribute

INVALID_SIGNATURE = 'InvalidSignature' class-attribute instance-attribute

MALFORMED = 'Malformed' class-attribute instance-attribute

NOT_SUPPORTED = 'NotSupported' class-attribute instance-attribute

SUCCESS = 'Success' class-attribute instance-attribute

TOKEN_DISABLED = 'TokenDisabled' class-attribute instance-attribute

UNKNOWN_TRIAL = 'UnknownTrial' class-attribute instance-attribute

WRONG_ORIGIN = 'WrongOrigin' class-attribute instance-attribute

WRONG_VERSION = 'WrongVersion' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

OriginTrialTokenWithStatus dataclass

Source code in zendriver/cdp/page.py

@dataclass
class OriginTrialTokenWithStatus:
    raw_token_text: str

    status: OriginTrialTokenStatus

    #: ``parsedToken`` is present only when the token is extractable and
    #: parsable.
    parsed_token: typing.Optional[OriginTrialToken] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["rawTokenText"] = self.raw_token_text
        json["status"] = self.status.to_json()
        if self.parsed_token is not None:
            json["parsedToken"] = self.parsed_token.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> OriginTrialTokenWithStatus:
        return cls(
            raw_token_text=str(json["rawTokenText"]),
            status=OriginTrialTokenStatus.from_json(json["status"]),
            parsed_token=(
                OriginTrialToken.from_json(json["parsedToken"])
                if json.get("parsedToken", None) is not None
                else None
            ),
        )

parsed_token: typing.Optional[OriginTrialToken] = None class-attribute instance-attribute

raw_token_text: str instance-attribute

status: OriginTrialTokenStatus instance-attribute

__init__(raw_token_text, status, parsed_token=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> OriginTrialTokenWithStatus:
    return cls(
        raw_token_text=str(json["rawTokenText"]),
        status=OriginTrialTokenStatus.from_json(json["status"]),
        parsed_token=(
            OriginTrialToken.from_json(json["parsedToken"])
            if json.get("parsedToken", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["rawTokenText"] = self.raw_token_text
    json["status"] = self.status.to_json()
    if self.parsed_token is not None:
        json["parsedToken"] = self.parsed_token.to_json()
    return json

OriginTrialUsageRestriction

Bases: Enum

Source code in zendriver/cdp/page.py

class OriginTrialUsageRestriction(enum.Enum):
    NONE = "None"
    SUBSET = "Subset"

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

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

NONE = 'None' class-attribute instance-attribute

SUBSET = 'Subset' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

PermissionsPolicyBlockLocator dataclass

Source code in zendriver/cdp/page.py

@dataclass
class PermissionsPolicyBlockLocator:
    frame_id: FrameId

    block_reason: PermissionsPolicyBlockReason

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["frameId"] = self.frame_id.to_json()
        json["blockReason"] = self.block_reason.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> PermissionsPolicyBlockLocator:
        return cls(
            frame_id=FrameId.from_json(json["frameId"]),
            block_reason=PermissionsPolicyBlockReason.from_json(json["blockReason"]),
        )

block_reason: PermissionsPolicyBlockReason instance-attribute

frame_id: FrameId instance-attribute

__init__(frame_id, block_reason)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> PermissionsPolicyBlockLocator:
    return cls(
        frame_id=FrameId.from_json(json["frameId"]),
        block_reason=PermissionsPolicyBlockReason.from_json(json["blockReason"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["frameId"] = self.frame_id.to_json()
    json["blockReason"] = self.block_reason.to_json()
    return json

PermissionsPolicyBlockReason

Bases: Enum

Reason for a permissions policy feature to be disabled.

Source code in zendriver/cdp/page.py

class PermissionsPolicyBlockReason(enum.Enum):
    """
    Reason for a permissions policy feature to be disabled.
    """

    HEADER = "Header"
    IFRAME_ATTRIBUTE = "IframeAttribute"
    IN_FENCED_FRAME_TREE = "InFencedFrameTree"
    IN_ISOLATED_APP = "InIsolatedApp"

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

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

HEADER = 'Header' class-attribute instance-attribute

IFRAME_ATTRIBUTE = 'IframeAttribute' class-attribute instance-attribute

IN_FENCED_FRAME_TREE = 'InFencedFrameTree' class-attribute instance-attribute

IN_ISOLATED_APP = 'InIsolatedApp' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

PermissionsPolicyFeature

Bases: Enum

All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.

Source code in zendriver/cdp/page.py

class PermissionsPolicyFeature(enum.Enum):
    """
    All Permissions Policy features. This enum should match the one defined
    in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.
    """

    ACCELEROMETER = "accelerometer"
    AMBIENT_LIGHT_SENSOR = "ambient-light-sensor"
    ATTRIBUTION_REPORTING = "attribution-reporting"
    AUTOPLAY = "autoplay"
    BLUETOOTH = "bluetooth"
    BROWSING_TOPICS = "browsing-topics"
    CAMERA = "camera"
    CAPTURED_SURFACE_CONTROL = "captured-surface-control"
    CH_DPR = "ch-dpr"
    CH_DEVICE_MEMORY = "ch-device-memory"
    CH_DOWNLINK = "ch-downlink"
    CH_ECT = "ch-ect"
    CH_PREFERS_COLOR_SCHEME = "ch-prefers-color-scheme"
    CH_PREFERS_REDUCED_MOTION = "ch-prefers-reduced-motion"
    CH_PREFERS_REDUCED_TRANSPARENCY = "ch-prefers-reduced-transparency"
    CH_RTT = "ch-rtt"
    CH_SAVE_DATA = "ch-save-data"
    CH_UA = "ch-ua"
    CH_UA_ARCH = "ch-ua-arch"
    CH_UA_BITNESS = "ch-ua-bitness"
    CH_UA_PLATFORM = "ch-ua-platform"
    CH_UA_MODEL = "ch-ua-model"
    CH_UA_MOBILE = "ch-ua-mobile"
    CH_UA_FORM_FACTORS = "ch-ua-form-factors"
    CH_UA_FULL_VERSION = "ch-ua-full-version"
    CH_UA_FULL_VERSION_LIST = "ch-ua-full-version-list"
    CH_UA_PLATFORM_VERSION = "ch-ua-platform-version"
    CH_UA_WOW64 = "ch-ua-wow64"
    CH_VIEWPORT_HEIGHT = "ch-viewport-height"
    CH_VIEWPORT_WIDTH = "ch-viewport-width"
    CH_WIDTH = "ch-width"
    CLIPBOARD_READ = "clipboard-read"
    CLIPBOARD_WRITE = "clipboard-write"
    COMPUTE_PRESSURE = "compute-pressure"
    CROSS_ORIGIN_ISOLATED = "cross-origin-isolated"
    DEFERRED_FETCH = "deferred-fetch"
    DIRECT_SOCKETS = "direct-sockets"
    DISPLAY_CAPTURE = "display-capture"
    DOCUMENT_DOMAIN = "document-domain"
    ENCRYPTED_MEDIA = "encrypted-media"
    EXECUTION_WHILE_OUT_OF_VIEWPORT = "execution-while-out-of-viewport"
    EXECUTION_WHILE_NOT_RENDERED = "execution-while-not-rendered"
    FOCUS_WITHOUT_USER_ACTIVATION = "focus-without-user-activation"
    FULLSCREEN = "fullscreen"
    FROBULATE = "frobulate"
    GAMEPAD = "gamepad"
    GEOLOCATION = "geolocation"
    GYROSCOPE = "gyroscope"
    HID = "hid"
    IDENTITY_CREDENTIALS_GET = "identity-credentials-get"
    IDLE_DETECTION = "idle-detection"
    INTEREST_COHORT = "interest-cohort"
    JOIN_AD_INTEREST_GROUP = "join-ad-interest-group"
    KEYBOARD_MAP = "keyboard-map"
    LOCAL_FONTS = "local-fonts"
    MAGNETOMETER = "magnetometer"
    MICROPHONE = "microphone"
    MIDI = "midi"
    OTP_CREDENTIALS = "otp-credentials"
    PAYMENT = "payment"
    PICTURE_IN_PICTURE = "picture-in-picture"
    PRIVATE_AGGREGATION = "private-aggregation"
    PRIVATE_STATE_TOKEN_ISSUANCE = "private-state-token-issuance"
    PRIVATE_STATE_TOKEN_REDEMPTION = "private-state-token-redemption"
    PUBLICKEY_CREDENTIALS_CREATE = "publickey-credentials-create"
    PUBLICKEY_CREDENTIALS_GET = "publickey-credentials-get"
    RUN_AD_AUCTION = "run-ad-auction"
    SCREEN_WAKE_LOCK = "screen-wake-lock"
    SERIAL = "serial"
    SHARED_AUTOFILL = "shared-autofill"
    SHARED_STORAGE = "shared-storage"
    SHARED_STORAGE_SELECT_URL = "shared-storage-select-url"
    SMART_CARD = "smart-card"
    SPEAKER_SELECTION = "speaker-selection"
    STORAGE_ACCESS = "storage-access"
    SUB_APPS = "sub-apps"
    SYNC_XHR = "sync-xhr"
    UNLOAD = "unload"
    USB = "usb"
    USB_UNRESTRICTED = "usb-unrestricted"
    VERTICAL_SCROLL = "vertical-scroll"
    WEB_PRINTING = "web-printing"
    WEB_SHARE = "web-share"
    WINDOW_MANAGEMENT = "window-management"
    XR_SPATIAL_TRACKING = "xr-spatial-tracking"

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

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

ACCELEROMETER = 'accelerometer' class-attribute instance-attribute

AMBIENT_LIGHT_SENSOR = 'ambient-light-sensor' class-attribute instance-attribute

ATTRIBUTION_REPORTING = 'attribution-reporting' class-attribute instance-attribute

AUTOPLAY = 'autoplay' class-attribute instance-attribute

BLUETOOTH = 'bluetooth' class-attribute instance-attribute

BROWSING_TOPICS = 'browsing-topics' class-attribute instance-attribute

CAMERA = 'camera' class-attribute instance-attribute

CAPTURED_SURFACE_CONTROL = 'captured-surface-control' class-attribute instance-attribute

CH_DEVICE_MEMORY = 'ch-device-memory' class-attribute instance-attribute

CH_DOWNLINK = 'ch-downlink' class-attribute instance-attribute

CH_DPR = 'ch-dpr' class-attribute instance-attribute

CH_ECT = 'ch-ect' class-attribute instance-attribute

CH_PREFERS_COLOR_SCHEME = 'ch-prefers-color-scheme' class-attribute instance-attribute

CH_PREFERS_REDUCED_MOTION = 'ch-prefers-reduced-motion' class-attribute instance-attribute

CH_PREFERS_REDUCED_TRANSPARENCY = 'ch-prefers-reduced-transparency' class-attribute instance-attribute

CH_RTT = 'ch-rtt' class-attribute instance-attribute

CH_SAVE_DATA = 'ch-save-data' class-attribute instance-attribute

CH_UA = 'ch-ua' class-attribute instance-attribute

CH_UA_ARCH = 'ch-ua-arch' class-attribute instance-attribute

CH_UA_BITNESS = 'ch-ua-bitness' class-attribute instance-attribute

CH_UA_FORM_FACTORS = 'ch-ua-form-factors' class-attribute instance-attribute

CH_UA_FULL_VERSION = 'ch-ua-full-version' class-attribute instance-attribute

CH_UA_FULL_VERSION_LIST = 'ch-ua-full-version-list' class-attribute instance-attribute

CH_UA_MOBILE = 'ch-ua-mobile' class-attribute instance-attribute

CH_UA_MODEL = 'ch-ua-model' class-attribute instance-attribute

CH_UA_PLATFORM = 'ch-ua-platform' class-attribute instance-attribute

CH_UA_PLATFORM_VERSION = 'ch-ua-platform-version' class-attribute instance-attribute

CH_UA_WOW64 = 'ch-ua-wow64' class-attribute instance-attribute

CH_VIEWPORT_HEIGHT = 'ch-viewport-height' class-attribute instance-attribute

CH_VIEWPORT_WIDTH = 'ch-viewport-width' class-attribute instance-attribute

CH_WIDTH = 'ch-width' class-attribute instance-attribute

CLIPBOARD_READ = 'clipboard-read' class-attribute instance-attribute

CLIPBOARD_WRITE = 'clipboard-write' class-attribute instance-attribute

COMPUTE_PRESSURE = 'compute-pressure' class-attribute instance-attribute

CROSS_ORIGIN_ISOLATED = 'cross-origin-isolated' class-attribute instance-attribute

DEFERRED_FETCH = 'deferred-fetch' class-attribute instance-attribute

DIRECT_SOCKETS = 'direct-sockets' class-attribute instance-attribute

DISPLAY_CAPTURE = 'display-capture' class-attribute instance-attribute

DOCUMENT_DOMAIN = 'document-domain' class-attribute instance-attribute

ENCRYPTED_MEDIA = 'encrypted-media' class-attribute instance-attribute

EXECUTION_WHILE_NOT_RENDERED = 'execution-while-not-rendered' class-attribute instance-attribute

EXECUTION_WHILE_OUT_OF_VIEWPORT = 'execution-while-out-of-viewport' class-attribute instance-attribute

FOCUS_WITHOUT_USER_ACTIVATION = 'focus-without-user-activation' class-attribute instance-attribute

FROBULATE = 'frobulate' class-attribute instance-attribute

FULLSCREEN = 'fullscreen' class-attribute instance-attribute

GAMEPAD = 'gamepad' class-attribute instance-attribute

GEOLOCATION = 'geolocation' class-attribute instance-attribute

GYROSCOPE = 'gyroscope' class-attribute instance-attribute

HID = 'hid' class-attribute instance-attribute

IDENTITY_CREDENTIALS_GET = 'identity-credentials-get' class-attribute instance-attribute

IDLE_DETECTION = 'idle-detection' class-attribute instance-attribute

INTEREST_COHORT = 'interest-cohort' class-attribute instance-attribute

JOIN_AD_INTEREST_GROUP = 'join-ad-interest-group' class-attribute instance-attribute

KEYBOARD_MAP = 'keyboard-map' class-attribute instance-attribute

LOCAL_FONTS = 'local-fonts' class-attribute instance-attribute

MAGNETOMETER = 'magnetometer' class-attribute instance-attribute

MICROPHONE = 'microphone' class-attribute instance-attribute

MIDI = 'midi' class-attribute instance-attribute

OTP_CREDENTIALS = 'otp-credentials' class-attribute instance-attribute

PAYMENT = 'payment' class-attribute instance-attribute

PICTURE_IN_PICTURE = 'picture-in-picture' class-attribute instance-attribute

PRIVATE_AGGREGATION = 'private-aggregation' class-attribute instance-attribute

PRIVATE_STATE_TOKEN_ISSUANCE = 'private-state-token-issuance' class-attribute instance-attribute

PRIVATE_STATE_TOKEN_REDEMPTION = 'private-state-token-redemption' class-attribute instance-attribute

PUBLICKEY_CREDENTIALS_CREATE = 'publickey-credentials-create' class-attribute instance-attribute

PUBLICKEY_CREDENTIALS_GET = 'publickey-credentials-get' class-attribute instance-attribute

RUN_AD_AUCTION = 'run-ad-auction' class-attribute instance-attribute

SCREEN_WAKE_LOCK = 'screen-wake-lock' class-attribute instance-attribute

SERIAL = 'serial' class-attribute instance-attribute

SHARED_AUTOFILL = 'shared-autofill' class-attribute instance-attribute

SHARED_STORAGE = 'shared-storage' class-attribute instance-attribute

SHARED_STORAGE_SELECT_URL = 'shared-storage-select-url' class-attribute instance-attribute

SMART_CARD = 'smart-card' class-attribute instance-attribute

SPEAKER_SELECTION = 'speaker-selection' class-attribute instance-attribute

STORAGE_ACCESS = 'storage-access' class-attribute instance-attribute

SUB_APPS = 'sub-apps' class-attribute instance-attribute

SYNC_XHR = 'sync-xhr' class-attribute instance-attribute

UNLOAD = 'unload' class-attribute instance-attribute

USB = 'usb' class-attribute instance-attribute

USB_UNRESTRICTED = 'usb-unrestricted' class-attribute instance-attribute

VERTICAL_SCROLL = 'vertical-scroll' class-attribute instance-attribute

WEB_PRINTING = 'web-printing' class-attribute instance-attribute

WEB_SHARE = 'web-share' class-attribute instance-attribute

WINDOW_MANAGEMENT = 'window-management' class-attribute instance-attribute

XR_SPATIAL_TRACKING = 'xr-spatial-tracking' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

PermissionsPolicyFeatureState dataclass

Source code in zendriver/cdp/page.py

@dataclass
class PermissionsPolicyFeatureState:
    feature: PermissionsPolicyFeature

    allowed: bool

    locator: typing.Optional[PermissionsPolicyBlockLocator] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["feature"] = self.feature.to_json()
        json["allowed"] = self.allowed
        if self.locator is not None:
            json["locator"] = self.locator.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> PermissionsPolicyFeatureState:
        return cls(
            feature=PermissionsPolicyFeature.from_json(json["feature"]),
            allowed=bool(json["allowed"]),
            locator=(
                PermissionsPolicyBlockLocator.from_json(json["locator"])
                if json.get("locator", None) is not None
                else None
            ),
        )

allowed: bool instance-attribute

feature: PermissionsPolicyFeature instance-attribute

locator: typing.Optional[PermissionsPolicyBlockLocator] = None class-attribute instance-attribute

__init__(feature, allowed, locator=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> PermissionsPolicyFeatureState:
    return cls(
        feature=PermissionsPolicyFeature.from_json(json["feature"]),
        allowed=bool(json["allowed"]),
        locator=(
            PermissionsPolicyBlockLocator.from_json(json["locator"])
            if json.get("locator", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["feature"] = self.feature.to_json()
    json["allowed"] = self.allowed
    if self.locator is not None:
        json["locator"] = self.locator.to_json()
    return json

ProtocolHandler dataclass

Source code in zendriver/cdp/page.py

@dataclass
class ProtocolHandler:
    protocol: str

    url: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["protocol"] = self.protocol
        json["url"] = self.url
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ProtocolHandler:
        return cls(
            protocol=str(json["protocol"]),
            url=str(json["url"]),
        )

protocol: str instance-attribute

url: str instance-attribute

__init__(protocol, url)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ProtocolHandler:
    return cls(
        protocol=str(json["protocol"]),
        url=str(json["url"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["protocol"] = self.protocol
    json["url"] = self.url
    return json

ReferrerPolicy

Bases: Enum

The referring-policy used for the navigation.

Source code in zendriver/cdp/page.py

class ReferrerPolicy(enum.Enum):
    """
    The referring-policy used for the navigation.
    """

    NO_REFERRER = "noReferrer"
    NO_REFERRER_WHEN_DOWNGRADE = "noReferrerWhenDowngrade"
    ORIGIN = "origin"
    ORIGIN_WHEN_CROSS_ORIGIN = "originWhenCrossOrigin"
    SAME_ORIGIN = "sameOrigin"
    STRICT_ORIGIN = "strictOrigin"
    STRICT_ORIGIN_WHEN_CROSS_ORIGIN = "strictOriginWhenCrossOrigin"
    UNSAFE_URL = "unsafeUrl"

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

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

NO_REFERRER = 'noReferrer' class-attribute instance-attribute

NO_REFERRER_WHEN_DOWNGRADE = 'noReferrerWhenDowngrade' class-attribute instance-attribute

ORIGIN = 'origin' class-attribute instance-attribute

ORIGIN_WHEN_CROSS_ORIGIN = 'originWhenCrossOrigin' class-attribute instance-attribute

SAME_ORIGIN = 'sameOrigin' class-attribute instance-attribute

STRICT_ORIGIN = 'strictOrigin' class-attribute instance-attribute

STRICT_ORIGIN_WHEN_CROSS_ORIGIN = 'strictOriginWhenCrossOrigin' class-attribute instance-attribute

UNSAFE_URL = 'unsafeUrl' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

RelatedApplication dataclass

Source code in zendriver/cdp/page.py

@dataclass
class RelatedApplication:
    url: str

    id_: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["url"] = self.url
        if self.id_ is not None:
            json["id"] = self.id_
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> RelatedApplication:
        return cls(
            url=str(json["url"]),
            id_=str(json["id"]) if json.get("id", None) is not None else None,
        )

id_: typing.Optional[str] = None class-attribute instance-attribute

url: str instance-attribute

__init__(url, id_=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> RelatedApplication:
    return cls(
        url=str(json["url"]),
        id_=str(json["id"]) if json.get("id", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["url"] = self.url
    if self.id_ is not None:
        json["id"] = self.id_
    return json

ScopeExtension dataclass

Source code in zendriver/cdp/page.py

@dataclass
class ScopeExtension:
    #: Instead of using tuple, this field always returns the serialized string
    #: for easy understanding and comparison.
    origin: str

    has_origin_wildcard: bool

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["origin"] = self.origin
        json["hasOriginWildcard"] = self.has_origin_wildcard
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ScopeExtension:
        return cls(
            origin=str(json["origin"]),
            has_origin_wildcard=bool(json["hasOriginWildcard"]),
        )

has_origin_wildcard: bool instance-attribute

origin: str instance-attribute

__init__(origin, has_origin_wildcard)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ScopeExtension:
    return cls(
        origin=str(json["origin"]),
        has_origin_wildcard=bool(json["hasOriginWildcard"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["origin"] = self.origin
    json["hasOriginWildcard"] = self.has_origin_wildcard
    return json

ScreencastFrame dataclass

EXPERIMENTAL

Compressed image data requested by the startScreencast.

Source code in zendriver/cdp/page.py

@event_class("Page.screencastFrame")
@dataclass
class ScreencastFrame:
    """
    **EXPERIMENTAL**

    Compressed image data requested by the ``startScreencast``.
    """

    #: Base64-encoded compressed image. (Encoded as a base64 string when passed over JSON)
    data: str
    #: Screencast frame metadata.
    metadata: ScreencastFrameMetadata
    #: Frame number.
    session_id: int

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ScreencastFrame:
        return cls(
            data=str(json["data"]),
            metadata=ScreencastFrameMetadata.from_json(json["metadata"]),
            session_id=int(json["sessionId"]),
        )

data: str instance-attribute

metadata: ScreencastFrameMetadata instance-attribute

session_id: int instance-attribute

__init__(data, metadata, session_id)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ScreencastFrame:
    return cls(
        data=str(json["data"]),
        metadata=ScreencastFrameMetadata.from_json(json["metadata"]),
        session_id=int(json["sessionId"]),
    )

ScreencastFrameMetadata dataclass

Screencast frame metadata.

Source code in zendriver/cdp/page.py

@dataclass
class ScreencastFrameMetadata:
    """
    Screencast frame metadata.
    """

    #: Top offset in DIP.
    offset_top: float

    #: Page scale factor.
    page_scale_factor: float

    #: Device screen width in DIP.
    device_width: float

    #: Device screen height in DIP.
    device_height: float

    #: Position of horizontal scroll in CSS pixels.
    scroll_offset_x: float

    #: Position of vertical scroll in CSS pixels.
    scroll_offset_y: float

    #: Frame swap timestamp.
    timestamp: typing.Optional[network.TimeSinceEpoch] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["offsetTop"] = self.offset_top
        json["pageScaleFactor"] = self.page_scale_factor
        json["deviceWidth"] = self.device_width
        json["deviceHeight"] = self.device_height
        json["scrollOffsetX"] = self.scroll_offset_x
        json["scrollOffsetY"] = self.scroll_offset_y
        if self.timestamp is not None:
            json["timestamp"] = self.timestamp.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ScreencastFrameMetadata:
        return cls(
            offset_top=float(json["offsetTop"]),
            page_scale_factor=float(json["pageScaleFactor"]),
            device_width=float(json["deviceWidth"]),
            device_height=float(json["deviceHeight"]),
            scroll_offset_x=float(json["scrollOffsetX"]),
            scroll_offset_y=float(json["scrollOffsetY"]),
            timestamp=(
                network.TimeSinceEpoch.from_json(json["timestamp"])
                if json.get("timestamp", None) is not None
                else None
            ),
        )

device_height: float instance-attribute

device_width: float instance-attribute

offset_top: float instance-attribute

page_scale_factor: float instance-attribute

scroll_offset_x: float instance-attribute

scroll_offset_y: float instance-attribute

timestamp: typing.Optional[network.TimeSinceEpoch] = None class-attribute instance-attribute

__init__(offset_top, page_scale_factor, device_width, device_height, scroll_offset_x, scroll_offset_y, timestamp=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ScreencastFrameMetadata:
    return cls(
        offset_top=float(json["offsetTop"]),
        page_scale_factor=float(json["pageScaleFactor"]),
        device_width=float(json["deviceWidth"]),
        device_height=float(json["deviceHeight"]),
        scroll_offset_x=float(json["scrollOffsetX"]),
        scroll_offset_y=float(json["scrollOffsetY"]),
        timestamp=(
            network.TimeSinceEpoch.from_json(json["timestamp"])
            if json.get("timestamp", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["offsetTop"] = self.offset_top
    json["pageScaleFactor"] = self.page_scale_factor
    json["deviceWidth"] = self.device_width
    json["deviceHeight"] = self.device_height
    json["scrollOffsetX"] = self.scroll_offset_x
    json["scrollOffsetY"] = self.scroll_offset_y
    if self.timestamp is not None:
        json["timestamp"] = self.timestamp.to_json()
    return json

ScreencastVisibilityChanged dataclass

EXPERIMENTAL

Fired when the page with currently enabled screencast was shown or hidden .

Source code in zendriver/cdp/page.py

@event_class("Page.screencastVisibilityChanged")
@dataclass
class ScreencastVisibilityChanged:
    """
    **EXPERIMENTAL**

    Fired when the page with currently enabled screencast was shown or hidden .
    """

    #: True if the page is visible.
    visible: bool

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ScreencastVisibilityChanged:
        return cls(visible=bool(json["visible"]))

visible: bool instance-attribute

__init__(visible)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ScreencastVisibilityChanged:
    return cls(visible=bool(json["visible"]))

Screenshot dataclass

Source code in zendriver/cdp/page.py

@dataclass
class Screenshot:
    image: ImageResource

    form_factor: str

    label: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["image"] = self.image.to_json()
        json["formFactor"] = self.form_factor
        if self.label is not None:
            json["label"] = self.label
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Screenshot:
        return cls(
            image=ImageResource.from_json(json["image"]),
            form_factor=str(json["formFactor"]),
            label=str(json["label"]) if json.get("label", None) is not None else None,
        )

form_factor: str instance-attribute

image: ImageResource instance-attribute

label: typing.Optional[str] = None class-attribute instance-attribute

__init__(image, form_factor, label=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Screenshot:
    return cls(
        image=ImageResource.from_json(json["image"]),
        form_factor=str(json["formFactor"]),
        label=str(json["label"]) if json.get("label", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["image"] = self.image.to_json()
    json["formFactor"] = self.form_factor
    if self.label is not None:
        json["label"] = self.label
    return json

ScriptFontFamilies dataclass

Font families collection for a script.

Source code in zendriver/cdp/page.py

@dataclass
class ScriptFontFamilies:
    """
    Font families collection for a script.
    """

    #: Name of the script which these font families are defined for.
    script: str

    #: Generic font families collection for the script.
    font_families: FontFamilies

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["script"] = self.script
        json["fontFamilies"] = self.font_families.to_json()
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ScriptFontFamilies:
        return cls(
            script=str(json["script"]),
            font_families=FontFamilies.from_json(json["fontFamilies"]),
        )

font_families: FontFamilies instance-attribute

script: str instance-attribute

__init__(script, font_families)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ScriptFontFamilies:
    return cls(
        script=str(json["script"]),
        font_families=FontFamilies.from_json(json["fontFamilies"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["script"] = self.script
    json["fontFamilies"] = self.font_families.to_json()
    return json

ScriptIdentifier

Bases: str

Unique script identifier.

Source code in zendriver/cdp/page.py

class ScriptIdentifier(str):
    """
    Unique script identifier.
    """

    def to_json(self) -> str:
        return self

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

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

__repr__()

Source code in zendriver/cdp/page.py

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

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> str:
    return self

SecureContextType

Bases: Enum

Indicates whether the frame is a secure context and why it is the case.

Source code in zendriver/cdp/page.py

class SecureContextType(enum.Enum):
    """
    Indicates whether the frame is a secure context and why it is the case.
    """

    SECURE = "Secure"
    SECURE_LOCALHOST = "SecureLocalhost"
    INSECURE_SCHEME = "InsecureScheme"
    INSECURE_ANCESTOR = "InsecureAncestor"

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

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

INSECURE_ANCESTOR = 'InsecureAncestor' class-attribute instance-attribute

INSECURE_SCHEME = 'InsecureScheme' class-attribute instance-attribute

SECURE = 'Secure' class-attribute instance-attribute

SECURE_LOCALHOST = 'SecureLocalhost' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

ShareTarget dataclass

Source code in zendriver/cdp/page.py

@dataclass
class ShareTarget:
    action: str

    method: str

    enctype: str

    #: Embed the ShareTargetParams
    title: typing.Optional[str] = None

    text: typing.Optional[str] = None

    url: typing.Optional[str] = None

    files: typing.Optional[typing.List[FileFilter]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["action"] = self.action
        json["method"] = self.method
        json["enctype"] = self.enctype
        if self.title is not None:
            json["title"] = self.title
        if self.text is not None:
            json["text"] = self.text
        if self.url is not None:
            json["url"] = self.url
        if self.files is not None:
            json["files"] = [i.to_json() for i in self.files]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ShareTarget:
        return cls(
            action=str(json["action"]),
            method=str(json["method"]),
            enctype=str(json["enctype"]),
            title=str(json["title"]) if json.get("title", None) is not None else None,
            text=str(json["text"]) if json.get("text", None) is not None else None,
            url=str(json["url"]) if json.get("url", None) is not None else None,
            files=(
                [FileFilter.from_json(i) for i in json["files"]]
                if json.get("files", None) is not None
                else None
            ),
        )

action: str instance-attribute

enctype: str instance-attribute

files: typing.Optional[typing.List[FileFilter]] = None class-attribute instance-attribute

method: str instance-attribute

text: typing.Optional[str] = None class-attribute instance-attribute

title: typing.Optional[str] = None class-attribute instance-attribute

url: typing.Optional[str] = None class-attribute instance-attribute

__init__(action, method, enctype, title=None, text=None, url=None, files=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ShareTarget:
    return cls(
        action=str(json["action"]),
        method=str(json["method"]),
        enctype=str(json["enctype"]),
        title=str(json["title"]) if json.get("title", None) is not None else None,
        text=str(json["text"]) if json.get("text", None) is not None else None,
        url=str(json["url"]) if json.get("url", None) is not None else None,
        files=(
            [FileFilter.from_json(i) for i in json["files"]]
            if json.get("files", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["action"] = self.action
    json["method"] = self.method
    json["enctype"] = self.enctype
    if self.title is not None:
        json["title"] = self.title
    if self.text is not None:
        json["text"] = self.text
    if self.url is not None:
        json["url"] = self.url
    if self.files is not None:
        json["files"] = [i.to_json() for i in self.files]
    return json

Shortcut dataclass

Source code in zendriver/cdp/page.py

@dataclass
class Shortcut:
    name: str

    url: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["url"] = self.url
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Shortcut:
        return cls(
            name=str(json["name"]),
            url=str(json["url"]),
        )

name: str instance-attribute

url: str instance-attribute

__init__(name, url)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Shortcut:
    return cls(
        name=str(json["name"]),
        url=str(json["url"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["url"] = self.url
    return json

TransitionType

Bases: Enum

Transition type.

Source code in zendriver/cdp/page.py

class TransitionType(enum.Enum):
    """
    Transition type.
    """

    LINK = "link"
    TYPED = "typed"
    ADDRESS_BAR = "address_bar"
    AUTO_BOOKMARK = "auto_bookmark"
    AUTO_SUBFRAME = "auto_subframe"
    MANUAL_SUBFRAME = "manual_subframe"
    GENERATED = "generated"
    AUTO_TOPLEVEL = "auto_toplevel"
    FORM_SUBMIT = "form_submit"
    RELOAD = "reload"
    KEYWORD = "keyword"
    KEYWORD_GENERATED = "keyword_generated"
    OTHER = "other"

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

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

ADDRESS_BAR = 'address_bar' class-attribute instance-attribute

AUTO_BOOKMARK = 'auto_bookmark' class-attribute instance-attribute

AUTO_SUBFRAME = 'auto_subframe' class-attribute instance-attribute

AUTO_TOPLEVEL = 'auto_toplevel' class-attribute instance-attribute

FORM_SUBMIT = 'form_submit' class-attribute instance-attribute

GENERATED = 'generated' class-attribute instance-attribute

KEYWORD = 'keyword' class-attribute instance-attribute

KEYWORD_GENERATED = 'keyword_generated' class-attribute instance-attribute

LINK = 'link' class-attribute instance-attribute

MANUAL_SUBFRAME = 'manual_subframe' class-attribute instance-attribute

OTHER = 'other' class-attribute instance-attribute

RELOAD = 'reload' class-attribute instance-attribute

TYPED = 'typed' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/page.py

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

to_json()

Source code in zendriver/cdp/page.py

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

Viewport dataclass

Viewport for capturing screenshot.

Source code in zendriver/cdp/page.py

@dataclass
class Viewport:
    """
    Viewport for capturing screenshot.
    """

    #: X offset in device independent pixels (dip).
    x: float

    #: Y offset in device independent pixels (dip).
    y: float

    #: Rectangle width in device independent pixels (dip).
    width: float

    #: Rectangle height in device independent pixels (dip).
    height: float

    #: Page scale factor.
    scale: float

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["x"] = self.x
        json["y"] = self.y
        json["width"] = self.width
        json["height"] = self.height
        json["scale"] = self.scale
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Viewport:
        return cls(
            x=float(json["x"]),
            y=float(json["y"]),
            width=float(json["width"]),
            height=float(json["height"]),
            scale=float(json["scale"]),
        )

height: float instance-attribute

scale: float instance-attribute

width: float instance-attribute

x: float instance-attribute

y: float instance-attribute

__init__(x, y, width, height, scale)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> Viewport:
    return cls(
        x=float(json["x"]),
        y=float(json["y"]),
        width=float(json["width"]),
        height=float(json["height"]),
        scale=float(json["scale"]),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["x"] = self.x
    json["y"] = self.y
    json["width"] = self.width
    json["height"] = self.height
    json["scale"] = self.scale
    return json

VisualViewport dataclass

Visual viewport position, dimensions, and scale.

Source code in zendriver/cdp/page.py

@dataclass
class VisualViewport:
    """
    Visual viewport position, dimensions, and scale.
    """

    #: Horizontal offset relative to the layout viewport (CSS pixels).
    offset_x: float

    #: Vertical offset relative to the layout viewport (CSS pixels).
    offset_y: float

    #: Horizontal offset relative to the document (CSS pixels).
    page_x: float

    #: Vertical offset relative to the document (CSS pixels).
    page_y: float

    #: Width (CSS pixels), excludes scrollbar if present.
    client_width: float

    #: Height (CSS pixels), excludes scrollbar if present.
    client_height: float

    #: Scale relative to the ideal viewport (size at width=device-width).
    scale: float

    #: Page zoom factor (CSS to device independent pixels ratio).
    zoom: typing.Optional[float] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["offsetX"] = self.offset_x
        json["offsetY"] = self.offset_y
        json["pageX"] = self.page_x
        json["pageY"] = self.page_y
        json["clientWidth"] = self.client_width
        json["clientHeight"] = self.client_height
        json["scale"] = self.scale
        if self.zoom is not None:
            json["zoom"] = self.zoom
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> VisualViewport:
        return cls(
            offset_x=float(json["offsetX"]),
            offset_y=float(json["offsetY"]),
            page_x=float(json["pageX"]),
            page_y=float(json["pageY"]),
            client_width=float(json["clientWidth"]),
            client_height=float(json["clientHeight"]),
            scale=float(json["scale"]),
            zoom=float(json["zoom"]) if json.get("zoom", None) is not None else None,
        )

client_height: float instance-attribute

client_width: float instance-attribute

offset_x: float instance-attribute

offset_y: float instance-attribute

page_x: float instance-attribute

page_y: float instance-attribute

scale: float instance-attribute

zoom: typing.Optional[float] = None class-attribute instance-attribute

__init__(offset_x, offset_y, page_x, page_y, client_width, client_height, scale, zoom=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> VisualViewport:
    return cls(
        offset_x=float(json["offsetX"]),
        offset_y=float(json["offsetY"]),
        page_x=float(json["pageX"]),
        page_y=float(json["pageY"]),
        client_width=float(json["clientWidth"]),
        client_height=float(json["clientHeight"]),
        scale=float(json["scale"]),
        zoom=float(json["zoom"]) if json.get("zoom", None) is not None else None,
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["offsetX"] = self.offset_x
    json["offsetY"] = self.offset_y
    json["pageX"] = self.page_x
    json["pageY"] = self.page_y
    json["clientWidth"] = self.client_width
    json["clientHeight"] = self.client_height
    json["scale"] = self.scale
    if self.zoom is not None:
        json["zoom"] = self.zoom
    return json

WebAppManifest dataclass

Source code in zendriver/cdp/page.py

@dataclass
class WebAppManifest:
    background_color: typing.Optional[str] = None

    #: The extra description provided by the manifest.
    description: typing.Optional[str] = None

    dir_: typing.Optional[str] = None

    display: typing.Optional[str] = None

    #: The overrided display mode controlled by the user.
    display_overrides: typing.Optional[typing.List[str]] = None

    #: The handlers to open files.
    file_handlers: typing.Optional[typing.List[FileHandler]] = None

    icons: typing.Optional[typing.List[ImageResource]] = None

    id_: typing.Optional[str] = None

    lang: typing.Optional[str] = None

    #: TODO(crbug.com/1231886): This field is non-standard and part of a Chrome
    #: experiment. See:
    #: https://github.com/WICG/web-app-launch/blob/main/launch_handler.md
    launch_handler: typing.Optional[LaunchHandler] = None

    name: typing.Optional[str] = None

    orientation: typing.Optional[str] = None

    prefer_related_applications: typing.Optional[bool] = None

    #: The handlers to open protocols.
    protocol_handlers: typing.Optional[typing.List[ProtocolHandler]] = None

    related_applications: typing.Optional[typing.List[RelatedApplication]] = None

    scope: typing.Optional[str] = None

    #: Non-standard, see
    #: https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md
    scope_extensions: typing.Optional[typing.List[ScopeExtension]] = None

    #: The screenshots used by chromium.
    screenshots: typing.Optional[typing.List[Screenshot]] = None

    share_target: typing.Optional[ShareTarget] = None

    short_name: typing.Optional[str] = None

    shortcuts: typing.Optional[typing.List[Shortcut]] = None

    start_url: typing.Optional[str] = None

    theme_color: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        if self.background_color is not None:
            json["backgroundColor"] = self.background_color
        if self.description is not None:
            json["description"] = self.description
        if self.dir_ is not None:
            json["dir"] = self.dir_
        if self.display is not None:
            json["display"] = self.display
        if self.display_overrides is not None:
            json["displayOverrides"] = [i for i in self.display_overrides]
        if self.file_handlers is not None:
            json["fileHandlers"] = [i.to_json() for i in self.file_handlers]
        if self.icons is not None:
            json["icons"] = [i.to_json() for i in self.icons]
        if self.id_ is not None:
            json["id"] = self.id_
        if self.lang is not None:
            json["lang"] = self.lang
        if self.launch_handler is not None:
            json["launchHandler"] = self.launch_handler.to_json()
        if self.name is not None:
            json["name"] = self.name
        if self.orientation is not None:
            json["orientation"] = self.orientation
        if self.prefer_related_applications is not None:
            json["preferRelatedApplications"] = self.prefer_related_applications
        if self.protocol_handlers is not None:
            json["protocolHandlers"] = [i.to_json() for i in self.protocol_handlers]
        if self.related_applications is not None:
            json["relatedApplications"] = [
                i.to_json() for i in self.related_applications
            ]
        if self.scope is not None:
            json["scope"] = self.scope
        if self.scope_extensions is not None:
            json["scopeExtensions"] = [i.to_json() for i in self.scope_extensions]
        if self.screenshots is not None:
            json["screenshots"] = [i.to_json() for i in self.screenshots]
        if self.share_target is not None:
            json["shareTarget"] = self.share_target.to_json()
        if self.short_name is not None:
            json["shortName"] = self.short_name
        if self.shortcuts is not None:
            json["shortcuts"] = [i.to_json() for i in self.shortcuts]
        if self.start_url is not None:
            json["startUrl"] = self.start_url
        if self.theme_color is not None:
            json["themeColor"] = self.theme_color
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> WebAppManifest:
        return cls(
            background_color=(
                str(json["backgroundColor"])
                if json.get("backgroundColor", None) is not None
                else None
            ),
            description=(
                str(json["description"])
                if json.get("description", None) is not None
                else None
            ),
            dir_=str(json["dir"]) if json.get("dir", None) is not None else None,
            display=(
                str(json["display"]) if json.get("display", None) is not None else None
            ),
            display_overrides=(
                [str(i) for i in json["displayOverrides"]]
                if json.get("displayOverrides", None) is not None
                else None
            ),
            file_handlers=(
                [FileHandler.from_json(i) for i in json["fileHandlers"]]
                if json.get("fileHandlers", None) is not None
                else None
            ),
            icons=(
                [ImageResource.from_json(i) for i in json["icons"]]
                if json.get("icons", None) is not None
                else None
            ),
            id_=str(json["id"]) if json.get("id", None) is not None else None,
            lang=str(json["lang"]) if json.get("lang", None) is not None else None,
            launch_handler=(
                LaunchHandler.from_json(json["launchHandler"])
                if json.get("launchHandler", None) is not None
                else None
            ),
            name=str(json["name"]) if json.get("name", None) is not None else None,
            orientation=(
                str(json["orientation"])
                if json.get("orientation", None) is not None
                else None
            ),
            prefer_related_applications=(
                bool(json["preferRelatedApplications"])
                if json.get("preferRelatedApplications", None) is not None
                else None
            ),
            protocol_handlers=(
                [ProtocolHandler.from_json(i) for i in json["protocolHandlers"]]
                if json.get("protocolHandlers", None) is not None
                else None
            ),
            related_applications=(
                [RelatedApplication.from_json(i) for i in json["relatedApplications"]]
                if json.get("relatedApplications", None) is not None
                else None
            ),
            scope=str(json["scope"]) if json.get("scope", None) is not None else None,
            scope_extensions=(
                [ScopeExtension.from_json(i) for i in json["scopeExtensions"]]
                if json.get("scopeExtensions", None) is not None
                else None
            ),
            screenshots=(
                [Screenshot.from_json(i) for i in json["screenshots"]]
                if json.get("screenshots", None) is not None
                else None
            ),
            share_target=(
                ShareTarget.from_json(json["shareTarget"])
                if json.get("shareTarget", None) is not None
                else None
            ),
            short_name=(
                str(json["shortName"])
                if json.get("shortName", None) is not None
                else None
            ),
            shortcuts=(
                [Shortcut.from_json(i) for i in json["shortcuts"]]
                if json.get("shortcuts", None) is not None
                else None
            ),
            start_url=(
                str(json["startUrl"])
                if json.get("startUrl", None) is not None
                else None
            ),
            theme_color=(
                str(json["themeColor"])
                if json.get("themeColor", None) is not None
                else None
            ),
        )

background_color: typing.Optional[str] = None class-attribute instance-attribute

description: typing.Optional[str] = None class-attribute instance-attribute

dir_: typing.Optional[str] = None class-attribute instance-attribute

display: typing.Optional[str] = None class-attribute instance-attribute

display_overrides: typing.Optional[typing.List[str]] = None class-attribute instance-attribute

file_handlers: typing.Optional[typing.List[FileHandler]] = None class-attribute instance-attribute

icons: typing.Optional[typing.List[ImageResource]] = None class-attribute instance-attribute

id_: typing.Optional[str] = None class-attribute instance-attribute

lang: typing.Optional[str] = None class-attribute instance-attribute

launch_handler: typing.Optional[LaunchHandler] = None class-attribute instance-attribute

name: typing.Optional[str] = None class-attribute instance-attribute

orientation: typing.Optional[str] = None class-attribute instance-attribute

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

protocol_handlers: typing.Optional[typing.List[ProtocolHandler]] = None class-attribute instance-attribute

related_applications: typing.Optional[typing.List[RelatedApplication]] = None class-attribute instance-attribute

scope: typing.Optional[str] = None class-attribute instance-attribute

scope_extensions: typing.Optional[typing.List[ScopeExtension]] = None class-attribute instance-attribute

screenshots: typing.Optional[typing.List[Screenshot]] = None class-attribute instance-attribute

share_target: typing.Optional[ShareTarget] = None class-attribute instance-attribute

short_name: typing.Optional[str] = None class-attribute instance-attribute

shortcuts: typing.Optional[typing.List[Shortcut]] = None class-attribute instance-attribute

start_url: typing.Optional[str] = None class-attribute instance-attribute

theme_color: typing.Optional[str] = None class-attribute instance-attribute

__init__(background_color=None, description=None, dir_=None, display=None, display_overrides=None, file_handlers=None, icons=None, id_=None, lang=None, launch_handler=None, name=None, orientation=None, prefer_related_applications=None, protocol_handlers=None, related_applications=None, scope=None, scope_extensions=None, screenshots=None, share_target=None, short_name=None, shortcuts=None, start_url=None, theme_color=None)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> WebAppManifest:
    return cls(
        background_color=(
            str(json["backgroundColor"])
            if json.get("backgroundColor", None) is not None
            else None
        ),
        description=(
            str(json["description"])
            if json.get("description", None) is not None
            else None
        ),
        dir_=str(json["dir"]) if json.get("dir", None) is not None else None,
        display=(
            str(json["display"]) if json.get("display", None) is not None else None
        ),
        display_overrides=(
            [str(i) for i in json["displayOverrides"]]
            if json.get("displayOverrides", None) is not None
            else None
        ),
        file_handlers=(
            [FileHandler.from_json(i) for i in json["fileHandlers"]]
            if json.get("fileHandlers", None) is not None
            else None
        ),
        icons=(
            [ImageResource.from_json(i) for i in json["icons"]]
            if json.get("icons", None) is not None
            else None
        ),
        id_=str(json["id"]) if json.get("id", None) is not None else None,
        lang=str(json["lang"]) if json.get("lang", None) is not None else None,
        launch_handler=(
            LaunchHandler.from_json(json["launchHandler"])
            if json.get("launchHandler", None) is not None
            else None
        ),
        name=str(json["name"]) if json.get("name", None) is not None else None,
        orientation=(
            str(json["orientation"])
            if json.get("orientation", None) is not None
            else None
        ),
        prefer_related_applications=(
            bool(json["preferRelatedApplications"])
            if json.get("preferRelatedApplications", None) is not None
            else None
        ),
        protocol_handlers=(
            [ProtocolHandler.from_json(i) for i in json["protocolHandlers"]]
            if json.get("protocolHandlers", None) is not None
            else None
        ),
        related_applications=(
            [RelatedApplication.from_json(i) for i in json["relatedApplications"]]
            if json.get("relatedApplications", None) is not None
            else None
        ),
        scope=str(json["scope"]) if json.get("scope", None) is not None else None,
        scope_extensions=(
            [ScopeExtension.from_json(i) for i in json["scopeExtensions"]]
            if json.get("scopeExtensions", None) is not None
            else None
        ),
        screenshots=(
            [Screenshot.from_json(i) for i in json["screenshots"]]
            if json.get("screenshots", None) is not None
            else None
        ),
        share_target=(
            ShareTarget.from_json(json["shareTarget"])
            if json.get("shareTarget", None) is not None
            else None
        ),
        short_name=(
            str(json["shortName"])
            if json.get("shortName", None) is not None
            else None
        ),
        shortcuts=(
            [Shortcut.from_json(i) for i in json["shortcuts"]]
            if json.get("shortcuts", None) is not None
            else None
        ),
        start_url=(
            str(json["startUrl"])
            if json.get("startUrl", None) is not None
            else None
        ),
        theme_color=(
            str(json["themeColor"])
            if json.get("themeColor", None) is not None
            else None
        ),
    )

to_json()

Source code in zendriver/cdp/page.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    if self.background_color is not None:
        json["backgroundColor"] = self.background_color
    if self.description is not None:
        json["description"] = self.description
    if self.dir_ is not None:
        json["dir"] = self.dir_
    if self.display is not None:
        json["display"] = self.display
    if self.display_overrides is not None:
        json["displayOverrides"] = [i for i in self.display_overrides]
    if self.file_handlers is not None:
        json["fileHandlers"] = [i.to_json() for i in self.file_handlers]
    if self.icons is not None:
        json["icons"] = [i.to_json() for i in self.icons]
    if self.id_ is not None:
        json["id"] = self.id_
    if self.lang is not None:
        json["lang"] = self.lang
    if self.launch_handler is not None:
        json["launchHandler"] = self.launch_handler.to_json()
    if self.name is not None:
        json["name"] = self.name
    if self.orientation is not None:
        json["orientation"] = self.orientation
    if self.prefer_related_applications is not None:
        json["preferRelatedApplications"] = self.prefer_related_applications
    if self.protocol_handlers is not None:
        json["protocolHandlers"] = [i.to_json() for i in self.protocol_handlers]
    if self.related_applications is not None:
        json["relatedApplications"] = [
            i.to_json() for i in self.related_applications
        ]
    if self.scope is not None:
        json["scope"] = self.scope
    if self.scope_extensions is not None:
        json["scopeExtensions"] = [i.to_json() for i in self.scope_extensions]
    if self.screenshots is not None:
        json["screenshots"] = [i.to_json() for i in self.screenshots]
    if self.share_target is not None:
        json["shareTarget"] = self.share_target.to_json()
    if self.short_name is not None:
        json["shortName"] = self.short_name
    if self.shortcuts is not None:
        json["shortcuts"] = [i.to_json() for i in self.shortcuts]
    if self.start_url is not None:
        json["startUrl"] = self.start_url
    if self.theme_color is not None:
        json["themeColor"] = self.theme_color
    return json

WindowOpen dataclass

Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.

Source code in zendriver/cdp/page.py

@event_class("Page.windowOpen")
@dataclass
class WindowOpen:
    """
    Fired when a new window is going to be opened, via window.open(), link click, form submission,
    etc.
    """

    #: The URL for the new window.
    url: str
    #: Window name.
    window_name: str
    #: An array of enabled window features.
    window_features: typing.List[str]
    #: Whether or not it was triggered by user gesture.
    user_gesture: bool

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> WindowOpen:
        return cls(
            url=str(json["url"]),
            window_name=str(json["windowName"]),
            window_features=[str(i) for i in json["windowFeatures"]],
            user_gesture=bool(json["userGesture"]),
        )

url: str instance-attribute

user_gesture: bool instance-attribute

window_features: typing.List[str] instance-attribute

window_name: str instance-attribute

__init__(url, window_name, window_features, user_gesture)

from_json(json) classmethod

Source code in zendriver/cdp/page.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> WindowOpen:
    return cls(
        url=str(json["url"]),
        window_name=str(json["windowName"]),
        window_features=[str(i) for i in json["windowFeatures"]],
        user_gesture=bool(json["userGesture"]),
    )

add_compilation_cache(url, data)

Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
url	str		required
data	str	Base64-encoded data (Encoded as a base64 string when passed over JSON)	required

Source code in zendriver/cdp/page.py

def add_compilation_cache(
    url: str, data: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Seeds compilation cache for given url. Compilation cache does not survive
    cross-process navigation.

    **EXPERIMENTAL**

    :param url:
    :param data: Base64-encoded data (Encoded as a base64 string when passed over JSON)
    """
    params: T_JSON_DICT = dict()
    params["url"] = url
    params["data"] = data
    cmd_dict: T_JSON_DICT = {
        "method": "Page.addCompilationCache",
        "params": params,
    }
    json = yield cmd_dict

add_script_to_evaluate_on_load(script_source)

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
script_source	str		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, ScriptIdentifier]	Identifier of the added script.

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def add_script_to_evaluate_on_load(
    script_source: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, ScriptIdentifier]:
    """
    Deprecated, please use addScriptToEvaluateOnNewDocument instead.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param script_source:
    :returns: Identifier of the added script.
    """
    params: T_JSON_DICT = dict()
    params["scriptSource"] = script_source
    cmd_dict: T_JSON_DICT = {
        "method": "Page.addScriptToEvaluateOnLoad",
        "params": params,
    }
    json = yield cmd_dict
    return ScriptIdentifier.from_json(json["identifier"])

add_script_to_evaluate_on_new_document(source, world_name=None, include_command_line_api=None, run_immediately=None)

Evaluates given script in every frame upon creation (before loading frame's scripts).

Parameters:

Name	Type	Description	Default
source	str		required
world_name	Optional[str]	(EXPERIMENTAL) (Optional) If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.	None
include_command_line_api	Optional[bool]	(EXPERIMENTAL) (Optional) Specifies whether command line API should be available to the script, defaults to false.	None
run_immediately	Optional[bool]	(EXPERIMENTAL) (Optional) If true, runs the script immediately on existing execution contexts or worlds. Default: false.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, ScriptIdentifier]	Identifier of the added script.

Source code in zendriver/cdp/page.py

def add_script_to_evaluate_on_new_document(
    source: str,
    world_name: typing.Optional[str] = None,
    include_command_line_api: typing.Optional[bool] = None,
    run_immediately: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, ScriptIdentifier]:
    """
    Evaluates given script in every frame upon creation (before loading frame's scripts).

    :param source:
    :param world_name: **(EXPERIMENTAL)** *(Optional)* If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.
    :param include_command_line_api: **(EXPERIMENTAL)** *(Optional)* Specifies whether command line API should be available to the script, defaults to false.
    :param run_immediately: **(EXPERIMENTAL)** *(Optional)* If true, runs the script immediately on existing execution contexts or worlds. Default: false.
    :returns: Identifier of the added script.
    """
    params: T_JSON_DICT = dict()
    params["source"] = source
    if world_name is not None:
        params["worldName"] = world_name
    if include_command_line_api is not None:
        params["includeCommandLineAPI"] = include_command_line_api
    if run_immediately is not None:
        params["runImmediately"] = run_immediately
    cmd_dict: T_JSON_DICT = {
        "method": "Page.addScriptToEvaluateOnNewDocument",
        "params": params,
    }
    json = yield cmd_dict
    return ScriptIdentifier.from_json(json["identifier"])

bring_to_front()

Brings page to front (activates tab).

Source code in zendriver/cdp/page.py

def bring_to_front() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Brings page to front (activates tab).
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.bringToFront",
    }
    json = yield cmd_dict

capture_screenshot(format_=None, quality=None, clip=None, from_surface=None, capture_beyond_viewport=None, optimize_for_speed=None)

Capture page screenshot.

Parameters:

Name	Type	Description	Default
format_	Optional[str]	(Optional) Image compression format (defaults to png).	None
quality	Optional[int]	(Optional) Compression quality from range [0..100] (jpeg only).	None
clip	Optional[Viewport]	(Optional) Capture the screenshot of a given region only.	None
from_surface	Optional[bool]	(EXPERIMENTAL) (Optional) Capture the screenshot from the surface, rather than the view. Defaults to true.	None
capture_beyond_viewport	Optional[bool]	(EXPERIMENTAL) (Optional) Capture the screenshot beyond the viewport. Defaults to false.	None
optimize_for_speed	Optional[bool]	(EXPERIMENTAL) (Optional) Optimize image encoding for speed, not for resulting size (defaults to false)	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, str]	Base64-encoded image data. (Encoded as a base64 string when passed over JSON)

Source code in zendriver/cdp/page.py

def capture_screenshot(
    format_: typing.Optional[str] = None,
    quality: typing.Optional[int] = None,
    clip: typing.Optional[Viewport] = None,
    from_surface: typing.Optional[bool] = None,
    capture_beyond_viewport: typing.Optional[bool] = None,
    optimize_for_speed: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, str]:
    """
    Capture page screenshot.

    :param format_: *(Optional)* Image compression format (defaults to png).
    :param quality: *(Optional)* Compression quality from range [0..100] (jpeg only).
    :param clip: *(Optional)* Capture the screenshot of a given region only.
    :param from_surface: **(EXPERIMENTAL)** *(Optional)* Capture the screenshot from the surface, rather than the view. Defaults to true.
    :param capture_beyond_viewport: **(EXPERIMENTAL)** *(Optional)* Capture the screenshot beyond the viewport. Defaults to false.
    :param optimize_for_speed: **(EXPERIMENTAL)** *(Optional)* Optimize image encoding for speed, not for resulting size (defaults to false)
    :returns: Base64-encoded image data. (Encoded as a base64 string when passed over JSON)
    """
    params: T_JSON_DICT = dict()
    if format_ is not None:
        params["format"] = format_
    if quality is not None:
        params["quality"] = quality
    if clip is not None:
        params["clip"] = clip.to_json()
    if from_surface is not None:
        params["fromSurface"] = from_surface
    if capture_beyond_viewport is not None:
        params["captureBeyondViewport"] = capture_beyond_viewport
    if optimize_for_speed is not None:
        params["optimizeForSpeed"] = optimize_for_speed
    cmd_dict: T_JSON_DICT = {
        "method": "Page.captureScreenshot",
        "params": params,
    }
    json = yield cmd_dict
    return str(json["data"])

capture_snapshot(format_=None)

Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
format_	Optional[str]	(Optional) Format (defaults to mhtml).	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, str]	Serialized page data.

Source code in zendriver/cdp/page.py

def capture_snapshot(
    format_: typing.Optional[str] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, str]:
    """
    Returns a snapshot of the page as a string. For MHTML format, the serialization includes
    iframes, shadow DOM, external resources, and element-inline styles.

    **EXPERIMENTAL**

    :param format_: *(Optional)* Format (defaults to mhtml).
    :returns: Serialized page data.
    """
    params: T_JSON_DICT = dict()
    if format_ is not None:
        params["format"] = format_
    cmd_dict: T_JSON_DICT = {
        "method": "Page.captureSnapshot",
        "params": params,
    }
    json = yield cmd_dict
    return str(json["data"])

clear_compilation_cache()

Clears seeded compilation cache.

EXPERIMENTAL

Source code in zendriver/cdp/page.py

def clear_compilation_cache() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears seeded compilation cache.

    **EXPERIMENTAL**
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.clearCompilationCache",
    }
    json = yield cmd_dict

clear_device_metrics_override()

Clears the overridden device metrics.

.. deprecated:: 1.3

EXPERIMENTAL

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def clear_device_metrics_override() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears the overridden device metrics.

    .. deprecated:: 1.3

    **EXPERIMENTAL**
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.clearDeviceMetricsOverride",
    }
    json = yield cmd_dict

clear_device_orientation_override()

Clears the overridden Device Orientation.

.. deprecated:: 1.3

EXPERIMENTAL

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def clear_device_orientation_override() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, None]
):
    """
    Clears the overridden Device Orientation.

    .. deprecated:: 1.3

    **EXPERIMENTAL**
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.clearDeviceOrientationOverride",
    }
    json = yield cmd_dict

clear_geolocation_override()

Clears the overridden Geolocation Position and Error.

.. deprecated:: 1.3

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def clear_geolocation_override() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears the overridden Geolocation Position and Error.

    .. deprecated:: 1.3
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.clearGeolocationOverride",
    }
    json = yield cmd_dict

close()

Tries to close page, running its beforeunload hooks, if any.

Source code in zendriver/cdp/page.py

def close() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Tries to close page, running its beforeunload hooks, if any.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.close",
    }
    json = yield cmd_dict

crash()

Crashes renderer on the IO thread, generates minidumps.

EXPERIMENTAL

Source code in zendriver/cdp/page.py

def crash() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Crashes renderer on the IO thread, generates minidumps.

    **EXPERIMENTAL**
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.crash",
    }
    json = yield cmd_dict

create_isolated_world(frame_id, world_name=None, grant_univeral_access=None)

Creates an isolated world for the given frame.

Parameters:

Name	Type	Description	Default
frame_id	FrameId	Id of the frame in which the isolated world should be created.	required
world_name	Optional[str]	(Optional) An optional name which is reported in the Execution Context.	None
grant_univeral_access	Optional[bool]	(Optional) Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, ExecutionContextId]	Execution context of the isolated world.

Source code in zendriver/cdp/page.py

def create_isolated_world(
    frame_id: FrameId,
    world_name: typing.Optional[str] = None,
    grant_univeral_access: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, runtime.ExecutionContextId]:
    """
    Creates an isolated world for the given frame.

    :param frame_id: Id of the frame in which the isolated world should be created.
    :param world_name: *(Optional)* An optional name which is reported in the Execution Context.
    :param grant_univeral_access: *(Optional)* Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.
    :returns: Execution context of the isolated world.
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    if world_name is not None:
        params["worldName"] = world_name
    if grant_univeral_access is not None:
        params["grantUniveralAccess"] = grant_univeral_access
    cmd_dict: T_JSON_DICT = {
        "method": "Page.createIsolatedWorld",
        "params": params,
    }
    json = yield cmd_dict
    return runtime.ExecutionContextId.from_json(json["executionContextId"])

delete_cookie(cookie_name, url)

Deletes browser cookie with given name, domain and path.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
cookie_name	str	Name of the cookie to remove.	required
url	str	URL to match cooke domain and path.	required

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def delete_cookie(
    cookie_name: str, url: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Deletes browser cookie with given name, domain and path.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param cookie_name: Name of the cookie to remove.
    :param url: URL to match cooke domain and path.
    """
    params: T_JSON_DICT = dict()
    params["cookieName"] = cookie_name
    params["url"] = url
    cmd_dict: T_JSON_DICT = {
        "method": "Page.deleteCookie",
        "params": params,
    }
    json = yield cmd_dict

disable()

Disables page domain notifications.

Source code in zendriver/cdp/page.py

def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables page domain notifications.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.disable",
    }
    json = yield cmd_dict

enable()

Enables page domain notifications.

Source code in zendriver/cdp/page.py

def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables page domain notifications.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.enable",
    }
    json = yield cmd_dict

generate_test_report(message, group=None)

Generates a report for testing.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
message	str	Message to be displayed in the report.	required
group	Optional[str]	(Optional) Specifies the endpoint group to deliver the report to.	None

Source code in zendriver/cdp/page.py

def generate_test_report(
    message: str, group: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Generates a report for testing.

    **EXPERIMENTAL**

    :param message: Message to be displayed in the report.
    :param group: *(Optional)* Specifies the endpoint group to deliver the report to.
    """
    params: T_JSON_DICT = dict()
    params["message"] = message
    if group is not None:
        params["group"] = group
    cmd_dict: T_JSON_DICT = {
        "method": "Page.generateTestReport",
        "params": params,
    }
    json = yield cmd_dict

get_ad_script_id(frame_id)

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
frame_id	FrameId		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Optional[AdScriptId]]	(Optional) Identifies the bottom-most script which caused the frame to be labelled as an ad. Only sent if frame is labelled as an ad and id is available.

Source code in zendriver/cdp/page.py

def get_ad_script_id(
    frame_id: FrameId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.Optional[AdScriptId]]:
    """


    **EXPERIMENTAL**

    :param frame_id:
    :returns: *(Optional)* Identifies the bottom-most script which caused the frame to be labelled as an ad. Only sent if frame is labelled as an ad and id is available.
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getAdScriptId",
        "params": params,
    }
    json = yield cmd_dict
    return (
        AdScriptId.from_json(json["adScriptId"])
        if json.get("adScriptId", None) is not None
        else None
    )

get_app_id()

Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[Optional[str], Optional[str]]]	A tuple with the following items: 0. appId - (Optional) App id, either from manifest's id attribute or computed from start_url 1. recommendedId - (Optional) Recommendation for manifest's id attribute to match current id computed from start_url

Source code in zendriver/cdp/page.py

def get_app_id() -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[typing.Optional[str], typing.Optional[str]],
]:
    """
    Returns the unique (PWA) app id.
    Only returns values if the feature flag 'WebAppEnableManifestId' is enabled

    **EXPERIMENTAL**

    :returns: A tuple with the following items:

        0. **appId** - *(Optional)* App id, either from manifest's id attribute or computed from start_url
        1. **recommendedId** - *(Optional)* Recommendation for manifest's id attribute to match current id computed from start_url
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getAppId",
    }
    json = yield cmd_dict
    return (
        str(json["appId"]) if json.get("appId", None) is not None else None,
        (
            str(json["recommendedId"])
            if json.get("recommendedId", None) is not None
            else None
        ),
    )

get_app_manifest(manifest_id=None)

Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately.

Parameters:

Name	Type	Description	Default
manifest_id	Optional[str]	(Optional)	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[str, List[AppManifestError], Optional[str], Optional[AppManifestParsedProperties], WebAppManifest]]	A tuple with the following items: 0. url - Manifest location. 1. errors - 2. data - (Optional) Manifest content. 3. parsed - (Optional) Parsed manifest properties. Deprecated, use manifest instead. 4. manifest -

Source code in zendriver/cdp/page.py

def get_app_manifest(
    manifest_id: typing.Optional[str] = None,
) -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[
        str,
        typing.List[AppManifestError],
        typing.Optional[str],
        typing.Optional[AppManifestParsedProperties],
        WebAppManifest,
    ],
]:
    """
    Gets the processed manifest for this current document.
      This API always waits for the manifest to be loaded.
      If manifestId is provided, and it does not match the manifest of the
        current document, this API errors out.
      If there is not a loaded page, this API errors out immediately.

    :param manifest_id: *(Optional)*
    :returns: A tuple with the following items:

        0. **url** - Manifest location.
        1. **errors** -
        2. **data** - *(Optional)* Manifest content.
        3. **parsed** - *(Optional)* Parsed manifest properties. Deprecated, use manifest instead.
        4. **manifest** -
    """
    params: T_JSON_DICT = dict()
    if manifest_id is not None:
        params["manifestId"] = manifest_id
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getAppManifest",
        "params": params,
    }
    json = yield cmd_dict
    return (
        str(json["url"]),
        [AppManifestError.from_json(i) for i in json["errors"]],
        str(json["data"]) if json.get("data", None) is not None else None,
        (
            AppManifestParsedProperties.from_json(json["parsed"])
            if json.get("parsed", None) is not None
            else None
        ),
        WebAppManifest.from_json(json["manifest"]),
    )

get_frame_tree()

Returns present frame tree structure.

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, FrameTree]	Present frame tree structure.

Source code in zendriver/cdp/page.py

def get_frame_tree() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, FrameTree]:
    """
    Returns present frame tree structure.

    :returns: Present frame tree structure.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getFrameTree",
    }
    json = yield cmd_dict
    return FrameTree.from_json(json["frameTree"])

get_installability_errors()

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[InstallabilityError]]

Source code in zendriver/cdp/page.py

def get_installability_errors() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[InstallabilityError]]
):
    """


    **EXPERIMENTAL**

    :returns:
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getInstallabilityErrors",
    }
    json = yield cmd_dict
    return [InstallabilityError.from_json(i) for i in json["installabilityErrors"]]

get_layout_metrics()

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

Returns:

Type

Description

Generator[T_JSON_DICT, T_JSON_DICT, Tuple[LayoutViewport, VisualViewport, Rect, LayoutViewport, VisualViewport, Rect]]

A tuple with the following items: 0. layoutViewport - Deprecated metrics relating to the layout viewport. Is in device pixels. Use cssLayoutViewport instead. 1. visualViewport - Deprecated metrics relating to the visual viewport. Is in device pixels. Use cssVisualViewport instead. 2. contentSize - Deprecated size of scrollable area. Is in DP. Use cssContentSize instead. 3. cssLayoutViewport - Metrics relating to the layout viewport in CSS pixels. 4. cssVisualViewport - Metrics relating to the visual viewport in CSS pixels. 5. cssContentSize - Size of scrollable area in CSS pixels.

Source code in zendriver/cdp/page.py

def get_layout_metrics() -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[
        LayoutViewport,
        VisualViewport,
        dom.Rect,
        LayoutViewport,
        VisualViewport,
        dom.Rect,
    ],
]:
    """
    Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

    :returns: A tuple with the following items:

        0. **layoutViewport** - Deprecated metrics relating to the layout viewport. Is in device pixels. Use ``cssLayoutViewport`` instead.
        1. **visualViewport** - Deprecated metrics relating to the visual viewport. Is in device pixels. Use ``cssVisualViewport`` instead.
        2. **contentSize** - Deprecated size of scrollable area. Is in DP. Use ``cssContentSize`` instead.
        3. **cssLayoutViewport** - Metrics relating to the layout viewport in CSS pixels.
        4. **cssVisualViewport** - Metrics relating to the visual viewport in CSS pixels.
        5. **cssContentSize** - Size of scrollable area in CSS pixels.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getLayoutMetrics",
    }
    json = yield cmd_dict
    return (
        LayoutViewport.from_json(json["layoutViewport"]),
        VisualViewport.from_json(json["visualViewport"]),
        dom.Rect.from_json(json["contentSize"]),
        LayoutViewport.from_json(json["cssLayoutViewport"]),
        VisualViewport.from_json(json["cssVisualViewport"]),
        dom.Rect.from_json(json["cssContentSize"]),
    )

get_manifest_icons()

Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

.. deprecated:: 1.3

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Optional[str]]

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def get_manifest_icons() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.Optional[str]]
):
    """
    Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :returns:
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getManifestIcons",
    }
    json = yield cmd_dict
    return (
        str(json["primaryIcon"]) if json.get("primaryIcon", None) is not None else None
    )

get_navigation_history()

Returns navigation history for the current page.

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[int, List[NavigationEntry]]]	A tuple with the following items: 0. currentIndex - Index of the current navigation history entry. 1. entries - Array of navigation history entries.

Source code in zendriver/cdp/page.py

def get_navigation_history() -> (
    typing.Generator[
        T_JSON_DICT, T_JSON_DICT, typing.Tuple[int, typing.List[NavigationEntry]]
    ]
):
    """
    Returns navigation history for the current page.

    :returns: A tuple with the following items:

        0. **currentIndex** - Index of the current navigation history entry.
        1. **entries** - Array of navigation history entries.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getNavigationHistory",
    }
    json = yield cmd_dict
    return (
        int(json["currentIndex"]),
        [NavigationEntry.from_json(i) for i in json["entries"]],
    )

get_origin_trials(frame_id)

Get Origin Trials on given frame.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
frame_id	FrameId		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[OriginTrial]]

Source code in zendriver/cdp/page.py

def get_origin_trials(
    frame_id: FrameId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[OriginTrial]]:
    """
    Get Origin Trials on given frame.

    **EXPERIMENTAL**

    :param frame_id:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getOriginTrials",
        "params": params,
    }
    json = yield cmd_dict
    return [OriginTrial.from_json(i) for i in json["originTrials"]]

get_permissions_policy_state(frame_id)

Get Permissions Policy state on given frame.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
frame_id	FrameId		required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[PermissionsPolicyFeatureState]]

Source code in zendriver/cdp/page.py

def get_permissions_policy_state(
    frame_id: FrameId,
) -> typing.Generator[
    T_JSON_DICT, T_JSON_DICT, typing.List[PermissionsPolicyFeatureState]
]:
    """
    Get Permissions Policy state on given frame.

    **EXPERIMENTAL**

    :param frame_id:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getPermissionsPolicyState",
        "params": params,
    }
    json = yield cmd_dict
    return [PermissionsPolicyFeatureState.from_json(i) for i in json["states"]]

get_resource_content(frame_id, url)

Returns content of the given resource.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
frame_id	FrameId	Frame id to get resource for.	required
url	str	URL of the resource to get content for.	required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[str, bool]]	A tuple with the following items: 0. content - Resource content. 1. base64Encoded - True, if content was served as base64.

Source code in zendriver/cdp/page.py

def get_resource_content(
    frame_id: FrameId, url: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.Tuple[str, bool]]:
    """
    Returns content of the given resource.

    **EXPERIMENTAL**

    :param frame_id: Frame id to get resource for.
    :param url: URL of the resource to get content for.
    :returns: A tuple with the following items:

        0. **content** - Resource content.
        1. **base64Encoded** - True, if content was served as base64.
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    params["url"] = url
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getResourceContent",
        "params": params,
    }
    json = yield cmd_dict
    return (str(json["content"]), bool(json["base64Encoded"]))

get_resource_tree()

Returns present frame / resource tree structure.

EXPERIMENTAL

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, FrameResourceTree]	Present frame / resource tree structure.

Source code in zendriver/cdp/page.py

def get_resource_tree() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, FrameResourceTree]
):
    """
    Returns present frame / resource tree structure.

    **EXPERIMENTAL**

    :returns: Present frame / resource tree structure.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.getResourceTree",
    }
    json = yield cmd_dict
    return FrameResourceTree.from_json(json["frameTree"])

handle_java_script_dialog(accept, prompt_text=None)

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

Parameters:

Name	Type	Description	Default
accept	bool	Whether to accept or dismiss the dialog.	required
prompt_text	Optional[str]	(Optional) The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.	None

Source code in zendriver/cdp/page.py

def handle_java_script_dialog(
    accept: bool, prompt_text: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

    :param accept: Whether to accept or dismiss the dialog.
    :param prompt_text: *(Optional)* The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.
    """
    params: T_JSON_DICT = dict()
    params["accept"] = accept
    if prompt_text is not None:
        params["promptText"] = prompt_text
    cmd_dict: T_JSON_DICT = {
        "method": "Page.handleJavaScriptDialog",
        "params": params,
    }
    json = yield cmd_dict

navigate(url, referrer=None, transition_type=None, frame_id=None, referrer_policy=None)

Navigates current page to the given URL.

Parameters:

Name	Type	Description	Default
url	str	URL to navigate the page to.	required
referrer	Optional[str]	(Optional) Referrer URL.	None
transition_type	Optional[TransitionType]	(Optional) Intended transition type.	None
frame_id	Optional[FrameId]	(Optional) Frame id to navigate, if not specified navigates the top frame.	None
referrer_policy	Optional[ReferrerPolicy]	(EXPERIMENTAL) (Optional) Referrer-policy used for the navigation.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[FrameId, Optional[LoaderId], Optional[str]]]	A tuple with the following items: 0. frameId - Frame id that has navigated (or failed to navigate) 1. loaderId - (Optional) Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change. 2. errorText - (Optional) User friendly error message, present if and only if navigation has failed.

Source code in zendriver/cdp/page.py

def navigate(
    url: str,
    referrer: typing.Optional[str] = None,
    transition_type: typing.Optional[TransitionType] = None,
    frame_id: typing.Optional[FrameId] = None,
    referrer_policy: typing.Optional[ReferrerPolicy] = None,
) -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[FrameId, typing.Optional[network.LoaderId], typing.Optional[str]],
]:
    """
    Navigates current page to the given URL.

    :param url: URL to navigate the page to.
    :param referrer: *(Optional)* Referrer URL.
    :param transition_type: *(Optional)* Intended transition type.
    :param frame_id: *(Optional)* Frame id to navigate, if not specified navigates the top frame.
    :param referrer_policy: **(EXPERIMENTAL)** *(Optional)* Referrer-policy used for the navigation.
    :returns: A tuple with the following items:

        0. **frameId** - Frame id that has navigated (or failed to navigate)
        1. **loaderId** - *(Optional)* Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change.
        2. **errorText** - *(Optional)* User friendly error message, present if and only if navigation has failed.
    """
    params: T_JSON_DICT = dict()
    params["url"] = url
    if referrer is not None:
        params["referrer"] = referrer
    if transition_type is not None:
        params["transitionType"] = transition_type.to_json()
    if frame_id is not None:
        params["frameId"] = frame_id.to_json()
    if referrer_policy is not None:
        params["referrerPolicy"] = referrer_policy.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.navigate",
        "params": params,
    }
    json = yield cmd_dict
    return (
        FrameId.from_json(json["frameId"]),
        (
            network.LoaderId.from_json(json["loaderId"])
            if json.get("loaderId", None) is not None
            else None
        ),
        str(json["errorText"]) if json.get("errorText", None) is not None else None,
    )

navigate_to_history_entry(entry_id)

Navigates current page to the given history entry.

Parameters:

Name	Type	Description	Default
entry_id	int	Unique id of the entry to navigate to.	required

Source code in zendriver/cdp/page.py

def navigate_to_history_entry(
    entry_id: int,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Navigates current page to the given history entry.

    :param entry_id: Unique id of the entry to navigate to.
    """
    params: T_JSON_DICT = dict()
    params["entryId"] = entry_id
    cmd_dict: T_JSON_DICT = {
        "method": "Page.navigateToHistoryEntry",
        "params": params,
    }
    json = yield cmd_dict

print_to_pdf(landscape=None, display_header_footer=None, print_background=None, scale=None, paper_width=None, paper_height=None, margin_top=None, margin_bottom=None, margin_left=None, margin_right=None, page_ranges=None, header_template=None, footer_template=None, prefer_css_page_size=None, transfer_mode=None, generate_tagged_pdf=None, generate_document_outline=None)

Print page as PDF.

Parameters:

Name	Type	Description	Default
landscape	Optional[bool]	(Optional) Paper orientation. Defaults to false.	None
display_header_footer	Optional[bool]	(Optional) Display header and footer. Defaults to false.	None
print_background	Optional[bool]	(Optional) Print background graphics. Defaults to false.	None
scale	Optional[float]	(Optional) Scale of the webpage rendering. Defaults to 1.	None
paper_width	Optional[float]	(Optional) Paper width in inches. Defaults to 8.5 inches.	None
paper_height	Optional[float]	(Optional) Paper height in inches. Defaults to 11 inches.	None
margin_top	Optional[float]	(Optional) Top margin in inches. Defaults to 1cm (~0.4 inches).	None
margin_bottom	Optional[float]	(Optional) Bottom margin in inches. Defaults to 1cm (~0.4 inches).	None
margin_left	Optional[float]	(Optional) Left margin in inches. Defaults to 1cm (~0.4 inches).	None
margin_right	Optional[float]	(Optional) Right margin in inches. Defaults to 1cm (~0.4 inches).	None
page_ranges	Optional[str]	(Optional) Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.	None
header_template	Optional[str]	(Optional) HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - ```date: formatted print date -title: document title -url: document location -pageNumber: current page number -totalPages: total pages in the document For example,```` would generate span containing the title.	None
footer_template	Optional[str]	(Optional) HTML template for the print footer. Should use the same format as the headerTemplate.	None
prefer_css_page_size	Optional[bool]	(Optional) Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.	None
transfer_mode	Optional[str]	(EXPERIMENTAL) (Optional) return as stream	None
generate_tagged_pdf	Optional[bool]	(EXPERIMENTAL) (Optional) Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.	None
generate_document_outline	Optional[bool]	(EXPERIMENTAL) (Optional) Whether or not to embed the document outline into the PDF.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[str, Optional[StreamHandle]]]	A tuple with the following items: 0. data - Base64-encoded pdf data. Empty if ` returnAsStream is specified. (Encoded as a base64 string when passed over JSON) 1. stream - (Optional) A handle of the stream that holds resulting PDF data.

Source code in zendriver/cdp/page.py

def print_to_pdf(
    landscape: typing.Optional[bool] = None,
    display_header_footer: typing.Optional[bool] = None,
    print_background: typing.Optional[bool] = None,
    scale: typing.Optional[float] = None,
    paper_width: typing.Optional[float] = None,
    paper_height: typing.Optional[float] = None,
    margin_top: typing.Optional[float] = None,
    margin_bottom: typing.Optional[float] = None,
    margin_left: typing.Optional[float] = None,
    margin_right: typing.Optional[float] = None,
    page_ranges: typing.Optional[str] = None,
    header_template: typing.Optional[str] = None,
    footer_template: typing.Optional[str] = None,
    prefer_css_page_size: typing.Optional[bool] = None,
    transfer_mode: typing.Optional[str] = None,
    generate_tagged_pdf: typing.Optional[bool] = None,
    generate_document_outline: typing.Optional[bool] = None,
) -> typing.Generator[
    T_JSON_DICT, T_JSON_DICT, typing.Tuple[str, typing.Optional[io.StreamHandle]]
]:
    """
    Print page as PDF.

    :param landscape: *(Optional)* Paper orientation. Defaults to false.
    :param display_header_footer: *(Optional)* Display header and footer. Defaults to false.
    :param print_background: *(Optional)* Print background graphics. Defaults to false.
    :param scale: *(Optional)* Scale of the webpage rendering. Defaults to 1.
    :param paper_width: *(Optional)* Paper width in inches. Defaults to 8.5 inches.
    :param paper_height: *(Optional)* Paper height in inches. Defaults to 11 inches.
    :param margin_top: *(Optional)* Top margin in inches. Defaults to 1cm (~0.4 inches).
    :param margin_bottom: *(Optional)* Bottom margin in inches. Defaults to 1cm (~0.4 inches).
    :param margin_left: *(Optional)* Left margin in inches. Defaults to 1cm (~0.4 inches).
    :param margin_right: *(Optional)* Right margin in inches. Defaults to 1cm (~0.4 inches).
    :param page_ranges: *(Optional)* Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.
    :param header_template: *(Optional)* HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - ```date````: formatted print date - ````title````: document title - ````url````: document location - ````pageNumber````: current page number - ````totalPages````: total pages in the document  For example, ````<span class=title></span>```` would generate span containing the title.
    :param footer_template: *(Optional)* HTML template for the print footer. Should use the same format as the ````headerTemplate````.
    :param prefer_css_page_size: *(Optional)* Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.
    :param transfer_mode: **(EXPERIMENTAL)** *(Optional)* return as stream
    :param generate_tagged_pdf: **(EXPERIMENTAL)** *(Optional)* Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.
    :param generate_document_outline: **(EXPERIMENTAL)** *(Optional)* Whether or not to embed the document outline into the PDF.
    :returns: A tuple with the following items:

        0. **data** - Base64-encoded pdf data. Empty if `` returnAsStream` is specified. (Encoded as a base64 string when passed over JSON)
        1. **stream** - *(Optional)* A handle of the stream that holds resulting PDF data.
    """
    params: T_JSON_DICT = dict()
    if landscape is not None:
        params["landscape"] = landscape
    if display_header_footer is not None:
        params["displayHeaderFooter"] = display_header_footer
    if print_background is not None:
        params["printBackground"] = print_background
    if scale is not None:
        params["scale"] = scale
    if paper_width is not None:
        params["paperWidth"] = paper_width
    if paper_height is not None:
        params["paperHeight"] = paper_height
    if margin_top is not None:
        params["marginTop"] = margin_top
    if margin_bottom is not None:
        params["marginBottom"] = margin_bottom
    if margin_left is not None:
        params["marginLeft"] = margin_left
    if margin_right is not None:
        params["marginRight"] = margin_right
    if page_ranges is not None:
        params["pageRanges"] = page_ranges
    if header_template is not None:
        params["headerTemplate"] = header_template
    if footer_template is not None:
        params["footerTemplate"] = footer_template
    if prefer_css_page_size is not None:
        params["preferCSSPageSize"] = prefer_css_page_size
    if transfer_mode is not None:
        params["transferMode"] = transfer_mode
    if generate_tagged_pdf is not None:
        params["generateTaggedPDF"] = generate_tagged_pdf
    if generate_document_outline is not None:
        params["generateDocumentOutline"] = generate_document_outline
    cmd_dict: T_JSON_DICT = {
        "method": "Page.printToPDF",
        "params": params,
    }
    json = yield cmd_dict
    return (
        str(json["data"]),
        (
            io.StreamHandle.from_json(json["stream"])
            if json.get("stream", None) is not None
            else None
        ),
    )

produce_compilation_cache(scripts)

Requests backend to produce compilation cache for the specified scripts. scripts are appended to the list of scripts for which the cache would be produced. The list may be reset during page navigation. When script with a matching URL is encountered, the cache is optionally produced upon backend discretion, based on internal heuristics. See also: Page.compilationCacheProduced.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
scripts	List[CompilationCacheParams]		required

Source code in zendriver/cdp/page.py

def produce_compilation_cache(
    scripts: typing.List[CompilationCacheParams],
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Requests backend to produce compilation cache for the specified scripts.
    ``scripts`` are appended to the list of scripts for which the cache
    would be produced. The list may be reset during page navigation.
    When script with a matching URL is encountered, the cache is optionally
    produced upon backend discretion, based on internal heuristics.
    See also: ``Page.compilationCacheProduced``.

    **EXPERIMENTAL**

    :param scripts:
    """
    params: T_JSON_DICT = dict()
    params["scripts"] = [i.to_json() for i in scripts]
    cmd_dict: T_JSON_DICT = {
        "method": "Page.produceCompilationCache",
        "params": params,
    }
    json = yield cmd_dict

reload(ignore_cache=None, script_to_evaluate_on_load=None, loader_id=None)

Reloads given page optionally ignoring the cache.

Parameters:

Name	Type	Description	Default
ignore_cache	Optional[bool]	(Optional) If true, browser cache is ignored (as if the user pressed Shift+refresh).	None
script_to_evaluate_on_load	Optional[str]	(Optional) If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.	None
loader_id	Optional[LoaderId]	(EXPERIMENTAL) (Optional) If set, an error will be thrown if the target page's main frame's loader id does not match the provided id. This prevents accidentally reloading an unintended target in case there's a racing navigation.	None

Source code in zendriver/cdp/page.py

def reload(
    ignore_cache: typing.Optional[bool] = None,
    script_to_evaluate_on_load: typing.Optional[str] = None,
    loader_id: typing.Optional[network.LoaderId] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Reloads given page optionally ignoring the cache.

    :param ignore_cache: *(Optional)* If true, browser cache is ignored (as if the user pressed Shift+refresh).
    :param script_to_evaluate_on_load: *(Optional)* If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.
    :param loader_id: **(EXPERIMENTAL)** *(Optional)* If set, an error will be thrown if the target page's main frame's loader id does not match the provided id. This prevents accidentally reloading an unintended target in case there's a racing navigation.
    """
    params: T_JSON_DICT = dict()
    if ignore_cache is not None:
        params["ignoreCache"] = ignore_cache
    if script_to_evaluate_on_load is not None:
        params["scriptToEvaluateOnLoad"] = script_to_evaluate_on_load
    if loader_id is not None:
        params["loaderId"] = loader_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.reload",
        "params": params,
    }
    json = yield cmd_dict

remove_script_to_evaluate_on_load(identifier)

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
identifier	ScriptIdentifier		required

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def remove_script_to_evaluate_on_load(
    identifier: ScriptIdentifier,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param identifier:
    """
    params: T_JSON_DICT = dict()
    params["identifier"] = identifier.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.removeScriptToEvaluateOnLoad",
        "params": params,
    }
    json = yield cmd_dict

remove_script_to_evaluate_on_new_document(identifier)

Removes given script from the list.

Parameters:

Name	Type	Description	Default
identifier	ScriptIdentifier		required

Source code in zendriver/cdp/page.py

def remove_script_to_evaluate_on_new_document(
    identifier: ScriptIdentifier,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Removes given script from the list.

    :param identifier:
    """
    params: T_JSON_DICT = dict()
    params["identifier"] = identifier.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.removeScriptToEvaluateOnNewDocument",
        "params": params,
    }
    json = yield cmd_dict

reset_navigation_history()

Resets navigation history for the current page.

Source code in zendriver/cdp/page.py

def reset_navigation_history() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Resets navigation history for the current page.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.resetNavigationHistory",
    }
    json = yield cmd_dict

screencast_frame_ack(session_id)

Acknowledges that a screencast frame has been received by the frontend.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
session_id	int	Frame number.	required

Source code in zendriver/cdp/page.py

def screencast_frame_ack(
    session_id: int,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Acknowledges that a screencast frame has been received by the frontend.

    **EXPERIMENTAL**

    :param session_id: Frame number.
    """
    params: T_JSON_DICT = dict()
    params["sessionId"] = session_id
    cmd_dict: T_JSON_DICT = {
        "method": "Page.screencastFrameAck",
        "params": params,
    }
    json = yield cmd_dict

search_in_resource(frame_id, url, query, case_sensitive=None, is_regex=None)

Searches for given string in resource content.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
frame_id	FrameId	Frame id for resource to search in.	required
url	str	URL of the resource to search in.	required
query	str	String to search for.	required
case_sensitive	Optional[bool]	(Optional) If true, search is case sensitive.	None
is_regex	Optional[bool]	(Optional) If true, treats string parameter as regex.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, List[SearchMatch]]	List of search matches.

Source code in zendriver/cdp/page.py

def search_in_resource(
    frame_id: FrameId,
    url: str,
    query: str,
    case_sensitive: typing.Optional[bool] = None,
    is_regex: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[debugger.SearchMatch]]:
    """
    Searches for given string in resource content.

    **EXPERIMENTAL**

    :param frame_id: Frame id for resource to search in.
    :param url: URL of the resource to search in.
    :param query: String to search for.
    :param case_sensitive: *(Optional)* If true, search is case sensitive.
    :param is_regex: *(Optional)* If true, treats string parameter as regex.
    :returns: List of search matches.
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    params["url"] = url
    params["query"] = query
    if case_sensitive is not None:
        params["caseSensitive"] = case_sensitive
    if is_regex is not None:
        params["isRegex"] = is_regex
    cmd_dict: T_JSON_DICT = {
        "method": "Page.searchInResource",
        "params": params,
    }
    json = yield cmd_dict
    return [debugger.SearchMatch.from_json(i) for i in json["result"]]

set_ad_blocking_enabled(enabled)

Enable Chrome's experimental ad filter on all sites.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
enabled	bool	Whether to block ads.	required

Source code in zendriver/cdp/page.py

def set_ad_blocking_enabled(
    enabled: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enable Chrome's experimental ad filter on all sites.

    **EXPERIMENTAL**

    :param enabled: Whether to block ads.
    """
    params: T_JSON_DICT = dict()
    params["enabled"] = enabled
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setAdBlockingEnabled",
        "params": params,
    }
    json = yield cmd_dict

set_bypass_csp(enabled)

Enable page Content Security Policy by-passing.

Parameters:

Name	Type	Description	Default
enabled	bool	Whether to bypass page CSP.	required

Source code in zendriver/cdp/page.py

def set_bypass_csp(enabled: bool) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enable page Content Security Policy by-passing.

    :param enabled: Whether to bypass page CSP.
    """
    params: T_JSON_DICT = dict()
    params["enabled"] = enabled
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setBypassCSP",
        "params": params,
    }
    json = yield cmd_dict

set_device_metrics_override(width, height, device_scale_factor, mobile, scale=None, screen_width=None, screen_height=None, position_x=None, position_y=None, dont_set_visible_size=None, screen_orientation=None, viewport=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).

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
width	int	Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.	required
height	int	Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.	required
device_scale_factor	float	Overriding device scale factor value. 0 disables the override.	required
mobile	bool	Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.	required
scale	Optional[float]	(Optional) Scale to apply to resulting view image.	None
screen_width	Optional[int]	(Optional) Overriding screen width value in pixels (minimum 0, maximum 10000000).	None
screen_height	Optional[int]	(Optional) Overriding screen height value in pixels (minimum 0, maximum 10000000).	None
position_x	Optional[int]	(Optional) Overriding view X position on screen in pixels (minimum 0, maximum 10000000).	None
position_y	Optional[int]	(Optional) Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).	None
dont_set_visible_size	Optional[bool]	(Optional) Do not set visible view size, rely upon explicit setVisibleSize call.	None
screen_orientation	Optional[ScreenOrientation]	(Optional) Screen orientation override.	None
viewport	Optional[Viewport]	(Optional) The viewport dimensions and scale. If not set, the override is cleared.	None

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
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[emulation.ScreenOrientation] = None,
    viewport: typing.Optional[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).

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :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: *(Optional)* Scale to apply to resulting view image.
    :param screen_width: *(Optional)* Overriding screen width value in pixels (minimum 0, maximum 10000000).
    :param screen_height: *(Optional)* Overriding screen height value in pixels (minimum 0, maximum 10000000).
    :param position_x: *(Optional)* Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
    :param position_y: *(Optional)* Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
    :param dont_set_visible_size: *(Optional)* Do not set visible view size, rely upon explicit setVisibleSize call.
    :param screen_orientation: *(Optional)* Screen orientation override.
    :param viewport: *(Optional)* The viewport dimensions and scale. If not set, the override is cleared.
    """
    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": "Page.setDeviceMetricsOverride",
        "params": params,
    }
    json = yield cmd_dict

set_device_orientation_override(alpha, beta, gamma)

Overrides the Device Orientation.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
alpha	float	Mock alpha	required
beta	float	Mock beta	required
gamma	float	Mock gamma	required

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def set_device_orientation_override(
    alpha: float, beta: float, gamma: float
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Overrides the Device Orientation.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param alpha: Mock alpha
    :param beta: Mock beta
    :param gamma: Mock gamma
    """
    params: T_JSON_DICT = dict()
    params["alpha"] = alpha
    params["beta"] = beta
    params["gamma"] = gamma
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setDeviceOrientationOverride",
        "params": params,
    }
    json = yield cmd_dict

set_document_content(frame_id, html)

Sets given markup as the document's HTML.

Parameters:

Name	Type	Description	Default
frame_id	FrameId	Frame id to set HTML for.	required
html	str	HTML content to set.	required

Source code in zendriver/cdp/page.py

def set_document_content(
    frame_id: FrameId, html: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Sets given markup as the document's HTML.

    :param frame_id: Frame id to set HTML for.
    :param html: HTML content to set.
    """
    params: T_JSON_DICT = dict()
    params["frameId"] = frame_id.to_json()
    params["html"] = html
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setDocumentContent",
        "params": params,
    }
    json = yield cmd_dict

set_download_behavior(behavior, download_path=None)

Set the behavior when downloading a file.

.. deprecated:: 1.3

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).	required
download_path	Optional[str]	(Optional) The default path to save downloaded files to. This is required if behavior is set to 'allow'	None

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def set_download_behavior(
    behavior: str, download_path: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Set the behavior when downloading a file.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param behavior: Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny).
    :param download_path: *(Optional)* The default path to save downloaded files to. This is required if behavior is set to 'allow'
    """
    params: T_JSON_DICT = dict()
    params["behavior"] = behavior
    if download_path is not None:
        params["downloadPath"] = download_path
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setDownloadBehavior",
        "params": params,
    }
    json = yield cmd_dict

set_font_families(font_families, for_scripts=None)

Set generic font families.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
font_families	FontFamilies	Specifies font families to set. If a font family is not specified, it won't be changed.	required
for_scripts	Optional[List[ScriptFontFamilies]]	(Optional) Specifies font families to set for individual scripts.	None

Source code in zendriver/cdp/page.py

def set_font_families(
    font_families: FontFamilies,
    for_scripts: typing.Optional[typing.List[ScriptFontFamilies]] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Set generic font families.

    **EXPERIMENTAL**

    :param font_families: Specifies font families to set. If a font family is not specified, it won't be changed.
    :param for_scripts: *(Optional)* Specifies font families to set for individual scripts.
    """
    params: T_JSON_DICT = dict()
    params["fontFamilies"] = font_families.to_json()
    if for_scripts is not None:
        params["forScripts"] = [i.to_json() for i in for_scripts]
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setFontFamilies",
        "params": params,
    }
    json = yield cmd_dict

set_font_sizes(font_sizes)

Set default font sizes.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
font_sizes	FontSizes	Specifies font sizes to set. If a font size is not specified, it won't be changed.	required

Source code in zendriver/cdp/page.py

def set_font_sizes(
    font_sizes: FontSizes,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Set default font sizes.

    **EXPERIMENTAL**

    :param font_sizes: Specifies font sizes to set. If a font size is not specified, it won't be changed.
    """
    params: T_JSON_DICT = dict()
    params["fontSizes"] = font_sizes.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setFontSizes",
        "params": params,
    }
    json = yield cmd_dict

set_geolocation_override(latitude=None, longitude=None, accuracy=None)

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

.. deprecated:: 1.3

Parameters:

Name	Type	Description	Default
latitude	Optional[float]	(Optional) Mock latitude	None
longitude	Optional[float]	(Optional) Mock longitude	None
accuracy	Optional[float]	(Optional) Mock accuracy	None

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def set_geolocation_override(
    latitude: typing.Optional[float] = None,
    longitude: typing.Optional[float] = None,
    accuracy: typing.Optional[float] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
    unavailable.

    .. deprecated:: 1.3

    :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": "Page.setGeolocationOverride",
        "params": params,
    }
    json = yield cmd_dict

set_intercept_file_chooser_dialog(enabled)

Intercept file chooser requests and transfer control to protocol clients. When file chooser interception is enabled, native file chooser dialog is not shown. Instead, a protocol event Page.fileChooserOpened is emitted.

Parameters:

Name	Type	Description	Default
enabled	bool		required

Source code in zendriver/cdp/page.py

def set_intercept_file_chooser_dialog(
    enabled: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Intercept file chooser requests and transfer control to protocol clients.
    When file chooser interception is enabled, native file chooser dialog is not shown.
    Instead, a protocol event ``Page.fileChooserOpened`` is emitted.

    :param enabled:
    """
    params: T_JSON_DICT = dict()
    params["enabled"] = enabled
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setInterceptFileChooserDialog",
        "params": params,
    }
    json = yield cmd_dict

set_lifecycle_events_enabled(enabled)

Controls whether page will emit lifecycle events.

Parameters:

Name	Type	Description	Default
enabled	bool	If true, starts emitting lifecycle events.	required

Source code in zendriver/cdp/page.py

def set_lifecycle_events_enabled(
    enabled: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Controls whether page will emit lifecycle events.

    :param enabled: If true, starts emitting lifecycle events.
    """
    params: T_JSON_DICT = dict()
    params["enabled"] = enabled
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setLifecycleEventsEnabled",
        "params": params,
    }
    json = yield cmd_dict

set_prerendering_allowed(is_allowed)

Enable/disable prerendering manually.

This command is a short-term solution for https://crbug.com/1440085. See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0_wpA for more details.

TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
is_allowed	bool		required

Source code in zendriver/cdp/page.py

def set_prerendering_allowed(
    is_allowed: bool,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enable/disable prerendering manually.

    This command is a short-term solution for https://crbug.com/1440085.
    See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0_wpA
    for more details.

    TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets.

    **EXPERIMENTAL**

    :param is_allowed:
    """
    params: T_JSON_DICT = dict()
    params["isAllowed"] = is_allowed
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setPrerenderingAllowed",
        "params": params,
    }
    json = yield cmd_dict

set_rph_registration_mode(mode)

Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
mode	AutoResponseMode		required

Source code in zendriver/cdp/page.py

def set_rph_registration_mode(
    mode: AutoResponseMode,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Extensions for Custom Handlers API:
    https://html.spec.whatwg.org/multipage/system-state.html#rph-automation

    **EXPERIMENTAL**

    :param mode:
    """
    params: T_JSON_DICT = dict()
    params["mode"] = mode.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setRPHRegistrationMode",
        "params": params,
    }
    json = yield cmd_dict

set_spc_transaction_mode(mode)

Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
mode	AutoResponseMode		required

Source code in zendriver/cdp/page.py

def set_spc_transaction_mode(
    mode: AutoResponseMode,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Sets the Secure Payment Confirmation transaction mode.
    https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode

    **EXPERIMENTAL**

    :param mode:
    """
    params: T_JSON_DICT = dict()
    params["mode"] = mode.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setSPCTransactionMode",
        "params": params,
    }
    json = yield cmd_dict

set_touch_emulation_enabled(enabled, configuration=None)

Toggles mouse event-based touch event emulation.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
enabled	bool	Whether the touch event emulation should be enabled.	required
configuration	Optional[str]	(Optional) Touch/gesture events configuration. Default: current platform.	None

Source code in zendriver/cdp/page.py

@deprecated(version="1.3")
def set_touch_emulation_enabled(
    enabled: bool, configuration: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Toggles mouse event-based touch event emulation.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param enabled: Whether the touch event emulation 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": "Page.setTouchEmulationEnabled",
        "params": params,
    }
    json = yield cmd_dict

set_web_lifecycle_state(state)

Tries to update the web lifecycle state of the page. It will transition the page to the given state according to: https://github.com/WICG/web-lifecycle/

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
state	str	Target lifecycle state	required

Source code in zendriver/cdp/page.py

def set_web_lifecycle_state(
    state: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Tries to update the web lifecycle state of the page.
    It will transition the page to the given state according to:
    https://github.com/WICG/web-lifecycle/

    **EXPERIMENTAL**

    :param state: Target lifecycle state
    """
    params: T_JSON_DICT = dict()
    params["state"] = state
    cmd_dict: T_JSON_DICT = {
        "method": "Page.setWebLifecycleState",
        "params": params,
    }
    json = yield cmd_dict

start_screencast(format_=None, quality=None, max_width=None, max_height=None, every_nth_frame=None)

Starts sending each frame using the screencastFrame event.

EXPERIMENTAL

Parameters:

Name	Type	Description	Default
format_	Optional[str]	(Optional) Image compression format.	None
quality	Optional[int]	(Optional) Compression quality from range [0..100].	None
max_width	Optional[int]	(Optional) Maximum screenshot width.	None
max_height	Optional[int]	(Optional) Maximum screenshot height.	None
every_nth_frame	Optional[int]	(Optional) Send every n-th frame.	None

Source code in zendriver/cdp/page.py

def start_screencast(
    format_: typing.Optional[str] = None,
    quality: typing.Optional[int] = None,
    max_width: typing.Optional[int] = None,
    max_height: typing.Optional[int] = None,
    every_nth_frame: typing.Optional[int] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Starts sending each frame using the ``screencastFrame`` event.

    **EXPERIMENTAL**

    :param format_: *(Optional)* Image compression format.
    :param quality: *(Optional)* Compression quality from range [0..100].
    :param max_width: *(Optional)* Maximum screenshot width.
    :param max_height: *(Optional)* Maximum screenshot height.
    :param every_nth_frame: *(Optional)* Send every n-th frame.
    """
    params: T_JSON_DICT = dict()
    if format_ is not None:
        params["format"] = format_
    if quality is not None:
        params["quality"] = quality
    if max_width is not None:
        params["maxWidth"] = max_width
    if max_height is not None:
        params["maxHeight"] = max_height
    if every_nth_frame is not None:
        params["everyNthFrame"] = every_nth_frame
    cmd_dict: T_JSON_DICT = {
        "method": "Page.startScreencast",
        "params": params,
    }
    json = yield cmd_dict

stop_loading()

Force the page stop all navigations and pending resource fetches.

Source code in zendriver/cdp/page.py

def stop_loading() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Force the page stop all navigations and pending resource fetches.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.stopLoading",
    }
    json = yield cmd_dict

stop_screencast()

Stops sending each frame in the screencastFrame.

EXPERIMENTAL

Source code in zendriver/cdp/page.py

def stop_screencast() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Stops sending each frame in the ``screencastFrame``.

    **EXPERIMENTAL**
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.stopScreencast",
    }
    json = yield cmd_dict

wait_for_debugger()

Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.

EXPERIMENTAL

Source code in zendriver/cdp/page.py

def wait_for_debugger() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.

    **EXPERIMENTAL**
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Page.waitForDebugger",
    }
    json = yield cmd_dict