Audits

Audits domain allows investigation of page violations and possible improvements.

This CDP domain is experimental.

• Types

• Commands

• Events

Types

Generally, you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.

class AffectedCookie(name, path, domain)

Information about a cookie that is affected by an inspector issue.

name: str

The following three properties uniquely identify a cookie

path: str

domain: str

class AffectedRequest(url, request_id=None)

Information about a request that is affected by an inspector issue.

url: str

request_id: Optional[RequestId] = None

The unique request id.

class AffectedFrame(frame_id)

Information about the frame affected by an inspector issue.

frame_id: FrameId

class CookieExclusionReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

EXCLUDE_SAME_SITE_UNSPECIFIED_TREATED_AS_LAX = 'ExcludeSameSiteUnspecifiedTreatedAsLax'

EXCLUDE_SAME_SITE_NONE_INSECURE = 'ExcludeSameSiteNoneInsecure'

EXCLUDE_SAME_SITE_LAX = 'ExcludeSameSiteLax'

EXCLUDE_SAME_SITE_STRICT = 'ExcludeSameSiteStrict'

EXCLUDE_INVALID_SAME_PARTY = 'ExcludeInvalidSameParty'

EXCLUDE_SAME_PARTY_CROSS_PARTY_CONTEXT = 'ExcludeSamePartyCrossPartyContext'

EXCLUDE_DOMAIN_NON_ASCII = 'ExcludeDomainNonASCII'

EXCLUDE_THIRD_PARTY_COOKIE_BLOCKED_IN_FIRST_PARTY_SET = 'ExcludeThirdPartyCookieBlockedInFirstPartySet'

EXCLUDE_THIRD_PARTY_PHASEOUT = 'ExcludeThirdPartyPhaseout'

EXCLUDE_PORT_MISMATCH = 'ExcludePortMismatch'

EXCLUDE_SCHEME_MISMATCH = 'ExcludeSchemeMismatch'

class CookieWarningReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

WARN_SAME_SITE_UNSPECIFIED_CROSS_SITE_CONTEXT = 'WarnSameSiteUnspecifiedCrossSiteContext'

WARN_SAME_SITE_NONE_INSECURE = 'WarnSameSiteNoneInsecure'

WARN_SAME_SITE_UNSPECIFIED_LAX_ALLOW_UNSAFE = 'WarnSameSiteUnspecifiedLaxAllowUnsafe'

WARN_SAME_SITE_STRICT_LAX_DOWNGRADE_STRICT = 'WarnSameSiteStrictLaxDowngradeStrict'

WARN_SAME_SITE_STRICT_CROSS_DOWNGRADE_STRICT = 'WarnSameSiteStrictCrossDowngradeStrict'

WARN_SAME_SITE_STRICT_CROSS_DOWNGRADE_LAX = 'WarnSameSiteStrictCrossDowngradeLax'

WARN_SAME_SITE_LAX_CROSS_DOWNGRADE_STRICT = 'WarnSameSiteLaxCrossDowngradeStrict'

WARN_SAME_SITE_LAX_CROSS_DOWNGRADE_LAX = 'WarnSameSiteLaxCrossDowngradeLax'

WARN_ATTRIBUTE_VALUE_EXCEEDS_MAX_SIZE = 'WarnAttributeValueExceedsMaxSize'

WARN_DOMAIN_NON_ASCII = 'WarnDomainNonASCII'

WARN_THIRD_PARTY_PHASEOUT = 'WarnThirdPartyPhaseout'

WARN_CROSS_SITE_REDIRECT_DOWNGRADE_CHANGES_INCLUSION = 'WarnCrossSiteRedirectDowngradeChangesInclusion'

WARN_DEPRECATION_TRIAL_METADATA = 'WarnDeprecationTrialMetadata'

WARN_THIRD_PARTY_COOKIE_HEURISTIC = 'WarnThirdPartyCookieHeuristic'

class CookieOperation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

SET_COOKIE = 'SetCookie'

READ_COOKIE = 'ReadCookie'

class InsightType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Represents the category of insight that a cookie issue falls under.

GIT_HUB_RESOURCE = 'GitHubResource'

GRACE_PERIOD = 'GracePeriod'

HEURISTICS = 'Heuristics'

class CookieIssueInsight(type_, table_entry_url=None)

Information about the suggested solution to a cookie issue.

type_: InsightType

table_entry_url: Optional[str] = None

Link to table entry in third-party cookie migration readiness list.

class CookieIssueDetails(cookie_warning_reasons, cookie_exclusion_reasons, operation, cookie=None, raw_cookie_line=None, site_for_cookies=None, cookie_url=None, request=None, insight=None)

This information is currently necessary, as the front-end has a difficult time finding a specific cookie. With this, we can convey specific error information without the cookie.

cookie_warning_reasons: List[CookieWarningReason]

cookie_exclusion_reasons: List[CookieExclusionReason]

operation: CookieOperation

Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context.

cookie: Optional[AffectedCookie] = None

If AffectedCookie is not set then rawCookieLine contains the raw Set-Cookie header string. This hints at a problem where the cookie line is syntactically or semantically malformed in a way that no valid cookie could be created.

raw_cookie_line: Optional[str] = None

site_for_cookies: Optional[str] = None

cookie_url: Optional[str] = None

request: Optional[AffectedRequest] = None

insight: Optional[CookieIssueInsight] = None

The recommended solution to the issue.

class MixedContentResolutionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

MIXED_CONTENT_BLOCKED = 'MixedContentBlocked'

MIXED_CONTENT_AUTOMATICALLY_UPGRADED = 'MixedContentAutomaticallyUpgraded'

MIXED_CONTENT_WARNING = 'MixedContentWarning'

class MixedContentResourceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

ATTRIBUTION_SRC = 'AttributionSrc'

AUDIO = 'Audio'

BEACON = 'Beacon'

CSP_REPORT = 'CSPReport'

DOWNLOAD = 'Download'

EVENT_SOURCE = 'EventSource'

FAVICON = 'Favicon'

FONT = 'Font'

FORM = 'Form'

FRAME = 'Frame'

IMAGE = 'Image'

IMPORT = 'Import'

JSON = 'JSON'

MANIFEST = 'Manifest'

PING = 'Ping'

PLUGIN_DATA = 'PluginData'

PLUGIN_RESOURCE = 'PluginResource'

PREFETCH = 'Prefetch'

RESOURCE = 'Resource'

SCRIPT = 'Script'

SERVICE_WORKER = 'ServiceWorker'

SHARED_WORKER = 'SharedWorker'

SPECULATION_RULES = 'SpeculationRules'

STYLESHEET = 'Stylesheet'

TRACK = 'Track'

VIDEO = 'Video'

WORKER = 'Worker'

XML_HTTP_REQUEST = 'XMLHttpRequest'

XSLT = 'XSLT'

class MixedContentIssueDetails(resolution_status, insecure_url, main_resource_url, resource_type=None, request=None, frame=None)

resolution_status: MixedContentResolutionStatus

The way the mixed content issue is being resolved.

insecure_url: str

The unsafe http url causing the mixed content issue.

main_resource_url: str

The url responsible for the call to an unsafe url.

resource_type: Optional[MixedContentResourceType] = None

The type of resource causing the mixed content issue (css, js, iframe, form,…). Marked as optional because it is mapped to from blink::mojom::RequestContextType, which will be replaced by network::mojom::RequestDestination

request: Optional[AffectedRequest] = None

The mixed content request. Does not always exist (e.g. for unsafe form submission urls).

frame: Optional[AffectedFrame] = None

Optional because not every mixed content issue is necessarily linked to a frame.

class BlockedByResponseReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Enum indicating the reason a response has been blocked. These reasons are refinements of the net error BLOCKED_BY_RESPONSE.

COEP_FRAME_RESOURCE_NEEDS_COEP_HEADER = 'CoepFrameResourceNeedsCoepHeader'

COOP_SANDBOXED_I_FRAME_CANNOT_NAVIGATE_TO_COOP_PAGE = 'CoopSandboxedIFrameCannotNavigateToCoopPage'

CORP_NOT_SAME_ORIGIN = 'CorpNotSameOrigin'

CORP_NOT_SAME_ORIGIN_AFTER_DEFAULTED_TO_SAME_ORIGIN_BY_COEP = 'CorpNotSameOriginAfterDefaultedToSameOriginByCoep'

CORP_NOT_SAME_ORIGIN_AFTER_DEFAULTED_TO_SAME_ORIGIN_BY_DIP = 'CorpNotSameOriginAfterDefaultedToSameOriginByDip'

CORP_NOT_SAME_ORIGIN_AFTER_DEFAULTED_TO_SAME_ORIGIN_BY_COEP_AND_DIP = 'CorpNotSameOriginAfterDefaultedToSameOriginByCoepAndDip'

CORP_NOT_SAME_SITE = 'CorpNotSameSite'

SRI_MESSAGE_SIGNATURE_MISMATCH = 'SRIMessageSignatureMismatch'

class BlockedByResponseIssueDetails(request, reason, parent_frame=None, blocked_frame=None)

Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code. Currently only used for COEP/COOP, but may be extended to include some CSP errors in the future.

request: AffectedRequest

reason: BlockedByResponseReason

parent_frame: Optional[AffectedFrame] = None

blocked_frame: Optional[AffectedFrame] = None

class HeavyAdResolutionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

HEAVY_AD_BLOCKED = 'HeavyAdBlocked'

HEAVY_AD_WARNING = 'HeavyAdWarning'

class HeavyAdReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

NETWORK_TOTAL_LIMIT = 'NetworkTotalLimit'

CPU_TOTAL_LIMIT = 'CpuTotalLimit'

CPU_PEAK_LIMIT = 'CpuPeakLimit'

class HeavyAdIssueDetails(resolution, reason, frame)

resolution: HeavyAdResolutionStatus

The resolution status, either blocking the content or warning.

reason: HeavyAdReason

The reason the ad was blocked, total network or cpu or peak cpu.

frame: AffectedFrame

The frame that was blocked.

class ContentSecurityPolicyViolationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

K_INLINE_VIOLATION = 'kInlineViolation'

K_EVAL_VIOLATION = 'kEvalViolation'

K_URL_VIOLATION = 'kURLViolation'

K_SRI_VIOLATION = 'kSRIViolation'

K_TRUSTED_TYPES_SINK_VIOLATION = 'kTrustedTypesSinkViolation'

K_TRUSTED_TYPES_POLICY_VIOLATION = 'kTrustedTypesPolicyViolation'

K_WASM_EVAL_VIOLATION = 'kWasmEvalViolation'

class SourceCodeLocation(url, line_number, column_number, script_id=None)

url: str

line_number: int

column_number: int

script_id: Optional[ScriptId] = None

class ContentSecurityPolicyIssueDetails(violated_directive, is_report_only, content_security_policy_violation_type, blocked_url=None, frame_ancestor=None, source_code_location=None, violating_node_id=None)

violated_directive: str

Specific directive that is violated, causing the CSP issue.

is_report_only: bool

content_security_policy_violation_type: ContentSecurityPolicyViolationType

blocked_url: Optional[str] = None

The url not included in allowed sources.

frame_ancestor: Optional[AffectedFrame] = None

source_code_location: Optional[SourceCodeLocation] = None

violating_node_id: Optional[BackendNodeId] = None

class SharedArrayBufferIssueType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

TRANSFER_ISSUE = 'TransferIssue'

CREATION_ISSUE = 'CreationIssue'

class SharedArrayBufferIssueDetails(source_code_location, is_warning, type_)

Details for a issue arising from an SAB being instantiated in, or transferred to a context that is not cross-origin isolated.

source_code_location: SourceCodeLocation

is_warning: bool

type_: SharedArrayBufferIssueType

class LowTextContrastIssueDetails(violating_node_id, violating_node_selector, contrast_ratio, threshold_aa, threshold_aaa, font_size, font_weight)

violating_node_id: BackendNodeId

violating_node_selector: str

contrast_ratio: float

threshold_aa: float

threshold_aaa: float

font_size: str

font_weight: str

class CorsIssueDetails(cors_error_status, is_warning, request, location=None, initiator_origin=None, resource_ip_address_space=None, client_security_state=None)

Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.

cors_error_status: CorsErrorStatus

is_warning: bool

request: AffectedRequest

location: Optional[SourceCodeLocation] = None

initiator_origin: Optional[str] = None

resource_ip_address_space: Optional[IPAddressSpace] = None

client_security_state: Optional[ClientSecurityState] = None

class AttributionReportingIssueType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

PERMISSION_POLICY_DISABLED = 'PermissionPolicyDisabled'

UNTRUSTWORTHY_REPORTING_ORIGIN = 'UntrustworthyReportingOrigin'

INSECURE_CONTEXT = 'InsecureContext'

INVALID_HEADER = 'InvalidHeader'

INVALID_REGISTER_TRIGGER_HEADER = 'InvalidRegisterTriggerHeader'

SOURCE_AND_TRIGGER_HEADERS = 'SourceAndTriggerHeaders'

SOURCE_IGNORED = 'SourceIgnored'

TRIGGER_IGNORED = 'TriggerIgnored'

OS_SOURCE_IGNORED = 'OsSourceIgnored'

OS_TRIGGER_IGNORED = 'OsTriggerIgnored'

INVALID_REGISTER_OS_SOURCE_HEADER = 'InvalidRegisterOsSourceHeader'

INVALID_REGISTER_OS_TRIGGER_HEADER = 'InvalidRegisterOsTriggerHeader'

WEB_AND_OS_HEADERS = 'WebAndOsHeaders'

NO_WEB_OR_OS_SUPPORT = 'NoWebOrOsSupport'

NAVIGATION_REGISTRATION_WITHOUT_TRANSIENT_USER_ACTIVATION = 'NavigationRegistrationWithoutTransientUserActivation'

INVALID_INFO_HEADER = 'InvalidInfoHeader'

NO_REGISTER_SOURCE_HEADER = 'NoRegisterSourceHeader'

NO_REGISTER_TRIGGER_HEADER = 'NoRegisterTriggerHeader'

NO_REGISTER_OS_SOURCE_HEADER = 'NoRegisterOsSourceHeader'

NO_REGISTER_OS_TRIGGER_HEADER = 'NoRegisterOsTriggerHeader'

NAVIGATION_REGISTRATION_UNIQUE_SCOPE_ALREADY_SET = 'NavigationRegistrationUniqueScopeAlreadySet'

class SharedDictionaryError(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

USE_ERROR_CROSS_ORIGIN_NO_CORS_REQUEST = 'UseErrorCrossOriginNoCorsRequest'

USE_ERROR_DICTIONARY_LOAD_FAILURE = 'UseErrorDictionaryLoadFailure'

USE_ERROR_MATCHING_DICTIONARY_NOT_USED = 'UseErrorMatchingDictionaryNotUsed'

USE_ERROR_UNEXPECTED_CONTENT_DICTIONARY_HEADER = 'UseErrorUnexpectedContentDictionaryHeader'

WRITE_ERROR_COSS_ORIGIN_NO_CORS_REQUEST = 'WriteErrorCossOriginNoCorsRequest'

WRITE_ERROR_DISALLOWED_BY_SETTINGS = 'WriteErrorDisallowedBySettings'

WRITE_ERROR_EXPIRED_RESPONSE = 'WriteErrorExpiredResponse'

WRITE_ERROR_FEATURE_DISABLED = 'WriteErrorFeatureDisabled'

WRITE_ERROR_INSUFFICIENT_RESOURCES = 'WriteErrorInsufficientResources'

WRITE_ERROR_INVALID_MATCH_FIELD = 'WriteErrorInvalidMatchField'

WRITE_ERROR_INVALID_STRUCTURED_HEADER = 'WriteErrorInvalidStructuredHeader'

WRITE_ERROR_NAVIGATION_REQUEST = 'WriteErrorNavigationRequest'

WRITE_ERROR_NO_MATCH_FIELD = 'WriteErrorNoMatchField'

WRITE_ERROR_NON_LIST_MATCH_DEST_FIELD = 'WriteErrorNonListMatchDestField'

WRITE_ERROR_NON_SECURE_CONTEXT = 'WriteErrorNonSecureContext'

WRITE_ERROR_NON_STRING_ID_FIELD = 'WriteErrorNonStringIdField'

WRITE_ERROR_NON_STRING_IN_MATCH_DEST_LIST = 'WriteErrorNonStringInMatchDestList'

WRITE_ERROR_NON_STRING_MATCH_FIELD = 'WriteErrorNonStringMatchField'

WRITE_ERROR_NON_TOKEN_TYPE_FIELD = 'WriteErrorNonTokenTypeField'

WRITE_ERROR_REQUEST_ABORTED = 'WriteErrorRequestAborted'

WRITE_ERROR_SHUTTING_DOWN = 'WriteErrorShuttingDown'

WRITE_ERROR_TOO_LONG_ID_FIELD = 'WriteErrorTooLongIdField'

WRITE_ERROR_UNSUPPORTED_TYPE = 'WriteErrorUnsupportedType'

class SRIMessageSignatureError(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

MISSING_SIGNATURE_HEADER = 'MissingSignatureHeader'

MISSING_SIGNATURE_INPUT_HEADER = 'MissingSignatureInputHeader'

INVALID_SIGNATURE_HEADER = 'InvalidSignatureHeader'

INVALID_SIGNATURE_INPUT_HEADER = 'InvalidSignatureInputHeader'

SIGNATURE_HEADER_VALUE_IS_NOT_BYTE_SEQUENCE = 'SignatureHeaderValueIsNotByteSequence'

SIGNATURE_HEADER_VALUE_IS_PARAMETERIZED = 'SignatureHeaderValueIsParameterized'

SIGNATURE_HEADER_VALUE_IS_INCORRECT_LENGTH = 'SignatureHeaderValueIsIncorrectLength'

SIGNATURE_INPUT_HEADER_MISSING_LABEL = 'SignatureInputHeaderMissingLabel'

SIGNATURE_INPUT_HEADER_VALUE_NOT_INNER_LIST = 'SignatureInputHeaderValueNotInnerList'

SIGNATURE_INPUT_HEADER_VALUE_MISSING_COMPONENTS = 'SignatureInputHeaderValueMissingComponents'

SIGNATURE_INPUT_HEADER_INVALID_COMPONENT_TYPE = 'SignatureInputHeaderInvalidComponentType'

SIGNATURE_INPUT_HEADER_INVALID_COMPONENT_NAME = 'SignatureInputHeaderInvalidComponentName'

SIGNATURE_INPUT_HEADER_INVALID_HEADER_COMPONENT_PARAMETER = 'SignatureInputHeaderInvalidHeaderComponentParameter'

SIGNATURE_INPUT_HEADER_INVALID_DERIVED_COMPONENT_PARAMETER = 'SignatureInputHeaderInvalidDerivedComponentParameter'

SIGNATURE_INPUT_HEADER_KEY_ID_LENGTH = 'SignatureInputHeaderKeyIdLength'

SIGNATURE_INPUT_HEADER_INVALID_PARAMETER = 'SignatureInputHeaderInvalidParameter'

SIGNATURE_INPUT_HEADER_MISSING_REQUIRED_PARAMETERS = 'SignatureInputHeaderMissingRequiredParameters'

VALIDATION_FAILED_SIGNATURE_EXPIRED = 'ValidationFailedSignatureExpired'

VALIDATION_FAILED_INVALID_LENGTH = 'ValidationFailedInvalidLength'

VALIDATION_FAILED_SIGNATURE_MISMATCH = 'ValidationFailedSignatureMismatch'

VALIDATION_FAILED_INTEGRITY_MISMATCH = 'ValidationFailedIntegrityMismatch'

class UnencodedDigestError(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

MALFORMED_DICTIONARY = 'MalformedDictionary'

UNKNOWN_ALGORITHM = 'UnknownAlgorithm'

INCORRECT_DIGEST_TYPE = 'IncorrectDigestType'

INCORRECT_DIGEST_LENGTH = 'IncorrectDigestLength'

class AttributionReportingIssueDetails(violation_type, request=None, violating_node_id=None, invalid_parameter=None)

Details for issues around “Attribution Reporting API” usage. Explainer: https://github.com/WICG/attribution-reporting-api

violation_type: AttributionReportingIssueType

request: Optional[AffectedRequest] = None

violating_node_id: Optional[BackendNodeId] = None

invalid_parameter: Optional[str] = None

class QuirksModeIssueDetails(is_limited_quirks_mode, document_node_id, url, frame_id, loader_id)

Details for issues about documents in Quirks Mode or Limited Quirks Mode that affects page layouting.

is_limited_quirks_mode: bool

If false, it means the document’s mode is “quirks” instead of “limited-quirks”.

document_node_id: BackendNodeId

url: str

frame_id: FrameId

loader_id: LoaderId

class NavigatorUserAgentIssueDetails(url, location=None)

url: str

location: Optional[SourceCodeLocation] = None

class SharedDictionaryIssueDetails(shared_dictionary_error, request)

shared_dictionary_error: SharedDictionaryError

request: AffectedRequest

class SRIMessageSignatureIssueDetails(error, signature_base, integrity_assertions, request)

error: SRIMessageSignatureError

signature_base: str

integrity_assertions: List[str]

request: AffectedRequest

class UnencodedDigestIssueDetails(error, request)

error: UnencodedDigestError

request: AffectedRequest

class GenericIssueErrorType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

FORM_LABEL_FOR_NAME_ERROR = 'FormLabelForNameError'

FORM_DUPLICATE_ID_FOR_INPUT_ERROR = 'FormDuplicateIdForInputError'

FORM_INPUT_WITH_NO_LABEL_ERROR = 'FormInputWithNoLabelError'

FORM_AUTOCOMPLETE_ATTRIBUTE_EMPTY_ERROR = 'FormAutocompleteAttributeEmptyError'

FORM_EMPTY_ID_AND_NAME_ATTRIBUTES_FOR_INPUT_ERROR = 'FormEmptyIdAndNameAttributesForInputError'

FORM_ARIA_LABELLED_BY_TO_NON_EXISTING_ID = 'FormAriaLabelledByToNonExistingId'

FORM_INPUT_ASSIGNED_AUTOCOMPLETE_VALUE_TO_ID_OR_NAME_ATTRIBUTE_ERROR = 'FormInputAssignedAutocompleteValueToIdOrNameAttributeError'

FORM_LABEL_HAS_NEITHER_FOR_NOR_NESTED_INPUT = 'FormLabelHasNeitherForNorNestedInput'

FORM_LABEL_FOR_MATCHES_NON_EXISTING_ID_ERROR = 'FormLabelForMatchesNonExistingIdError'

FORM_INPUT_HAS_WRONG_BUT_WELL_INTENDED_AUTOCOMPLETE_VALUE_ERROR = 'FormInputHasWrongButWellIntendedAutocompleteValueError'

RESPONSE_WAS_BLOCKED_BY_ORB = 'ResponseWasBlockedByORB'

class GenericIssueDetails(error_type, frame_id=None, violating_node_id=None, violating_node_attribute=None, request=None)

Depending on the concrete errorType, different properties are set.

error_type: GenericIssueErrorType

Issues with the same errorType are aggregated in the frontend.

frame_id: Optional[FrameId] = None

violating_node_id: Optional[BackendNodeId] = None

violating_node_attribute: Optional[str] = None

request: Optional[AffectedRequest] = None

class DeprecationIssueDetails(source_code_location, type_, affected_frame=None)

This issue tracks information needed to print a deprecation message. https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md

source_code_location: SourceCodeLocation

type_: str

One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5

affected_frame: Optional[AffectedFrame] = None

class BounceTrackingIssueDetails(tracking_sites)

This issue warns about sites in the redirect chain of a finished navigation that may be flagged as trackers and have their state cleared if they don’t receive a user interaction. Note that in this context ‘site’ means eTLD+1. For example, if the URL https://example.test:80/bounce was in the redirect chain, the site reported would be example.test.

tracking_sites: List[str]

class CookieDeprecationMetadataIssueDetails(allowed_sites, opt_out_percentage, is_opt_out_top_level, operation)

This issue warns about third-party sites that are accessing cookies on the current page, and have been permitted due to having a global metadata grant. Note that in this context ‘site’ means eTLD+1. For example, if the URL https://example.test:80/web_page was accessing cookies, the site reported would be example.test.

allowed_sites: List[str]

opt_out_percentage: float

is_opt_out_top_level: bool

operation: CookieOperation

class ClientHintIssueReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

META_TAG_ALLOW_LIST_INVALID_ORIGIN = 'MetaTagAllowListInvalidOrigin'

META_TAG_MODIFIED_HTML = 'MetaTagModifiedHTML'

class FederatedAuthRequestIssueDetails(federated_auth_request_issue_reason)

federated_auth_request_issue_reason: FederatedAuthRequestIssueReason

class FederatedAuthRequestIssueReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Represents the failure reason when a federated authentication reason fails. Should be updated alongside RequestIdTokenStatus in third_party/blink/public/mojom/devtools/inspector_issue.mojom to include all cases except for success.

SHOULD_EMBARGO = 'ShouldEmbargo'

TOO_MANY_REQUESTS = 'TooManyRequests'

WELL_KNOWN_HTTP_NOT_FOUND = 'WellKnownHttpNotFound'

WELL_KNOWN_NO_RESPONSE = 'WellKnownNoResponse'

WELL_KNOWN_INVALID_RESPONSE = 'WellKnownInvalidResponse'

WELL_KNOWN_LIST_EMPTY = 'WellKnownListEmpty'

WELL_KNOWN_INVALID_CONTENT_TYPE = 'WellKnownInvalidContentType'

CONFIG_NOT_IN_WELL_KNOWN = 'ConfigNotInWellKnown'

WELL_KNOWN_TOO_BIG = 'WellKnownTooBig'

CONFIG_HTTP_NOT_FOUND = 'ConfigHttpNotFound'

CONFIG_NO_RESPONSE = 'ConfigNoResponse'

CONFIG_INVALID_RESPONSE = 'ConfigInvalidResponse'

CONFIG_INVALID_CONTENT_TYPE = 'ConfigInvalidContentType'

CLIENT_METADATA_HTTP_NOT_FOUND = 'ClientMetadataHttpNotFound'

CLIENT_METADATA_NO_RESPONSE = 'ClientMetadataNoResponse'

CLIENT_METADATA_INVALID_RESPONSE = 'ClientMetadataInvalidResponse'

CLIENT_METADATA_INVALID_CONTENT_TYPE = 'ClientMetadataInvalidContentType'

IDP_NOT_POTENTIALLY_TRUSTWORTHY = 'IdpNotPotentiallyTrustworthy'

DISABLED_IN_SETTINGS = 'DisabledInSettings'

DISABLED_IN_FLAGS = 'DisabledInFlags'

ERROR_FETCHING_SIGNIN = 'ErrorFetchingSignin'

INVALID_SIGNIN_RESPONSE = 'InvalidSigninResponse'

ACCOUNTS_HTTP_NOT_FOUND = 'AccountsHttpNotFound'

ACCOUNTS_NO_RESPONSE = 'AccountsNoResponse'

ACCOUNTS_INVALID_RESPONSE = 'AccountsInvalidResponse'

ACCOUNTS_LIST_EMPTY = 'AccountsListEmpty'

ACCOUNTS_INVALID_CONTENT_TYPE = 'AccountsInvalidContentType'

ID_TOKEN_HTTP_NOT_FOUND = 'IdTokenHttpNotFound'

ID_TOKEN_NO_RESPONSE = 'IdTokenNoResponse'

ID_TOKEN_INVALID_RESPONSE = 'IdTokenInvalidResponse'

ID_TOKEN_IDP_ERROR_RESPONSE = 'IdTokenIdpErrorResponse'

ID_TOKEN_CROSS_SITE_IDP_ERROR_RESPONSE = 'IdTokenCrossSiteIdpErrorResponse'

ID_TOKEN_INVALID_REQUEST = 'IdTokenInvalidRequest'

ID_TOKEN_INVALID_CONTENT_TYPE = 'IdTokenInvalidContentType'

ERROR_ID_TOKEN = 'ErrorIdToken'

CANCELED = 'Canceled'

RP_PAGE_NOT_VISIBLE = 'RpPageNotVisible'

SILENT_MEDIATION_FAILURE = 'SilentMediationFailure'

THIRD_PARTY_COOKIES_BLOCKED = 'ThirdPartyCookiesBlocked'

NOT_SIGNED_IN_WITH_IDP = 'NotSignedInWithIdp'

MISSING_TRANSIENT_USER_ACTIVATION = 'MissingTransientUserActivation'

REPLACED_BY_ACTIVE_MODE = 'ReplacedByActiveMode'

INVALID_FIELDS_SPECIFIED = 'InvalidFieldsSpecified'

RELYING_PARTY_ORIGIN_IS_OPAQUE = 'RelyingPartyOriginIsOpaque'

TYPE_NOT_MATCHING = 'TypeNotMatching'

UI_DISMISSED_NO_EMBARGO = 'UiDismissedNoEmbargo'

CORS_ERROR = 'CorsError'

SUPPRESSED_BY_SEGMENTATION_PLATFORM = 'SuppressedBySegmentationPlatform'

class FederatedAuthUserInfoRequestIssueDetails(federated_auth_user_info_request_issue_reason)

federated_auth_user_info_request_issue_reason: FederatedAuthUserInfoRequestIssueReason

class FederatedAuthUserInfoRequestIssueReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Represents the failure reason when a getUserInfo() call fails. Should be updated alongside FederatedAuthUserInfoRequestResult in third_party/blink/public/mojom/devtools/inspector_issue.mojom.

NOT_SAME_ORIGIN = 'NotSameOrigin'

NOT_IFRAME = 'NotIframe'

NOT_POTENTIALLY_TRUSTWORTHY = 'NotPotentiallyTrustworthy'

NO_API_PERMISSION = 'NoApiPermission'

NOT_SIGNED_IN_WITH_IDP = 'NotSignedInWithIdp'

NO_ACCOUNT_SHARING_PERMISSION = 'NoAccountSharingPermission'

INVALID_CONFIG_OR_WELL_KNOWN = 'InvalidConfigOrWellKnown'

INVALID_ACCOUNTS_RESPONSE = 'InvalidAccountsResponse'

NO_RETURNING_USER_FROM_FETCHED_ACCOUNTS = 'NoReturningUserFromFetchedAccounts'

class ClientHintIssueDetails(source_code_location, client_hint_issue_reason)

This issue tracks client hints related issues. It’s used to deprecate old features, encourage the use of new ones, and provide general guidance.

source_code_location: SourceCodeLocation

client_hint_issue_reason: ClientHintIssueReason

class FailedRequestInfo(url, failure_message, request_id=None)

url: str

The URL that failed to load.

failure_message: str

The failure message for the failed request.

request_id: Optional[RequestId] = None

class PartitioningBlobURLInfo(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

BLOCKED_CROSS_PARTITION_FETCHING = 'BlockedCrossPartitionFetching'

ENFORCE_NOOPENER_FOR_NAVIGATION = 'EnforceNoopenerForNavigation'

class PartitioningBlobURLIssueDetails(url, partitioning_blob_url_info)

url: str

The BlobURL that failed to load.

partitioning_blob_url_info: PartitioningBlobURLInfo

Additional information about the Partitioning Blob URL issue.

class ElementAccessibilityIssueReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

DISALLOWED_SELECT_CHILD = 'DisallowedSelectChild'

DISALLOWED_OPT_GROUP_CHILD = 'DisallowedOptGroupChild'

NON_PHRASING_CONTENT_OPTION_CHILD = 'NonPhrasingContentOptionChild'

INTERACTIVE_CONTENT_OPTION_CHILD = 'InteractiveContentOptionChild'

INTERACTIVE_CONTENT_LEGEND_CHILD = 'InteractiveContentLegendChild'

INTERACTIVE_CONTENT_SUMMARY_DESCENDANT = 'InteractiveContentSummaryDescendant'

class ElementAccessibilityIssueDetails(node_id, element_accessibility_issue_reason, has_disallowed_attributes)

This issue warns about errors in the select or summary element content model.

node_id: BackendNodeId

element_accessibility_issue_reason: ElementAccessibilityIssueReason

has_disallowed_attributes: bool

class StyleSheetLoadingIssueReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

LATE_IMPORT_RULE = 'LateImportRule'

REQUEST_FAILED = 'RequestFailed'

class StylesheetLoadingIssueDetails(source_code_location, style_sheet_loading_issue_reason, failed_request_info=None)

This issue warns when a referenced stylesheet couldn’t be loaded.

source_code_location: SourceCodeLocation

Source code position that referenced the failing stylesheet.

style_sheet_loading_issue_reason: StyleSheetLoadingIssueReason

Reason why the stylesheet couldn’t be loaded.

failed_request_info: Optional[FailedRequestInfo] = None

Contains additional info when the failure was due to a request.

class PropertyRuleIssueReason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

INVALID_SYNTAX = 'InvalidSyntax'

INVALID_INITIAL_VALUE = 'InvalidInitialValue'

INVALID_INHERITS = 'InvalidInherits'

INVALID_NAME = 'InvalidName'

class PropertyRuleIssueDetails(source_code_location, property_rule_issue_reason, property_value=None)

This issue warns about errors in property rules that lead to property registrations being ignored.

source_code_location: SourceCodeLocation

Source code position of the property rule.

property_rule_issue_reason: PropertyRuleIssueReason

Reason why the property rule was discarded.

property_value: Optional[str] = None

The value of the property rule property that failed to parse

class UserReidentificationIssueType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

BLOCKED_FRAME_NAVIGATION = 'BlockedFrameNavigation'

BLOCKED_SUBRESOURCE = 'BlockedSubresource'

NOISED_CANVAS_READBACK = 'NoisedCanvasReadback'

class UserReidentificationIssueDetails(type_, request=None, source_code_location=None)

This issue warns about uses of APIs that may be considered misuse to re-identify users.

type_: UserReidentificationIssueType

request: Optional[AffectedRequest] = None

Applies to BlockedFrameNavigation and BlockedSubresource issue types.

source_code_location: Optional[SourceCodeLocation] = None

Applies to NoisedCanvasReadback issue type.

class InspectorIssueCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

A unique identifier for the type of issue. Each type may use one of the optional fields in InspectorIssueDetails to convey more specific information about the kind of issue.

COOKIE_ISSUE = 'CookieIssue'

MIXED_CONTENT_ISSUE = 'MixedContentIssue'

BLOCKED_BY_RESPONSE_ISSUE = 'BlockedByResponseIssue'

HEAVY_AD_ISSUE = 'HeavyAdIssue'

CONTENT_SECURITY_POLICY_ISSUE = 'ContentSecurityPolicyIssue'

SHARED_ARRAY_BUFFER_ISSUE = 'SharedArrayBufferIssue'

LOW_TEXT_CONTRAST_ISSUE = 'LowTextContrastIssue'

CORS_ISSUE = 'CorsIssue'

ATTRIBUTION_REPORTING_ISSUE = 'AttributionReportingIssue'

QUIRKS_MODE_ISSUE = 'QuirksModeIssue'

PARTITIONING_BLOB_URL_ISSUE = 'PartitioningBlobURLIssue'

NAVIGATOR_USER_AGENT_ISSUE = 'NavigatorUserAgentIssue'

GENERIC_ISSUE = 'GenericIssue'

DEPRECATION_ISSUE = 'DeprecationIssue'

CLIENT_HINT_ISSUE = 'ClientHintIssue'

FEDERATED_AUTH_REQUEST_ISSUE = 'FederatedAuthRequestIssue'

BOUNCE_TRACKING_ISSUE = 'BounceTrackingIssue'

COOKIE_DEPRECATION_METADATA_ISSUE = 'CookieDeprecationMetadataIssue'

STYLESHEET_LOADING_ISSUE = 'StylesheetLoadingIssue'

FEDERATED_AUTH_USER_INFO_REQUEST_ISSUE = 'FederatedAuthUserInfoRequestIssue'

PROPERTY_RULE_ISSUE = 'PropertyRuleIssue'

SHARED_DICTIONARY_ISSUE = 'SharedDictionaryIssue'

ELEMENT_ACCESSIBILITY_ISSUE = 'ElementAccessibilityIssue'

SRI_MESSAGE_SIGNATURE_ISSUE = 'SRIMessageSignatureIssue'

UNENCODED_DIGEST_ISSUE = 'UnencodedDigestIssue'

USER_REIDENTIFICATION_ISSUE = 'UserReidentificationIssue'

class InspectorIssueDetails(cookie_issue_details=None, mixed_content_issue_details=None, blocked_by_response_issue_details=None, heavy_ad_issue_details=None, content_security_policy_issue_details=None, shared_array_buffer_issue_details=None, low_text_contrast_issue_details=None, cors_issue_details=None, attribution_reporting_issue_details=None, quirks_mode_issue_details=None, partitioning_blob_url_issue_details=None, navigator_user_agent_issue_details=None, generic_issue_details=None, deprecation_issue_details=None, client_hint_issue_details=None, federated_auth_request_issue_details=None, bounce_tracking_issue_details=None, cookie_deprecation_metadata_issue_details=None, stylesheet_loading_issue_details=None, property_rule_issue_details=None, federated_auth_user_info_request_issue_details=None, shared_dictionary_issue_details=None, element_accessibility_issue_details=None, sri_message_signature_issue_details=None, unencoded_digest_issue_details=None, user_reidentification_issue_details=None)

This struct holds a list of optional fields with additional information specific to the kind of issue. When adding a new issue code, please also add a new optional field to this type.

cookie_issue_details: Optional[CookieIssueDetails] = None

mixed_content_issue_details: Optional[MixedContentIssueDetails] = None

blocked_by_response_issue_details: Optional[BlockedByResponseIssueDetails] = None

heavy_ad_issue_details: Optional[HeavyAdIssueDetails] = None

content_security_policy_issue_details: Optional[ContentSecurityPolicyIssueDetails] = None

shared_array_buffer_issue_details: Optional[SharedArrayBufferIssueDetails] = None

low_text_contrast_issue_details: Optional[LowTextContrastIssueDetails] = None

cors_issue_details: Optional[CorsIssueDetails] = None

attribution_reporting_issue_details: Optional[AttributionReportingIssueDetails] = None

quirks_mode_issue_details: Optional[QuirksModeIssueDetails] = None

partitioning_blob_url_issue_details: Optional[PartitioningBlobURLIssueDetails] = None

navigator_user_agent_issue_details: Optional[NavigatorUserAgentIssueDetails] = None

generic_issue_details: Optional[GenericIssueDetails] = None

deprecation_issue_details: Optional[DeprecationIssueDetails] = None

client_hint_issue_details: Optional[ClientHintIssueDetails] = None

federated_auth_request_issue_details: Optional[FederatedAuthRequestIssueDetails] = None

bounce_tracking_issue_details: Optional[BounceTrackingIssueDetails] = None

cookie_deprecation_metadata_issue_details: Optional[CookieDeprecationMetadataIssueDetails] = None

stylesheet_loading_issue_details: Optional[StylesheetLoadingIssueDetails] = None

property_rule_issue_details: Optional[PropertyRuleIssueDetails] = None

federated_auth_user_info_request_issue_details: Optional[FederatedAuthUserInfoRequestIssueDetails] = None

shared_dictionary_issue_details: Optional[SharedDictionaryIssueDetails] = None

element_accessibility_issue_details: Optional[ElementAccessibilityIssueDetails] = None

sri_message_signature_issue_details: Optional[SRIMessageSignatureIssueDetails] = None

unencoded_digest_issue_details: Optional[UnencodedDigestIssueDetails] = None

user_reidentification_issue_details: Optional[UserReidentificationIssueDetails] = None

class IssueId

A unique id for a DevTools inspector issue. Allows other entities (e.g. exceptions, CDP message, console messages, etc.) to reference an issue.

class InspectorIssue(code, details, issue_id=None)

An inspector issue reported from the back-end.

code: InspectorIssueCode

details: InspectorIssueDetails

issue_id: Optional[IssueId] = None

A unique id for this issue. May be omitted if no other entity (e.g. exception, CDP message, etc.) is referencing this issue.

Commands

Each command is a generator function. The return type Generator[x, y, z] indicates that the generator yields arguments of type x, it must be resumed with an argument of type y, and it returns type z. In this library, types x and y are the same for all commands, and z is the return type you should pay attention to. For more information, see Getting Started: Commands.

check_contrast(report_aaa=None)

Runs the contrast check for the target page. Found issues are reported using Audits.issueAdded event.

Parameters:

report_aaa (Optional[bool]) – (Optional) Whether to report WCAG AAA level issues. Default is false.

Return type:

Generator[Dict[str, Any], Dict[str, Any], None]

check_forms_issues()

Runs the form issues check for the target page. Found issues are reported using Audits.issueAdded event.

Return type:

Generator[Dict[str, Any], Dict[str, Any], List[GenericIssueDetails]]

Returns:

disable()

Disables issues domain, prevents further issues from being reported to the client.

Return type:

Generator[Dict[str, Any], Dict[str, Any], None]

enable()

Enables issues domain, sends the issues collected so far to the client by means of the issueAdded event.

Return type:

Generator[Dict[str, Any], Dict[str, Any], None]

get_encoded_response(request_id, encoding, quality=None, size_only=None)

Returns the response body and size if it were re-encoded with the specified settings. Only applies to images.

Parameters:

• request_id (RequestId) – Identifier of the network request to get content for.

• encoding (str) – The encoding to use.

• quality (Optional[float]) – (Optional) The quality of the encoding (0-1). (defaults to 1)

• size_only (Optional[bool]) – (Optional) Whether to only return the size information (defaults to false).

Return type:

Generator[Dict[str, Any], Dict[str, Any], Tuple[Optional[str], int, int]]

Returns:

A tuple with the following items:

0. body - (Optional) The encoded body as a base64 string. Omitted if sizeOnly is true. (Encoded as a base64 string when passed over JSON)

1. originalSize - Size before re-encoding.

2. encodedSize - Size after re-encoding.

Events

Generally, you do not need to instantiate CDP events yourself. Instead, the API creates events for you and then you use the event’s attributes.

class IssueAdded(issue)

issue: InspectorIssue