Developing addons

Addons are way to customize localization workflow in Weblate.

class weblate.addons.base.BaseAddon(storage=None)

classmethod can_install(component, user)

Check whether addon is compatible with given component.

configure(settings)

Save configuration.

daily(component)

Hook triggered daily.

classmethod get_add_form(user, component, **kwargs)

Return configuration form for adding new addon.

get_settings_form(user, **kwargs)

Return configuration form for this addon.

post_add(translation)

Hook triggered after new translation is added.

post_commit(component)

Hook triggered after changes are committed to the repository.

post_push(component)

Hook triggered after repository is pushed upstream.

post_update(component, previous_head: str, skip_push: bool)

Hook triggered after repository is updated from upstream.

Parameters

• previous_head (str) – HEAD of the repository prior to update, can be blank on initial clone.

• skip_push (bool) – Whether the addon operation should skip pushing changes upstream. Usually you can pass this to underlying methods as commit_and_push or commit_pending.

pre_commit(translation, author)

Hook triggered before changes are committed to the repository.

pre_push(component)

Hook triggered before repository is pushed upstream.

pre_update(component)

Hook triggered before repository is updated from upstream.

save_state()

Save addon state information.

stay_on_create = False

Base class for Weblate addons.

store_post_load(translation, store)

Hook triggered after a file is parsed.

It receives an instance of a file format class as a argument.

This is useful to modify file format class parameters, for example adjust how the file will be saved.

unit_pre_create(unit)

Hook triggered before new unit is created.

Here is an example addon:

#
# Copyright © 2012 - 2021 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#


from django.utils.translation import gettext_lazy as _

from weblate.addons.base import BaseAddon
from weblate.addons.events import EVENT_PRE_COMMIT


class ExampleAddon(BaseAddon):
    # Filter for compatible components, every key is
    # matched against property of component
    compat = {"file_format": {"po", "po-mono"}}
    # List of events addon should receive
    events = (EVENT_PRE_COMMIT,)
    # Addon unique identifier
    name = "weblate.example.example"
    # Verbose name shown in the user interface
    verbose = _("Example addon")
    # Detailed addon description
    description = _("This addon does nothing it is just an example.")

    # Callback to implement custom behavior
    def pre_commit(self, translation, author):
        return