class QWebEngineProfile#

QWebEngineProfile 类提供了多个页面共享的网络引擎配置。 更多…

Inheritance diagram of PySide6.QtWebEngineCore.QWebEngineProfile

摘要#

方法#

信号#

静态函数#

注意

本文档可能包含从C++自动翻译到Python的片段。我们始终欢迎对片段翻译的贡献。如果您发现翻译中的问题，您也可以通过在https:/bugreports.qt.io/projects/PYSIDE上创建工单来通知我们

详细说明#

Web引擎配置文件包含设置、脚本、持久性Cookies策略以及属于配置文件的所有Web引擎页面共享的已访问链接列表。

属于配置文件的所有页面共享一个共同的QWebEngineSettings实例，可以通过settings()方法访问。同样，scripts()方法提供了到共同的QWebEngineScriptCollection实例的访问。

已访问链接的信息与持久性Cookies和其他持久性数据一起存储在storageName()返回的存储中。持久性数据存储在通过调用setPersistentStoragePath()设置的子目录中，缓存位于通过调用setCachePath()设置的子目录中。缓存类型可以通过调用setHttpCacheType()设置为内存中或在磁盘上。如果仅设置了存储名称，则会自动创建子目录并命名。如果手动设置了任何值，应在创建属于配置文件的任何页面之前进行。

可以通过调用clearVisitedLinks()或clearAllVisitedLinks()清除缓存中的链接。PersistentCookiesPolicy描述了会话和持久性Cookies是否保存到内存或磁盘并从内存或磁盘恢复。

class HttpCacheType#

常量

描述

QWebEngineProfile.MemoryHttpCache

QWebEngineProfile.DiskHttpCache

QWebEngineProfile.NoCache

禁用内存和磁盘缓存。（自Qt 5.7版本新增）
class PersistentCookiesPolicy#

此枚举描述了cookie持久性的策略

常量

描述

QWebEngineProfile.NoPersistentCookies

会话和持久cookie都存储在内存中。如果设置了off-the-record或没有可用的持久数据路径，这将是最可能的设置。

QWebEngineProfile.AllowPersistentCookies

标记为持久的cookie会被保存到磁盘恢复，而会话cookie只存储在磁盘上以供崩溃恢复。这是默认设置。

QWebEngineProfile.ForcePersistentCookies

会话和持久cookie都保存到磁盘并从磁盘恢复。
__init__(name[, parent=None])#
参数：

  • name – 字符串

  • parent – QObject

使用存储名称 storageName 和父对象 parent 创建一个新的配置。

存储名称必须是唯一的。

基于磁盘的 QWebEngineProfile 应在应用程序退出前或退出时销毁，否则缓存和持久数据可能不会完全刷新到磁盘。

另请参阅

storageName()

__init__([parent=None])
参数：

parent – QObject

使用父对象 parent 创建一个新的无记录配置。

无记录配置在本地计算机上不留下记录，没有持久数据或缓存。因此，HTTP缓存只能存在于内存中，cookie只能是持久的。尝试更改这些设置将不会产生效果。

另请参阅

isOffTheRecord()

cachePath()#
返回类型：:

字符串

返回用于缓存的路由。

默认情况下，这位于QtWebengine/StorageName特定子目录下的StandardPaths::CacheLocation。

注意

使用QStandardPaths::writableLocation(QStandardPaths::CacheLocation) 获取QStandardPaths::CacheLocation路径。

另请参阅

setCachePath() storageName() writableLocation()

清除访问链接数据库中的所有链接。

另请参阅

clearVisitedLinks()

clearHttpCache()#

移除配置文件的缓存条目。

注意

确保在清空操作进行时，不要在配置文件上开始新的导航或进行任何操作。《清除缓存完成》信号将通知操作完成。

另请参阅

clearHttpCacheCompleted()

clearHttpCacheCompleted()#

当《清除缓存》操作完成时，将发射此信号。

另请参阅

clearHttpCache()

参数：

urls - QUrl 列表

从访问过的链接数据库中清除 urls 中的链接。

另请参阅

clearAllVisitedLinks()

cookieStore()#
返回类型：:

QWebEngineCookieStore

返回此配置文件的 cookie 存储库。

静态 defaultProfile()#
返回类型：:

QWebEngineProfile

返回默认配置文件。

默认配置文件是无记录的。

另请参阅

storageName()

downloadPath()#
返回类型：:

字符串

已下载文件的存储位置的路径。

注意

默认情况下，下载路径为 QStandardPaths::DownloadLocation。

另请参阅

setDownloadPath() writableLocation()

downloadRequested(download)#
参数：

download - QWebEngineDownloadRequest

每当有下载被触发时，都会发射此信号。参数 download 包含下载状态。下载必须通过 accept() 明确接受或默认取消。下载项是以配置文件为主体的。如果未接受，将在信号发射后立即删除。此信号不得与排队连接一起使用。

httpAcceptLanguage()#
返回类型：:

字符串

返回HTTP请求头字段Accept-Language的值。

httpCacheMaximumSize()#
返回类型：:

int

返回HTTP缓存的最大大小（字节数）。

如果大小由QtWebEngine 自动控制，则返回 0。

httpCacheType()#
返回类型：:

HttpCacheType

返回所使用的HTTP缓存类型。

如果配置为离线存储，则返回MemoryHttpCache。

httpUserAgent()#
返回类型：:

字符串

返回与HTTP一起发送的标识浏览器的用户代理字符串。

注意

在Windows 8.1及更高版本中，除非应用程序包含声明支持较新Windows版本的清单，否则默认用户代理总是报告“Windows NT 6.2”（Windows 8）。

另请参阅

setHttpUserAgent() Windows应用程序清单

installUrlSchemeHandler(scheme, arg__2)#
参数：

在配置中注册处理器 handler 以处理自定义URL方案 scheme。

应用程序启动时，需要先使用 registerScheme 注册方案。

isOffTheRecord()#
返回类型：:

bool

如果这是一个无记录的配置文件，不会在计算机上留下记录，则返回 true。

这将强制将 cookies 和 HTTP 缓存保存在内存中，但也将所有其他通常持久数据强制存储在内存中。

isPushServiceEnabled()#
返回类型：:

bool

如果启用推送消息服务，则返回 true。

注意

默认情况下，推送消息服务是禁用的。

另请参阅

setPushServiceEnabled()

isSpellCheckEnabled()#
返回类型：:

bool

如果启用拼写检查器，则返回 true；否则返回 false。

另请参阅

setSpellCheckEnabled()

persistentCookiesPolicy()#
返回类型：:

PersistentCookiesPolicy

返回当前持久 cookies 的策略。

如果配置文件为无记录模式，返回 NoPersistentCookies。

persistentStoragePath()#
返回类型：:

字符串

返回用于存储浏览器和网络内容持久数据的路径。

持久数据包括持久 cookies、HTML5 本地存储和已访问链接。

默认情况下，此路径位于 QStandardPaths::DataLocation 的 QtWebengine/StorageName 的特定子目录下。

注意

使用 QStandardPaths::writableLocation(QStandardPaths::DataLocation) 获取 QStandardPaths::DataLocation 路径。

另请参阅

setPersistentStoragePath() storageName() writableLocation()

removeAllUrlSchemeHandlers()#

从配置文件中删除所有已安装的自定义 URL 方案处理器。

removeUrlScheme(scheme)#
参数：

schema – QByteArray

从配置文件中删除自定义 URL 方案 scheme。

removeUrlSchemeHandler(arg__1)#
参数：

arg__1 – QWebEngineUrlSchemeHandler

从配置文件中删除自定义 URL 方案处理器 handler。

另请参阅

removeUrlScheme()

scripts()#
返回类型：:

QWebEngineScriptCollection

返回注入到共享此配置文件的所有页面中的脚本集合。

setCachePath(path)#
参数：

path - 字符串

覆盖默认磁盘缓存的路径，将其设置为 path。

如果设置为空字符串，则恢复默认路径。

另请参阅

cachePath()

setDownloadPath(path)#
参数：

path - 字符串

覆盖默认用于下载位置的路径，将其设置为 path。

如果设置为空字符串，则恢复默认路径。

另请参阅

downloadPath()

setHttpAcceptLanguage(httpAcceptLanguage)#
参数：

httpAcceptLanguage - 字符串

将 Accept-Language HTTP 请求头字段的值设置为 httpAcceptLanguage。

另请参阅

httpAcceptLanguage()

setHttpCacheMaximumSize(maxSize)#
参数：

maxSize - 整数

设置 HTTP 缓存的最大大小为 maxSize 字节。

将它设置为 0 表示大小将由 QtWebEngine 自动控制。

setHttpCacheType(arg__1)#
参数：

arg__1 - HttpCacheType

将 HTTP 缓存类型设置为 httpCacheType。

注意

将配置文件中的 httpCacheType 设置为 NoCache，即使配置文件中已经有一些缓存条目，也不会触发这些条目的删除。

另请参阅

httpCacheType() setCachePath() clearHttpCache()

setHttpUserAgent(userAgent)#
参数：

userAgent – str

覆盖默认的用户代理字符串，将其设置为 userAgent。

另请参阅

httpUserAgent()

setNotificationPresenter(notificationPresenter)#
参数：

notificationPresenter – PyCallable

setPersistentCookiesPolicy(arg__1)#
参数：

arg__1 – PersistentCookiesPolicy

将持久cookie的策略设置到 newPersistentCookiesPolicy。

setPersistentStoragePath(path)#
参数：

path - 字符串

覆盖默认的路径，用于存储持久Web引擎数据。

如果 path 设置为空字符串，则恢复默认路径。

setPushServiceEnabled(enabled)#
参数：

enabled – bool

如果 enable 设置为 true，则启用推送消息服务，否则禁用它。

注意

Qt WebEngine 使用 Firebase Cloud Messaging (FCM) 作为浏览器推送服务。因此，所有推送消息都将通过Google推送服务及其相应服务器。

另请参阅

isPushServiceEnabled()

setSpellCheckEnabled(enabled)#
参数：

enabled – bool

如果 enable 设置为 true，则启用拼写检查器，否则禁用。

另请参阅

isSpellCheckEnabled()

setSpellCheckLanguages(languages)#
参数：

languages – 字符串列表

设置用于拼写检查的当前语言列表。每种语言应匹配 .bdic 字典的名称。例如，语言 en-US 将加载 en-US.bdic 字典文件。

有关字典文件搜索方式的详细信息，请参阅拼写检查功能文档。

有关编译 .bdic 字典的更多信息，请参阅拼写检查示例。

另请参阅

spellCheckLanguages()

setUrlRequestInterceptor(interceptor)#
参数：

interceptor – QWebEngineUrlRequestInterceptor

注册一个请求拦截器单例 interceptor 以拦截 URL 请求。

配置文件不会接管指针。

settings()#
返回类型：:

QWebEngineSettings

返回此配置文件中所有页面的默认设置。

spellCheckLanguages()#
返回类型：:

字符串列表

返回拼写检查器使用的语言列表。

storageName()#
返回类型：:

字符串

返回配置文件的存储名称。

存储名称用于为使用磁盘的每个配置文件提供持久数据缓存和缓存的单独子目录。

urlSchemeHandler(arg__1)#
参数：

arg__1 – QByteArray

返回类型：:

QWebEngineUrlSchemeHandler

返回为 URL 方案 scheme 注册的自定义 URL 方案处理器。

visitedLinksContainsUrl(url)#
参数：

url – QUrl

返回类型：:

bool

如果此配置文件认为 url 是已访问的链接，则返回 true。