開發附加元件¶

附加元件可用來自訂 Weblate 中的在地化工作流程。

class weblate.addons.base.BaseAddon(storage)¶

Base class for Weblate add-ons.

classmethod can_install(*, component=None, category=None, project=None) → bool¶: Check whether add-on is compatible with given component.

change_event(change, activity_log_id: int | None = None)¶: Event handler for change event.

check_change_action(change) → bool¶: Early filtering of Change actions before triggering change_event callback.

component_update(component, activity_log_id: int | None = None)¶: Event handler for component update.

configure(configuration) → None¶: Save configuration.

daily(component=None, category=None, project=None, activity_log_id: int | None = None)¶

Scope-aware daily entry point.

Override this for project-level logic, or override daily_component() for per-component logic.

daily_component(component, activity_log_id: int | None = None)¶: Per-component daily processing. Override this for component-level logic.

classmethod get_add_form(user, *, component=None, category=None, project=None, **kwargs)¶: Return configuration form for adding new add-on.

get_settings_form(user, **kwargs)¶: Return configuration form for this add-on.

manual(component=None, category=None, project=None, activity_log_id: int | None = None)¶

Scope-aware manual entry point.

By default this mirrors the daily handler and lets add-ons opt in explicitly by subscribing to the manual event.

manual_component(component, activity_log_id: int | None = None)¶: Per-component manual processing.

post_add(translation, activity_log_id: int | None = None)¶: Event handler after new translation is added.

post_commit(component, store_hash: bool, activity_log_id: int | None = None)¶: Event handler after changes are committed to the repository.

post_install(component, store_hash: bool, activity_log_id: int | None = None)¶: Event handler after add-on is installed.

post_push(component, activity_log_id: int | None = None)¶: Event handler after repository is pushed upstream.

post_remove(translation, activity_log_id: int | None = None)¶: Event handler after a translation is removed.

post_update(component, previous_head: str, skip_push: bool, changed_files: list[str], parse_after_update: bool = False, activity_log_id: int | None = None)¶

Event handler after repository is updated from upstream.

參數:

previous_head (str) -- HEAD of the repository prior to update, can be blank on initial clone.
skip_push (bool) -- Whether the add-on operation should skip pushing changes upstream. Usually you can pass this to underlying methods as commit_and_push or commit_pending.
changed_files (list[str]) -- Files changed by the repository update.

pre_commit(translation, author: str, store_hash: bool, activity_log_id: int | None = None)¶: Event handler before changes are committed to the repository.

pre_push(component, activity_log_id: int | None = None)¶: Event handler before repository is pushed upstream.

pre_update(component, activity_log_id: int | None = None)¶: Event handler before repository is updated from upstream.

resolve_components(*, component=None, category=None, project=None)¶: Resolve scope to components iterator.

save_state() → None¶: Save add-on state information.

unit_pre_create(unit, activity_log_id: int | None = None)¶: Event handler before new unit is created.

update_component_state(component, updater: Callable[[dict[str, object]], None]) → None¶: Atomically merge component-scoped add-on state into the shared JSON field.

user()¶: Weblate user used to track changes by this add-on.

附加元件掛勾從 weblate.*.models 模組接收 ORM 物件，包括 Addon, Component, Translation, Category, Project, Unit, Change 和 User 。附加元件設定表單應把 weblate.addons.forms.BaseAddonForm 作為子類。

這裡是一個範例附加元件：

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

from __future__ import annotations

from typing import TYPE_CHECKING, ClassVar

from django.utils.translation import gettext_lazy

from weblate.addons.base import BaseAddon
from weblate.addons.events import AddonEvent

if TYPE_CHECKING:
    from weblate.addons.base import CompatDict


class ExampleAddon(BaseAddon):
    # Filter for compatible components, every key is
    # matched against property of component
    compat: ClassVar[CompatDict] = {
        "file_format": {"po", "po-mono"},
    }
    # List of events add-on should receive
    events: ClassVar[set[AddonEvent]] = {
        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: str,
        store_hash: bool,
        activity_log_id: int | None = None,
    ) -> None:
        return

為附加元件設定加上型別¶

附加元件設定儲存在 Addon.configuration JSON 欄位中，因此模型會以原始 JSON 保留持久化資料。附加元件實作可透過參數化 BaseAddon 與 BaseAddonForm，為自己的設定指定型別。

當儲存的 JSON 與執行階段結構可能不同時，請使用兩個 TypedDict 類別：一個寬鬆且通常設為 total=False 的儲存設定，用於舊值或缺少的值；另一個則是由 normalize_configuration() 傳回的完整執行階段設定。附加元件的執行階段程式碼應讀取 self.configuration 或 self.get_configuration()，以取得正規化的預設值，而非原始持久化 JSON。

對於儲存與執行階段結構相同的簡單附加元件，請定義單一 TypedDict，並將它用於兩個 BaseAddon 型別參數。表單的 serialize_form() 傳回型別應與儲存設定型別一致。