Skip to content

[core] fix field detection for escaped % and { format styles - #75

Merged
nhairs merged 3 commits into
nhairs:mainfrom
dylanpulver:fix-parse-style-escapes
Sep 23, 2026
Merged

nhairs merged 3 commits into
nhairs:mainfrom
dylanpulver:fix-parse-style-escapes

Conversation

@dylanpulver

Copy link
Copy Markdown
Contributor

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.

`parse()` read `%%(name)s` and `{{name}}` as fields even though both are
escaped literals, and read a `{` style conversion or format spec as part
of the field name, so `{levelname:>8}` produced a `"levelname:>8": null`
key and dropped `levelname`.

`%` now skips `%%` the same way the `$` style skips `$$` (nhairs#69), and `{`
uses `string.Formatter`, which is what `logging.StrFormatStyle.validate`
parses the same string with.

Assisted-by: claude-opus-5
A regex-only fix passes the plain `{levelname:>8}` case but reads
`{width}` out of `{levelname:>{width}}`, which stdlib accepts.

Assisted-by: claude-opus-5

@nhairs nhairs left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dylanpulver, overall looks good, though have a number of comments for you

Comment thread docs/changelog.md Outdated
Comment thread src/pythonjsonlogger/core.py Outdated
Comment thread src/pythonjsonlogger/core.py Outdated
Comment thread tests/test_formatters.py Outdated
Comment thread src/pythonjsonlogger/core.py Outdated
Comment thread docs/changelog.md
Comment thread docs/changelog.md Outdated
Comment on lines +10 to +14
- `%` style formats no longer treat the escaped literal `%%` as the start of a field, so
`"%%(notafield)s"` is correctly read as literal text.
- `{` style formats now use `string.Formatter` (as `logging.StrFormatStyle.validate` does) to find
fields, so escaped literal braces (`{{`/`}}`) are skipped and a conversion (`{message!r}`) or
format spec (`{levelname:>8}`) is no longer treated as part of the field name.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should have a reference to the issue

Remove STYLE_STRING_FORMAT_REGEX rather than deprecating it, drop the
explanatory comments in parse, merge the escaped-percent test into
test_percentage_format, and fill in the changelog heading and references.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011M5uTyCU4WcNTsPvGrErDo

@nhairs nhairs left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good, thanks for your work @dylanpulver

I'll look to merge this soon

@nhairs
nhairs merged commit 453913a into nhairs:main Sep 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

parse() reads escaped %% and {{ }} as fields, and {-style format specs as part of the field name

2 participants