Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

`logging.Logger.propagate` : propager les enregistrements de journal

`propagate` détermine si un enregistrement atteint aussi les gestionnaires des loggers ancêtres. `False` arrête la propagation vers le haut sans désactiver les gestionnaires locaux.

Version : Python 3.12

Syntaxe

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

En Python 3.12, propagate est un attribut d’instance de logging.Logger, et non une méthode. Sa valeur par défaut est True. L’appel logger.addHandler(handler) attache un gestionnaire directement à ce logger sans modifier propagate.

Si un événement satisfait au seuil effectif et aux filtres du logger d’origine, son enregistrement est d’abord proposé aux gestionnaires de ce logger. Avec True, la propagation remonte la hiérarchie des noms séparés par des points, éventuellement jusqu’au logger racine. Si un logger de la chaîne a propagate = False, ses propres gestionnaires peuvent encore traiter l’enregistrement, mais ceux des niveaux supérieurs ne le reçoivent pas.

La propagation ne vérifie pas à nouveau les niveaux ni les filtres des loggers ancêtres. Le niveau et les filtres de chaque gestionnaire continuent toutefois de s’appliquer. C’est différent de l’héritage du niveau effectif : si le logger d’origine n’est pas la racine et que son niveau est NOTSET, son seuil effectif est déterminé dans la hiérarchie avant la propagation.

Si un gestionnaire local et un gestionnaire ancêtre écrivent vers la même destination, des doublons peuvent apparaître. Configurez les gestionnaires uniquement sur un ancêtre approprié, ou attachez un gestionnaire local et définissez logger.propagate = False pour isoler sa sortie. False seul ne garantit pas le silence : si aucun gestionnaire n’est trouvé sur le trajet, logging.lastResort peut émettre des enregistrements de niveau WARNING ou supérieur.

Exemples

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

Résultat

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

Les deux gestionnaires affichent le premier enregistrement `INFO`. Le gestionnaire de la racine l’accepte même si le logger racine est réglé sur `ERROR`. Après le passage à `False`, seul le gestionnaire de `checkout` affiche le second enregistrement.

Leçons associées

  • Python · Leçon 24 · Intermédiaire · Version : 3

Sources