WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

`logging.Logger.propagate`: Log-Datensätze weitergeben

`propagate` steuert, ob ein Log-Datensatz auch die Handler übergeordneter Logger erreicht. `False` stoppt die Weitergabe nach oben, ohne lokale Handler zu deaktivieren.

Version: Python 3.12

Syntax

logger.addHandler(handler)
logger.propagate = False  # Stop forwarding to ancestor handlers.
logger.propagate = True   # Allow forwarding to ancestor handlers.

In Python 3.12 ist propagate ein Attribut einer logging.Logger-Instanz, keine Methode. Der Standardwert ist True. Mit logger.addHandler(handler) hängst du einen Handler direkt an diesen Logger, ohne propagate zu ändern.

Wenn ein Ereignis die Prüfung des effektiven Log-Levels und der Filter des ursprünglichen Loggers besteht, wird sein Datensatz zuerst dessen Handlern angeboten. Bei True geht die Weitergabe in der Hierarchie der durch Punkte getrennten Namen nach oben, gegebenenfalls bis zum Root-Logger. Hat ein Logger in der Kette propagate = False, können seine eigenen Handler den Datensatz noch verarbeiten, aber die Handler darüber erhalten ihn nicht.

Bei der Weitergabe werden Level und Filter übergeordneter Logger nicht erneut geprüft. Level und Filter der einzelnen Handler gelten weiterhin. Das ist etwas anderes als das Erben des effektiven Levels: Hat der ursprüngliche Logger, sofern er nicht der Root-Logger ist, das Level NOTSET, wird seine wirksame Schwelle vor der Weitergabe über die Hierarchie ermittelt.

Schreiben ein lokaler und ein übergeordneter Handler an dasselbe Ziel, können doppelte Einträge entstehen. Konfiguriere Handler nur an einem geeigneten übergeordneten Logger oder hänge einen lokalen Handler an und setze logger.propagate = False, um dessen Ausgabe zu isolieren. False allein garantiert keine Stille: Wird auf dem Weg kein Handler gefunden, kann logging.lastResort Datensätze ab WARNING ausgeben.

Beispiele

import logging
import sys


def console_handler(label):
    handler = logging.StreamHandler(sys.stdout)
    handler.setLevel(logging.INFO)
    handler.setFormatter(logging.Formatter(f"{label}: %(message)s"))
    return handler


root = logging.getLogger()
root.setLevel(logging.ERROR)
root.addHandler(console_handler("root"))

logger = logging.getLogger("checkout")
logger.setLevel(logging.INFO)
logger.addHandler(console_handler("checkout"))

logger.propagate = True
logger.info("order received")

logger.propagate = False
logger.info("order saved")

Ergebnis

checkout: order received
root: order received
checkout: order saved

Beide Handler geben den ersten `INFO`-Datensatz aus. Der Root-Handler verarbeitet ihn, obwohl der Root-Logger selbst auf `ERROR` steht. Nach dem Setzen von `False` gibt nur der Handler von `checkout` den zweiten Datensatz aus.

Zugehörige Lektionen

  • Python · Lektion 24 · Mittlere Stufe · Version: 3

Quellen