Fix LevelFormatter KeyError on unlisted or custom log levels#141
Open
ArmaanjeetSandhu wants to merge 1 commit into
Open
Fix LevelFormatter KeyError on unlisted or custom log levels#141ArmaanjeetSandhu wants to merge 1 commit into
ArmaanjeetSandhu wants to merge 1 commit into
Conversation
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.
LevelFormatter.format()looked upself.formatters[record.levelname]with no fallback, so any record whose level name wasn't an exact key infmtraisedKeyErrorat log time. This breaks two common cases:TRACElevel shown indocs/custom_level.py).fmtdicts, where you only want to override some levels. Every unlisted level then crashes the logging call.Changes
LevelFormatternow resolves the formatter withself.formatters.get(record.levelname, self.default_formatter)."DEFAULT"entry infmt, if providedColoredFormatterusing the default format for the chosenstyle, inheriting the same**kwargs.LevelFormatterdocstring to document the fallback and the"DEFAULT"key.test_unlisted_level_uses_default(reproduces the originalKeyError) andtest_explicit_default_key.I chose a lenient fallback (format the record) over a stricter approach (re-raise with a clearer message), since silently crashing the logging path is the worse outcome and it matches how
loggingitself tolerates unexpected levels. Happy to switch to a descriptive error instead if strictness is preferred.