Skip to content

Commit 1d5a7e5

Browse files
miss-islingtonvsajip
authored andcommitted
bpo-39142: Avoid converting namedtuple instances to ConvertingTuple. (GH-17773) (GH-17785)
(cherry picked from commit 46abfc1)
1 parent dad526e commit 1d5a7e5

File tree

3 files changed

+37
-1
lines changed

3 files changed

+37
-1
lines changed

Lib/logging/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ def convert(self, value):
447447
value = ConvertingList(value)
448448
value.configurator = self
449449
elif not isinstance(value, ConvertingTuple) and\
450-
isinstance(value, tuple):
450+
isinstance(value, tuple) and not hasattr(value, '_fields'):
451451
value = ConvertingTuple(value)
452452
value.configurator = self
453453
elif isinstance(value, str): # str for py3k

Lib/test/test_logging.py

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3361,6 +3361,37 @@ def test_baseconfig(self):
33613361
self.assertRaises(ValueError, bc.convert, 'cfg://!')
33623362
self.assertRaises(KeyError, bc.convert, 'cfg://adict[2]')
33633363

3364+
def test_namedtuple(self):
3365+
# see bpo-39142
3366+
from collections import namedtuple
3367+
3368+
class MyHandler(logging.StreamHandler):
3369+
def __init__(self, resource, *args, **kwargs):
3370+
super().__init__(*args, **kwargs)
3371+
self.resource: namedtuple = resource
3372+
3373+
def emit(self, record):
3374+
record.msg += f' {self.resource.type}'
3375+
return super().emit(record)
3376+
3377+
Resource = namedtuple('Resource', ['type', 'labels'])
3378+
resource = Resource(type='my_type', labels=['a'])
3379+
3380+
config = {
3381+
'version': 1,
3382+
'handlers': {
3383+
'myhandler': {
3384+
'()': MyHandler,
3385+
'resource': resource
3386+
}
3387+
},
3388+
'root': {'level': 'INFO', 'handlers': ['myhandler']},
3389+
}
3390+
with support.captured_stderr() as stderr:
3391+
self.apply_config(config)
3392+
logging.info('some log')
3393+
self.assertEqual(stderr.getvalue(), 'some log my_type\n')
3394+
33643395
class ManagerTest(BaseTest):
33653396
def test_manager_loggerclass(self):
33663397
logged = []
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
A change was made to logging.config.dictConfig to avoid converting instances
2+
of named tuples to ConvertingTuple. It's assumed that named tuples are too
3+
specialised to be treated like ordinary tuples; if a user of named tuples
4+
requires ConvertingTuple functionality, they will have to implement that
5+
themselves in their named tuple class.

0 commit comments

Comments
 (0)