traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521)

This commit is contained in:
Vinay Sajip 2019-07-01 18:45:07 +01:00 committed by GitHub
parent 36242fd871
commit e6b64b756f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Doc/library/logging.handlers.rst
View File

@ -992,9 +992,11 @@ possible, while any potentially slow operations (such as sending an email via
.. class:: QueueHandler(queue) .. class:: QueueHandler(queue)
Returns a new instance of the :class:`QueueHandler` class. The instance is Returns a new instance of the :class:`QueueHandler` class. The instance is
initialized with the queue to send messages to. The queue can be any initialized with the queue to send messages to. The *queue* can be any
queue-like object; it's used as-is by the :meth:`enqueue` method, which needs queue-like object; it's used as-is by the :meth:`enqueue` method, which
to know how to send messages to it. needs to know how to send messages to it. The queue is not *required* to
have the task tracking API, which means that you can use
:class:`~queue.SimpleQueue` instances for *queue*.
.. method:: emit(record) .. method:: emit(record)
@ -1050,11 +1052,14 @@ possible, while any potentially slow operations (such as sending an email via
initialized with the queue to send messages to and a list of handlers which initialized with the queue to send messages to and a list of handlers which
will handle entries placed on the queue. The queue can be any queue-like will handle entries placed on the queue. The queue can be any queue-like
object; it's passed as-is to the :meth:`dequeue` method, which needs object; it's passed as-is to the :meth:`dequeue` method, which needs
to know how to get messages from it. If ``respect_handler_level`` is ``True``, to know how to get messages from it. The queue is not *required* to have the
a handler's level is respected (compared with the level for the message) when task tracking API (though it's used if available), which means that you can
deciding whether to pass messages to that handler; otherwise, the behaviour use :class:`~queue.SimpleQueue` instances for *queue*.
is as in previous Python versions - to always pass each message to each
handler. If ``respect_handler_level`` is ``True``, a handler's level is respected
(compared with the level for the message) when deciding whether to pass
messages to that handler; otherwise, the behaviour is as in previous Python
versions - to always pass each message to each handler.
.. versionchanged:: 3.5 .. versionchanged:: 3.5
The ``respect_handler_levels`` argument was added. The ``respect_handler_levels`` argument was added.