BF: RF f-string uses in logger to %-interpolations #6886
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
Codecov Report
@@ Coverage Diff @@
## maint #6886 +/- ##
==========================================
+ Coverage 90.25% 91.21% +0.95%
==========================================
Files 354 354
Lines 46116 46116
==========================================
+ Hits 41622 42064 +442
+ Misses 4494 4052 -442
Continue to review full report at Codecov.
|
mih
approved these changes
Jul 25, 2022
yarikoptic
commented
Jul 25, 2022
datalad/cmd.py
Outdated
| self.return_code = self.generator.return_code | ||
| self.runner = None | ||
|
|
||
| except CommandError as command_error: | ||
| # The command exited with a non-zero return code | ||
| lgr.error(f"{self}: command error: {command_error}") | ||
| lgr.error("%s: command error: command_error", self, command_error) |
There was a problem hiding this comment.
dang, I did I screw up here, travis picked it up in https://app.travis-ci.com/github/datalad/datalad/jobs/577595841#L3864
f-strings should not be used for logger since if any of the .format-ed content contains some %, it would then be incorrectly or causing a crash %-polated by the logger. Although some of the "fixed" cases would be ok (we know that it was an int etc) for consistency and to avoid needed "is this particular use safe?" checks, better to avoid f-strings in logger in general
yarikoptic
force-pushed
the
bf-no-f-strings-logger
branch
from
b5edd7c to
564027c
Compare
adswa
approved these changes
Jul 25, 2022
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.
f-strings should not be used for logger since if any of the .format-ed
content contains some %, it would then be incorrectly or causing a crash
%-polated by the logger. Although some of the "fixed" cases would be ok
(we know that it was an int etc) for consistency and to avoid needed
"is this particular use safe?" checks, better to avoid f-strings in
logger in general