introduce --help-xoptions

python · merwok · Jun 1, 2022 · Jan 2, 2022 · Jan 2, 2022 · Jan 2, 2022
commit 0c9a995fe668900f09fe890de38eacf91bf510f2
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
@@ -193,11 +193,21 @@ Generic options
                --help
 
    Print a short description of all command line options and corresponding
-   environment variables.
+   environment variables and exit.
 
 .. cmdoption:: --help-env
 
-   Print a short description of Python-specific environment variables.
+   Print a short description of Python-specific environment variables
+   and exit.
+
+   .. versionadded:: 3.11
+
+.. cmdoption:: --help-xoptions
+
+   Print a description of implementation-specific :option:`-X` options
+   and exit.
+
+   .. versionadded:: 3.11
 
 .. cmdoption:: -V
                --version
@@ -218,9 +228,6 @@ Generic options
    .. versionadded:: 3.6
       The ``-VV`` option.
 
-   .. versionadded:: 3.11
-      The ``--help-env`` option.
-
 
 .. _using-on-misc-options:
 
@@ -458,7 +465,6 @@ Miscellaneous options
    Reserved for various implementation-specific options.  CPython currently
    defines the following possible values:
 
-   * ``-X help`` to print a short description of all ``-X`` options;
    * ``-X faulthandler`` to enable :mod:`faulthandler`;
    * ``-X showrefcount`` to output the total reference count and number of used
      memory blocks when the program finishes or after each statement in the
@@ -540,8 +546,6 @@ Miscellaneous options
    .. versionadded:: 3.11
       The ``-X frozen_modules`` option.
 
-   .. versionadded:: 3.11
-      The ``-X help`` option.
 
 
 Options you shouldn't use

diff --git a/Lib/test/test_cmd_line.py b/Lib/test/test_cmd_line.py
@@ -99,7 +99,7 @@ def get_xoptions(*args):
     def test_unknown_xoptions(self):
         _, out, err = assert_python_failure('-X', 'blech')
         self.assertIn(b'Unknown value for option -X', err)
-        msg = b'Fatal Python error: Unknown value for option -X (see -X help)'
+        msg = b'Fatal Python error: Unknown value for option -X (see --help-xoptions)'
         self.assertEqual(err.splitlines().count(msg), 1)
         self.assertEqual(b'', out)
 

diff --git a/Misc/NEWS.d/next/Core and Builtins/2022-01-02-14-53-59.bpo-46142.WayjgT.rst b/Misc/NEWS.d/next/Core and Builtins/2022-01-02-14-53-59.bpo-46142.WayjgT.rst
@@ -1,2 +1,2 @@
 Make ``--help`` output shorter by moving some info to the new
-``--help-env`` and ``-X help`` options.
+``--help-env`` and ``--help-xoptions`` command-line options.
diff --git a/Misc/python.man b/Misc/python.man
@@ -89,7 +89,7 @@ python \- an interpreted, interactive, object-oriented programming language
 .B \--help-env
 ]
 [
-.B \-X help
+.B \--help-xoptions
 ]
 .br
        [
@@ -156,9 +156,12 @@ the behavior of the interpreter.
 .B \-h ", " \-? ", "\-\-help
 Prints the usage for the interpreter executable and exits.
 .TP
-.B \-\-help\-env
+.B "\-\-help\-env"
 Prints help about Python-specific environment variables and exits.
 .TP
+.B "\-\-help\-xoptions"
+Prints help about implementation-specific \fB\-X\fP options and exits.
+.TP
 .B \-i
 When a script is passed as first argument or the \fB\-c\fP option is
 used, enter interactive mode after executing the script or the
@@ -294,8 +297,6 @@ a regular expression on the warning message.
 .BI "\-X " option
 Set implementation-specific option. The following options are available:
 
-    -X help: show help about available options
-
     -X faulthandler: enable faulthandler
 
     -X showrefcount: output the total reference count and number of used

diff --git a/Python/getopt.c b/Python/getopt.c
@@ -46,6 +46,7 @@ static const wchar_t *opt_ptr = L"";
 static const _PyOS_LongOption longopts[] = {
     {L"check-hash-based-pycs", 1, 0},
     {L"help-env", 0, 1},
+    {L"help-xoptions", 0, 2},
     {NULL, 0, -1},
 };
 

@@ -40,6 +40,8 @@ Options (and corresponding environment variables):\n\
          debug builds); also PYTHONDEBUG=x\n\
 -E     : ignore PYTHON* environment variables (such as PYTHONPATH)\n\
 -h     : print this help message and exit (also --help)\n\
+--help-env      : print help about Python-specific environment variables and exit\n\
+--help-xoptions : print help about implementation-specific -X options and exit\n\
 ";
 static const char usage_2[] = "\
 -i     : inspect interactively after running script; forces a prompt even\n\
@@ -64,8 +66,7 @@ static const char usage_3[] = "\
 -W arg : warning control; arg is action:message:category:module:lineno\n\
          also PYTHONWARNINGS=arg\n\
 -x     : skip first line of source, allowing use of non-Unix forms of #!cmd\n\
--X opt : set implementation-specific option (see details with -X help)\n\
---help-env : print help about Python-specific environment variables\n\
+-X opt : set implementation-specific option\n\
-X opt : set implementation-specific option\n\
+-X opt : set implementation-specific option (see --help-xoptions)\n\
-X opt : set implementation-specific option\n\
+-X opt : set implementation-specific option (see --help-xoptions)\n\
 --check-hash-based-pycs always|default|never :\n\
          control how Python invalidates hash-based .pyc files\n\
 ";
@@ -78,7 +79,6 @@ arg ...: arguments passed to program in sys.argv[1:]\n\
 
 static const char usage_xoptions[] = "\
 The following implementation-specific options are available:\n\
-         -X help: show this help and exit\n\
          -X faulthandler: enable faulthandler\n\
          -X showrefcount: output the total reference count and number of used\n\
              memory blocks when the program finishes or after each statement in the\n\
@@ -2028,7 +2028,6 @@ _PyConfig_InitImportConfig(PyConfig *config)
 // set, like -X showrefcount which requires a debug build. In this case unknown
 // options are silently ignored.
 const wchar_t* known_xoptions[] = {
-    L"help",
     L"faulthandler",
     L"showrefcount",
     L"tracemalloc",
@@ -2084,7 +2083,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 (see -X help)");
+        return PyStatus_Error("Unknown value for option -X (see --help-xoptions)");
     }
 
     if (config_get_xoption(config, L"showrefcount")) {
@@ -2271,7 +2270,6 @@ config_parse_cmdline(PyConfig *config, PyWideStringList *warnoptions,
     const PyWideStringList *argv = &config->argv;
     int print_version = 0;
     const wchar_t* program = config->program_name;
-    const wchar_t* xoption_help;
 
     _PyOS_ResetGetOpt();
     do {
@@ -2338,6 +2336,11 @@ config_parse_cmdline(PyConfig *config, PyWideStringList *warnoptions,
             config_envvars_usage();
             return _PyStatus_EXIT(0);
 
+        case 2:
+            // help-xoptions
+            config_xoptions_usage();
+            return _PyStatus_EXIT(0);
+
         case 'b':
             config->bytes_warning++;
             break;
@@ -2353,6 +2356,7 @@ config_parse_cmdline(PyConfig *config, PyWideStringList *warnoptions,
 
         case 'E':
         case 'I':
+        case 'X':
             /* option handled by _PyPreCmdline_Read() */
             break;
 
@@ -2414,15 +2418,6 @@ config_parse_cmdline(PyConfig *config, PyWideStringList *warnoptions,
             config->use_hash_seed = 0;
             break;
 
-        case 'X':
-            xoption_help = config_get_xoption(config, L"help");
-            if (xoption_help) {
-     
52FE
           config_xoptions_usage();
-                return _PyStatus_EXIT(0);
-            }
-            /* option handled by _PyPreCmdline_Read() */
-            break;
-
         /* This space reserved for other options */
 
         default: