Wtyczki — rozszerzanie natywnego GUI

Desktopowy klient Pytigon używa systemu wtyczek do rozszerzania funkcjonalności bez modyfikowania kodu core.

Architektura wtyczek

Wtyczki to moduły Python, które są dynamicznie wykrywane, pobierane i inicjowane przy starcie aplikacji.

Wykrywanie wtyczek

System wtyczek przeszukuje trzy katalogi: - pytigon_path/appdata/plugins/ — wbudowane wtyczki - data_path/plugins/ — wtyczki zainstalowane przez użytkownika - cwd/plugins/ — wtyczki specyficzne dla aplikacji

Automatyczne ładowanie

Wtyczki w podkatalogu auto/ lub wymienione w konfiguracji auto_plugins są ładowane automatycznie przy starcie. Wtyczki ręczne można ładować na żądanie.

Inicjacja wtyczki

Każdy moduł wtyczki może eksportować funkcję init_plugin(app, frame, panels):

def init_plugin(app, frame, panels):
    """Wywoływana, gdy wtyczka jest ładowana.

    Args:
        app: Instancja wx.App
        frame: Główna ramka aplikacji
        panels: Dostępne kontenery paneli
    """
    # Rejestracja niestandardowych kontrolek, przycisków paska narzędzi lub modyfikacja UI
    pass

Instalacja wtyczki

  1. Wtyczki są dystrybuowane jako pliki ZIP
  2. Klient pobiera wtyczki z endpointu /schsys/plugins/<plugin>/
  3. Pliki ZIP są rozpakowywane do plugins_cache/
  4. Obsługiwane są zarówno wtyczki standardowe, jak i niestandardowe

Możliwości wtyczek

Wtyczki mogą: - Rejestrować niestandardowe kontrolki — dodawać nowe widgety wxPython lub modyfikować istniejące przez system guictrl.factory - Dodawać przyciski paska narzędzi — rozszerzać paski narzędzi o niestandardowe akcje - Modyfikować przestrzeń nazw — dynamicznie rozszerzać przestrzeń nazw guictrl.ctrl (np. klasa przeglądarki HTML2 jest ustawiana przez wtyczki webview, takie jak cef czy wxwebview) - Tworzyć podstrony potomne — new_plugin_child_page() tworzy dynamiczne strony notebooka z danych wtyczki - Obsługiwać zdarzenia — łączyć się z systemem sygnałów/zdarzeń

Konfiguracja

Nazwy wtyczek są parsowane z wierszy danych konfiguracyjnych z data == "plugins". Wartości to rozdzielone średnikami ścieżki wtyczek, np.:

standard/keymap;standard/install

To ustawia app.plugins na listę aktywnych wtyczek.

Import wtyczki

Użyj import_plugin() z guilib.tools, aby dynamicznie załadować wtyczki przez nazwę modułu z kropkami:

from pytigon_gui.guilib.tools import import_plugin
my_plugin = import_plugin('plugins.my_plugin')
?: Plugins ?: Plugins