This repository has been archived by the owner on Jul 25, 2024. It is now read-only.
Stop logging with eagerly-formatted strings #157
Merged
Conversation
This file contains 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
samuelhwilliams
force-pushed
the
bau/fix-logging
branch
from
228b026 to
d52f22c
Compare
samuelhwilliams
force-pushed
the
bau/fix-logging
branch
from
d52f22c to
c4f4cf4
Compare
gidsg
reviewed
Apr 25, 2024
This is a single tool that replaces three, and is generally seeing a lot of development and improves recently. It's also generally faster than all of those tools. We also enable some extra 'flake8-equivalent' linting rules, specifically here one that blocks eagerly-formatted strings in log lines.
Don't use f-strings in logging calls - leave it to be handled by fsd_utils.
samuelhwilliams
force-pushed
the
bau/fix-logging
branch
from
c4f4cf4 to
5472eaa
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
https://dluhcdigital.atlassian.net/browse/SMD-812
Change description
Stop eagerly formatting log messages, which ends up causing some log messages to be double-formatted. When the initial format is injecting a dictionary into the string, the second format (by fsd_utils.logging) can error because the dict looks like a format injection point, but is incorrectly structured.
I've also switched black+flake8+isort out for ruff, which is a fast modern tool that combines a bunch of formatting and linting rules. One of these will raise linting issues for log call that have eagerly-formatted log lines.