Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-44473: Update docstring and documentation for QueueHandler.prepar… (GH-27140) 

…e().
This commit is contained in:
Vinay Sajip 2021-07-15 01:06:48 +01:00 committed by GitHub
parent d59d7374a3
commit 3b8075f907
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/logging.handlers.rst
View File

@ -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

11
Lib/logging/handlers.py
View File

@ -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