fix: correct broken format string in decode() TypeError message - #59
Open
AmSach wants to merge 1 commit into
Open
fix: correct broken format string in decode() TypeError message#59AmSach wants to merge 1 commit into
AmSach wants to merge 1 commit into
Conversation
The decode() function raised TypeError with a non-f-string format,
causing '{}' to be printed literally instead of being replaced with the
actual type. Switch to an f-string so the offending type is interpolated
into the error message (e.g. "<class 'str'>").
Closes multiformats#47
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.
Fixes #47.
What was broken
The
decode()function inmultihash/multihash.pyraised aTypeErrorusing a non-f-string format:Because the literal string is not prefixed with
f, the{}placeholder is not interpolated — it is printed verbatim, with the offending type captured only as a separate element ofe.args. The user sees:Fix
Switch the literal to a proper f-string so the type is interpolated into the message at raise time:
Tested
test_decode_type_error_message_interpolates_typeintests/test_multihash.pythat asserts the message contains"should be bytes, not"and does not contain the literal"{}".{}present) and passes on the patched code.ruff checkclean on touched files.Files changed
multihash/multihash.py— fix the format string (1 line)tests/test_multihash.py— add regression test (21 lines)newsfragments/47.bugfix.rst— release note (new file)