]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Closed #26533: expanded on behaviour of logging.config.listen().
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Sun, 11 Sep 2016 12:15:06 +0000 (13:15 +0100)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Sun, 11 Sep 2016 12:15:06 +0000 (13:15 +0100)
Doc/library/logging.config.rst

index 794cd22e5b077b2967670c9312b76f06f0c27a37..bf60f1721d0d04ecfede26b59c8c76566b5b241d 100644 (file)
@@ -126,10 +126,10 @@ in :mod:`logging` itself) and defining handlers which are declared either in
    Starts up a socket server on the specified port, and listens for new
    configurations. If no port is specified, the module's default
    :const:`DEFAULT_LOGGING_CONFIG_PORT` is used. Logging configurations will be
-   sent as a file suitable for processing by :func:`fileConfig`. Returns a
-   :class:`~threading.Thread` instance on which you can call
-   :meth:`~threading.Thread.start` to start the server, and which you can
-   :meth:`~threading.Thread.join` when appropriate. To stop the server,
+   sent as a file suitable for processing by :func:`dictConfig` or
+   :func:`fileConfig`. Returns a :class:`~threading.Thread` instance on which
+   you can call :meth:`~threading.Thread.start` to start the server, and which
+   you can :meth:`~threading.Thread.join` when appropriate. To stop the server,
    call :func:`stopListening`.
 
    The ``verify`` argument, if specified, should be a callable which should
@@ -165,9 +165,18 @@ in :mod:`logging` itself) and defining handlers which are declared either in
       ``verify`` argument to :func:`listen` to prevent unrecognised
       configurations from being applied.
 
-   .. versionchanged:: 3.4.
+   .. versionchanged:: 3.4
       The ``verify`` argument was added.
 
+   .. note::
+
+      If you want to send configurations to the listener which don't
+      disable existing loggers, you will need to use a JSON format for
+      the configuration, which will use :func:`dictConfig` for configuration.
+      This method allows you to specify ``disable_existing_loggers`` as
+      ``False`` in the configuration you send.
+
+
 .. function:: stopListening()
 
    Stops the listening server which was created with a call to :func:`listen`.