pr feedback

python · vsajip · Jun 7, 2022 · May 10, 2022 · May 10, 2022 · May 10, 2022
commit 225329fcb4d192a07490177a078e753e2f32ac14
@@ -713,28 +713,21 @@ which, when run, produces something like:
     2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters
     2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters
 
-Imparting contextual in Handlers
----------------------------------
+Imparting contextual information in handlers
+--------------------------------------------
 
-Each :class:`~Handler` has it's own chain of Filters.
+Each :class:`~Handler` has its own chain of filters.
 If you want to add contextual information to a :class:`LogRecord` without leaking
-this contextual information to other handlers, you can use a filter that returns
+it to other handlers, you can use a filter that returns
 a new :class:`~LogRecord` instead of modifying it in-place:
 
 script::
 
+    import copy
     import logging
 
     def filter(record: logging.LogRecord):
-        record = logging.LogRecord(
-            name=record.name,
-            level=record.levelno,
-            pathname=record.pathname,
-            lineno=record.lineno,
-            msg=record.msg,
-            exc_info=record.exc_info,
-            args=(),
-        )
+        record = copy.copy(record)
         record.user = 'jim'
         return record
 

@@ -662,8 +662,8 @@ empty string, all events are passed.
 
    .. method:: filter(record)
 
-      Is the specified record to be logged? Returns zero for no, nonzero for
-      yes. Filters can also modify log records in-place or return a completely
+      Is the specified record to be logged? Returns falsy for no, truthy for
+      yes. Filters can either modify log records in-place or return a completely
       different record instance which will replace the original
       log record without modifying it.
 
@@ -689,7 +689,7 @@ which has a ``filter`` method with the same semantics.
 
 .. versionchanged:: 3.12
    You can now return a :class:`LogRecord` instance from filters to replace
-   the log record without modifying it in place. This allows filters installed
+   the log record without modifying it in place. This allows filters attached to
    on a :class:`Handler` to modify the log record before it is emitted without
    having side effects on other handlers.
 

@@ -817,15 +817,17 @@ def filter(self, record):
         Determine if a record is loggable by consulting all the filters.
 
         The default is to allow the record to be logged; any filter can veto
-        this by returning a falsy value  and the record is then dropped and
-        this method returns a falsy value.
-        Filters can return a log record, which case that log record
-        is used to call the next filter.
-        If filters return a truthy value that is not a log record the
-        next filter is called with the existing log record.
+        this by returning a falsy value.
+        If a filter attached to a handler returns a log record instance,
+        then that instance is used in place of the original log record in
+        any further processing of the event by that handler.
+        If a filter returns any other truthy value, the original log record
+        is used in any further processing of the event by that handler.
 
         If none of the filters return falsy values, this method returns
         a log record.
+        If any of the filters return a falsy value, this method returns
+        a falsy value.
 
         .. versionchanged:: 3.2
 

@@ -469,15 +469,9 @@ def log_at_all_levels(self, logger):
 
     def test_handler_filter_replaces_record(self):
         def replace_message(record: logging.LogRecord):
-            return logging.LogRecord(
-                name=record.name,
-                level=record.levelno,
-                pathname=record.pathname,
-                lineno=record.lineno,
-                msg="new message!",
-                exc_info=record.exc_info,
-                args=(),
-            )
+            record = copy.copy(record)
+            record.msg = "new message!"
+            return record
 
         # Set up a logging hierarchy such that "child" and it's handler
         # (and thus `replace_message()`) always get called before
@@ -507,15 +501,7 @@ def test_logging_filter_replaces_record(self):
         class RecordingFilter(logging.Filter):
             def filter(self, record: logging.LogRecord):
                 records.add(id(record))
-                return logging.LogRecord(
-                    name=record.name,
-                    level=record.levelno,
-                    pathname=record.pathname,
-                    lineno=record.lineno,
-                    msg=record.msg,
-                    exc_info=record.exc_info,
-                    args=(),
-                )
+                return copy.copy(record)
 
         logger = logging.getLogger("logger")
         logger.setLevel(logging.INFO)

diff --git a/Misc/NEWS.d/next/Library/2022-05-09-22-27-11.gh-issue-92591.V7RCk2.rst b/Misc/NEWS.d/next/Library/2022-05-09-22-27-11.gh-issue-92591.V7RCk2.rst
@@ -1,3 +1,3 @@
-Let :mod:`logging` Filters to return a :class:`logging.LogRecord` instance
-so that :class:`logging.Handler`\ s can enrich records without side effects on
-other Handlers.
+Let :mod:`logging` filters to return a :class:`logging.LogRecord` instance
+so that filters attached to :class:`logging.Handler`\ s can enrich records without
+side effects on other handlers.