1. Command line and environment¶
The CPython interpreter scans the command line and the environment for various settings.
CPython implementation detail: Other implementations’ command line schemes may differ. See Alternate Implementations for further resources.
1.1. Command line¶
When invoking Python, you may specify any of these options:
python [-bBdEhiIOPqRsSuvVWx?] [-c command | -m module-name | script | - ] [args]
The most common use case is, of course, a simple invocation of a script:
python myscript.py
1.1.1. Interface options¶
The interpreter interface resembles that of the UNIX shell, but provides some additional methods of invocation:
- When called with standard input connected to a tty device, it prompts for commands and executes them until an EOF (an end-of-file character, you can produce that with Ctrl-D on UNIX or Ctrl-Z, Enter on Windows) is read. For more on interactive mode, see Interactive Mode. 
- When called with a file name argument or with a file as standard input, it reads and executes a script from that file. 
- When called with a directory name argument, it reads and executes an appropriately named script from that directory. 
- When called with - -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!
- When called with - -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>¶
- Execute the Python code in command. command can be one or more statements separated by newlines, with significant leading whitespace as in normal module code. - If this option is given, the first element of - sys.argvwill be- "-c"and the current directory will be added to the start of- sys.path(allowing modules in that directory to be imported as top level modules).- Raises an auditing event - cpython.run_commandwith argument- command.
- -m <module-name>¶
- Search - sys.pathfor the named module and execute its contents as the- __main__module.- Since the argument is a module 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.- Note - 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. - If this option is given, the first element of - sys.argvwill 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- -coption, the current directory will be added to the start of- sys.path.- -Ioption can be used to run the script in isolated mode where- sys.pathcontains neither the current directory nor the user’s site-packages directory. All- PYTHON*environment variables are ignored, too.- Many standard library modules contain code that is invoked on their execution as a script. An example is the - timeitmodule:- python -m timeit -s "setup here" "benchmarked code here" python -m timeit -h # for details - Raises an auditing event - cpython.run_modulewith argument- module-name.- See also - runpy.run_module()
- Equivalent functionality directly available to Python code 
 - PEP 338 – Executing modules as scripts - Changed in version 3.1: Supply the package name to run a - __main__submodule.- Changed in version 3.4: namespace packages are also supported 
- -
- Read commands from standard input ( - sys.stdin). If standard input is a terminal,- -iis implied.- If this option is given, the first element of - sys.argvwill be- "-"and the current directory will be added to the start of- sys.path.- Raises an auditing event - cpython.run_stdinwith no arguments.
- <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__.pyfile, or a zipfile containing a- __main__.pyfile.- If this option is given, the first element of - sys.argvwill 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__module.- If the script name refers to a directory or zipfile, the script name is added to the start of - sys.pathand the- __main__.pyfile in that location is executed as the- __main__module.- -Ioption can be used to run the script in isolated mode where- sys.pathcontains neither the script’s directory nor the user’s site-packages directory. All- PYTHON*environment variables are ignored, too.- Raises an auditing event - cpython.run_filewith argument- filename.- See also - runpy.run_path()
- Equivalent functionality directly available to Python code 
 
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 configuration).
See also
Changed in version 3.4: Automatic enabling of tab-completion and history editing.
1.1.2. Generic options¶
- -?¶
- -h¶
- --help¶
- Print a short description of all command line options and corresponding environment variables and exit. 
- --help-env¶
- Print a short description of Python-specific environment variables and exit. - Added in version 3.11. 
- --help-xoptions¶
- Print a description of implementation-specific - -Xoptions and exit.- Added in version 3.11. 
- --help-all¶
- Print complete usage information and exit. - Added in version 3.11. 
1.1.3. Miscellaneous options¶
- -b¶
- Issue a warning when converting - bytesor- bytearrayto- strwithout specifying encoding or comparing- bytesor- bytearraywith- stror- byteswith- int. Issue an error when the option is given twice (- -bb).
- -B¶
- If given, Python won’t try to write - .pycfiles on the import of source modules. See also- PYTHONDONTWRITEBYTECODE.
- --check-hash-based-pycs default|always|never¶
- Control the validation behavior of hash-based - .pycfiles. See Cached bytecode invalidation. When set to- default, checked and unchecked hash-based bytecode cache files are validated according to their default semantics. When set to- always, all hash-based- .pycfiles, whether checked or unchecked, are validated against their corresponding source file. When set to- never, hash-based- .pycfiles are not validated against their corresponding source files.- The semantics of timestamp-based - .pycfiles are unaffected by this option.
- -d¶
- Turn on parser debugging output (for expert only). See also the - PYTHONDEBUGenvironment variable.- This option requires a debug build of Python, otherwise it’s ignored. 
- -E¶
- Ignore all - PYTHON*environment variables, e.g.- PYTHONPATHand- PYTHONHOME, that might be set.
- -i¶
- Enter interactive mode after execution. - Using the - -ioption will enter interactive mode in any of the following circumstances:- Interactive mode will start even when - sys.stdindoes not appear to be a terminal. The- PYTHONSTARTUPfile 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,- -Pand- -soptions.- In isolated mode - sys.pathcontains 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.- Added in version 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-1before the- .pycextension (see PEP 488). See also- PYTHONOPTIMIZE.- Changed in version 3.5: Modify - .pycfilenames according to PEP 488.
- -OO¶
- Do - -Oand also discard docstrings. Augment the filename for compiled (bytecode) files by adding- .opt-2before the- .pycextension (see PEP 488).- Changed in version 3.5: Modify - .pycfilenames according to PEP 488.
- -P¶
- Don’t prepend a potentially unsafe path to - sys.path:- python -m modulecommand line: Don’t prepend the current working directory.
- python script.pycommand line: Don’t prepend the script’s directory. If it’s a symbolic link, resolve symbolic links.
- python -c codeand- python(REPL) command lines: Don’t prepend an empty string, which means the current working directory.
 - See also the - PYTHONSAFEPATHenvironment variable, and- -Eand- -I(isolated) options.- Added in version 3.11. 
- -q¶
- Don’t display the copyright and version messages even in interactive mode. - Added in version 3.2. 
- -R¶
- Turn on hash randomization. This option only has an effect if the - PYTHONHASHSEEDenvironment variable is set to- 0, since hash randomization is enabled by default.- On previous versions of Python, this option turns on hash randomization, so that the - __hash__()values of str and bytes objects 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(n2) complexity. See http://ocert.org/advisories/ocert-2011-003.html for details. - PYTHONHASHSEEDallows you to set a fixed value for the hash seed secret.- Added in version 3.2.3. - Changed in version 3.7: The option is no longer ignored. 
- -s¶
- Don’t add the - user site-packages directoryto- sys.path.- See also - PYTHONNOUSERSITE.- See also - PEP 370 – Per user site-packages directory 
- -S¶
- Disable the import of the module - siteand the site-dependent manipulations of- sys.paththat it entails. Also disable these manipulations if- siteis explicitly imported later (call- site.main()if you want them to be triggered).
- -u¶
- Force the stdout and stderr streams to be unbuffered. This option has no effect on the stdin stream. - See also - PYTHONUNBUFFERED.- Changed in version 3.7: The text layer of the stdout and stderr streams now is unbuffered. 
- -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.- Changed in version 3.10: The - sitemodule reports the site-specific paths and- .pthfiles being processed.- See also - PYTHONVERBOSE.
- -W arg¶
- Warning control. Python’s warning machinery by default prints warning messages to - sys.stderr.- The simplest settings apply a particular action unconditionally to all warnings emitted by a process (even those that are otherwise ignored by default): - -Wdefault # Warn once per call location -Werror # Convert to exceptions -Walways # Warn every time -Wall # Same as -Walways -Wmodule # Warn once per calling module -Wonce # Warn once per Python process -Wignore # Never warn - The action names can be abbreviated as desired and the interpreter will resolve them to the appropriate action name. For example, - -Wiis the same as- -Wignore.- The full form of argument is: - action:message:category:module:lineno - Empty fields match all values; trailing empty fields may be omitted. For example - -W ignore::DeprecationWarningignores all DeprecationWarning warnings.- The action field is as explained above but only applies to warnings that match the remaining fields. - The message field must match the whole warning message; this match is case-insensitive. - The category field matches the warning category (ex: - DeprecationWarning). This must be a class name; the match test whether the actual warning category of the message is a subclass of the specified warning category.- The module field matches the (fully qualified) module name; this match is case-sensitive. - The lineno field matches the line number, where zero matches all line numbers and is thus equivalent to an omitted line number. - Multiple - -Woptions can be given; when a warning matches more than one option, the action for the last matching option is performed. Invalid- -Woptions are ignored (though, a warning message is printed about invalid options when the first warning is issued).- Warnings can also be controlled using the - PYTHONWARNINGSenvironment variable and from within a Python program using the- warningsmodule. For example, the- warnings.filterwarnings()function can be used to use a regular expression on the warning message.- See The Warnings Filter and Describing Warning Filters for more details. 
- -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 faulthandlerto enable- faulthandler. See also- PYTHONFAULTHANDLER.- Added in version 3.3. 
- -X showrefcountto 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.- Added in version 3.4. 
- -X tracemallocto start tracing Python memory allocations using the- tracemallocmodule. By default, only the most recent frame is stored in a traceback of a trace. Use- -X tracemalloc=NFRAMEto start tracing with a traceback limit of NFRAME frames. See- tracemalloc.start()and- PYTHONTRACEMALLOCfor more information.- Added in version 3.4. 
- -X int_max_str_digitsconfigures the integer string conversion length limitation. See also- PYTHONINTMAXSTRDIGITS.- Added in version 3.11. 
- -X importtimeto show how long each import takes. It shows module name, cumulative time (including nested imports) and self time (excluding nested imports). Note that its output may be broken in multi-threaded application. Typical usage is- python3 -X importtime -c 'import asyncio'. See also- PYTHONPROFILEIMPORTTIME.- Added in version 3.7. 
- -X dev: enable Python Development Mode, introducing additional runtime checks that are too expensive to be enabled by default. See also- PYTHONDEVMODE.- Added in version 3.7. 
- -X utf8enables the Python UTF-8 Mode.- -X utf8=0explicitly disables Python UTF-8 Mode (even when it would otherwise activate automatically). See also- PYTHONUTF8.- Added in version 3.7. 
- -X pycache_prefix=PATHenables writing- .pycfiles to a parallel tree rooted at the given directory instead of to the code tree. See also- PYTHONPYCACHEPREFIX.- Added in version 3.8. 
- -X warn_default_encodingissues a- EncodingWarningwhen the locale-specific default encoding is used for opening files. See also- PYTHONWARNDEFAULTENCODING.- Added in version 3.10. 
- -X no_debug_rangesdisables the inclusion of the tables mapping extra location information (end line, start column offset and end column offset) to every instruction in code objects. This is useful when smaller code objects and pyc files are desired as well as suppressing the extra visual location indicators when the interpreter displays tracebacks. See also- PYTHONNODEBUGRANGES.- Added in version 3.11. 
- -X frozen_modulesdetermines whether or not frozen modules are ignored by the import machinery. A value of- onmeans they get imported and- offmeans they are ignored. The default is- onif this is an installed Python (the normal case). If it’s under development (running from the source tree) then the default is- off. Note that the- importlib_bootstrapand- importlib_bootstrap_externalfrozen modules are always used, even if this flag is set to- off. See also- PYTHON_FROZEN_MODULES.- Added in version 3.11. 
- -X perfenables support for the Linux- perfprofiler. When this option is provided, the- perfprofiler will be able to report Python calls. This option is only available on some platforms and will do nothing if is not supported on the current system. The default value is “off”. See also- PYTHONPERFSUPPORTand Python support for the Linux perf profiler.- Added in version 3.12. 
- -X perf_jitenables support for the Linux- perfprofiler with DWARF support. When this option is provided, the- perfprofiler will be able to report Python calls using DWARF information. This option is only available on some platforms and will do nothing if is not supported on the current system. The default value is “off”. See also- PYTHON_PERF_JIT_SUPPORTand Python support for the Linux perf profiler.- Added in version 3.13. 
- -X cpu_count=noverrides- os.cpu_count(),- os.process_cpu_count(), and- multiprocessing.cpu_count(). n must be greater than or equal to 1. This option may be useful for users who need to limit CPU resources of a container system. See also- PYTHON_CPU_COUNT. If n is- default, nothing is overridden.- Added in version 3.13. 
- -X presite=package.modulespecifies a module that should be imported before the- sitemodule is executed and before the- __main__module exists. Therefore, the imported module isn’t- __main__. This can be used to execute code early during Python initialization. Python needs to be built in debug mode for this option to exist. See also- PYTHON_PRESITE.- Added in version 3.13. 
- -X gil=0,1forces the GIL to be disabled or enabled, respectively. Setting to- 0is only available in builds configured with- --disable-gil. See also- PYTHON_GILand Free-threaded CPython.- Added in version 3.13. 
 - It also allows passing arbitrary values and retrieving them through the - sys._xoptionsdictionary.- Added in version 3.2. - Changed in version 3.9: Removed the - -X showalloccountoption.- Changed in version 3.10: Removed the - -X oldparseroption.
1.1.4. Controlling color¶
The Python interpreter is configured by default to use colors to highlight output in certain situations such as when displaying tracebacks. This behavior can be controlled by setting different environment variables.
Setting the environment variable TERM to dumb will disable color.
If the FORCE_COLOR environment variable is set, then color will be
enabled regardless of the value of TERM. This is useful on CI systems which
aren’t terminals but can still display ANSI escape sequences.
If the NO_COLOR environment variable is set, Python will disable all color
in the output. This takes precedence over FORCE_COLOR.
All these environment variables are used also by other tools to control color
output. To control the color output only in the Python interpreter, the
PYTHON_COLORS environment variable can be used. This variable takes
precedence over NO_COLOR, which in turn takes precedence over
FORCE_COLOR.
1.1.5. Options you shouldn’t use¶
1.2. Environment variables¶
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/pythonversionand- exec_prefix/lib/pythonversion, where- prefixand- exec_prefixare installation-dependent directories, both defaulting to- /usr/local.- When - PYTHONHOMEis set to a single directory, its value replaces both- prefixand- exec_prefix. To specify different values for these, set- PYTHONHOMEto- 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 - PYTHONPATHentries 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/pythonversion(see- PYTHONHOMEabove). It is always appended to- PYTHONPATH.- An additional directory will be inserted in the search path in front of - PYTHONPATHas described above under Interface options. The search path can be manipulated from within a Python program as the variable- sys.path.
- PYTHONSAFEPATH¶
- If this is set to a non-empty string, don’t prepend a potentially unsafe path to - sys.path: see the- -Poption for details.- Added in version 3.11. 
- PYTHONPLATLIBDIR¶
- If this is set to a non-empty string, it overrides the - sys.platlibdirvalue.- Added in version 3.9. 
- 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.ps1and- sys.ps2and the hook- sys.__interactivehook__in this file.- Raises an auditing event - cpython.run_startupwith the filename as the argument when called on startup.
- PYTHONOPTIMIZE¶
- If this is set to a non-empty string it is equivalent to specifying the - -Ooption. If set to an integer, it is equivalent to specifying- -Omultiple times.
- PYTHONBREAKPOINT¶
- If this is set, it names a callable using dotted-path notation. The module containing the callable will be imported and then the callable will be run by the default implementation of - sys.breakpointhook()which itself is called by built-in- breakpoint(). If not set, or set to the empty string, it is equivalent to the value “pdb.set_trace”. Setting this to the string “0” causes the default implementation of- sys.breakpointhook()to do nothing but return immediately.- Added in version 3.7. 
- PYTHONDEBUG¶
- If this is set to a non-empty string it is equivalent to specifying the - -doption. If set to an integer, it is equivalent to specifying- -dmultiple times.- This environment variable requires a debug build of Python, otherwise it’s ignored. 
- PYTHONINSPECT¶
- If this is set to a non-empty string it is equivalent to specifying the - -ioption.- This variable can also be modified by Python code using - os.environto force inspect mode on program termination.- Raises an auditing event - cpython.run_stdinwith no arguments.- Changed in version 3.12.5: (also 3.11.10, 3.10.15, 3.9.20, and 3.8.20) Emits audit events. - Changed in version 3.13: Uses PyREPL if possible, in which case - PYTHONSTARTUPis also executed. Emits audit events.
- PYTHONUNBUFFERED¶
- If this is set to a non-empty string it is equivalent to specifying the - -uoption.
- PYTHONVERBOSE¶
- If this is set to a non-empty string it is equivalent to specifying the - -voption. If set to an integer, it is equivalent to specifying- -vmultiple times.
- PYTHONCASEOK¶
- If this is set, Python ignores case in - importstatements. This only works on Windows and macOS.
- PYTHONDONTWRITEBYTECODE¶
- If this is set to a non-empty string, Python won’t try to write - .pycfiles on the import of source modules. This is equivalent to specifying the- -Boption.
- PYTHONPYCACHEPREFIX¶
- If this is set, Python will write - .pycfiles in a mirror directory tree at this path, instead of in- __pycache__directories within the source tree. This is equivalent to specifying the- -X- pycache_prefix=PATHoption.- Added in version 3.8. 
- PYTHONHASHSEED¶
- If this variable is not set or set to - random, a random value is used to seed the hashes of str and bytes objects.- If - PYTHONHASHSEEDis 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. - Added in version 3.2.3. 
- PYTHONINTMAXSTRDIGITS¶
- If this variable is set to an integer, it is used to configure the interpreter’s global integer string conversion length limitation. - Added in version 3.11. 
- 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- encodingnameand the- :errorhandlerparts are optional and have the same meaning as in- str.encode().- For stderr, the - :errorhandlerpart is ignored; the handler will always be- 'backslashreplace'.- Changed in version 3.4: The - encodingnamepart is now optional.- Changed in version 3.6: On Windows, the encoding specified by this variable is ignored for interactive console buffers unless - PYTHONLEGACYWINDOWSSTDIOis also specified. Files and pipes redirected through the standard streams are not affected.
- PYTHONNOUSERSITE¶
- If this is set, Python won’t add the - user site-packages directoryto- sys.path.- See also - PEP 370 – Per user site-packages directory 
- PYTHONUSERBASE¶
- Defines the - user base directory, which is used to compute the path of the- user site-packages directoryand installation paths for- python -m pip install --user.- See also - PEP 370 – Per user site-packages directory 
- PYTHONEXECUTABLE¶
- If this environment variable is set, - sys.argv[0]will be set to its value instead of the value got through the C runtime. Only works on macOS.
- PYTHONWARNINGS¶
- This is equivalent to the - -Woption. If set to a comma separated string, it is equivalent to specifying- -Wmultiple times, with filters later in the list taking precedence over those earlier in the list.- The simplest settings apply a particular action unconditionally to all warnings emitted by a process (even those that are otherwise ignored by default): - PYTHONWARNINGS=default # Warn once per call location PYTHONWARNINGS=error # Convert to exceptions PYTHONWARNINGS=always # Warn every time PYTHONWARNINGS=all # Same as PYTHONWARNINGS=always PYTHONWARNINGS=module # Warn once per calling module PYTHONWARNINGS=once # Warn once per Python process PYTHONWARNINGS=ignore # Never warn - See The Warnings Filter and Describing Warning Filters for more details. 
- 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,- SIGBUSand- SIGILLsignals to dump the Python traceback. This is equivalent to- -X- faulthandleroption.- Added in version 3.3. 
- PYTHONTRACEMALLOC¶
- If this environment variable is set to a non-empty string, start tracing Python memory allocations using the - tracemallocmodule. The value of the variable is the maximum number of frames stored in a traceback of a trace. For example,- PYTHONTRACEMALLOC=1stores only the most recent frame. See the- tracemalloc.start()function for more information. This is equivalent to setting the- -X- tracemallocoption.- Added in version 3.4. 
- PYTHONPROFILEIMPORTTIME¶
- If this environment variable is set to a non-empty string, Python will show how long each import takes. This is equivalent to setting the - -X- importtimeoption.- Added in version 3.7. 
- PYTHONASYNCIODEBUG¶
- If this environment variable is set to a non-empty string, enable the debug mode of the - asynciomodule.- Added in version 3.4. 
- PYTHONMALLOC¶
- Set the Python memory allocators and/or install debug hooks. - Set the family of memory allocators used by Python: - default: use the default memory allocators.
- 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_MEMand- PYMEM_DOMAIN_OBJdomains and use the- malloc()function for the- PYMEM_DOMAIN_RAWdomain.
- mimalloc: use the mimalloc allocator for- PYMEM_DOMAIN_MEMand- PYMEM_DOMAIN_OBJdomains and use the- malloc()function for the- PYMEM_DOMAIN_RAWdomain.
 - Install debug hooks: - debug: install debug hooks on top of the default memory allocators.
- malloc_debug: same as- mallocbut also install debug hooks.
- pymalloc_debug: same as- pymallocbut also install debug hooks.
- mimalloc_debug: same as- mimallocbut also install debug hooks.
 - Added in version 3.6. - Changed in version 3.7: Added the - "default"allocator.
- PYTHONMALLOCSTATS¶
- If set to a non-empty string, Python will print statistics of the pymalloc memory allocator every time a new pymalloc object arena is created, and on shutdown. - This variable is ignored if the - PYTHONMALLOCenvironment variable is used to force the- malloc()allocator of the C library, or if Python is configured without- pymallocsupport.- Changed in version 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 error handler 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().- Availability: Windows. - Added in version 3.6: See PEP 529 for more details. 
- 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. - Availability: Windows. - Added in version 3.6. 
- PYTHONCOERCECLOCALE¶
- If set to the value - 0, causes the main Python command line application to skip coercing the legacy ASCII-based C and POSIX locales to a more capable UTF-8 based alternative.- If this variable is not set (or is set to a value other than - 0), the- LC_ALLlocale override environment variable is also not set, and the current locale reported for the- LC_CTYPEcategory is either the default- Clocale, or else the explicitly ASCII-based- POSIXlocale, then the Python CLI will attempt to configure the following locales for the- LC_CTYPEcategory in the order listed before loading the interpreter runtime:- C.UTF-8
- C.utf8
- UTF-8
 - If setting one of these locale categories succeeds, then the - LC_CTYPEenvironment variable will also be set accordingly in the current process environment before the Python runtime is initialized. This ensures that in addition to being seen by both the interpreter itself and other locale-aware components running in the same process (such as the GNU- readlinelibrary), the updated setting is also seen in subprocesses (regardless of whether or not those processes are running a Python interpreter), as well as in operations that query the environment rather than the current C locale (such as Python’s own- locale.getdefaultlocale()).- Configuring one of these locales (either explicitly or via the above implicit locale coercion) automatically enables the - surrogateescapeerror handler for- sys.stdinand- sys.stdout(- sys.stderrcontinues to use- backslashreplaceas it does in any other locale). This stream handling behavior can be overridden using- PYTHONIOENCODINGas usual.- For debugging purposes, setting - PYTHONCOERCECLOCALE=warnwill cause Python to emit warning messages on- stderrif either the locale coercion activates, or else if a locale that would have triggered coercion is still active when the Python runtime is initialized.- Also note that even when locale coercion is disabled, or when it fails to find a suitable target locale, - PYTHONUTF8will still activate by default in legacy ASCII-based locales. Both features must be disabled in order to force the interpreter to use- ASCIIinstead of- UTF-8for system interfaces.- Availability: Unix. - Added in version 3.7: See PEP 538 for more details. 
- PYTHONDEVMODE¶
- If this environment variable is set to a non-empty string, enable Python Development Mode, introducing additional runtime checks that are too expensive to be enabled by default. This is equivalent to setting the - -X- devoption.- Added in version 3.7. 
- PYTHONUTF8¶
- If set to - 1, enable the Python UTF-8 Mode.- If set to - 0, disable the Python UTF-8 Mode.- Setting any other non-empty string causes an error during interpreter initialisation. - Added in version 3.7. 
- PYTHONWARNDEFAULTENCODING¶
- If this environment variable is set to a non-empty string, issue a - EncodingWarningwhen the locale-specific default encoding is used.- See Opt-in EncodingWarning for details. - Added in version 3.10. 
- PYTHONNODEBUGRANGES¶
- If this variable is set, it disables the inclusion of the tables mapping extra location information (end line, start column offset and end column offset) to every instruction in code objects. This is useful when smaller code objects and pyc files are desired as well as suppressing the extra visual location indicators when the interpreter displays tracebacks. - Added in version 3.11. 
- PYTHONPERFSUPPORT¶
- If this variable is set to a nonzero value, it enables support for the Linux - perfprofiler so Python calls can be detected by it.- If set to - 0, disable Linux- perfprofiler support.- See also the - -X perfcommand-line option and Python support for the Linux perf profiler.- Added in version 3.12. 
- PYTHON_PERF_JIT_SUPPORT¶
- If this variable is set to a nonzero value, it enables support for the Linux - perfprofiler so Python calls can be detected by it using DWARF information.- If set to - 0, disable Linux- perfprofiler support.- See also the - -X perf_jitcommand-line option and Python support for the Linux perf profiler.- Added in version 3.13. 
- PYTHON_CPU_COUNT¶
- If this variable is set to a positive integer, it overrides the return values of - os.cpu_count()and- os.process_cpu_count().- See also the - -X cpu_countcommand-line option.- Added in version 3.13. 
- PYTHON_FROZEN_MODULES¶
- If this variable is set to - onor- off, it determines whether or not frozen modules are ignored by the import machinery. A value of- onmeans they get imported and- offmeans they are ignored. The default is- onfor non-debug builds (the normal case) and- offfor debug builds. Note that the- importlib_bootstrapand- importlib_bootstrap_externalfrozen modules are always used, even if this flag is set to- off.- See also the - -X frozen_modulescommand-line option.- Added in version 3.13. 
- PYTHON_COLORS¶
- If this variable is set to - 1, the interpreter will colorize various kinds of output. Setting it to- 0deactivates this behavior. See also Controlling color.- Added in version 3.13. 
- PYTHON_BASIC_REPL¶
- If this variable is set to any value, the interpreter will not attempt to load the Python-based REPL that requires - cursesand- readline, and will instead use the traditional parser-based REPL.- Added in version 3.13. 
- PYTHON_HISTORY¶
- This environment variable can be used to set the location of a - .python_historyfile (by default, it is- .python_historyin the user’s home directory).- Added in version 3.13. 
- PYTHON_GIL¶
- If this variable is set to - 1, the global interpreter lock (GIL) will be forced on. Setting it to- 0forces the GIL off (needs Python configured with the- --disable-gilbuild option).- See also the - -X gilcommand-line option, which takes precedence over this variable, and Free-threaded CPython.- Added in version 3.13. 
1.2.1. Debug-mode variables¶
- PYTHONDUMPREFS¶
- If set, Python will dump objects and reference counts still alive after shutting down the interpreter. - Needs Python configured with the - --with-trace-refsbuild option.
- PYTHONDUMPREFSFILE¶
- If set, Python will dump objects and reference counts still alive after shutting down the interpreter into a file under the path given as the value to this environment variable. - Needs Python configured with the - --with-trace-refsbuild option.- Added in version 3.11. 
- PYTHON_PRESITE¶
- If this variable is set to a module, that module will be imported early in the interpreter lifecycle, before the - sitemodule is executed, and before the- __main__module is created. Therefore, the imported module is not treated as- __main__.- This can be used to execute code early during Python initialization. - To import a submodule, use - package.moduleas the value, like in an import statement.- See also the - -X presitecommand-line option, which takes precedence over this variable.- Needs Python configured with the - --with-pydebugbuild option.- Added in version 3.13.