CPython 解释器扫描命令行和各种设置的环境。
CPython 实现细节: 其它实现的命令行方案可能不同。见 替代实现 为进一步资源。
当援引 Python 时,可以指定这些任何选项:
python [-bBdEhiIOqsSuvVWx?] [-c command | -m module-name | script | - ] [args]
当然,最常见用例是简单援引脚本:
python myscript.py
The interpreter interface resembles that of the UNIX shell, but provides some additional methods of invocation:
-c
command
, it executes the Python statement(s) given as
command
. Here
command
may contain multiple statements separated by newlines. Leading whitespace is significant in Python statements!
-m
module-name
, the given module is located on the Python module path and executed as a script.
In non-interactive mode, the entire input is parsed before it is executed.
An interface option terminates the list of options consumed by the interpreter, all consecutive arguments will end up in
sys.argv
– note that the first element, subscript zero (
sys.argv[0]
), is a string reflecting the program’s source.
-c
<command>
¶
执行 Python 代码在 command . command 可以是由换行符分隔的一条或多条语句,采用如正常模块代码中的显著前导空格。
若给出此选项,第一元素对于
sys.argv
将是
"-c"
且当前目录将被添加到起始在
sys.path
(允许该目录下的模块被导入作为顶层模块)。
-m
<module-name>
¶
搜索
sys.path
for the named module and execute its contents as the
__main__
模块。
由于自变量是
模块
name, you must not give a file extension (
.py
). The module name should be a valid absolute Python module name, but the implementation may not always enforce this (e.g. it may allow you to use a name that includes a hyphen).
Package names (including namespace packages) are also permitted. When a package name is supplied instead of a normal module, the interpreter will execute
<pkg>.__main__
as the main module. This behaviour is deliberately similar to the handling of directories and zipfiles that are passed to the interpreter as the script argument.
注意
This option cannot be used with built-in modules and extension modules written in C, since they do not have Python module files. However, it can still be used for precompiled modules, even if the original source file is not available.
若给出此选项,第一元素对于
sys.argv
will be the full path to the module file (while the module file is being located, the first element will be set to
"-m"
). As with the
-c
option, the current directory will be added to the start of
sys.path
.
Many standard library modules contain code that is invoked on their execution as a script. An example is the
timeit
模块:
python -mtimeit -s 'setup here' 'benchmarked code here'
python -mtimeit -h # for details
另请参阅
runpy.run_module()
PEP 338 – 将模块作为脚本执行
3.1 版改变:
Supply the package name to run a
__main__
子模块。
3.4 版改变: 还支持名称空间包
<script>
Execute the Python code contained in
script
, which must be a filesystem path (absolute or relative) referring to either a Python file, a directory containing a
__main__.py
file, or a zipfile containing a
__main__.py
文件。
若给出此选项,第一元素对于
sys.argv
will be the script name as given on the command line.
If the script name refers directly to a Python file, the directory containing that file is added to the start of
sys.path
, and the file is executed as the
__main__
模块。
If the script name refers to a directory or zipfile, the script name is added to the start of
sys.path
和
__main__.py
file in that location is executed as the
__main__
模块。
另请参阅
runpy.run_path()
If no interface option is given,
-i
is implied,
sys.argv[0]
is an empty string (
""
) and the current directory will be added to the start of
sys.path
. Also, tab-completion and history editing is automatically enabled, if available on your platform (see
Readline 配置
).
另请参阅
3.4 版改变: Automatic enabling of tab-completion and history editing.
-b
¶
Issue a warning when comparing
bytes
or
bytearray
with
str
or
bytes
with
int
. Issue an error when the option is given twice (
-bb
).
-B
¶
If given, Python won’t try to write
.pyc
files on the import of source modules. See also
PYTHONDONTWRITEBYTECODE
.
-d
¶
Turn on parser debugging output (for wizards only, depending on compilation options). See also
PYTHONDEBUG
.
-E
¶
忽略所有
PYTHON*
环境变量,如
PYTHONPATH
and
PYTHONHOME
, that might be set.
-i
¶
When a script is passed as first argument or the
-c
option is used, enter interactive mode after executing the script or the command, even when
sys.stdin
does not appear to be a terminal. The
PYTHONSTARTUP
file is not read.
This can be useful to inspect global variables or a stack trace when a script raises an exception. See also
PYTHONINSPECT
.
-I
¶
Run Python in isolated mode. This also implies -E and -s. In isolated mode
sys.path
contains neither the script’s directory nor the user’s site-packages directory. All
PYTHON*
environment variables are ignored, too. Further restrictions may be imposed to prevent the user from injecting malicious code.
3.4 版新增。
-O
¶
Remove assert statements and any code conditional on the value of
__debug__
. Augment the filename for compiled (
bytecode
) files by adding
.opt-1
before the
.pyc
扩展 (见
PEP 488
). See also
PYTHONOPTIMIZE
.
3.5 版改变:
修改
.pyc
文件名根据
PEP 488
.
-OO
¶
Do
-O
and also discard docstrings. Augment the filename for compiled (
bytecode
) files by adding
.opt-2
before the
.pyc
扩展 (见
PEP 488
).
3.5 版改变:
修改
.pyc
文件名根据
PEP 488
.
-q
¶
Don’t display the copyright and version messages even in interactive mode.
3.2 版新增。
-R
¶
Kept for compatibility. On Python 3.3 and greater, hash randomization is turned on by default.
On previous versions of Python, this option turns on hash randomization, so that the
__hash__()
values of str, bytes and datetime are “salted” with an unpredictable random value. Although they remain constant within an individual Python process, they are not predictable between repeated invocations of Python.
Hash randomization is intended to provide protection against a denial-of-service caused by carefully-chosen inputs that exploit the worst case performance of a dict construction, O(n^2) complexity. See http://www.ocert.org/advisories/ocert-2011-003.html 了解细节。
PYTHONHASHSEED
allows you to set a fixed value for the hash seed secret.
3.2.3 版新增。
-s
¶
不添加
user
site-packages
directory
to
sys.path
.
另请参阅
PEP 370 – 每用户站点包目录
-S
¶
Disable the import of the module
site
and the site-dependent manipulations of
sys.path
that it entails. Also disable these manipulations if
site
is explicitly imported later (call
site.main()
if you want them to be triggered).
-u
¶
Force the binary layer of the stdout and stderr streams (which is available as their
buffer
attribute) to be unbuffered. The text I/O layer will still be line-buffered if writing to the console, or block-buffered if redirected to a non-interactive file.
另请参阅
PYTHONUNBUFFERED
.
-v
¶
Print a message each time a module is initialized, showing the place (filename or built-in module) from which it is loaded. When given twice (
-vv
), print a message for each file that is checked for when searching for a module. Also provides information on module cleanup at exit. See also
PYTHONVERBOSE
.
-W
arg
¶
Warning control. Python’s warning machinery by default prints warning messages to
sys.stderr
. A typical warning message has the following form:
file:line: category: message
By default, each warning is printed once for each source line where it occurs. This option controls how often warnings are printed.
Multiple
-W
options may be given; when a warning matches more than one option, the action for the last matching option is performed. Invalid
-W
options are ignored (though, a warning message is printed about invalid options when the first warning is issued).
Warnings can also be controlled from within a Python program using the
warnings
模块。
The simplest form of argument is one of the following action strings (or a unique abbreviation):
ignore
default
all
模块
once
error
The full form of argument is:
action:message:category:module:line
Here, action is as explained above but only applies to messages that match the remaining fields. Empty fields match all values; trailing empty fields may be omitted. The message field matches the start of the warning message printed; this match is case-insensitive. The category field matches the warning category. This must be a class name; the match tests whether the actual warning category of the message is a subclass of the specified warning category. The full class name must be given. The 模块 field matches the (fully-qualified) module name; this match is case-sensitive. The line field matches the line number, where zero matches all line numbers and is thus equivalent to an omitted line number.
-x
¶
Skip the first line of the source, allowing use of non-Unix forms of
#!cmd
. This is intended for a DOS specific hack only.
-X
¶
Reserved for various implementation-specific options. CPython currently defines the following possible values:
-X
faulthandler
to enable
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 interactive interpreter. This only works on debug builds.
-X
tracemalloc
to start tracing Python memory allocations using the
tracemalloc
module. By default, only the most recent frame is stored in a traceback of a trace. Use
-X
tracemalloc=NFRAME
to start tracing with a traceback limit of
NFRAME
frames. See the
tracemalloc.start()
了解更多信息。
-X
showalloccount
to output the total count of allocated objects for each type when the program finishes. This only works when Python was built with
COUNT_ALLOCS
defined.
It also allows passing arbitrary values and retrieving them through the
sys._xoptions
字典。
3.2 版改变:
-X
选项被添加。
3.3 版新增:
-X
faulthandler
选项。
3.4 版新增:
-X
showrefcount
and
-X
tracemalloc
选项。
3.6 版新增:
-X
showalloccount
选项。
These environment variables influence Python’s behavior, they are processed before the command-line switches other than -E or -I. It is customary that command-line switches override environmental variables where there is a conflict.
PYTHONHOME
¶
Change the location of the standard Python libraries. By default, the libraries are searched in
prefix
/lib/python
version
and
exec_prefix
/lib/python
version
,其中
prefix
and
exec_prefix
are installation-dependent directories, both defaulting to
/usr/local
.
当
PYTHONHOME
is set to a single directory, its value replaces both
prefix
and
exec_prefix
. To specify different values for these, set
PYTHONHOME
to
prefix
:
exec_prefix
.
PYTHONPATH
¶
Augment the default search path for module files. The format is the same as the shell’s
PATH
: one or more directory pathnames separated by
os.pathsep
(e.g. colons on Unix or semicolons on Windows). Non-existent directories are silently ignored.
In addition to normal directories, individual
PYTHONPATH
entries may refer to zipfiles containing pure Python modules (in either source or compiled form). Extension modules cannot be imported from zipfiles.
The default search path is installation dependent, but generally begins with
prefix
/lib/python
version
(见
PYTHONHOME
above). It is
always
appended to
PYTHONPATH
.
An additional directory will be inserted in the search path in front of
PYTHONPATH
as described above under
接口选项
. The search path can be manipulated from within a Python program as the variable
sys.path
.
PYTHONSTARTUP
¶
If this is the name of a readable file, the Python commands in that file are executed before the first prompt is displayed in interactive mode. The file is executed in the same namespace where interactive commands are executed so that objects defined or imported in it can be used without qualification in the interactive session. You can also change the prompts
sys.ps1
and
sys.ps2
and the hook
sys.__interactivehook__
in this file.
PYTHONOPTIMIZE
¶
If this is set to a non-empty string it is equivalent to specifying the
-O
option. If set to an integer, it is equivalent to specifying
-O
multiple times.
PYTHONDEBUG
¶
If this is set to a non-empty string it is equivalent to specifying the
-d
option. If set to an integer, it is equivalent to specifying
-d
multiple times.
PYTHONINSPECT
¶
If this is set to a non-empty string it is equivalent to specifying the
-i
选项。
This variable can also be modified by Python code using
os.environ
to force inspect mode on program termination.
PYTHONVERBOSE
¶
If this is set to a non-empty string it is equivalent to specifying the
-v
option. If set to an integer, it is equivalent to specifying
-v
multiple times.
PYTHONCASEOK
¶
If this is set, Python ignores case in
import
statements. This only works on Windows and OS X.
PYTHONDONTWRITEBYTECODE
¶
If this is set to a non-empty string, Python won’t try to write
.pyc
files on the import of source modules. This is equivalent to specifying the
-B
选项。
PYTHONHASHSEED
¶
如果此变量未设置或被设为
random
, a random value is used to seed the hashes of str, bytes and datetime objects.
若
PYTHONHASHSEED
is set to an integer value, it is used as a fixed seed for generating the hash() of the types covered by the hash randomization.
Its purpose is to allow repeatable hashing, such as for selftests for the interpreter itself, or to allow a cluster of python processes to share hash values.
The integer must be a decimal number in the range [0,4294967295]. Specifying the value 0 will disable hash randomization.
3.2.3 版新增。
PYTHONIOENCODING
¶
If this is set before running the interpreter, it overrides the encoding used for stdin/stdout/stderr, in the syntax
encodingname:errorhandler
. Both the
encodingname
和
:errorhandler
parts are optional and have the same meaning as in
str.encode()
.
对于 stderr,
:errorhandler
part is ignored; the handler will always be
'backslashreplace'
.
3.4 版改变:
encodingname
部分现在是可选的。
3.6 版改变:
On Windows, the encoding specified by this variable is ignored for interactive console buffers unless
PYTHONLEGACYWINDOWSSTDIO
is also specified. Files and pipes redirected through the standard streams are not affected.
PYTHONNOUSERSITE
¶
若设置,Python 将不添加
user
site-packages
directory
to
sys.path
.
另请参阅
PEP 370 – 每用户站点包目录
PYTHONUSERBASE
¶
定义
user
base
directory
, which is used to compute the path of the
user
site-packages
directory
and
distutils 安装路径
for
python
setup.py
安装
--user
.
另请参阅
PEP 370 – 每用户站点包目录
PYTHONEXECUTABLE
¶
若此环境变量有设置,
sys.argv[0]
will be set to its value instead of the value got through the C runtime. Only works on Mac OS X.
PYTHONWARNINGS
¶
这相当于
-W
option. If set to a comma separated string, it is equivalent to specifying
-W
multiple times.
PYTHONFAULTHANDLER
¶
If this environment variable is set to a non-empty string,
faulthandler.enable()
is called at startup: install a handler for
SIGSEGV
,
SIGFPE
,
SIGABRT
,
SIGBUS
and
SIGILL
signals to dump the Python traceback. This is equivalent to
-X
faulthandler
选项。
3.3 版新增。
PYTHONTRACEMALLOC
¶
If this environment variable is set to a non-empty string, start tracing Python memory allocations using the
tracemalloc
module. The value of the variable is the maximum number of frames stored in a traceback of a trace. For example,
PYTHONTRACEMALLOC=1
stores only the most recent frame. See the
tracemalloc.start()
了解更多信息。
3.4 版新增。
PYTHONASYNCIODEBUG
¶
If this environment variable is set to a non-empty string, enable the
调试模式
of the
asyncio
模块。
3.4 版新增。
PYTHONMALLOC
¶
Set the Python memory allocators and/or install debug hooks.
Set the family of memory allocators used by Python:
malloc
: use the
malloc()
function of the C library for all domains (
PYMEM_DOMAIN_RAW
,
PYMEM_DOMAIN_MEM
,
PYMEM_DOMAIN_OBJ
).
pymalloc
: use the
pymalloc allocator
for
PYMEM_DOMAIN_MEM
and
PYMEM_DOMAIN_OBJ
domains and use the
malloc()
function for the
PYMEM_DOMAIN_RAW
domain.
安装调试挂钩:
debug
: install debug hooks on top of the default memory allocator
malloc_debug
: same as
malloc
but also install debug hooks
pymalloc_debug
: same as
pymalloc
but also install debug hooks
When Python is compiled in release mode, the default is
pymalloc
. When compiled in debug mode, the default is
pymalloc_debug
and the debug hooks are used automatically.
If Python is configured without
pymalloc
支持,
pymalloc
and
pymalloc_debug
are not available, the default is
malloc
in release mode and
malloc_debug
in debug mode.
见
PyMem_SetupDebugHooks()
function for debug hooks on Python memory allocators.
3.6 版新增。
PYTHONMALLOCSTATS
¶
If set to a non-empty string, Python will print statistics of the pymalloc 内存分配器 每次创建新 pymalloc 对象 arena 时和关闭时。
This variable is ignored if the
PYTHONMALLOC
environment variable is used to force the
malloc()
allocator of the C library, or if Python is configured without
pymalloc
支持。
3.6 版改变: This variable can now also be used on Python compiled in release mode. It now has no effect if set to an empty string.
PYTHONLEGACYWINDOWSFSENCODING
¶
If set to a non-empty string, the default filesystem encoding and errors mode will revert to their pre-3.6 values of ‘mbcs’ and ‘replace’, respectively. Otherwise, the new defaults ‘utf-8’ and ‘surrogatepass’ are used.
This may also be enabled at runtime with
sys._enablelegacywindowsfsencoding()
.
可用性:Windows
3.6 版新增: 见 PEP 529 了解更多细节。
PYTHONLEGACYWINDOWSSTDIO
¶
If set to a non-empty string, does not use the new console reader and writer. This means that Unicode characters will be encoded according to the active console code page, rather than using utf-8.
This variable is ignored if the standard streams are redirected (to files or pipes) rather than referring to console buffers.
可用性:Windows
3.6 版新增。
Setting these variables only has an effect in a debug build of Python, that is, if Python was configured with the
--with-pydebug
build option.
PYTHONTHREADDEBUG
¶
If set, Python will print threading debug info.
PYTHONDUMPREFS
¶
If set, Python will dump objects and reference counts still alive after shutting down the interpreter.