utils: mention bytes in force_bytes type error#1173
Open
c-tonneslan wants to merge 1 commit into
Open
Conversation
force_bytes accepts str or bytes and returns bytes, so saying "Expected a string value" when something else lands made the error read like the bytes case was a bug rather than a supported input. Wording is the only change. Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Improves the clarity of jwt.utils.force_bytes’s fallback TypeError by explicitly stating that both str and bytes inputs are supported, and updates the corresponding assertion in the HMAC algorithm tests.
Changes:
- Update
force_bytesto raiseTypeError("Expected a string or bytes value")for unsupported input types. - Update
test_hmac_should_reject_nonstring_keyto assert the revised error message.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
jwt/utils.py |
Adjusts the force_bytes TypeError message to mention both supported input types (str and bytes). |
tests/test_algorithms.py |
Updates the HMAC key rejection test to match the new TypeError message text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
force_bytesacceptsstrorbytesand returnsbytes, but thefallback
TypeErroronly says "Expected a string value". When theerror fires it reads like the bytes input path is unsupported, even
though it's the second branch in the function itself.
Updated the message to mention both types, and bumped the matching
assertion in
test_hmac_should_reject_nonstring_key.