gh-148766: Add colour to Python help#148767
Conversation
hugovk
requested review from
AA-Turner,
FFY00 and
ericsnowcurrently
as code owners
| #if defined(MS_WINDOWS) && defined(HAVE_WINDOWS_CONSOLE_IO) | ||
| { | ||
| DWORD mode = 0; | ||
| HANDLE handle = GetStdHandle(STD_OUTPUT_HANDLE); |
There was a problem hiding this comment.
Shouldn't this also consider stderr (or maybe it does? I don't know Windows quirks).
| PyMem_RawFree(buf); | ||
| } | ||
| else { | ||
| fprintf(f, usage_line, program); |
There was a problem hiding this comment.
If PyMem_RawMalloc fails we will get the raw tags, no?
There was a problem hiding this comment.
This now falls back to no tags.
| return; | ||
| } | ||
| } | ||
| fprint_tagged(stdout, usage_envvars, 0); |
There was a problem hiding this comment.
We still need formatting here?
There was a problem hiding this comment.
Yes, updated to use colour if available.
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
There was a problem hiding this comment.
What if the program path by accident contains {E}?
|
Updated to flip it: colour codes are now included in the help text (via macros to keep it tidier), and stripped out when not needed. So |
Here we go: 
|
|
Thanks for the reviews, any further comments? |
3 participants
python --help(and especially--help-all) is a monochrome wall of text. Similar to argparse help, let's add some colour to add structure and improve readability.Here's real screenshots of
--helpand termshot capture of--help-all:📚 Documentation preview 📚: https://cpython-previews--148767.org.readthedocs.build/