PySide6.QtWebEngineCore.QWebEngineExtensionManager

class QWebEngineExtensionManager

The QWebEngineExtensionManager class allows applications to install and load Chrome extensions from the filesystem.

Details

QWebEngineExtensionManager can load or install Chrome extensions. Extensions can be loaded via loadExtension . Extensions loaded this way are not remembered by the associated profile and has to be manually loaded in every new browsing session. To preserve extensions between browsing sessions, applications can install zipped or unpacked extensions via installExtension . In this case the manager will unpack the extension to the profile’s directory and load it from there. Installed extensions are always loaded at startup, after the profile is initialized.

You can access the loaded extensions with extensions() which provides a list of QWebEngineExtensionInfo , or connect to the manager’s signals to get notified about the state of the load or install processes.

Each QWebEngineProfile has its own QWebEngineExtensionManager , so every page that shares the same profile will share the same extensions too. Extensions can’t be loaded into off-the-record profiles.

Note

Only ManifestV3 extensions are supported, other versions won’t be loaded nor installed

See also

extensionManager QWebEngineExtensionInfo

Inheritance diagram of PySide6.QtWebEngineCore.QWebEngineExtensionManager

Added in version 6.10.

Synopsis

Properties

  • extensionsᅟ - Returns a list of the loaded extensions

  • installPathᅟ - Returns the directory’s path where the extensions are installed

Methods

Signals

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..

Access functions:
property installPathᅟ: str

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

Access functions:
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 QWebEngineExtensionManager::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 succeded. Installed extensions are automatically loaded at every starutup 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.

installFinished(extension)
Parameters:

extension – QWebEngineExtensionInfo

installPath()
Return type:

str

Getter of property installPathᅟ .

loadExtension(path)
Parameters:

path – str

Loads an unpacked extension from path

The QWebEngineExtensionManager::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

setExtensionEnabled(extension, enabled)
Parameters:

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.

See also

isEnabled()

uninstallExtension(extension)
Parameters:

extension – QWebEngineExtensionInfo

Uninstalls the extension

Removes the extension’s files from the install path and unloads the extension. The QWebEngineExtensionManager::uninstallFinished signal is emitted after the process finished.

uninstallFinished(extension)
Parameters:

extension – QWebEngineExtensionInfo

unloadExtension(extension)
Parameters:

extension – QWebEngineExtensionInfo

Unloads the extension

Removes all the extension’s data from memory.

The QWebEngineExtensionManager::unloadFinished signal is emitted after the unload process finished.

Note

It is also possible to unload internal extensions like Hangouts and PDF, but they will be loaded at next startup like other installed extensions.

See also

isLoaded()

unloadFinished(extension)
Parameters:

extension – QWebEngineExtensionInfo