Repository navigation
fix: escape % in class-variable comments so argparse help formatting does not crash (#183) - #185
Merged
martinjm97 merged 1 commit intoAug 29, 2026
Conversation
martinjm97
reviewed
Jul 11, 2026
Collaborator
There was a problem hiding this comment.
This test would benefit from a full string match to ensure the parse is actually "The % chance this will break" and not mangled.
Collaborator
|
Thank you for your contribution to Tap! --JK |
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.
Problem
Fixes #183. A
%in a class-variable comment crashes Tap (TypeError: %c requires int or charon Python <3.14;ValueErrorfrom_check_helpon 3.14+). Confirmed on main HEADfd2e8416.Root cause
Tap._add_argumentappends the extracted comment to the argparsehelpstring verbatim (kwargs["help"] += " " + comment). argparse%-formats every help string (help_string % params), so a literal%in the comment is read as a format spec and crashes.Fix
Escape
%to%%(the standard argparse escape for a literal percent) when appending the comment. One source line insrc/tap/tap.py; no API changes.How to test
With this PR it returns the help text with the comment intact. Added
test_comment_with_percentintests/test_integration.py, verified to fail on unpatched main and pass with the fix.Backward compatibility
No breaking changes. Comments render identically;
%%is collapsed back to%by argparse's own formatting.Assisted-by: Claude (code generation, reviewed and tested locally)