gh-110875: Handle '.' properties in logging formatter configuration c… (GH-110943)

This commit is contained in:
Vinay Sajip 2023-11-09 18:55:22 +00:00 committed by GitHub
parent 7d21e3d5ee
commit a5f29c9faf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 5 deletions

View file

@ -482,10 +482,10 @@ def configure_custom(self, config):
c = config.pop('()')
if not callable(c):
c = self.resolve(c)
props = config.pop('.', None)
# Check for valid identifiers
kwargs = {k: config[k] for k in config if valid_ident(k)}
kwargs = {k: config[k] for k in config if (k != '.' and valid_ident(k))}
result = c(**kwargs)
props = config.pop('.', None)
if props:
for name, value in props.items():
setattr(result, name, value)
@ -835,8 +835,7 @@ def configure_handler(self, config):
factory = functools.partial(self._configure_queue_handler, klass)
else:
factory = klass
props = config.pop('.', None)
kwargs = {k: config[k] for k in config if valid_ident(k)}
kwargs = {k: config[k] for k in config if (k != '.' and valid_ident(k))}
try:
result = factory(**kwargs)
except TypeError as te:
@ -854,6 +853,7 @@ def configure_handler(self, config):
result.setLevel(logging._checkLevel(level))
if filters:
self.add_filters(result, filters)
props = config.pop('.', None)
if props:
for name, value in props.items():
setattr(result, name, value)

View file

@ -2998,6 +2998,39 @@ class ConfigDictTest(BaseTest):
},
}
class CustomFormatter(logging.Formatter):
custom_property = "."
def format(self, record):
return super().format(record)
config17 = {
'version': 1,
'formatters': {
"custom": {
"()": CustomFormatter,
"style": "{",
"datefmt": "%Y-%m-%d %H:%M:%S",
"format": "{message}", # <-- to force an exception when configuring
".": {
"custom_property": "value"
}
}
},
'handlers' : {
'hand1' : {
'class' : 'logging.StreamHandler',
'formatter' : 'custom',
'level' : 'NOTSET',
'stream' : 'ext://sys.stdout',
},
},
'root' : {
'level' : 'WARNING',
'handlers' : ['hand1'],
},
}
bad_format = {
"version": 1,
"formatters": {
@ -3479,7 +3512,10 @@ def test_config16_ok(self):
{'msg': 'Hello'}))
self.assertEqual(result, 'Hello ++ defaultvalue')
def test_config17_ok(self):
self.apply_config(self.config17)
h = logging._handlers['hand1']
self.assertEqual(h.formatter.custom_property, 'value')
def setup_via_listener(self, text, verify=None):
text = text.encode("utf-8")