fix(cli): make --help ASCII-safe for non-UTF-8 Windows consoles#112
Merged
Conversation
The windio subcommand help carried a rightwards-arrow glyph, so pybmodes --help raised UnicodeEncodeError when argparse wrote the help to a legacy Windows console (cp1252 / cp437) where that character has no mapping. The printed help and description strings are now plain ASCII, with a test asserting every parser's formatted help is ASCII-encodable (and encodes on cp1252 / cp437). Caught by the conda-forge Windows build. Ship as 1.14.1.
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
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.
pybmodes --helpcrashed on a legacy Windows console (cp1252 / cp437) with aUnicodeEncodeError. Thewindiosubcommand help string contained a rightwards-arrow glyph, and argparse fails to write it when the console code page has no mapping for it. Linux/macOS use UTF-8 so it passed there, which is why CI and local dev never caught it. The conda-forge Windows build did.Fix: the printed CLI help and description strings are now plain ASCII. New
tests/test_cli_help.pyasserts every parser'sformat_help()is ASCII-encodable and also encodes on cp1252 / cp437, so this can't regress and the CLI prints on any code page.Shipping as 1.14.1; unblocks the conda-forge submission (#33448).