fix: allow f-string to trigger TRY003 #75
Merged
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.
Hello, and thank you for this package!
I stumble across the issue #31 and may have a potential fix.
The problem was false negative for rule TRY003, "Avoid specifying long messages outside the exception class", the root cause being the use of f-string in such messages.
The solution simply consists of checking whether the string is an f-string using
ast.JoinedStr
.However, this fix is not perfect, as illustrated by the following example:
This code triggers TRY003 with the fix, but it should be acceptable since there are no whitespaces, like in the existing test
The challenge is that, to my knowledge, there is no way to determine the content of an f-string during parsing without evaluating it first. It is probably beyond the scope of static analysis.
I think it is related to why Google discourages the use of f-string for logging in their styleguide. If f-strings are considered a bad practice for exceptions as well,, it might be worth adding a new violation rule in Tryceratops specifically for them.
Please let me know if you have any feedback or suggestions for improving this fix.