From 91f9f098fcdb023dbb89d06c8833e89a11cbae4c Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Mon, 1 Jul 2019 12:53:39 -0700 Subject: bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH-14532) (GH-14533) (cherry picked from commit 0f4e8132820947d93eccf31b9e526b81c6ffa53d) --- Doc/library/logging.handlers.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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) -- cgit v0.12