Erweiterungen entwickeln¶

Erweiterungen sind eine Möglichkeit, den Lokalisierungsprozess in Weblate anzupassen.

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

Basisklasse für Weblate-Erweiterungen.

classmethod can_install(*, component: Component | None = None, project: Project | None = None) → bool¶: Prüfen, ob die Erweiterung mit der angegebenen Komponente kompatibel ist.

change_event(change: Change, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler für Änderungsereignis.

check_change_action(change: Change) → bool¶: Frühzeitiges Filteren von Änderungsaktionen vor dem Auslösen des Callbacks change_event.

component_update(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler für Komponentenaktualisierung.

configure(configuration: dict[str, Any]) → None¶: Konfiguration speichern.

daily(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler täglich.

classmethod get_add_form(user: User | None, *, component: Component | None = None, project: Project | None = None, **kwargs) → BaseAddonForm | None¶: Konfigurationsformular zum Hinzufügen einer neuen Erweiterung zurückgeben.

get_settings_form(user: User | None, **kwargs) → BaseAddonForm | None¶: Konfigurationsformular für diese Erweiterung zurückgeben.

post_add(translation: Translation, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, nachdem eine neue Übersetzung hinzugefügt wird.

post_commit(component: weblate.trans.models.Component, store_hash: bool, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, nachdem Änderungen an das Repository committet werden.

post_install(component: weblate.trans.models.Component, store_hash: bool, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler nach der Installation der Erweiterung.

post_push(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, nachdem das Repository Upstream gepusht wird.

post_update(component: weblate.trans.models.Component, previous_head: str, skip_push: bool, activity_log_id: int | None = None) → dict | None¶

Ereignis-Handler, nachdem das Repository von Upstream aktualisiert wird.

Parameter:

previous_head (str) – HEAD des Repositorys vor der Aktualisierung, kann beim ersten Klonen leer sein.
skip_push (bool) – Ob die Erweiterungsoperation das Pushen von Änderungen im Upstream überspringen soll. Normalerweise können Sie dies den zugrunde liegenden Methoden als commit_and_push oder commit_pending übergeben.

pre_commit(translation: Translation, author: str, store_hash: bool, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, bevor Änderungen an das Repository committet werden.

pre_push(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, bevor das Repository Upstream gepusht wird.

pre_update(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, bevor das Repository von Upstream aktualisiert wird.

save_state() → None¶: Informationen über den Status der Erweiterung speichern.

unit_pre_create(unit: Unit, activity_log_id: int | None = None) → dict | None¶: Ereignis-Handler, bevor eine neue Einheit erstellt wird.

user() → User¶: Weblate-Benutzer, um Änderungen dieser Erweiterung nachzuverfolgen.

class weblate.addons.models.Addon¶: ORM-Objekt für eine Erweiterung.

class weblate.trans.models.Component¶: ORM-Objekt für eine Komponente.

class weblate.trans.models.Translation¶: ORM-Objekt für eine Übersetzung.

class weblate.trans.models.Project¶: ORM-Objekt für ein Projekt.

class weblate.trans.models.Unit¶: ORM-Objekt für eine Einheit.

class weblate.trans.models.Change¶: ORM-Objekt für eine Änderung.

class weblate.trans.models.User¶: ORM-Objekt für ein Benutzer.

class weblate.trans.models.TranslationFormat¶: Übersetzungsdatei-Wrapper.

class weblate.trans.models.BaseAddonForm¶: Basisformular für das Konfigurieren von Erweiterungen.

Hier ein Beispiel für eine Erweiterung:

# 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