Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Python

`logging.Logger.propagate`: przekazywanie rekordów logowania

Atrybut `propagate` określa, czy rekord trafia również do obiektów obsługi (handlerów) loggerów nadrzędnych. `False` zatrzymuje przekazywanie w górę, ale nie wyłącza lokalnych handlerów.

Wersja: Python 3.12

Składnia

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

W Pythonie 3.12 propagate to atrybut instancji logging.Logger, a nie metoda. Domyślnie ma wartość True. Wywołanie logger.addHandler(handler) dołącza handler bezpośrednio do loggera i nie zmienia ustawienia propagate.

Gdy zdarzenie przejdzie kontrolę efektywnego poziomu i filtrów loggera źródłowego, rekord najpierw trafia do jego handlerów. Przy True przekazywanie biegnie w górę hierarchii nazw rozdzielonych kropkami, aż do loggera głównego (root), o ile nic go nie zatrzyma. Jeśli logger w tym łańcuchu ma propagate = False, jego własne handlery nadal mogą obsłużyć rekord, ale handlery powyżej już go nie dostaną.

Podczas przekazywania poziomy i filtry loggerów nadrzędnych nie są sprawdzane ponownie. Nadal obowiązują jednak poziomy i filtry poszczególnych handlerów. Nie należy tego mylić z dziedziczeniem efektywnego poziomu: jeśli źródłowy logger inny niż root ma poziom NOTSET, jego efektywny poziom jest ustalany na podstawie hierarchii jeszcze przed przekazaniem rekordu.

Jeśli lokalny handler i handler nadrzędny zapisują rekord w to samo miejsce, wpis może się pojawić dwukrotnie. Skonfiguruj handlery tylko na odpowiednim loggerze nadrzędnym albo dołącz lokalny handler i ustaw logger.propagate = False, by odizolować jego wpisy. Samo False nie gwarantuje ciszy: jeśli po drodze nie zostanie znaleziony żaden handler, logging.lastResort może zapisać rekord o poziomie WARNING lub wyższym.

Przykłady

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")

Wynik

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

Pierwszy rekord `INFO` wypisują oba handlery. Handler loggera root przyjmuje go mimo poziomu `ERROR` ustawionego na samym loggerze root. Po ustawieniu `False` drugi rekord wypisuje tylko handler `checkout`.

Powiązane lekcje

  • Python · Lekcja 24 · Średniozaawansowany · Wersja: 3

Źródła