]> granicus.if.org Git - python/commitdiff
bpo-37470: Document more clearly the error handling for QueueHandler.emit(). (GH...
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Mon, 1 Jul 2019 19:45:01 +0000 (20:45 +0100)
committerGitHub <noreply@github.com>
Mon, 1 Jul 2019 19:45:01 +0000 (20:45 +0100)
Doc/library/logging.handlers.rst

index 592d7e5daf930ff9c835a95e208c595592f9482b..b7445a135b742ce6625f7647dbe04a56d1808de0 100644 (file)
@@ -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)