FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-37469: Document usability of SimpleQueue with QueueHandler and Qu… by vsajip · Pull Request #14521 · python/cpython · GitHub

/ cpython Public
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
21 changes: 13 additions & 8 deletions Doc/library/logging.handlers.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -992,9 +992,11 @@ possible, while any potentially slow operations (such as sending an email via
.. class:: QueueHandler(queue)

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
queue-like object; it's used as-is by the :meth:`enqueue` method, which needs
to know how to send messages to it.
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 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)
Expand Down Expand Up @@ -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
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
to know how to get messages from it. 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.
to know how to get messages from it. The queue is not *required* to have the
task tracking API (though it's used if available), which means that you can
use :class:`~queue.SimpleQueue` instances for *queue*.

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
The ``respect_handler_levels`` argument was added.
Expand Down

Back | FazBrowse Home | New Git URL