Do things right when obj is a tuple
#4
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
When `obj` is a tuple, this raise yields a TypeError given that the formatting is not resolved. The proper way of doing this is by ensuring that a tuple is being used for string formatting (in particular, a single element tuple). And, on the way there, it's much better to use `%r` in this context, just in case `obj` is a complex object and has a non-trivial `__str__` method --while the `__repr__` method should be simpler. In a lot of scenarios this change is imperceptible, in others improves log messages a lot.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
When
objis a tuple, this raise yields a TypeError given that the formatting is not resolved.The proper way of doing this is by ensuring that a tuple is being used for string formatting (in particular, a single element tuple).
And, on the way there, it's much better to use
%rin this context, just in caseobjis a complex object and has a non-trivial__str__method --while the__repr__method should be simpler. In a lot of scenarios this change is imperceptible, in others improves log messages a lot.