💡 Feature Spotlight: Persistentes Caching für Plugins¶

💾 Cache-Nutzung zur Steigerung der Performance und Ausfallsicherheit¶

Das System bietet einen zentralen, persistenten Cache-Mechanismus (simple_plugin_cache), der externe API-Aufrufe (wie Wetter, Übersetzungen, etc.) beschleunigt und reduziert. Der Cache ist persistent, d.h. er bleibt auch nach einem Neustart des Haupt-Services erhalten.

Ziel: Reduzierung der Netzwerklast und Failover auf die letzte bekannte Antwort bei einem API-Ausfall.

1. Caching aktivieren (Der Standardfall)¶

Um eine Funktion zu zwischenspeichern, müssen Sie die Funktionen „get_cached_result“ und „set_cached_result“ importieren.

1.1 Importe und Konfiguration¶

Fügen Sie diese Zeilen zu Ihrem Plugin-Skript hinzu (z.B. weather.py):

from scripts.py.func.simple_plugin_cache import get_cached_result, set_cached_result
# Definieren Sie eine Time-To-Live (TTL) für Ihre Daten
WEATHER_TTL = 300 # 5 Minuten

1.2 Caching-Logik im `execute`-Block¶

Sie müssen den Code in drei Blöcke unterteilen: Prüfen, Ausführen und Speichern.

def execute(match_data, logger):
    # ANNAHME: BASE_DIR_FOR_CACHE ist der stabile Pfad (z.B. der TMP-Ordner)
    BASE_DIR_FOR_CACHE = Path(...)
    
    # Der Cache-Key basiert auf allen Argumenten, die das Ergebnis beeinflussen.
    cache_key_args = (city, lang) 
    
    # --- BLOCK A: PRIMÄRER CACHE-ABRUF (TTL-gesteuert) ---
    cached_response = get_cached_result(
        BASE_DIR_FOR_CACHE,
        'plugin_get_weather',      # Eindeutiger Name für die Funktion
        cache_key_args,
        WEATHER_TTL,               # Die TTL für diesen Eintrag
        logger=logger
    )
    if cached_response:
        return cached_response # <-- CACHE HIT: Liefere sofort zurück
        
    # --- BLOCK B: NETZWERK-AUFRUF (NUR bei Cache Miss) ---
    try:
        # Führe hier Ihren CURL/Request-Code aus.
        response = "Erfolgreiche Antwort..." 

        # --- ERFOLG: ERGEBNIS SPEICHERN ---
        set_cached_result(BASE_DIR_FOR_CACHE, 'plugin_get_weather', cache_key_args, response)
        
        return response

    # --- BLOCK C: FEHLER & FAILOVER (FALLBACK-Strategie) ---
    except Exception as e:
        logger.warning(f"API-Abruf fehlgeschlagen ({type(e).__name__}). Versuche Fallback...")
        
        # ZWEITER CACHE-ABRUF: Lese den letzten gespeicherten Eintrag, egal wie alt (ttl_seconds=None).
        stale_response = get_cached_result(
            BASE_DIR_FOR_CACHE, 
            'plugin_get_weather', 
            cache_key_args,
            logger=logger # Wichtig: TTL wird hier weggelassen/ist None
        )
        
        if stale_response:
            logger.warning("Liefere ABGELAUFENEN (stale) Cache als Fallback.")
            return stale_response
        
        # KEIN FALLBACK VORHANDEN: Liefere die ursprüngliche Fehlermeldung.
        return f"Fehler: Daten konnten nicht abgerufen werden und kein Fallback verfügbar. Ursache: {e}"

2. Spezielle Caching-Fälle¶

A. Permanentes Caching (Ewiger Cache)¶

Wenn ein Ergebnis niemals ablaufen soll (z.B. eine API-URL, die sich nicht ändert), lassen Sie den ttl_seconds Parameter einfach weg.

# Abruf (Prüfung)
# Dieser Eintrag läuft nie ab.
cached_result = get_cached_result(BASE_DIR, 'static_config', ('my_key',), logger=logger) 

# Speichern
set_cached_result(BASE_DIR, 'static_config', ('my_key',), 'My static value')

B. Wichtige Hinweise zum `key_args`¶

Der key_args Parameter muss ein Tupel sein und alle Werte enthalten, die das Ergebnis der Funktion beeinflussen (z.B. ('Berlin', 'de')).

Der Mechanismus wandelt automatisch pathlib.Path-Objekte in Strings um, bevor der Cache-Schlüssel generiert wird, um Probleme zu vermeiden.