Dezvoltarea de addon-uri
Extensii sunt o modalitate de a personaliza fluxul de lucru al localizării în Weblate.
- class weblate.addons.base.BaseAddon(storage=None)
- classmethod can_install(component, user)
Verifică dacă suplimentul este compatibil cu componenta dată.
- configure(settings)
Salvați configurația.
- daily(component)
Cârligul se declanșează zilnic.
- classmethod get_add_form(user, component, **kwargs)
Returnează formularul de configurare pentru adăugarea unui nou add-on.
- get_settings_form(user, **kwargs)
Returnează formularul de configurare pentru acest add-on.
- post_add(translation)
Se declanșează după ce se adaugă o nouă traducere.
- post_commit(component)
Hook declanșat după ce modificările sunt confirmate în depozit.
- post_push(component)
Hook declanșat după ce depozitul este împins în amonte.
- post_update(component, previous_head: str, skip_push: bool)
Hook declanșat după ce depozitul este actualizat din amonte.
- Parametrii
previous_head (str) – HEAD al depozitului înainte de actualizare, poate fi gol la clona inițială.
skip_push (bool) – Dacă operațiunea de adăugare trebuie să sară peste împingerea modificărilor în amonte. De obicei, puteți trece acest lucru la metodele subiacente ca
commit_and_push
saucommit_pending
.
- pre_commit(translation, author)
Hook declanșat înainte ca modificările să fie confirmate în depozit.
- pre_push(component)
Hook declanșat înainte ca depozitul să fie împins în upstream.
- pre_update(component)
Hook declanșat înainte ca depozitul să fie actualizat din upstream.
- save_state()
Salvați informațiile privind starea add-on-ului.
- stay_on_create = False
Clasa de bază pentru add-on-urile Weblate.
- store_post_load(translation, store)
Hook declanșat după ce un fișier este analizat.
Acesta primește ca argument o instanță a unei clase de format de fișier.
Acest lucru este util pentru a modifica parametrii clasei de format de fișier, de exemplu pentru a ajusta modul în care va fi salvat fișierul.
- unit_pre_create(unit)
Cârlig declanșat înainte de crearea unei noi unități.
Iată un exemplu de addon:
#
# Copyright © 2012 - 2021 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