Skip to content

Commit ce9e625

Browse files
authored
bpo-31457: Don't omit inner process() calls with nested LogAdapters (#4044)
This used to be the case on Python 2. Commit 212b590 changed the implementation for Python 3, making the `log()` method of LogAdapter call `logger._log()` directly. This makes nested log adapters not execute their ``process()`` method. This patch fixes the issue. Also, now proxying `name`, too, to make `repr()` work with nested log adapters. New tests added.
1 parent 05a634b commit ce9e625

File tree

3 files changed

+21
-7
lines changed

3 files changed

+21
-7
lines changed

Lib/logging/__init__.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1713,7 +1713,7 @@ def log(self, level, msg, *args, **kwargs):
17131713
"""
17141714
if self.isEnabledFor(level):
17151715
msg, kwargs = self.process(msg, kwargs)
1716-
self.logger._log(level, msg, args, **kwargs)
1716+
self.logger.log(level, msg, *args, **kwargs)
17171717

17181718
def isEnabledFor(self, level):
17191719
"""
@@ -1760,6 +1760,10 @@ def manager(self):
17601760
def manager(self, value):
17611761
self.logger.manager = value
17621762

1763+
@property
1764+
def name(self):
1765+
return self.logger.name
1766+
17631767
def __repr__(self):
17641768
logger = self.logger
17651769
level = getLevelName(logger.getEffectiveLevel())

Lib/test/test_logging.py

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3904,7 +3904,6 @@ def test_critical(self):
39043904

39053905

39063906
class LoggerAdapterTest(unittest.TestCase):
3907-
39083907
def setUp(self):
39093908
super(LoggerAdapterTest, self).setUp()
39103909
old_handler_list = logging._handlerList[:]
@@ -3979,27 +3978,36 @@ def test_has_handlers(self):
39793978
self.assertFalse(self.adapter.hasHandlers())
39803979

39813980
def test_nested(self):
3981+
class Adapter(logging.LoggerAdapter):
3982+
prefix = 'Adapter'
3983+
3984+
def process(self, msg, kwargs):
3985+
return f"{self.prefix} {msg}", kwargs
3986+
39823987
msg = 'Adapters can be nested, yo.'
3983-
adapter_adapter = logging.LoggerAdapter(logger=self.adapter, extra=None)
3988+
adapter = Adapter(logger=self.logger, extra=None)
3989+
adapter_adapter = Adapter(logger=adapter, extra=None)
3990+
adapter_adapter.prefix = 'AdapterAdapter'
3991+
self.assertEqual(repr(adapter), repr(adapter_adapter))
39843992
adapter_adapter.log(logging.CRITICAL, msg, self.recording)
39853993
self.assertEqual(len(self.recording.records), 1)
39863994
record = self.recording.records[0]
39873995
self.assertEqual(record.levelno, logging.CRITICAL)
3988-
self.assertEqual(record.msg, msg)
3996+
self.assertEqual(record.msg, f"Adapter AdapterAdapter {msg}")
39893997
self.assertEqual(record.args, (self.recording,))
39903998
orig_manager = adapter_adapter.manager
3991-
self.assertIs(self.adapter.manager, orig_manager)
3999+
self.assertIs(adapter.manager, orig_manager)
39924000
self.assertIs(self.logger.manager, orig_manager)
39934001
temp_manager = object()
39944002
try:
39954003
adapter_adapter.manager = temp_manager
39964004
self.assertIs(adapter_adapter.manager, temp_manager)
3997-
self.assertIs(self.adapter.manager, temp_manager)
4005+
self.assertIs(adapter.manager, temp_manager)
39984006
self.assertIs(self.logger.manager, temp_manager)
39994007
finally:
40004008
adapter_adapter.manager = orig_manager
40014009
self.assertIs(adapter_adapter.manager, orig_manager)
4002-
self.assertIs(self.adapter.manager, orig_manager)
4010+
self.assertIs(adapter.manager, orig_manager)
40034011
self.assertIs(self.logger.manager, orig_manager)
40044012

40054013

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
If nested log adapters are used, the inner ``process()`` methods are no
2+
longer omitted.

0 commit comments

Comments
 (0)