summaryrefslogtreecommitdiffstats
path: root/Doc/library/logging.config.rst
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2016-09-11 12:15:06 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2016-09-11 12:15:06 (GMT)
commit3d639b2c2eb6f2488604c1b7e09e6f435e4dcf6a (patch)
tree061c463f305d7428e75834122a32299e4881551f /Doc/library/logging.config.rst
parent8d82559ca7cd50de45e1aff0b9f9851f4cb64019 (diff)
downloadcpython-3d639b2c2eb6f2488604c1b7e09e6f435e4dcf6a.zip
cpython-3d639b2c2eb6f2488604c1b7e09e6f435e4dcf6a.tar.gz
cpython-3d639b2c2eb6f2488604c1b7e09e6f435e4dcf6a.tar.bz2
Closed #26533: expanded on behaviour of logging.config.listen().
Diffstat (limited to 'Doc/library/logging.config.rst')
-rw-r--r--Doc/library/logging.config.rst19
1 files changed, 14 insertions, 5 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 794cd22..bf60f17 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -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`.