8000 [3.11] gh-90300: Sort the -X options and some envvars in the Python C… · python/cpython@1080dd1 · GitHub
[go: up one dir, main page]

Skip to content

Commit 1080dd1

Browse files
[3.11] gh-90300: Sort the -X options and some envvars in the Python CLI help (GH-116739) (GH-116766) (GH-116779)
(cherry picked from commit 870cd90) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit e54bdea)
1 parent 3cc24f1 commit 1080dd1

File tree

1 file changed

+30
-25
lines changed

1 file changed

+30
-25
lines changed

Python/initconfig.c

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -78,19 +78,6 @@ arg ...: arguments passed to program in sys.argv[1:]\n\
7878

7979
static const char usage_xoptions[] = "\
8080
The following implementation-specific options are available:\n\
81-
-X faulthandler: enable faulthandler\n\
82-
-X showrefcount: output the total reference count and number of used\n\
83-
memory blocks when the program finishes or after each statement in\n\
84-
the interactive interpreter. This only works on debug builds\n\
85-
-X tracemalloc: start tracing Python memory allocations using the\n\
86-
tracemalloc module. By default, only the most recent frame is stored\n\
87-
in a traceback of a trace. Use -X tracemalloc=NFRAME to start\n\
88-
tracing with a traceback limit of NFRAME frames\n\
89-
-X importtime: show how long each import takes. It shows module name,\n\
90-
cumulative time (including nested imports) and self time (excluding\n\
91-
nested imports). Note that its output may be broken in\n\
92-
multi-threaded application.\n\
93-
Typical usage is python3 -X importtime -c 'import asyncio'\n\
9481
-X dev : enable CPython's \"development mode\", introducing additional runtime\n\
9582
checks which are too expensive to be enabled by default. Effect of\n\
9683
the developer mode:\n\
@@ -102,23 +89,41 @@ The following implementation-specific options are available:\n\
10289
* Enable asyncio debug mode\n\
10390
* Set the dev_mode attribute of sys.flags to True\n\
10491
* io.IOBase destructor logs close() exceptions\n\
105-
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the\n\
106-
default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode\n\
107-
(even when it would otherwise activate automatically)\n\
108-
-X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted\n\
109-
at the given directory instead of to the code tree\n\
110-
-X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\n\
111-
-X no_debug_ranges: disable the inclusion of the tables mapping extra location\n\
112-
information (end line, start column offset and end column offset) to\n\
113-
every instruction in code objects. This is useful when smaller code\n\
114-
objects and pyc files are desired as well as suppressing the extra\n\
115-
visual location indicators when the interpreter displays tracebacks.\n\
92+
-X faulthandler: enable faulthandler\n\
11693
-X frozen_modules=[on|off]: whether or not frozen modules should be used.\n\
11794
The default is \"on\" (or \"off\" if you are running a local build).\n\
95+
-X importtime: show how long each import takes. It shows module name,\n\
96+
cumulative time (including nested imports) and self time (excluding\n\
97+
nested imports). Note that its output may be broken in\n\
98+
multi-threaded application.\n\
99+
Typical usage is python3 -X importtime -c 'import asyncio'\n\
118100
-X int_max_str_digits=number: limit the size of int<->str conversions.\n\
119101
This helps avoid denial of service attacks when parsing untrusted\n\
120102
data. The default is sys.int_info.default_max_str_digits.\n\
121-
0 disables.\
103+
0 disables.\n\
104+
-X no_debug_ranges: disable the inclusion of the tables mapping extra location\n\
105+
information (end line, start column offset and end column offset) to\n\
106+
every instruction in code objects. This is useful when smaller code\n\
107+
objects and pyc files are desired as well as suppressing the extra\n\
108+
visual location indicators when the interpreter displays tracebacks.\n\
109+
-X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted\n\
110+
at the given directory instead of to the code tree\n\
111+
"
112+
#ifdef Py_STATS
113+
"-X pystats: Enable pystats collection at startup.\n"
114+
#endif
115+
"\
116+
-X showrefcount: output the total reference count and number of used\n\
117+
memory blocks when the program finishes or after each statement in\n\
118+
the interactive interpreter. This only works on debug builds\n\
119+
-X tracemalloc: start tracing Python memory allocations using the\n\
120+
tracemalloc module. By default, only the most recent frame is stored\n\
121+
in a traceback of a trace. Use -X tracemalloc=NFRAME to start\n\
122+
tracing with a traceback limit of NFRAME frames\n\
123+
-X utf8: enable UTF-8 mode for operating system interfaces, overriding the\n\
124+
default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode\n\
125+
(even when it would otherwise activate automatically)\n\
126+
-X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None'\
122127
"
123128
;
124129

0 commit comments

Comments
 (0)
0