concurrent: format the run_on_executor bad-args ValueError message#3680
Draft
HrachShah wants to merge 1 commit into
Draft
concurrent: format the run_on_executor bad-args ValueError message#3680HrachShah wants to merge 1 commit into
HrachShah 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.
The pre-fix code in
tornado/concurrent.pyraised the bad-arg error withtwo positional arguments to
ValueError:ValueError(like allExceptionsubclasses) takes a single messageargument; any further positional arguments end up in
e.argsas a tuplerather than being formatted into the message. The user-visible effect is
that
str(e)is the literal"('expected 1 argument, got %d', 2)"andthe offending count is hidden in
e.args[1], so a simpleassertRaisesRegexfor the formatted string fails, and any caller thatlogs
str(e)gets a useless tuple repr.The fix is the same single-character change that landed in
tornadoweb/tornado#3679
for
_convert_header_valueintornado/web.py:"expected 1 argument, got %d" % len(args)so the count is interpolated into the messagebefore the exception is raised.
Verified with a new test
test_run_on_executor_bad_argsintornado/test/concurrent_test.pythat asserts the message contains"expected 1 argument, got 2". On the pre-fix code the assertionfails with the exact tuple repr; on the fix the assertion passes.
All 12
concurrent_test.pytests pass.Drafted with MiniMax M3; reviewed by keenrose.