Skip to content

gh-110875: Handle '.' properties in logging formatter configuration c… #110943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 9, 2023
Merged

gh-110875: Handle '.' properties in logging formatter configuration c… #110943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c345dad
gh-110875: Handle '.' properties in logging formatter configuration c…
vsajip Oct 16, 2023
81b91d1
Improve readability of condition. Thanks to Petr Viktorin for the sug…
vsajip Nov 3, 2023
1a6a8d8
Make kwargs processing consistent, per review comments.
vsajip Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Lib/logging/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:
Expand All @@ -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)
Expand Down
38 changes: 37 additions & 1 deletion Lib/test/test_logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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")
Expand Down