Skip to content

Commit 991710a

Browse files
[3.12] gh-90300: Document equivalent -X options for envvars in the Python CLI help (GH-116756) (GH-116786)
(cherry picked from commit 8c6db45)
1 parent 870cd90 commit 991710a

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

Python/initconfig.c

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -142,18 +142,11 @@ static const char usage_envvars[] =
142142
" The default module search path uses %s.\n"
143143
"PYTHONPLATLIBDIR: override sys.platlibdir.\n"
144144
"PYTHONCASEOK : ignore case in 'import' statements (Windows).\n"
145-
"PYTHONUTF8 : if set to 1, enable the UTF-8 mode.\n"
146145
"PYTHONIOENCODING: Encoding[:errors] used for stdin/stdout/stderr.\n"
147-
"PYTHONFAULTHANDLER: dump the Python traceback on fatal errors.\n"
148146
"PYTHONHASHSEED : if this variable is set to 'random', a random value is used\n"
149147
" to seed the hashes of str and bytes objects. It can also be\n"
150148
" set to an integer in the range [0,4294967295] to get hash\n"
151149
" values with a predictable seed.\n"
152-
"PYTHONINTMAXSTRDIGITS: limits the maximum digit characters in an int value\n"
153-
" when converting from a string and when converting an int\n"
154-
" back to a str. A value of 0 disables the limit.\n"
155-
" Conversions to or from bases 2, 4, 8, 16, and 32 are never\n"
156-
" limited.\n"
157150
"PYTHONMALLOC : set the Python memory allocators and/or install debug hooks\n"
158151
" on Python memory allocators. Use PYTHONMALLOC=debug to\n"
159152
" install debug hooks.\n"
@@ -164,28 +157,36 @@ static const char usage_envvars[] =
164157
"PYTHONBREAKPOINT: if this variable is set to 0, it disables the default\n"
165158
" debugger. It can be set to the callable of your debugger of\n"
166159
" choice.\n"
167-
"PYTHONDEVMODE : enable the development mode.\n"
168-
"PYTHONPYCACHEPREFIX: root directory for bytecode cache (pyc) files.\n"
169-
"PYTHONWARNDEFAULTENCODING: enable opt-in EncodingWarning for 'encoding=None'.\n"
170-
"PYTHONNODEBUGRANGES: if this variable is set, it disables the inclusion of\n"
171-
" the tables mapping extra location information (end line,\n"
172-
" start column offset and end column offset) to every\n"
173-
" instruction in code objects. This is useful when smaller\n"
174-
" code objects and pyc files are desired as well as\n"
175-
" suppressing the extra visual location indicators when the\n"
176-
" interpreter displays tracebacks.\n"
177160
"\n"
178161
"These variables have equivalent command-line options (see --help for details):\n"
179162
"PYTHONDEBUG : enable parser debug mode (-d)\n"
163+
"PYTHONDEVMODE : enable the development mode (-X dev)\n"
180164
"PYTHONDONTWRITEBYTECODE: don't write .pyc files (-B)\n"
165+
"PYTHONFAULTHANDLER: dump the Python traceback on fatal errors (-X faulthandler)\n"
181166
"PYTHONINSPECT : inspect interactively after running script (-i)\n"
182-
"PYTHONINTMAXSTRDIGITS: limit max digit characters in an int value\n"
167+
"PYTHONINTMAXSTRDIGITS: limits the maximum digit characters in an int value\n"
168+
" when converting from a string and when converting an int\n"
169+
" back to a str. A value of 0 disables the limit.\n"
170+
" Conversions to or from bases 2, 4, 8, 16, and 32 are never\n"
171+
" limited.\n"
183172
" (-X int_max_str_digits=number)\n"
173+
"PYTHONNODEBUGRANGES: if this variable is set, it disables the inclusion of\n"
174+
" the tables mapping extra location information (end line,\n"
175+
" start column offset and end column offset) to every\n"
176+
" instruction in code objects. This is useful when smaller\n"
177+
" code objects and pyc files are desired as well as\n"
178+
" suppressing the extra visual location indicators when the\n"
179+
" interpreter displays tracebacks. (-X no_debug_ranges)\n"
184180
"PYTHONNOUSERSITE: disable user site directory (-s)\n"
185181
"PYTHONOPTIMIZE : enable level 1 optimizations (-O)\n"
182+
"PYTHONPYCACHEPREFIX: root directory for bytecode cache (pyc) files\n"
183+
" (-X pycache_prefix)\n"
186184
"PYTHONSAFEPATH : don't prepend a potentially unsafe path to sys.path.\n"
187185
"PYTHONUNBUFFERED: disable stdout/stderr buffering (-u)\n"
186+
"PYTHONUTF8 : if set to 1, enable the UTF-8 mode (-X utf8)\n"
188187
"PYTHONVERBOSE : trace import statements (-v)\n"
188+
"PYTHONWARNDEFAULTENCODING: enable opt-in EncodingWarning for 'encoding=None'\n"
189+
" (-X warn_default_encoding)\n"
189190
"PYTHONWARNINGS=arg: warning control (-W arg)\n"
190191
;
191192

0 commit comments

Comments
 (0)