Desenvolvendo extensões

Extensões são uma forma de personalizar o fluxo de trabalho de localização no Weblate.

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

classmethod can_install(component, user)

Verifica se a extensão é compatível com o componente dado.

configure(settings)

Salva a configuração.

daily(component)

Gancho acionado diariamente.

classmethod get_add_form(user, component, **kwargs)

Retorna um formulário de configuração para adicionar uma nova extensão.

get_settings_form(user, **kwargs)

Retorna um formulário de configuração para esta extensão.

post_add(translation)

Gancho acionado após nova tradução ser adicionada.

post_commit(component)

Gancho acionado após alterações terem feito um commit para o repositório.

post_push(component)

Gancho acionado após repositório ter o push feito para o upstream.

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

Gancho acionado após o repositório ser atualizado a partir do upstream.

Parâmetros

• previous_head (str) – HEAD do repositório antes da atualização, pode estar vazio na clonagem inicial.

• skip_push (bool) – Se a operação de extensão deve ignorar o push de alterações para o upstream. Normalmente você pode passar isso para métodos subjacentes como commit_and_push ou commit_pending.

pre_commit(translation, author)

Gancho acionado antes das alterações terem feito um commit para o repositório.

pre_push(component)

Gancho acionado antes do repositório ter feito push para o upstream.

pre_update(component)

Hook acionado antes do repositório ser atualizado a partir do upstream.

save_state()

Salva informações do estado da extensão.

stay_on_create = False

Classe base para as extensões do Weblate.

store_post_load(translation, store)

Gancho acionado após um ficheiro ser analisado.

Ele recebe uma instância de uma classe de formato de ficheiro como um argumento.

Isso é útil para modificar os parâmetros de classe de formato de ficheiro, por exemplo, ajustar como o ficheiro será salvo.

unit_pre_create(unit)

Gancho acionado antes que a nova unidade seja criada.

Aqui está um exemplo de extensão:

#
# 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 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):
        return