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, user: User | None)

Prüfen, ob die Erweiterung mit der angegebenen Komponente kompatibel ist.

component_update(component: Component) → None

Event handler for component update.

configure(configuration) → None

Konfiguration speichern.

daily(component: Component) → None

Event handler daily.

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

Konfigurationsformular zum Hinzufügen einer neuen Erweiterung zurückgeben.

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

Konfigurationsformular für diese Erweiterung zurückgeben.

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.

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: 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

Informationen über den Status der Erweiterung speichern.

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

Event handler after a file is parsed.

Er erhält eine Instanz einer Dateiformatklasse als Argument.

Dies ist nützlich, um die Parameter der Dateiformatklasse zu ändern, z. B. wie die Datei gespeichert werden soll.

unit_pre_create(unit: Unit) → None

Event handler before new unit is created.

user()

Weblate-Benutzer, um Änderungen dieser Erweiterung nachzuverfolgen.

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.

Hier ein Beispiel für eine Erweiterung:

# 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