Colorize the CLI help text #14455
Closed
Colorize the CLI help text #14455
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
Add a `ColoredHelpFormatter` argparse formatter class that colors the command line arguments of mypy CLI help. The formatter uses the existing `FancyFormatter` for the coloring itself and the detection of the terminal. It is added to the following commands: * `mypy` * `stubgen` * `stubtest` * `dmypy` and its subcommands The output has been tested locally with all the commands above as well as with `mypy.api.run` to ensure that the proper stdout and stderr are passed and colors are disabled.
This comment has been minimized.
This comment has been minimized.
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
|
Since this PR didn't see any interest after two years, I am closing it. I will gladly make another PR in the future if there is interest. In the meantime, those interested can try auto-rich-argparse that will apply colors automatically to command line tools that use argparse. You can try it out with |
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.
Add a
ColoredHelpFormatterargparse formatter class that colors the command line arguments of mypy CLI help. The formatter uses the existingFancyFormatterfor the coloring itself and the detection of the terminal. It is added to the following commands:mypystubgenstubtestdmypyand its subcommandsThe output has been tested locally with all the commands above in the terminal (coloring enabled) and when piped (coloring disabled). I also tested
mypy.api.runto ensure that the proper stdout and stderr are passed and colors are disabled.Here is a screenshot of
mypy --helpwith the colors: