summaryrefslogtreecommitdiffstats
path: root/Lib/logging
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2021-07-15 00:06:48 (GMT)
committerGitHub <noreply@github.com>2021-07-15 00:06:48 (GMT)
commit3b8075f9076490508567f0fb3dc689861544d1a8 (patch)
tree692432a612b567f314a2a943eb6f6b6fc58f60f2 /Lib/logging
parentd59d7374a364c4e5c2b9a83d8e4543ee494285b8 (diff)
downloadcpython-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 'Lib/logging')
-rw-r--r--Lib/logging/handlers.py11
1 files changed, 7 insertions, 4 deletions
diff --git a/Lib/logging/handlers.py b/Lib/logging/handlers.py
index b0d5885..e933f1b 100644
--- a/Lib/logging/handlers.py
+++ b/Lib/logging/handlers.py
@@ -1399,12 +1399,15 @@ class QueueHandler(logging.Handler):
def prepare(self, record):
"""
- Prepares a record for queuing. The object returned by this method is
+ Prepare a record for queuing. The object returned by this method is
enqueued.
- The base implementation formats the record to merge the message
- and arguments, and removes unpickleable items from the record
- in-place.
+ The base implementation formats the record to merge the message and
+ arguments, and removes unpickleable items from the record in-place.
+ Specifically, it overwrites the record's `msg` and
+ `message` attributes with the merged message (obtained by
+ calling the handler's `format` method), and sets the `args`,
+ `exc_info` and `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