From f78c229b4ec8621a9b15c6396b6c91518e8975d6 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Tue, 7 Dec 2021 03:45:13 -0800 Subject: [PATCH] [3.10] bpo-35821: Add an example to Logger.propagate documentation. (GH-29841) (GH-29957) --- Doc/library/logging.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index bb1bbf0e3708..ade4a3c6b261 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -80,6 +80,15 @@ is the module's name in the Python package namespace. If this evaluates to false, logging messages are not passed to the handlers of ancestor loggers. + Spelling it out with an example: If the propagate attribute of the logger named + `A.B.C` evaluates to true, any event logged to `A.B.C` via a method call such as + `logging.getLogger('A.B.C').error(...)` will [subject to passing that logger's + level and filter settings] be passed in turn to any handlers attached to loggers + named `A.B`, `A` and the root logger, after first being passed to any handlers + attached to `A.B.C`. If any logger in the chain `A.B.C`, `A.B`, `A` has its + `propagate` attribute set to false, then that is the last logger whose handlers + are offered the event to handle, and propagation stops at that point. + The constructor sets this attribute to ``True``. .. note:: If you attach a handler to a logger *and* one or more of its -- 2.47.3