From 0f4e8132820947d93eccf31b9e526b81c6ffa53d Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Mon, 1 Jul 2019 20:45:01 +0100 Subject: [PATCH] bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH-14532) --- 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 592d7e5daf..b7445a135b 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -1001,7 +1001,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) -- 2.40.0