アドオンの開発

アドオン は、Weblate の現地語化ワークフローをカスタマイズする方法です。

class weblate.addons.base.BaseAddon(storage: Addon)

Weblate アドオンの基本クラス。

classmethod can_install(component: Component, user: User | None)

アドオンが指定したコンポーネントと互換性があるかどうかを確認します。

component_update(component: Component) → None

Event handler for component update.

configure(configuration) → None

設定を保存します。

daily(component: Component) → None

Event handler daily.

classmethod get_add_form(user: User | None, *, component: Component | None = None, project: Project | None = None, **kwargs)

新しいアドオンを追加するための設定フォームを返します。

get_settings_form(user: User | None, **kwargs)

このアドオンの設定フォームを返します。

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_push(component: Component) → None

Event handler after repository is pushed upstream.

post_update(component: Component, previous_head: str, skip_push: bool, child: bool) → None

Event handler after repository is updated from upstream.

パラメータ:

• previous_head (str) -- 更新前のリポジトリの HEAD、最初のクローンでは空白にできる。

• skip_push (bool) -- アドオン操作で上流への変更のプッシュをスキップさせるどうかを指定します。通常、これは commit_and_push または commit_pending として基底クラスのメソッドに渡せます。

pre_commit(translation: Translation, author: User) → None

Event handler before changes are committed to the repository.

pre_push(component: Component) → None

Event handler before repository is pushed upstream.

pre_update(component: Component) → None

Event handler before repository is updated from upstream.

save_state() → None

アドオンの状態を保存します。

store_post_load(translation: Unit, store: TranslationFormat) → None

Event handler after a file is parsed.

ファイル形式クラスのインスタンスを引数として受け取ります。

ファイル形式クラスのパラメータを変更する場合、例えばファイルをどのように保存するか設定する場合に便利です。

unit_pre_create(unit: Unit) → None

Event handler before new unit is created.

user()

このアドオンによる変更を追跡するために使われる Weblate ユーザー。

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.

アドオンの例:

# 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