diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-07-01 19:53:39 (GMT) |
|---|---|---|
| committer | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2019-07-01 19:53:39 (GMT) |
| commit | 91f9f098fcdb023dbb89d06c8833e89a11cbae4c (patch) | |
| tree | 46866b51555ac22905259062bbfa167b4fe3e592 | |
| parent | 6cde61369e8174c493ca240cb52ebc9c2a2fe667 (diff) | |
| download | cpython-91f9f098fcdb023dbb89d06c8833e89a11cbae4c.zip cpython-91f9f098fcdb023dbb89d06c8833e89a11cbae4c.tar.gz cpython-91f9f098fcdb023dbb89d06c8833e89a11cbae4c.tar.bz2 | |
bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH-14532) (GH-14533)
(cherry picked from commit 0f4e8132820947d93eccf31b9e526b81c6ffa53d)
| -rw-r--r-- | Doc/library/logging.handlers.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index d5944ec..32919c1 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -980,7 +980,12 @@ possible, while any potentially slow operations (such as sending an email via .. method:: emit(record) - Enqueues the result of preparing the LogRecord. + Enqueues the result of preparing the LogRecord. Should an exception + occur (e.g. because a bounded queue has filled up), the + :meth:`~logging.Handler.handleError` method is called to handle the + error. This can result in the record silently being dropped (if + :attr:`logging.raiseExceptions` is ``False``) or a message printed to + ``sys.stderr`` (if :attr:`logging.raiseExceptions` is ``True``). .. method:: prepare(record) |