Tworzenie dodatków

Dodatki are way to customize localization workflow in Weblate.

class weblate.addons.base.BaseAddon(storage=None)

Base class for Weblate add-ons.

classmethod can_install(component, user)

Sprawdź, czy dodatek jest kompatybilny z danym komponentem.

configure(settings)

Zapisz konfigurację.

daily(component)

Hook wyzwalany codziennie.

classmethod get_add_form(user, component, **kwargs)

Zwróć formularz konfiguracji dla dodania nowego dodatku.

get_settings_form(user, **kwargs)

Zwróć formularz konfiguracji dla tego dodatku.

post_add(translation)

Hook wyzwalany po dodaniu nowego tłumaczenia.

post_commit(component)

Hook wyzwalany po scommitowaniu zmian do repozytorium.

post_push(component)

Hook wyzwalany po wysłaniu zmian na repozytorium.

post_update(component, previous_head: str, skip_push: bool)

Hook triggered after repository is updated from upstream.

Parametry

• 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.

pre_commit(translation, author)

Hook wyzwalany przed scommitowaniem zmian do repozytorium.

pre_push(component)

Hook triggered before repository is pushed upstream.

pre_update(component)

Hook triggered before repository is updated from upstream.

save_state()

Zapisz informacje o stanie dodatku.

store_post_load(translation, store)

Hook wyzwalany po przeparsowaniu pliku.

It receives an instance of a file format class as a argument.

This is useful to modify file format class parameters, for example adjust how the file will be saved.

unit_pre_create(unit)

Hook triggered before new unit is created.

Oto przykładowy dodatek:

#
# Copyright © 2012–2022 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#


from django.utils.translation import gettext_lazy as _

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 = _("Example add-on")
    # Detailed add-on description
    description = _("This add-on does nothing it is just an example.")

    # Callback to implement custom behavior
    def pre_commit(self, translation, author):
        return