class QWebEngineProfile#

The QWebEngineProfile class provides a web engine profile shared by multiple pages. More…

Synopsis#

Methods#

def __init__()
def cachePath()
def clearAllVisitedLinks()
def clearHttpCache()
def clearVisitedLinks()
def cookieStore()
def downloadPath()
def httpAcceptLanguage()
def httpCacheMaximumSize()
def httpCacheType()
def httpUserAgent()
def installUrlSchemeHandler()
def isOffTheRecord()
def isPushServiceEnabled()
def isSpellCheckEnabled()
def persistentCookiesPolicy()
def persistentStoragePath()
def removeAllUrlSchemeHandlers()
def removeUrlScheme()
def removeUrlSchemeHandler()
def scripts()
def setCachePath()
def setDownloadPath()
def setHttpAcceptLanguage()
def setHttpCacheMaximumSize()
def setHttpCacheType()
def setHttpUserAgent()
def setNotificationPresenter()
def setPersistentCookiesPolicy()
def setPersistentStoragePath()
def setPushServiceEnabled()
def setSpellCheckEnabled()
def setSpellCheckLanguages()
def setUrlRequestInterceptor()
def settings()
def spellCheckLanguages()
def storageName()
def urlSchemeHandler()
def visitedLinksContainsUrl()

Static functions#

def defaultProfile()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A web engine profile contains settings, scripts, persistent cookie policy, and the list of visited links shared by all web engine pages that belong to the profile.

All pages that belong to the profile share a common QWebEngineSettings instance, which can be accessed with the settings() method. Likewise, the scripts() method provides access to a common QWebEngineScriptCollection instance.

Information about visited links is stored together with persistent cookies and other persistent data in a storage returned by storageName() . Persistent data is stored in a subdirectory set by calling setPersistentStoragePath() , and the cache is located in a subdirectory set by calling setCachePath() . The cache type can be set to in-memory or on-disk by calling setHttpCacheType() . If only the storage name is set, the subdirectories are created and named automatically. If you set any of the values manually, you should do it before creating any pages that belong to the profile.

The cache can be cleared of links by calling clearVisitedLinks() or clearAllVisitedLinks() . PersistentCookiesPolicy describes whether session and persistent cookies are saved to and restored from memory or disk.

Profiles can be used to isolate pages from each other. A typical use case is a dedicated off-the-record profile for a private browsing mode. Using QWebEngineProfile() without defining a storage name constructs a new off-the-record profile that leaves no record on the local machine, and has no persistent data or cache. The isOffTheRecord() method can be used to check whether a profile is off-the-record.

The default profile can be accessed by defaultProfile() . It is a built-in profile that all web pages not specifically created with another profile belong to.

Implementing the QWebEngineUrlRequestInterceptor interface and registering the interceptor on a profile by setUrlRequestInterceptor() enables intercepting, blocking, and modifying URL requests ( QWebEngineUrlRequestInfo ) before they reach the networking stack of Chromium.

A QWebEngineUrlSchemeHandler can be registered for a profile by installUrlSchemeHandler() to add support for custom URL schemes. Requests for the scheme are then issued to requestStarted() as QWebEngineUrlRequestJob objects.

Spellchecking HTML form fields can be enabled per profile by using the setSpellCheckEnabled() method and the current languages used for spellchecking can be set by using the setSpellCheckLanguages() method.

class HttpCacheType#

This enum describes the HTTP cache type:

Constant

Description

QWebEngineProfile.MemoryHttpCache

Use an in-memory cache. This is the default if off-the-record is set.

QWebEngineProfile.DiskHttpCache

Use a disk cache. This is the default if the profile is not off-the-record. If set on an off-the-record profile will instead set MemoryHttpCache.

QWebEngineProfile.NoCache

Disable both in-memory and disk caching. (Added in Qt 5.7)

Constant	Description
QWebEngineProfile.MemoryHttpCache	Use an in-memory cache. This is the default if `off-the-record` is set.
QWebEngineProfile.DiskHttpCache	Use a disk cache. This is the default if the profile is not `off-the-record`. If set on an `off-the-record` profile will instead set `MemoryHttpCache`.
QWebEngineProfile.NoCache	Disable both in-memory and disk caching. (Added in Qt 5.7)

class PersistentCookiesPolicy#

This enum describes policy for cookie persistency:

Constant

Description

QWebEngineProfile.NoPersistentCookies

Both session and persistent cookies are stored in memory. This is the only setting possible if off-the-record is set or no persistent data path is available.

QWebEngineProfile.AllowPersistentCookies

Cookies marked persistent are saved to and restored from disk, whereas session cookies are only stored to disk for crash recovery. This is the default setting.

QWebEngineProfile.ForcePersistentCookies

Both session and persistent cookies are saved to and restored from disk.

Constant	Description
QWebEngineProfile.NoPersistentCookies	Both session and persistent cookies are stored in memory. This is the only setting possible if `off-the-record` is set or no persistent data path is available.
QWebEngineProfile.AllowPersistentCookies	Cookies marked persistent are saved to and restored from disk, whereas session cookies are only stored to disk for crash recovery. This is the default setting.
QWebEngineProfile.ForcePersistentCookies	Both session and persistent cookies are saved to and restored from disk.

__init__(name[, parent=None])#

Parameters:

name – str
parent – QObject

Constructs a new profile with the storage name storageName and parent parent.

The storage name must be unique.

A disk-based QWebEngineProfile should be destroyed on or before application exit, otherwise the cache and persistent data may not be fully flushed to disk.

See also

storageName()

__init__([parent=None])

Parameters:: parent – QObject

Constructs a new off-the-record profile with the parent parent.

An off-the-record profile leaves no record on the local machine, and has no persistent data or cache. Thus, the HTTP cache can only be in memory and the cookies can only be non-persistent. Trying to change these settings will have no effect.

See also

isOffTheRecord()

cachePath()#

Return type:: str

Returns the path used for caches.

By default, this is below StandardPaths::CacheLocation in a QtWebengine/StorageName specific subdirectory.

Note

Use QStandardPaths::writableLocation(QStandardPaths::CacheLocation) to obtain the QStandardPaths::CacheLocation path.

clearAllVisitedLinks()#

Clears all links from the visited links database.

See also

clearVisitedLinks()

clearHttpCache()#

Removes the profile’s cache entries.

Note

Make sure that you do not start new navigation or any operation on the profile while the clear operation is in progress. The clearHttpCacheCompleted() signal notifies about the completion.

See also

clearHttpCacheCompleted()

clearHttpCacheCompleted()#

This signal is emitted when the clearHttpCache() operation is completed.

See also

clearHttpCache()

clearVisitedLinks(urls)#

Parameters:: urls – .list of QUrl

Clears the links in urls from the visited links database.

See also

clearAllVisitedLinks()

cookieStore()#

Return type:: QWebEngineCookieStore

Returns the cookie store for this profile.

static defaultProfile()#

Return type:: QWebEngineProfile

Returns the default profile.

The default profile is off-the-record.

See also

storageName()

downloadPath()#

Return type:: str

The path to the location where the downloaded files are stored.

Note

By default, the download path is QStandardPaths::DownloadLocation.

downloadRequested(download)#

Parameters:: download – QWebEngineDownloadRequest

This signal is emitted whenever a download has been triggered. The download argument holds the state of the download. The download has to be explicitly accepted with accept() or it will be cancelled by default. The download item is parented by the profile. If it is not accepted, it will be deleted immediately after the signal emission. This signal cannot be used with a queued connection.

See also

QWebEngineDownloadRequest download()

httpAcceptLanguage()#

Return type:: str

Returns the value of the Accept-Language HTTP request-header field.

See also

setHttpAcceptLanguage()

httpCacheMaximumSize()#

Return type:: int

Returns the maximum size of the HTTP cache in bytes.

Will return 0 if the size is automatically controlled by QtWebEngine .

See also

setHttpCacheMaximumSize() httpCacheType()

httpCacheType()#

Return type:: HttpCacheType

Returns the type of HTTP cache used.

If the profile is off-the-record, MemoryHttpCache is returned.

See also

setHttpCacheType() cachePath()

httpUserAgent()#

Return type:: str

Returns the user-agent string sent with HTTP to identify the browser.

Note

On Windows 8.1 and newer, the default user agent will always report “Windows NT 6.2” (Windows 8), unless the application does contain a manifest that declares newer Windows versions as supported.

installUrlSchemeHandler(scheme, arg__2)#

Parameters:

scheme – QByteArray
arg__2 – QWebEngineUrlSchemeHandler

Registers a handler handler for custom URL scheme scheme in the profile.

It is necessary to first register the scheme with registerScheme at application startup.

isOffTheRecord()#

Return type:: bool

Returns true if this is an off-the-record profile that leaves no record on the computer.

This will force cookies and HTTP cache to be in memory, but also force all other normally persistent data to be stored in memory.

isPushServiceEnabled()#

Return type:: bool

Returns true if the push messaging service is enabled.

Note

By default the push messaging service is disabled.

See also

setPushServiceEnabled()

isSpellCheckEnabled()#

Return type:: bool

Returns true if the spell checker is enabled; otherwise returns false.

See also

setSpellCheckEnabled()

persistentCookiesPolicy()#

Return type:: PersistentCookiesPolicy

Returns the current policy for persistent cookies.

If the profile is off-the-record, NoPersistentCookies is returned.

See also

setPersistentCookiesPolicy()

persistentStoragePath()#

Return type:: str

Returns the path used to store persistent data for the browser and web content.

Persistent data includes persistent cookies, HTML5 local storage, and visited links.

By default, this is below QStandardPaths::DataLocation in a QtWebengine/StorageName specific subdirectory.

Note

Use QStandardPaths::writableLocation(QStandardPaths::DataLocation) to obtain the QStandardPaths::DataLocation path.

removeAllUrlSchemeHandlers()#

Removes all custom URL scheme handlers installed in the profile.

removeUrlScheme(scheme)#

Parameters:: scheme – QByteArray

Removes the custom URL scheme scheme from the profile.

See also

removeUrlSchemeHandler()

removeUrlSchemeHandler(arg__1)#

Parameters:: arg__1 – QWebEngineUrlSchemeHandler

Removes the custom URL scheme handler handler from the profile.

See also

removeUrlScheme()

scripts()#

Return type:: QWebEngineScriptCollection

Returns the collection of scripts that are injected into all pages that share this profile.

See also

QWebEngineScriptCollection QWebEngineScript scripts() Script Injection

setCachePath(path)#

Parameters:: path – str

Overrides the default path used for disk caches, setting it to path.

If set to the null string, the default path is restored.

See also

cachePath()

setDownloadPath(path)#

Parameters:: path – str

Overrides the default path used for download location, setting it to path.

If set to the null string, the default path is restored.

See also

downloadPath()

setHttpAcceptLanguage(httpAcceptLanguage)#

Parameters:: httpAcceptLanguage – str

Sets the value of the Accept-Language HTTP request-header field to httpAcceptLanguage.

See also

httpAcceptLanguage()

setHttpCacheMaximumSize(maxSize)#

Parameters:: maxSize – int

Sets the maximum size of the HTTP cache to maxSize bytes.

Setting it to 0 means the size will be controlled automatically by QtWebEngine .

See also

httpCacheMaximumSize() setHttpCacheType()

setHttpCacheType(arg__1)#

Parameters:: arg__1 – HttpCacheType

Sets the HTTP cache type to httpCacheType.

Note

Setting the httpCacheType to NoCache on the profile, which has already some cache entries does not trigger the removal of those entries.

setHttpUserAgent(userAgent)#

Parameters:: userAgent – str

Overrides the default user-agent string, setting it to userAgent.

See also

httpUserAgent()

setNotificationPresenter(notificationPresenter)#

Parameters:: notificationPresenter – PyCallable

setPersistentCookiesPolicy(arg__1)#

Parameters:: arg__1 – PersistentCookiesPolicy

Sets the policy for persistent cookies to newPersistentCookiesPolicy.

See also

persistentCookiesPolicy()

setPersistentStoragePath(path)#

Parameters:: path – str

Overrides the default path used to store persistent web engine data.

If path is set to the null string, the default path is restored.

See also

persistentStoragePath()

setPushServiceEnabled(enabled)#

Parameters:: enabled – bool

Enables the push messaging service if enable is true, otherwise disables it.

Note

Qt WebEngine uses Firebase Cloud Messaging (FCM) as a browser push service. Therefore, all push messages will go through the Google push service and its respective servers.

See also

isPushServiceEnabled()

setSpellCheckEnabled(enabled)#

Parameters:: enabled – bool

Enables spell checker if enable is true, otherwise disables it.

See also

isSpellCheckEnabled()

setSpellCheckLanguages(languages)#

Parameters:: languages – list of strings

Sets the current list of languages for the spell checker. Each language should match the name of the .bdic dictionary. For example, the language en-US will load the en-US.bdic dictionary file.

See the Spellchecker feature documentation for how dictionary files are searched.

For more information about how to compile .bdic dictionaries, see the Spellchecker Example .

See also

spellCheckLanguages()

setUrlRequestInterceptor(interceptor)#

Parameters:: interceptor – QWebEngineUrlRequestInterceptor

Registers a request interceptor singleton interceptor to intercept URL requests.

The profile does not take ownership of the pointer.

See also

QWebEngineUrlRequestInfo QWebEngineUrlRequestInterceptor

settings()#

Return type:: QWebEngineSettings

Returns the default settings for all pages in this profile.

spellCheckLanguages()#

Return type:: list of strings

Returns the list of languages used by the spell checker.

See also

setSpellCheckLanguages()

storageName()#

Return type:: str

Returns the storage name for the profile.

The storage name is used to give each profile that uses the disk separate subdirectories for persistent data and cache.

urlSchemeHandler(arg__1)#

Parameters:: arg__1 – QByteArray
Return type:: QWebEngineUrlSchemeHandler

Returns the custom URL scheme handler register for the URL scheme scheme.

visitedLinksContainsUrl(url)#

Parameters:: url – QUrl
Return type:: bool

Returns true if url is considered a visited link by this profile.