[core] support unbraced $name fields in $ style formats - #69
Merged
nhairs merged 3 commits intoAug 15, 2026
Merged
Conversation
BaseJsonFormatter.parse() matched only ${name} for StringTemplateStyle,
so a format like "$asctime $message" produced no fields at all and the
resulting log records were missing every requested attribute. Python's
string.Template accepts both $name and ${name}.
The regex now matches both forms and skips the $$ escape, and parse()
picks whichever group matched.
Closes nhairs#18
nhairs
force-pushed
the
fix/string-template-unbraced-names
branch
from
August 15, 2026 10:59
c48cdca to
81d368f
Compare
nhairs
approved these changes
Aug 15, 2026
nhairs
left a comment
Owner
There was a problem hiding this comment.
Thanks for your work on this @Sanjays2402
This was referenced Sep 3, 2026
parse() reads escaped %% and {{ }} as fields, and {-style format specs as part of the field name
#74
Closed
nhairs
pushed a commit
that referenced
this pull request
Sep 23, 2026
Closes #74. `parse()` reads escaped literals as fields: `%%(b)s` in a `%` format, `{{b}}` in a `{` one. #69 fixed this for `$`; these two were left. `{` also folds a conversion or format spec into the name, so `"{levelname:>8} {message}"` — an ordinary stdlib format that `StrFormatStyle.validate()` accepts — logs `{"levelname:>8": null, "message": "hello"}`. **Changes** - `%`: skip `%%`, mirroring the `$` fix. - `{`: use `string.Formatter`, which is what `logging.StrFormatStyle.validate` parses the same string with. Covers `{{`/`}}`, `!r`, `:>8`, and nested specs like `{levelname:>{width}}`. `STYLE_STRING_FORMAT_REGEX` is kept but unused — say the word and I'll drop it. **Testing** `pytest tests`: 224 passed, 218 before. Two new tests beside the existing per-style ones. black/pylint/mypy/validate-pyproject clean. Oracle: the substitution engine itself (`fmt % tracking_dict`, `string.Formatter().parse`, `Template.get_identifiers`). Over 37 formats `$` agreed 7/7 as a control; `%`+`{` diverged 13x before, 1 after — the remainder is `"{}"`, which `validate()` skips too. Reverting only the `core.py` change fails the 6 new cases and nothing else. A regex-only alternative passes `{levelname:>8}` but reads `width` out of `{levelname:>{width}}`; hence that case in the test. One behaviour change: with `validate=False` a malformed `{` format now raises at construction instead of silently yielding no fields. Prepared with AI assistance; I reviewed and tested it locally. --------- Co-authored-by: Dylan Pulver <dylanpulver@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #18
parse()matched only${name}forStringTemplateStyle, so a$-style format like"$asctime $levelname $message"returned no fields at all and the emitted JSON was missing every requested attribute.string.Templateaccepts both$nameand${name}, so the regex now matches both and skips the$$escape.New
test_string_template_formatsits besidetest_percentage_format/test_comma_formatintests/test_formatters.pyand covers both forms plus$$; it fails on the current regex and passes with the fix.This change was prepared with AI assistance; the regression test was run locally and fails without the fix.