PySide6.QtWebEngineCore.QWebEngineExtensionManager¶

class QWebEngineExtensionManager¶

The QWebEngineExtensionManager class allows applications to access Chrome/Firefox extension-compatible interfaces through managed packages.

Details

QWebEngineExtensionManager exposes interfaces compatible with the Chrome/Firefox extension platform, letting applications load or install packages built against that format at runtime.

Loading via loadExtension() is temporary and doesn’t persist across sessions, while installExtension() stores the package in the profile directory so it loads automatically at startup.

Loaded packages can be inspected through extensions() property, which returns a list of QWebEngineExtensionInfo objects, and the manager emits signals when packages are loaded, installed, unloaded, or uninstalled. The installPath() property indicates where installed packages are persisted.

Only the ManifestV3 specification is supported — packages using other manifest versions are rejected outright. This capability is not available for off-the-record profiles. Every profile ships with two built-in components, Google Hangouts and the Chromium PDF Viewer, which can be disabled if not needed.

Note

If you use this API to develop a system that allows users to install extensions at runtime, you may fall under the CRA EN-304-617 rules on browser extensions.

Synopsis¶

Properties¶

extensionsᅟ - Returns a list of the loaded extensions
installPathᅟ - Returns the directory’s path where the extensions are installed

Signals¶

def installFinished()
def loadFinished()
def uninstallFinished()
def unloadFinished()

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

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property extensionsᅟ: list of QWebEngineExtensionInfo¶

This property holds Returns a list of the loaded extensions..

See also

QWebEngineExtensionInfo

Access functions:

extensions()

property installPathᅟ: str¶

This property holds Returns the directory’s path where the extensions are installed..

See also

installExtension() isInstalled()

Access functions:

installPath()

extensions()¶

Return type:: .list of QWebEngineExtensionInfo

Getter of property extensionsᅟ .

installExtension(path)¶

Parameters:: path – str

Installs an extension from path to the profile’s directory and loads it.

The installFinished() signal is emitted after an extension is installed or the install failed. If the install succeeded isInstalled() will return true, otherwise error() will contain information how the install process failed.

Extensions are loaded in disabled state after the install succeeded. Installed extensions are automatically loaded at every startup in disabled state. The install path can be queried with installPath() .

The installer is capable of installing zipped or unpacked extensions. The path parameter should point to a directory or a zip file containing the extension’s manifest file. If the manifest is missing from the top level directory, the install process will abort.

Installing an already loaded or installed extension from the same path will install a new extension.

See also

isInstalled() error() installPath()

installFinished(extension)¶

Parameters:: extension – QWebEngineExtensionInfo

Signals that are emitted when extension is loaded, unloaded, installed, or uninstalled.

installPath()¶

Return type:: str

Getter of property installPathᅟ .

loadExtension(path)¶

Parameters:: path – str

Loads an unpacked extension from path.

The loadFinished() signal is emitted when an extension is loaded or the load failed. If the load succeeded isLoaded() will return true, otherwise error() will contain information where the loading process failed.

Extensions are always loaded in disabled state, users have to enable them manually. Loading an already loaded extension from the same path will reload the extension.

See also

isLoaded() error()

loadFinished(extension)¶

Parameters:: extension – QWebEngineExtensionInfo

Signals that are emitted when extension is loaded, unloaded, installed, or uninstalled.

setExtensionEnabled(extension, enabled)¶

Parameters:

extension – QWebEngineExtensionInfo
enabled – bool

Allows to turn on/off the extension at runtime.

The enabled argument determines whether the extension should be enabled or disabled.

Note

It is also possible to disable internal extensions like Hangouts and PDF.