WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

Logger-Handler prüfen, entfernen und hinzufügen

In Python 3.12 zeigt `logger.handlers` nur die direkt am Logger registrierten Handler. Lies die Liste aus und ändere ihre Einträge nur mit `addHandler()` und `removeHandler()`.

Version: Python 3.12

Syntax

logger.handlers
logger.addHandler(handler)
logger.removeHandler(handler)

# Detach every handler in the snapshot of this logger's direct attachments.
for handler in list(logger.handlers):
    logger.removeHandler(handler)

logging.Logger.handlers ist ein Instanzattribut. Es enthält die Liste der direkt an diesem Logger registrierten Handler. Handler übergeordneter Logger stehen nicht darin, und das Attribut ist nicht das Modul logging.handlers. len(logger.handlers) zählt nur die direkt registrierten Handler.

Behandle die Liste als schreibgeschützt. logger.addHandler(handler) registriert einen Handler, logger.removeHandler(handler) entfernt ihn. Verwende weder logger.handlers.clear() noch append() oder eine Zuweisung: Damit würdest du die Sperren dieser Methoden umgehen. Um die Liste zu leeren, iteriere über die Kopie list(logger.handlers) und rufe für jeden Eintrag removeHandler() auf. So änderst du nicht die Liste, über die du gerade iterierst; der gesamte Vorgang ist aber nicht atomar.

Das Entfernen schließt einen Handler nicht. Rufe handler.close() separat für einen Handler auf, für den du verantwortlich bist, sobald er nirgends mehr benötigt wird. Schließe ihn nicht allein deshalb, weil du ihn von einem Logger entfernt hast: Er kann weiterhin gemeinsam genutzt werden.

Eine leere Liste bedeutet nicht, dass nichts ausgegeben wird. logger.hasHandlers() prüft auch die durch Weiterleitung erreichbaren übergeordneten Logger. Es prüft, ob ein Handler vorhanden ist, nicht ob ein bestimmter Logeintrag ausgegeben wird. logger.propagate = False unterbindet die Weiterleitung an übergeordnete Logger. Wird auf diesem Weg kein Handler gefunden, kann logging.lastResort einspringen; standardmäßig schreibt er Einträge ab WARNING auf die Standardfehlerausgabe.

Beispiele

import logging
import sys

logger = logging.getLogger('cktis.lesson27')
logger.setLevel(logging.INFO)
logger.propagate = False

old_handler = logging.NullHandler()
logger.addHandler(old_handler)
print('before:', len(logger.handlers))

for handler in list(logger.handlers):
    logger.removeHandler(handler)
old_handler.close()
print('cleared:', len(logger.handlers))

new_handler = logging.StreamHandler(sys.stdout)
new_handler.setFormatter(logging.Formatter('%(message)s'))
logger.addHandler(new_handler)
try:
    print('attached:', len(logger.handlers))
    logger.info('ready')
finally:
    logger.removeHandler(new_handler)
    new_handler.close()

Ergebnis

before: 1
cleared: 0
attached: 1
ready

Führe das Beispiel in einem neuen Prozess aus. Die Anzahlen zeigen einen direkt registrierten Handler, eine leere Liste und einen neuen Handler. Der neue `StreamHandler` schreibt `ready`; der `finally`-Block entfernt und schließt ihn.

Zugehörige Lektionen

  • Python · Lektion 27 · Fortgeschritten · Version: 5

Quellen