WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

Einen Logging-Handler hinzufügen und die Weitergabe stoppen

Mit `addHandler()` fügst du einem bestimmten Logger einen Handler hinzu. Mit `propagate = False` verhinderst du die Weitergabe an Handler übergeordneter Logger, einschließlich des Root-Loggers.

Version: Python 3.12

Syntax

logger.addHandler(hdlr)
logger.propagate = False

logging.Logger.addHandler fügt einem bestimmten Logger ein vorhandenes Handler-Objekt hinzu. Rufe den Logger mit logging.getLogger(name) ab und übergib an logger.addHandler(hdlr) ein Objekt, etwa eine Instanz von logging.StreamHandler, nicht die Klasse selbst. Der Handler bestimmt das Ausgabeziel, sein Formatter die Darstellung des Textes. Löse den Handler mit logger.removeHandler(hdlr), statt logger.handlers direkt zu ändern.

Der ursprüngliche Logger prüft zuerst seinen effektiven Log-Level und seine eigenen Filter. Einen akzeptierten Datensatz bietet er seinen lokalen Handlern an. Mit der Voreinstellung propagate = True wird der Datensatz auch den Handlern der übergeordneten Logger angeboten, bis die Weitergabe endet. Deren Logger-Level und Logger-Filter werden dabei nicht geprüft. Jeder Handler wendet aber weiterhin seinen eigenen Schwellenwert und seine eigenen Filter an.

Mit logger.propagate = False endet die Weitergabe bei diesem Logger, nachdem seine lokalen Handler den Datensatz verarbeiten konnten. Das deaktiviert weder den Logger noch ändert es die Konfiguration des Root-Loggers. Kein Handler weiter oben in diesem Zweig erhält den Datensatz. Schreiben lokale und übergeordnete Handler an dasselbe Ziel, kann die Ausgabe doppelt erscheinen. Genügt ein gemeinsames Ziel, füge den Handler nur dem passenden übergeordneten Logger hinzu und lasse die Weitergabe aktiviert.

Beispiele

import logging
import sys

logging.basicConfig(
    level=logging.WARNING,
    stream=sys.stdout,
    format="root: %(message)s",
)

logger = logging.getLogger("cktis.demo")
logger.setLevel(logging.INFO)
handler = logging.StreamHandler(sys.stdout)
handler.setFormatter(logging.Formatter("local: %(message)s"))
logger.addHandler(handler)

logger.info("first")
logger.propagate = False
logger.info("second")

Ergebnis

local: first
root: first
local: second

Führe das Skript in einem neuen Python-3.12-Prozess aus. `first` erscheint zweimal: mit `local:` und mit `root:`. Der Level `WARNING` des Root-Loggers blockiert den weitergegebenen `INFO`-Datensatz nicht, weil er direkt an dessen Handler geht. Nach dem Abschalten der Weitergabe erscheint `second` nur mit `local:`.

Zugehörige Lektionen

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

Quellen