Разработка надстроек#
Надстройки — это способ внести изменений в ваш рабочий процесс локализации с помощью Weblate.
- class weblate.addons.base.BaseAddon(storage=None)#
Базовый класс для всех надстроек Weblate.
- classmethod can_install(component, user)#
Проверяет, совместима ли надстройка с указанным компонентом.
- component_update(component)#
Обработчик обновления компонентов.
- configure(settings)#
Сохранение конфигурации.
- daily(component)#
Обработчики, которые будут вызываться ежедневно.
- classmethod get_add_form(user, component, **kwargs)#
Возвращает форму с пользовательскими настройками. Вызывается при добавлении новой надстройки к компоненту.
- get_settings_form(user, **kwargs)#
Возвращает форму с пользовательскими настройками этой надстройки.
- post_add(translation)#
Обработчик, вызываемый после добавления нового перевода.
- post_commit(component)#
Обработчик, вызываемый после того, как изменения будут закоммиченны в репозиторий.
- post_push(component)#
Обработчик, вызываемый после того как изменения в будут отправлены в вышестоящий репозиторий.
- post_update(component, previous_head: str, skip_push: bool)#
Обработчик, вызываемый после того, как локальный репозиторий будет обновлён из вышестоящего.
- Параметры:
previous_head (str) – Текущее состояние репозитория (HEAD) перед обновлением; может быть пустым, если этот репозиторий только что склонирован.
skip_push (bool) – Определяет, должна ли надстройка пропустить собственно отправку изменений в вышестоящий репозиторий. Обычно этот параметр просто передаётся в конкретные методы реализации, как
commit_and_push
илиcommit_pending
.
- pre_commit(translation, author)#
Обработчик, вызываемый перед тем, как изменения будут закоммиченны в репозиторий.
- pre_push(component)#
Обработчик, вызываемый перед тем как изменения в будут отправлены в вышестоящий репозиторий.
- pre_update(component)#
Обработчик, вызываемый перед тем, как локальный репозиторий будет обновлён из вышестоящего.
- save_state()#
Сохранить информацию о состоянии надстройки.
- store_post_load(translation, store)#
Обработчик, вызываемый после разбора файла.
В качестве аргумента ему передаётся объект класса формата файла.
Это может быть полезно для модификации параметров класса формата файла, например, изменить , как именно данный файл будет сохраняться.
- unit_pre_create(unit)#
Обработчик, вызываемый перед созданием новой единицы перевода.
Вот пример надстройки:
# 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 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 = 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