Developing add-ons#
Complementos are way to customize localization workflow in Weblate.
- class weblate.addons.base.BaseAddon(storage: Addon)#
Base class for Weblate add-ons.
- classmethod can_install(component: Component, user: User | None)#
Check whether add-on is compatible with given component.
- configure(configuration)#
Guardar configuración.
- classmethod get_add_form(user: User | None, component: Component, **kwargs)#
Return configuration form for adding new add-on.
- post_add(translation: Translation)#
Actuador desencadenado tras añadirse una traducción nueva.
- post_commit(component: Component)#
Actuador desencadenado tras consignarse cambios en el repositorio.
- post_push(component: Component)#
Actuador desencadenado tras enviar el repositorio a la ubicación del proyecto originario.
- post_update(component: Component, previous_head: str, skip_push: bool, child: bool)#
Actuador desencadenado tras actualizarse el repositorio desde el origen.
- Parámetros:
previous_head (str) – «HEAD» del repositorio antes de la actualización; puede estar vacía durante la clonación inicial.
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
orcommit_pending
.
- pre_commit(translation: Translation, author: User)#
El enlace se activa antes de que los cambios se confirmen en el repositorio.
- save_state()#
Guarde la información del estado del complemento.
- store_post_load(translation: Unit, store: TranslationFormat)#
Actuador desencadenado tras procesar un archivo.
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.
- user()#
Weblate user used to track changes by this add-on.
- class weblate.addons.base.Addon#
ORM object for an add-on.
- class weblate.addons.base.Component#
ORM object for a component.
- class weblate.addons.base.Translation#
ORM object for a translation.
- class weblate.addons.base.Project#
ORM object for a project.
- class weblate.addons.base.Unit#
ORM object for an unit.
- class weblate.addons.base.User#
ORM object for an user.
- class weblate.addons.base.TranslationFormat#
Translation file wrapper.
Here is an example add-on:
# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later
from django.utils.translation import gettext_lazy
from weblate.addons.base import BaseAddon
from weblate.addons.events import AddonEvent
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 = (AddonEvent.EVENT_PRE_COMMIT,)
# Add-on unique identifier
name = "weblate.example.example"
# Verbose name shown in the user interface
verbose = gettext_lazy("Example add-on")
# Detailed add-on description
description = gettext_lazy("This add-on does nothing it is just an example.")
# Callback to implement custom behavior
def pre_commit(self, translation, author):
return