]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[doc] Add a note in howto/logging.rst about "do not log to root logger in libraries...
authorYuxin Wu <ppwwyyxxc@gmail.com>
Sat, 26 Feb 2022 18:29:51 +0000 (10:29 -0800)
committerGitHub <noreply@github.com>
Sat, 26 Feb 2022 18:29:51 +0000 (18:29 +0000)
Doc/howto/logging.rst

index fcc6bec76880024f5b1b637e66e95e2f50e474d5..4d76c27332ccd3a16111f035df37ef42bd4131f4 100644 (file)
@@ -831,6 +831,13 @@ should have the desired effect. If an organisation produces a number of
 libraries, then the logger name specified can be 'orgname.foo' rather than
 just 'foo'.
 
+.. note:: It is strongly advised that you *do not log to the root logger*
+   in your library. Instead, use a logger with a unique and easily
+   identifiable name, such as the ``__name__`` for your library's top-level package
+   or module. Logging to the root logger will make it difficult or impossible for
+   the application developer to configure the logging verbosity or handlers of
+   your library as they wish.
+
 .. note:: It is strongly advised that you *do not add any handlers other
    than* :class:`~logging.NullHandler` *to your library's loggers*. This is
    because the configuration of handlers is the prerogative of the application