WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

logging.Handler.setFormatter — den Formatter eines Handlers festlegen

`logging.Handler.setFormatter` weist einem Handler einen Formatter zu oder entfernt ihn mit `None`. Die Methode steuert die Darstellung der Ausgabe, nicht den Schwellenwert der Protokollierungsstufe.

Version: Python 3.14; repository image, production runtime not attested

Syntax

handler.setFormatter(fmt)

logging.Handler.setFormatter(fmt) legt den Formatter für einen bestimmten Handler fest. Die Methode prüft nicht, ob fmt eine Instanz von logging.Formatter ist. Die Standardimplementierung von Handler.format(record) kann auch ein anderes Objekt verwenden, wenn es im booleschen Kontext als wahr gilt und eine kompatible Methode format(record) bereitstellt. Eine bloße Formatzeichenfolge ersetzt keinen Formatter. Verwende zum Beispiel handler.setFormatter(logging.Formatter("%(levelname)s | %(message)s")).

Der Aufruf handler.setFormatter(None) entfernt den zugewiesenen Formatter. Wenn der Handler Handler.format(record) verwendet, kommt anschließend der Standard-Formatter des Moduls zum Einsatz: Eine gewöhnliche Nachricht erhält weder ein Präfix mit der Stufe noch mit dem Loggernamen. Dadurch wird die Protokollierung nicht deaktiviert.

Ein Formatter steuert die Darstellung eines Records; Schwellenwerte für Stufen und Filter bestimmen dessen Verarbeitung. Die Einstellung gilt für diesen Handler, nicht für alle Handler des Loggers. Das Ausgabemuster des Formatters ist von der Interpolation der Nachrichtenargumente getrennt, etwa bei logger.info("Items: %s", 3).

Das Beispiel fängt die Ausgabe in io.StringIO ab, zuerst mit einem benutzerdefinierten Format und dann nach dessen Entfernung. Zeitstempel und die Konfiguration des Root-Loggers werden weggelassen, damit das Ergebnis deterministisch ist.

Beispiele

import io
import logging

stream = io.StringIO()
handler = logging.StreamHandler(stream)
logger = logging.getLogger("demo")
logger.setLevel(logging.INFO)
logger.propagate = False
logger.addHandler(handler)

handler.setFormatter(logging.Formatter("%(levelname)s | %(message)s"))
logger.info("Items: %s", 3)

handler.setFormatter(None)
logger.info("Items: %s", 3)

print(stream.getvalue(), end="")
logger.removeHandler(handler)
handler.close()

Ergebnis

INFO | Items: 3
Items: 3

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen