diff options
| author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2021-07-15 00:06:48 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-15 00:06:48 (GMT) |
| commit | 3b8075f9076490508567f0fb3dc689861544d1a8 (patch) | |
| tree | 692432a612b567f314a2a943eb6f6b6fc58f60f2 /Doc/library/logging.handlers.rst | |
| parent | d59d7374a364c4e5c2b9a83d8e4543ee494285b8 (diff) | |
| download | cpython-3b8075f9076490508567f0fb3dc689861544d1a8.zip cpython-3b8075f9076490508567f0fb3dc689861544d1a8.tar.gz cpython-3b8075f9076490508567f0fb3dc689861544d1a8.tar.bz2 | |
bpo-44473: Update docstring and documentation for QueueHandler.prepar… (GH-27140)
…e().
Diffstat (limited to 'Doc/library/logging.handlers.rst')
| -rw-r--r-- | Doc/library/logging.handlers.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index 059ab3d..7fe9a98 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -1014,8 +1014,12 @@ possible, while any potentially slow operations (such as sending an email via method is enqueued. The base implementation formats the record to merge the message, - arguments, and exception information, if present. It also - removes unpickleable items from the record in-place. + arguments, and exception information, if present. It also removes + unpickleable items from the record in-place. Specifically, it overwrites + the record's :attr:`msg` and :attr:`message` attributes with the merged + message (obtained by calling the handler's :meth:`format` method), and + sets the :attr:`args`, :attr:`exc_info` and :attr:`exc_text` attributes + to ``None``. You might want to override this method if you want to convert the record to a dict or JSON string, or send a modified copy |