Desenvolver 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: Addon)¶
Classe base para as extensões do Weblate.
- classmethod can_install(component: Component, user: User | None)¶
Verifica se a extensão é compatível com o componente dado.
- configure(configuration) None ¶
Salva a configuração.
- classmethod get_add_form(user: User | None, *, component: Component | None = None, project: Project | None = None, **kwargs)¶
Retorna um formulário de configuração para adicionar uma nova extensão.
- get_settings_form(user: User | None, **kwargs)¶
Retorna um formulário de configuração para esta extensão.
- post_add(translation: Translation) None ¶
Event handler after new translation is added.
- post_commit(component: Component) None ¶
Event handler after changes are committed to the repository.
- post_update(component: Component, previous_head: str, skip_push: bool, child: bool) None ¶
Event handler after repository is updated from 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
oucommit_pending
.
- pre_commit(translation: Translation, author: User) None ¶
Event handler before changes are committed to the repository.
- save_state() None ¶
Salva informações do estado da extensão.
- store_post_load(translation: Unit, store: TranslationFormat) None ¶
Event handler after a file is parsed.
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.
- 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.
Aqui está um exemplo de extensão:
# 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) -> None:
return