Eklentileri geliştirmek¶

Weblate üzerinde yerelleştirme iş akışını özelleştirmek için Eklentiler kullanılabilir.

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

Weblate eklentileri için temel sınıf.

classmethod can_install(*, component: Component | None = None, project: Project | None = None) → bool¶: Eklentinin belirtilen bileşenle uyumlu olup olmadığını denetler.

change_event(change: Change, activity_log_id: int | None = None) → dict | None¶: Değişiklik etkinliği işleyici.

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

component_update(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Bileşen güncelleme etkinliği işleyici.

configure(configuration: dict[str, Any]) → None¶: Yapılandırmayı kaydeder.

daily(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Günlük etkinlikleri işleyici.

classmethod get_add_form(user: User | None, *, component: Component | None = None, project: Project | None = None, **kwargs) → BaseAddonForm | None¶: Yeni eklenti eklemek için yapılandırma formunu görüntüler.

get_settings_form(user: User | None, **kwargs) → BaseAddonForm | None¶: Bu eklenti için yapılandırma formunu görüntüler.

post_add(translation: Translation, activity_log_id: int | None = None) → dict | None¶: Yeni çeviri eklendikten sonraki etkinlik işleyici.

post_commit(component: weblate.trans.models.Component, store_hash: bool, activity_log_id: int | None = None) → dict | None¶: Değişiklikler depoya işlendikten sonraki etkinlik işleyici.

post_install(component: weblate.trans.models.Component, store_hash: bool, activity_log_id: int | None = None) → dict | None¶: Event handler after add-on is installed.

post_push(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Depoyu yukarı akışa ittikten sonraki etkinlik işleyici.

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

Depo yukarı akıştan güncellendikten sonraki etkinlik işleyici.

Parametreler:

previous_head (str) – Güncellemeden önce deponun HEAD bölümü. İlk kopyalamada boş olabilir.
skip_push (bool) – Eklenti işleminin değişiklikleri yukarı akışa itmeyi atlayıp atlamayacağı. Genellikle bunu temeldeki yöntemlere commit_and_push ya da commit_pending olarak iletebilirsiniz.

pre_commit(translation: Translation, author: str, store_hash: bool, activity_log_id: int | None = None) → dict | None¶: Değişiklikler depoya işlenmeden önceki etkinlik işleyici.

pre_push(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Depo yukarı akışa itilmeden önceki etkinlik işleyici.

pre_update(component: weblate.trans.models.Component, activity_log_id: int | None = None) → dict | None¶: Depo yukarı akıştan güncellenmeden önceki etkinlik işleyici.

save_state() → None¶: Eklenti durum bilgilerini kaydeder.

unit_pre_create(unit: Unit, activity_log_id: int | None = None) → dict | None¶: Yeni birim oluşturulmadan önceki etkinlik işleyici.

user() → User¶: Weblate kullanıcısı bu eklentinin yaptığı değişiklikleri izler.

class weblate.addons.models.Addon¶: Bir eklentinin ORM nesnesi.

class weblate.trans.models.Component¶: Bir bileşenin ORM nesnesi.

class weblate.trans.models.Translation¶: Bir çevirinin ORM nesnesi.

class weblate.trans.models.Project¶: Bir projenin ORM nesnesi.

class weblate.trans.models.Unit¶: Bir birimin ORM nesnesi.

class weblate.trans.models.Change¶: Bir değişikliğin ORM nesnesi.

class weblate.trans.models.User¶: Bir kullanıcının ORM nesnesi.

class weblate.trans.models.TranslationFormat¶: Çeviri dosyası sarmalayıcı.

class weblate.trans.models.BaseAddonForm¶: Eklentileri yapılandırmak için temel form.

İşte bir örnek eklenti:

# 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