Source code
Revision control
Copy as Markdown
Other Tools
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
import os
from . import errors
__all__ = ["Addons", "AddonInstallException"]
class AddonInstallException(errors.MarionetteException):
pass
class Addons:
"""An API for installing and inspecting addons during Gecko
runtime. This is a partially implemented wrapper around Gecko's
`AddonManager API`_.
For example::
from marionette_driver.addons import Addons
addons = Addons(marionette)
addons.install("/path/to/extension.xpi")
"""
def __init__(self, marionette):
self._mn = marionette
def install(self, path=None, temp=False, data=None):
"""Install a Firefox addon, which can be used right away.
:param path: A file path to the extension to be installed.
:param temp: Install a temporary addon. Temporary addons will
automatically be uninstalled on shutdown and do not need
to be signed.
:param data: A base64-encoded string of a zip-packed addon.
:returns: The addon ID string of the newly installed addon.
:raises: :exc:`AddonInstallException`
"""
if (path and data) or (not path and not data):
raise AddonInstallException("Must use either path or data argument.")
body = {"temporary": temp}
if path:
# On windows we can end up with a path with mixed \ and /
# which Firefox doesn't like
path = path.replace("/", os.path.sep)
body.update({"path": path})
if data:
body.update({"addon": data})
try:
return self._mn._send_message("Addon:Install", body, key="value")
except errors.UnknownException as e:
raise AddonInstallException(e)
def uninstall(self, addon_id):
"""Uninstall a Firefox addon.
If the addon is restartless, it will be uninstalled right away.
Otherwise a restart using :func:`~marionette_driver.marionette.Marionette.restart`
will be needed.
If the call to uninstall is resulting in a `ScriptTimeoutException`,
an invalid ID is likely being passed in. Unfortunately due to
AddonManager's implementation, it's hard to retrieve this error from
Python.
:param addon_id: The addon ID string to uninstall.
"""
self._mn._send_message("Addon:Uninstall", {"id": addon_id})