KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / Python

`logging.Logger.propagate`: logrecords doorgeven

`propagate` bepaalt of een logrecord ook de handlers van bovenliggende loggers bereikt. `False` stopt het doorgeven naar boven zonder lokale handlers uit te schakelen.

Versie: 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 is propagate een attribuut van een logging.Logger-instantie, geen methode. De standaardwaarde is True. Met logger.addHandler(handler) koppel je een handler rechtstreeks aan die logger zonder propagate te wijzigen.

Als een gebeurtenis door de effectieve niveaudrempel en de filters van de oorspronkelijke logger komt, wordt het record eerst aan diens handlers aangeboden. Bij True gaat het record omhoog door de hiërarchie van namen met punten, eventueel tot aan de rootlogger. Heeft een logger in de keten propagate = False, dan kunnen zijn eigen handlers het record nog verwerken, maar hoger gelegen handlers krijgen het niet.

Bij het doorgeven worden de niveaus en filters van bovenliggende loggers niet opnieuw gecontroleerd. Het eigen niveau en de filters van elke handler blijven wel van toepassing. Dat is iets anders dan het overerven van het effectieve niveau: als de oorspronkelijke logger niet de rootlogger is en niveau NOTSET heeft, wordt zijn effectieve drempel vóór het doorgeven via de hiërarchie bepaald.

Als een lokale en een bovenliggende handler naar dezelfde bestemming schrijven, kunnen dubbele vermeldingen ontstaan. Configureer handlers alleen op een geschikte bovenliggende logger, of koppel een lokale handler en stel logger.propagate = False in om diens uitvoer te isoleren. Alleen False garandeert geen stilte: als er onderweg geen handler wordt gevonden, kan logging.lastResort records met niveau WARNING of hoger uitvoeren.

Voorbeelden

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

Resultaat

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

Beide handlers schrijven het eerste `INFO`-record. De handler van de rootlogger accepteert het, ook al staat de rootlogger zelf op `ERROR`. Na het instellen van `False` schrijft alleen de handler van `checkout` het tweede record.

Gerelateerde lessen

  • Python · Les 24 · Gemiddeld · Versie: 3

Bronnen