Skip to content

Commit b0ab95b

Browse files
miss-islingtonvsajip
authored andcommitted
bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521) (GH-14526)
(cherry picked from commit e6b64b7)
1 parent e34b5f4 commit b0ab95b

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

Doc/library/logging.handlers.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -971,9 +971,11 @@ possible, while any potentially slow operations (such as sending an email via
971971
.. class:: QueueHandler(queue)
972972

973973
Returns a new instance of the :class:`QueueHandler` class. The instance is
974-
initialized with the queue to send messages to. The queue can be any
975-
queue-like object; it's used as-is by the :meth:`enqueue` method, which needs
976-
to know how to send messages to it.
974+
initialized with the queue to send messages to. The *queue* can be any
975+
queue-like object; it's used as-is by the :meth:`enqueue` method, which
976+
needs to know how to send messages to it. The queue is not *required* to
977+
have the task tracking API, which means that you can use
978+
:class:`~queue.SimpleQueue` instances for *queue*.
977979

978980

979981
.. method:: emit(record)
@@ -1029,11 +1031,14 @@ possible, while any potentially slow operations (such as sending an email via
10291031
initialized with the queue to send messages to and a list of handlers which
10301032
will handle entries placed on the queue. The queue can be any queue-like
10311033
object; it's passed as-is to the :meth:`dequeue` method, which needs
1032-
to know how to get messages from it. If ``respect_handler_level`` is ``True``,
1033-
a handler's level is respected (compared with the level for the message) when
1034-
deciding whether to pass messages to that handler; otherwise, the behaviour
1035-
is as in previous Python versions - to always pass each message to each
1036-
handler.
1034+
to know how to get messages from it. The queue is not *required* to have the
1035+
task tracking API (though it's used if available), which means that you can
1036+
use :class:`~queue.SimpleQueue` instances for *queue*.
1037+
1038+
If ``respect_handler_level`` is ``True``, a handler's level is respected
1039+
(compared with the level for the message) when deciding whether to pass
1040+
messages to that handler; otherwise, the behaviour is as in previous Python
1041+
versions - to always pass each message to each handler.
10371042

10381043
.. versionchanged:: 3.5
10391044
The ``respect_handler_levels`` argument was added.

0 commit comments

Comments
 (0)