]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-65046: Add note about logging from async code. (GH-97602)
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Wed, 28 Sep 2022 04:17:42 +0000 (05:17 +0100)
committerGitHub <noreply@github.com>
Wed, 28 Sep 2022 04:17:42 +0000 (05:17 +0100)
Doc/howto/logging-cookbook.rst

index 16df3b730ac80e4633a361e689d053f2b10120b0..5b079744df12ed4c448be62a3cb73f46a2d121ef 100644 (file)
@@ -397,6 +397,14 @@ which, when run, will produce:
 
     MainThread: Look out!
 
+.. note:: Although the earlier discussion wasn't specifically talking about
+   async code, but rather about slow logging handlers, it should be noted that
+   when logging from async code, network and even file handlers could lead to
+   problems (blocking the event loop) because some logging is done from
+   :mod:`asyncio` internals. It might be best, if any async code is used in an
+   application, to use the above approach for logging, so that any blocking code
+   runs only in the ``QueueListener`` thread.
+
 .. versionchanged:: 3.5
    Prior to Python 3.5, the :class:`QueueListener` always passed every message
    received from the queue to every handler it was initialized with. (This was