Розробка додатків#
За допомогою можливості Додатки ви можете налаштувати процедуру локалізації у Weblate.
- class weblate.addons.base.BaseAddon(storage=None)#
Базовий клас для додатків Weblate.
- classmethod can_install(component, user)#
Перевірка, чи сумісний додаток із вказаним складником.
- component_update(component)#
Перехоплення подій щодо оновлення складника.
- configure(configuration)#
Збереження налаштувань.
- 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)#
Скрипт обробки, який вмикається до створення нового модуля.
- user()#
За допомогою цього додатка користувач Weblate стежить за змінами.
Ось приклад додатка:
# 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