Structure containing most parameters to configure Python.
When done, the PyConfig_Clear() function must be used to release the
configuration memory.
Structure methods:
void PyConfig_InitPythonConfig(PyConfig *config)¶
Initialize configuration with the Python Configuration.
void PyConfig_InitIsolatedConfig(PyConfig *config)¶
Initialize configuration with the Isolated Configuration.
PyStatus PyConfig_SetString(PyConfig *config, wchar_t *const *config_str, const wchar_t *str)¶
Copy the wide character string str into *config_str.
PyStatus PyConfig_SetBytesString(PyConfig *config, wchar_t *const *config_str, const char *str)¶
Decode str using Py_DecodeLocale() and set the result into
*config_str.
PyStatus PyConfig_SetArgv(PyConfig *config, int argc, wchar_t *const *argv)¶
Set command line arguments (argv member of
config) from the argv list of wide character strings.
PyStatus PyConfig_SetBytesArgv(PyConfig *config, int argc, char *const *argv)¶
Set command line arguments (argv member of
config) from the argv list of bytes strings. Decode bytes using
Py_DecodeLocale().
PyStatus PyConfig_SetWideStringList(PyConfig *config, PyWideStringList *list, Py_ssize_t length, wchar_t **items)¶
Set the list of wide strings list to length and items.
PyStatus PyConfig_Read(PyConfig *config)¶
Read all Python configuration.
Fields which are already initialized are left unchanged.
The PyConfig_Read() function only parses
PyConfig.argv arguments once: PyConfig.parse_argv
is set to 2 after arguments are parsed. Since Python arguments are
strippped from PyConfig.argv, parsing arguments twice would
parse the application options as Python options.
在 3.10 版更改:The PyConfig.argv arguments are now only parsed once,
PyConfig.parse_argv is set to 2 after arguments are
parsed, and arguments are only parsed if
PyConfig.parse_argv equals 1.
void PyConfig_Clear(PyConfig *config)¶
Release configuration memory.
Most PyConfig methods preinitialize Python if needed.
In that case, the Python preinitialization configuration
(PyPreConfig) in based on the PyConfig. If configuration
fields which are in common with PyPreConfig are tuned, they must
be set before calling a PyConfig method:
Moreover, if PyConfig_SetArgv() or PyConfig_SetBytesArgv()
is used, this method must be called before other methods, since the
preinitialization configuration depends on command line arguments (if
parse_argv is non-zero).
The caller of these methods is responsible to handle exceptions (error or
exit) using PyStatus_Exception() and Py_ExitStatusException().
Structure fields:
Command line arguments: sys.argv.
Set parse_argv to 1 to parse
argv the same way the regular Python parses Python
command line arguments and then to strip Python arguments from
argv.
If argv is empty, an empty string is added to
ensure that sys.argv always exists and is never empty.
Default: NULL.
See also the orig_argv member.
wchar_t *base_exec_prefix¶
wchar_t *base_executable¶
Python base executable: sys._base_executable.
Set by the __PYVENV_LAUNCHER__ environment variable.
Default: NULL.
wchar_t *base_prefix¶
int buffered_stdio¶
If equals to 0 and configure_c_stdio is non-zero,
disable buffering on the C streams stdout and stderr.
Set to 0 by the -u command line option and the
PYTHONUNBUFFERED environment variable.
stdin is always opened in buffered mode.
Default: 1.
int bytes_warning¶
If equals to 1, issue a warning when comparing bytes or
bytearray with str, or comparing bytes with
int.
If equal or greater to 2, raise a BytesWarning exception in these
cases.
Incremented by the -b command line option.
Default: 0.
wchar_t *check_hash_pycs_mode¶
Control the validation behavior of hash-based .pyc files:
value of the --check-hash-based-pycs command line option.
Valid values:
L"always": Hash the source file for invalidation regardless of
value of the 'check_source' flag.
L"never": Assume that hash-based pycs always are valid.
L"default": The 'check_source' flag in hash-based pycs
determines invalidation.
Default: L"default".
See also PEP 552 "Deterministic pycs".
int configure_c_stdio¶
If non-zero, configure C standard streams:
On Windows, set the binary mode (O_BINARY) on stdin, stdout and
stderr.
If buffered_stdio equals zero, disable buffering
of stdin, stdout and stderr streams.
If interactive is non-zero, enable stream
buffering on stdin and stdout (only stdout on Windows).
Default: 1 in Python config, 0 in isolated config.
int dev_mode¶
If non-zero, enable the Python Development Mode.
Default: -1 in Python mode, 0 in isolated mode.
int dump_refs¶
Dump Python refererences?
If non-zero, dump all objects which are still alive at exit.
Set to 1 by the PYTHONDUMPREFS environment variable.
Need a special build of Python with the Py_TRACE_REFS macro defined.
Default: 0.
wchar_t *exec_prefix¶
The site-specific directory prefix where the platform-dependent Python
files are installed: sys.exec_prefix.
Default: NULL.
wchar_t *executable¶
The absolute path of the executable binary for the Python interpreter:
sys.executable.
Default: NULL.
int faulthandler¶
Enable faulthandler?
If non-zero, call faulthandler.enable() at startup.
Set to 1 by -X faulthandler and the
PYTHONFAULTHANDLER environment variable.
Default: -1 in Python mode, 0 in isolated mode.
wchar_t *filesystem_encoding¶
On macOS, Android and VxWorks: use "utf-8" by default.
On Windows: use "utf-8" by default, or "mbcs" if
legacy_windows_fs_encoding of
PyPreConfig is non-zero.
Default encoding on other platforms:
"utf-8" if PyPreConfig.utf8_mode is non-zero.
"ascii" if Python detects that nl_langinfo(CODESET) announces
the ASCII encoding (or Roman8 encoding on HP-UX), whereas the
mbstowcs() function decodes from a different encoding (usually
Latin1).
"utf-8" if nl_langinfo(CODESET) returns an empty string.
Otherwise, use the locale encoding:
nl_langinfo(CODESET) result.
At Python statup, the encoding name is normalized to the Python codec
name. For example, "ANSI_X3.4-1968" is replaced with "ascii".
See also the filesystem_errors member.
wchar_t *filesystem_errors¶
On Windows: use "surrogatepass" by default, or "replace" if
legacy_windows_fs_encoding of
PyPreConfig is non-zero.
On other platforms: use "surrogateescape" by default.
Supported error handlers:
"strict"
"surrogateescape"
"surrogatepass" (only supported with the UTF-8 encoding)
See also the filesystem_encoding member.
unsigned long hash_seed¶
int use_hash_seed¶
Randomized hash function seed.
If use_hash_seed is zero, a seed is chosen randomly
at Python startup, and hash_seed is ignored.
Set by the PYTHONHASHSEED environment variable.
Default use_hash_seed value: -1 in Python mode, 0 in isolated
mode.
wchar_t *home¶
Python home directory.
If Py_SetPythonHome() has been called, use its argument if it is
not NULL.
Set by the PYTHONHOME environment variable.
Default: NULL.
int import_time¶
If non-zero, profile import time.
Set the 1 by the -X importtime option and the
PYTHONPROFILEIMPORTTIME environment variable.
Default: 0.
int inspect¶
Enter interactive mode after executing a script or a command.
If greater than 0, enable inspect: 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.
Incremented by the -i command line option. Set to 1 if the
PYTHONINSPECT environment variable is non-empty.
Default: 0.
int install_signal_handlers¶
Install Python signal handlers?
Default: 1 in Python mode, 0 in isolated mode.
int interactive¶
If greater than 0, enable the interactive mode (REPL).
Incremented by the -i command line option.
Default: 0.
int isolated¶
If greater than 0, enable isolated mode:
sys.path contains neither the script's directory (computed from
argv[0] or the current directory) nor the user's site-packages
directory.
Python REPL doesn't import readline nor enable default readline
configuration on interactive prompts.
Default: 0 in Python mode, 1 in isolated mode.
int legacy_windows_stdio¶
If non-zero, use io.FileIO instead of
io.WindowsConsoleIO for sys.stdin, sys.stdout
and sys.stderr.
Set to 1 if the PYTHONLEGACYWINDOWSSTDIO environment
variable is set to a non-empty string.
Only available on Windows. #ifdef MS_WINDOWS macro can be used for
Windows specific code.
Default: 0.
See also the PEP 528 (Change Windows console encoding to UTF-8).
int malloc_stats¶
If non-zero, dump statistics on Python pymalloc memory allocator at exit.
Set to 1 by the PYTHONMALLOCSTATS environment variable.
The option is ignored if Python is built using --without-pymalloc.
Default: 0.
wchar_t *platlibdir¶
Platform library directory name: sys.platlibdir.
Set by the PYTHONPLATLIBDIR environment variable.
Default: value of the PLATLIBDIR macro which is set at configure time
by --with-platlibdir (default: "lib").
3.9 新版功能.
wchar_t *pythonpath_env¶
Module search paths (sys.path) as a string separated by DELIM
(os.path.pathsep).
Set by the PYTHONPATH environment variable.
Default: NULL.
PyWideStringList module_search_paths¶
int module_search_paths_set¶
Module search paths: sys.path.
Default: empty list (module_search_paths) and 0
(module_search_paths_set).
int optimization_level¶
Compilation optimization level:
0: Peephole optimizer, set __debug__ to True.
1: Level 0, remove assertions, set __debug__ to False.
2: Level 1, strip docstrings.
Incremented by the -O command line option. Set to the
PYTHONOPTIMIZE environment variable value.
Default: 0.
The list of the original command line arguments passed to the Python
executable: sys.orig_argv.
If orig_argv list is empty and
argv is not a list only containing an empty
string, PyConfig_Read() copies argv into
orig_argv before modifying
argv (if parse_argv is
non-zero).
See also the argv member and the
Py_GetArgcArgv() function.
Default: empty list.
3.10 新版功能.
int parse_argv¶
Parse command line arguments?
If equals to 1, parse argv the same way the regular
Python parses command line arguments, and strip
Python arguments from argv.
The PyConfig_Read() function only parses
PyConfig.argv arguments once: PyConfig.parse_argv
is set to 2 after arguments are parsed. Since Python arguments are
strippped from PyConfig.argv, parsing arguments twice would
parse the application options as Python options.
Default: 1 in Python mode, 0 in isolated mode.
在 3.10 版更改:The PyConfig.argv arguments are now only parsed if
PyConfig.parse_argv equals to 1.
int parser_debug¶
Parser debug mode. If greater than 0, turn on parser debugging output (for expert only, depending
on compilation options).
Incremented by the -d command line option. Set to the
PYTHONDEBUG environment variable value.
Default: 0.
int pathconfig_warnings¶
On Unix, if non-zero, calculating the Python Path Configuration can log warnings into stderr. If equals to 0,
suppress these warnings.
It has no effect on Windows.
Default: 1 in Python mode, 0 in isolated mode.
wchar_t *prefix¶
The site-specific directory prefix where the platform independent Python
files are installed: sys.prefix.
Default: NULL.
wchar_t *program_name¶
Program name used to initialize executable and in
early error messages during Python initialization.
If Py_SetProgramName() has been called, use its argument.
On macOS, use PYTHONEXECUTABLE environment variable if set.
If the WITH_NEXT_FRAMEWORK macro is defined, use
__PYVENV_LAUNCHER__ environment variable if set.
Use argv[0] of argv if available and
non-empty.
Otherwise, use L"python" on Windows, or L"python3" on other
platforms.
Default: NULL.
wchar_t *pycache_prefix¶
Directory where cached .pyc files are written:
sys.pycache_prefix.
Set by the -X pycache_prefix=PATH command line option and
the PYTHONPYCACHEPREFIX environment variable.
If NULL, sys.pycache_prefix is set to None.
Default: NULL.
int quiet¶
Quiet mode. If greater than 0, don't display the copyright and version at
Python startup in interactive mode.
Incremented by the -q command line option.
Default: 0.
wchar_t *run_command¶
Value of the -c command line option.
Default: NULL.
wchar_t *run_filename¶
Filename passed on the command line: trailing command line argument
without -c or -m.
For example, it is set to script.py by the python3 script.py arg
command.
Default: NULL.
wchar_t *run_module¶
Value of the -m command line option.
Default: NULL.
int show_ref_count¶
Show total reference count at exit?
Set to 1 by -X showrefcount command line option.
Need a debug build of Python (Py_REF_DEBUG macro must be defined).
Default: 0.
int site_import¶
Import the site module at startup?
If equal to zero, disable the import of the module site and the
site-dependent manipulations of sys.path that it entails.
Also disable these manipulations if the site module is explicitly
imported later (call site.main() if you want them to be triggered).
Set to 0 by the -S command line option.
sys.flags.no_site is set to the inverted value of
site_import.
Default: 1.
int skip_source_first_line¶
If non-zero, skip the first line of the PyConfig.run_filename
source.
It allows the usage of non-Unix forms of #!cmd. This is intended for
a DOS specific hack only.
Set to 1 by the -x command line option.
Default: 0.
wchar_t *stdio_encoding¶
wchar_t *stdio_errors¶
Encoding and encoding errors of sys.stdin, sys.stdout and
sys.stderr (but sys.stderr always uses
"backslashreplace" error handler).
If Py_SetStandardStreamEncoding() has been called, use its
error and errors arguments if they are not NULL.
Use the PYTHONIOENCODING environment variable if it is
non-empty.
Default encoding:
"UTF-8" if PyPreConfig.utf8_mode is non-zero.
Otherwise, use the locale encoding.
Default error handler:
On Windows: use "surrogateescape".
"surrogateescape" if PyPreConfig.utf8_mode is non-zero,
or if the LC_CTYPE locale is "C" or "POSIX".
"strict" otherwise.
int tracemalloc¶
Enable tracemalloc?
If non-zero, call tracemalloc.start() at startup.
Set by -X tracemalloc=N command line option and by the
PYTHONTRACEMALLOC environment variable.
Default: -1 in Python mode, 0 in isolated mode.
int use_environment¶
If equals to zero, ignore the environment variables.
Default: 1 in Python config and 0 in isolated config.
int user_site_directory¶
If non-zero, add the user site directory to sys.path.
Set to 0 by the -s and -I command line options.
Set to 0 by the PYTHONNOUSERSITE environment variable.
Default: 1 in Python mode, 0 in isolated mode.
int verbose¶
Verbose mode. If greater than 0, print a message each time a module is
imported, showing the place (filename or built-in module) from which
it is loaded.
If greater or equal to 2, print a message for each file that is checked
for when searching for a module. Also provides information on module
cleanup at exit.
Incremented by the -v command line option.
Set to the PYTHONVERBOSE environment variable value.
Default: 0.
Options of the warnings module to build warnings filters, lowest
to highest priority: sys.warnoptions.
The warnings module adds sys.warnoptions in the reverse
order: the last PyConfig.warnoptions item becomes the first
item of warnings.filters which is checked first (highest
priority).
Default: empty list.
int write_bytecode¶
If equal to 0, Python won't try to write .pyc files on the import of
source modules.
Set to 0 by the -B command line option and the
PYTHONDONTWRITEBYTECODE environment variable.
sys.dont_write_bytecode is initialized to the inverted value of
write_bytecode.
Default: 1.
Values of the -X command line options: sys._xoptions.
Default: empty list.