Développement de greffons

Modules are way to customize localization workflow in Weblate.

class weblate.addons.base.BaseAddon(storage=None)
classmethod can_install(component, user)

Check whether add-on is compatible with given component.


Enregistrer la configuration.


Hook triggered daily.

classmethod get_add_form(user, component, **kwargs)

Return configuration form for adding new add-on.

get_settings_form(user, **kwargs)

Return configuration form for this add-on.


Crochet déclenché lors de l’ajout d’une nouvelle traduction.


Crochet déclenché après que des modifications aient été archivées dans le dépôt.


Crochet déclenché après que le dépôt est poussé en amont.

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

Hook triggered after repository is updated from upstream.

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

  • skip_push (bool) – Whether the add-on 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)

Crochet déclenché avant que des modifications aient été archivées dans le dépôt.


Hook triggered before repository is pushed upstream.


Hook triggered before repository is updated from upstream.


Save add-on state information.

stay_on_create = False

Base class for Weblate add-ons.

store_post_load(translation, store)

Crochet déclenché après l’analyse d’un fichier.

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.


Hook triggered before new unit is created.

Voici un exemple de greffon :

# 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
# 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 add-on should receive
    events = (EVENT_PRE_COMMIT,)
    # Add-on unique identifier
    name = "weblate.example.example"
    # Verbose name shown in the user interface
    verbose = _("Example add-on")
    # Detailed add-on description
    description = _("This add-on does nothing it is just an example.")

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