From: Yuxin Wu Date: Sat, 26 Feb 2022 18:29:51 +0000 (-0800) Subject: [doc] Add a note in howto/logging.rst about "do not log to root logger in libraries... X-Git-Tag: v3.11.0a6~72 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fc44b8136ffc501264731ccc7456729b5cf4e74b;p=thirdparty%2FPython%2Fcpython.git [doc] Add a note in howto/logging.rst about "do not log to root logger in libraries" (GH-31271) --- diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst index fcc6bec76880..4d76c27332cc 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -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