From 47ca122bdd988227262dac375d625f6156036a22 Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Mon, 27 Sep 2010 13:53:47 +0000 Subject: [PATCH] logging: Updated library configuration documentation. --- Doc/library/logging.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 342762406584..4acd1d48cef0 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -530,6 +530,14 @@ 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". +**PLEASE NOTE:** It is strongly advised that you *do not add any handlers other +than* :class:`NullHandler` *to your library's loggers*. This is because the +configuration of handlers is the prerogative of the application developer who +uses your library. The application developer knows their target audience and +what handlers are most appropriate for their application: if you add handlers +"under the hood", you might well interfere with their ability to carry out +unit tests and deliver logs which suit their requirements. + .. versionadded:: 2.7 The :class:`NullHandler` class was not present in previous versions, but is now @@ -1957,6 +1965,16 @@ for use by library developers. This method does nothing. + .. method:: handle(record) + + This method does nothing. + + .. method:: createLock() + + This method returns `None` for the lock, since there is no + underlying I/O to which access needs to be serialized. + + See :ref:`library-config` for more information on how to use :class:`NullHandler`. -- 2.47.3