Skip to content

Web Extension

The web extension module installs and uninstalls browser extensions.

Methods

install

Install a browser extension from an archive file:

result = await client.web_extension.install("/path/to/extension.zip")
print(result.extension)  # extension ID

uninstall

Uninstall a previously installed extension:

await client.web_extension.uninstall("extension-id")

Reference

WebExtensionModule

Module for managing browser extensions.

Commands
  • install — install a web extension from an archive path
  • uninstall — uninstall a previously installed extension
Example

result = await client.web_extension.install("/path/to/extension.zip") await client.web_extension.uninstall(result.extension)

Source code in bidiwave/modules/webextension.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class WebExtensionModule:
    """Module for managing browser extensions.

    Commands:
        - install — install a web extension from an archive path
        - uninstall — uninstall a previously installed extension

    Example:
        result = await client.web_extension.install("/path/to/extension.zip")
        await client.web_extension.uninstall(result.extension)
    """

    def __init__(self, connection: Connection) -> None:
        self._connection = connection

    async def install(
        self, extension_data: dict[str, str] | str
    ) -> WebExtensionInfo:
        """Installs a web extension.

        Args:
            extension_data: Either a path to a packed extension archive
                (sent as ``{"type": "archivePath", "path": ...}``) or a
                full ExtensionData dict per the spec:
                ``{"type": "path", "path": ...}`` for an unpacked
                directory, ``{"type": "archivePath", "path": ...}`` for a
                packed archive, or ``{"type": "base64", "value": ...}``.

        Returns:
            WebExtensionInfo with the extension ID.
        """
        if isinstance(extension_data, str):
            extension_data = {"type": "archivePath", "path": extension_data}
        result = await self._connection.send_command(
            WEB_EXTENSION_INSTALL, {"extensionData": extension_data}
        )
        return WebExtensionInfo.model_validate(result)

    async def uninstall(self, extension: str) -> None:
        """Uninstalls a previously installed web extension.

        Args:
            extension: ID of the extension to uninstall.
        """
        await self._connection.send_command(
            WEB_EXTENSION_UNINSTALL, {"extension": extension}
        )

install async 

install(extension_data: dict[str, str] | str) -> WebExtensionInfo

Installs a web extension.

Parameters:

Name Type Description Default
extension_data dict[str, str] | str

Either a path to a packed extension archive (sent as {"type": "archivePath", "path": ...}) or a full ExtensionData dict per the spec: {"type": "path", "path": ...} for an unpacked directory, {"type": "archivePath", "path": ...} for a packed archive, or {"type": "base64", "value": ...}.

 required

Returns:

Type Description
WebExtensionInfo

WebExtensionInfo with the extension ID.
Source code in bidiwave/modules/webextension.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
async def install(
    self, extension_data: dict[str, str] | str
) -> WebExtensionInfo:
    """Installs a web extension.

    Args:
        extension_data: Either a path to a packed extension archive
            (sent as ``{"type": "archivePath", "path": ...}``) or a
            full ExtensionData dict per the spec:
            ``{"type": "path", "path": ...}`` for an unpacked
            directory, ``{"type": "archivePath", "path": ...}`` for a
            packed archive, or ``{"type": "base64", "value": ...}``.

    Returns:
        WebExtensionInfo with the extension ID.
    """
    if isinstance(extension_data, str):
        extension_data = {"type": "archivePath", "path": extension_data}
    result = await self._connection.send_command(
        WEB_EXTENSION_INSTALL, {"extensionData": extension_data}
    )
    return WebExtensionInfo.model_validate(result)

uninstall async 

uninstall(extension: str) -> None

Uninstalls a previously installed web extension.

Parameters:

Name Type Description Default
extension str

ID of the extension to uninstall.

 required
Source code in bidiwave/modules/webextension.py 
60
61
62
63
64
65
66
67
68
async def uninstall(self, extension: str) -> None:
    """Uninstalls a previously installed web extension.

    Args:
        extension: ID of the extension to uninstall.
    """
    await self._connection.send_command(
        WEB_EXTENSION_UNINSTALL, {"extension": extension}
    )