gh-90300: split --help output into separate options #30331

merwok · 2022-01-02T05:58:25Z

gh-90300: Make --help output shorter and add new help options.

--help-env, --help-xoptions and --help-all command-line options are
added to complement --help.

Python/initconfig.c

Lib/test/test_cmd_line.py

Misc/python.man

merwok · 2022-01-02T23:28:35Z

Misc/python.man

+]
+[
+.B \-X help
+]


I thought showing all help options on their own line could be nice.

Python/initconfig.c

Doc/using/cmdline.rst

Lib/test/test_cmd_line.py

Python/initconfig.c

bedevere-bot · 2022-01-03T17:42:08Z

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

warsaw · 2022-01-03T17:42:50Z

Thanks for working on this! I left some comments and suggestions.

Python/initconfig.c

merwok · 2022-05-26T10:19:21Z

Python/initconfig.c

@@ -2085,7 +2106,7 @@ config_read(PyConfig *config, int compute_path_config)
    /* -X options */
    const wchar_t* option = _Py_check_xoptions(&config->xoptions, known_xoptions);
    if (option != NULL) {
-        return PyStatus_Error("Unknown value for option -X");
+        return PyStatus_Error("Unknown value for option -X (see --help-xoptions)");
    }


Turns out that showing the invalid value in this error message is not trivial: real C programmers had issue with it too before #28823

AA-Turner · 2022-05-29T21:09:41Z

Python/initconfig.c

-            when the interpreter displays tracebacks.\n\
-         -X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\
-            The default is \"on\" (or \"off\" if you are running a local build).\n\
+-X opt : set implementation-specific option\n\


--help-xoptions is listed a few items below, but if scanning the list it might be helpful to explicitly mention it here. (Sorry if it's been suggested before & declined!).

Suggested change

-X opt : set implementation-specific option\n\

-X opt : set implementation-specific option (see --help-xoptions)\n\

I’ve added it and removed it. In the current version, I think it is not needed, as it is a few lines later and in the man page and shown in error message for unknown X option, but have no problem adding it if someone adds 👍🏽 to your comment 🙂

merwok · 2022-05-31T17:06:54Z

This is ready and complete for me. I did not change all lines to be <80 columns like Serhiy requested, but the upside is that the diff size is very reasonable. I would like to merge this week-end, or sooner if there are approving reviews, then create the backport PR for 3.11.

bedevere-bot · 2022-05-31T20:15:25Z

🤖 New build scheduled with the buildbot fleet by @merwok for commit 5485255 🤖

If you want to schedule another build, you need to add the "🔨 test-with-buildbots" label again.

miss-islington · 2022-06-01T09:50:05Z

Thanks @merwok for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

…0331) Make --help output shorter and add new help options. --help-env, --help-xoptions and --help-all command-line options are added to complement --help. (cherry picked from commit 8aa9d40) Co-authored-by: Éric <earaujo@caravan.coop>

bedevere-bot · 2022-06-01T09:50:20Z

GH-93413 is a backport of this pull request to the 3.11 branch.

ericsnowcurrently · 2022-06-02T14:54:08Z

🎉 Thanks for seeing this through, @merwok! It's a nice improvement. 😄

move list of X options out of help output

225c869

the-knights-who-say-ni added the CLA signed label Jan 2, 2022

bedevere-bot added the awaiting core review label Jan 2, 2022

merwok reviewed Jan 2, 2022

View changes

Python/initconfig.c Outdated Show resolved Hide resolved

merwok reviewed Jan 2, 2022

View changes

Python/initconfig.c Show resolved Hide resolved

mention help option in fatal error message

eaefd1a

merwok reviewed Jan 2, 2022

View changes

Python/initconfig.c Outdated Show resolved Hide resolved

move variable declaration out of case block

57fd33b

merwok reviewed Jan 2, 2022

View changes

Python/initconfig.c Outdated Show resolved Hide resolved

move extra envvars help to separate option

55dbf69

merwok marked this pull request as ready for review Jan 2, 2022

merwok requested review from serhiy-storchaka, pablogsal, vstinner and ericsnowcurrently Jan 2, 2022

merwok changed the title ~~bpo-46142: make python --help output shorter [WIP]~~ bpo-46142: split --help output into separate options Jan 2, 2022

merwok added 2 commits Jan 2, 2022

doc

0aaf9af

add minimal tests

a592003

merwok reviewed Jan 2, 2022

View changes

Lib/test/test_cmd_line.py Outdated Show resolved Hide resolved

merwok reviewed Jan 2, 2022

View changes

Misc/python.man Outdated Show resolved Hide resolved

merwok reviewed Jan 2, 2022

View changes

Misc/python.man

]

[

.B \-X help

]

Copy link

Member Author

merwok Jan 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought showing all help options on their own line could be nice.

merwok reviewed Jan 2, 2022

View changes

Python/initconfig.c Outdated Show resolved Hide resolved

merwok reviewed Jan 2, 2022

View changes

Python/initconfig.c Outdated Show resolved Hide resolved

flatten the sub-switch

1c4cf63

merwok requested a review from warsaw Jan 3, 2022

warsaw requested changes Jan 3, 2022

View changes

bedevere-bot added awaiting changes and removed awaiting core review labels Jan 3, 2022

merwok changed the title ~~bpo-46142: split --help output into separate options~~ gh-90300: split --help output into separate options May 25, 2022

merwok linked an issue May 25, 2022 that may be closed by this pull request

python --help output is too long #90300

Open

fix formatting issues and missing info in man page and --help

24526bd

merwok mentioned this pull request May 25, 2022

python --help output is too long #90300

Open

make new tests a bit more useful

0bb5dfa

ericsnowcurrently reviewed May 25, 2022

View changes

Python/initconfig.c Outdated Show resolved Hide resolved

512 bytes should be enough for everyone

8fa72f5

merwok reviewed May 26, 2022

View changes

merwok added 4 commits May 26, 2022

keep long option at the end of help text

29d04a0

merge branch 'fix-help-man'

356d1bf

fix tests and output

ac1b5fb

final fixes

9bcea95

merwok requested review from ericsnowcurrently and serhiy-storchaka May 26, 2022

merge upstream

5485255

AA-Turner reviewed May 29, 2022

View changes

merwok added needs backport to 3.11 🔨 test-with-buildbots labels May 31, 2022

bedevere-bot removed the 🔨 test-with-buildbots label May 31, 2022

serhiy-storchaka approved these changes Jun 1, 2022

View changes

merwok merged commit 8aa9d40 into python:main Jun 1, 2022
85 checks passed

bedevere-bot removed the awaiting merge label Jun 1, 2022

merwok deleted the shorten-help-output branch Jun 1, 2022

bedevere-bot removed the needs backport to 3.11 label Jun 1, 2022

python / cpython Public

gh-90300: split --help output into separate options #30331

gh-90300: split --help output into separate options #30331

merwok commented Jan 2, 2022 •

edited

merwok Jan 2, 2022

bedevere-bot commented Jan 3, 2022

warsaw commented Jan 3, 2022

merwok May 26, 2022

AA-Turner May 29, 2022

merwok May 30, 2022 •

edited

merwok commented May 31, 2022 •

edited

bedevere-bot commented May 31, 2022

miss-islington commented Jun 1, 2022

bedevere-bot commented Jun 1, 2022

ericsnowcurrently commented Jun 2, 2022

	-X opt : set implementation-specific option\n\
	-X opt : set implementation-specific option (see --help-xoptions)\n\

python / cpython Public

gh-90300: split --help output into separate options #30331

gh-90300: split --help output into separate options #30331

Conversation

merwok commented Jan 2, 2022 • edited

merwok Jan 2, 2022

Choose a reason for hiding this comment

bedevere-bot commented Jan 3, 2022

warsaw commented Jan 3, 2022

merwok May 26, 2022

Choose a reason for hiding this comment

AA-Turner May 29, 2022

Choose a reason for hiding this comment

merwok May 30, 2022 • edited

Choose a reason for hiding this comment

merwok commented May 31, 2022 • edited

bedevere-bot commented May 31, 2022

miss-islington commented Jun 1, 2022

bedevere-bot commented Jun 1, 2022

ericsnowcurrently commented Jun 2, 2022

merwok commented Jan 2, 2022 •

edited

merwok May 30, 2022 •

edited

merwok commented May 31, 2022 •

edited