Python Initialization Configuration¶
PyInitConfig C API¶
Added in version 3.14.
Python can be initialized with Py_InitializeFromInitConfig().
The Py_RunMain() function can be used to write a customized Python
program.
See also Initialization, Finalization, and Threads.
See also
PEP 741 “Python Configuration C API”.
Example¶
Example of customized Python always running with the Python Development
Mode enabled; return -1 on error:
int init_python(void)
{
PyInitConfig *config = PyInitConfig_Create();
if (config == NULL) {
printf("PYTHON INIT ERROR: memory allocation failed\n");
return -1;
}
// Enable the Python Development Mode
if (PyInitConfig_SetInt(config, "dev_mode", 1) < 0) {
goto error;
}
// Initialize Python with the configuration
if (Py_InitializeFromInitConfig(config) < 0) {
goto error;
}
PyInitConfig_Free(config);
return 0;
error:
{
// Display the error message.
//
// This uncommon braces style is used, because you cannot make
// goto targets point to variable declarations.
const char *err_msg;
(void)PyInitConfig_GetError(config, &err_msg);
printf("PYTHON INIT ERROR: %s\n", err_msg);
PyInitConfig_Free(config);
return -1;
}
}
Create Config¶
-
struct PyInitConfig¶
Opaque structure to configure the Python initialization.
-
PyInitConfig *PyInitConfig_Create(void)¶
Create a new initialization configuration using Isolated Configuration default values.
It must be freed by
PyInitConfig_Free().Return
NULLon memory allocation failure.
-
void PyInitConfig_Free(PyInitConfig *config)¶
Free memory of the initialization configuration config.
If config is
NULL, no operation is performed.
Error Handling¶
-
int PyInitConfig_GetError(PyInitConfig *config, const char **err_msg)¶
Get the config error message.
Set *err_msg and return
1if an error is set.Set *err_msg to
NULLand return0otherwise.
An error message is a UTF-8 encoded string.
If config has an exit code, format the exit code as an error message.
The error message remains valid until another
PyInitConfigfunction is called with config. The caller doesn’t have to free the error message.
-
int PyInitConfig_GetExitCode(PyInitConfig *config, int *exitcode)¶
Get the config exit code.
Set *exitcode and return
1if config has an exit code set.Return
0if config has no exit code set.
Only the
Py_InitializeFromInitConfig()function can set an exit code if theparse_argvoption is non-zero.An exit code can be set when parsing the command line failed (exit code
2) or when a command line option asks to display the command line help (exit code0).
Get Options¶
The configuration option name parameter must be a non-NULL null-terminated UTF-8 encoded string. See Configuration Options.
-
int PyInitConfig_HasOption(PyInitConfig *config, const char *name)¶
Test if the configuration has an option called name.
Return
1if the option exists, or return0otherwise.
-
int PyInitConfig_GetInt(PyInitConfig *config, const char *name, int64_t *value)¶
Get an integer configuration option.
Set *value, and return
0on success.Set an error in config and return
-1on error.
-
int PyInitConfig_GetStr(PyInitConfig *config, const char *name, char **value)¶
Get a string configuration option as a null-terminated UTF-8 encoded string.
Set *value, and return
0on success.Set an error in config and return
-1on error.
*value can be set to
NULLif the option is an optional string and the option is unset.On success, the string must be released with
free(value)if it’s notNULL.
-
int PyInitConfig_GetStrList(PyInitConfig *config, const char *name, size_t *length, char ***items)¶
Get a string list configuration option as an array of null-terminated UTF-8 encoded strings.
Set *length and *value, and return
0on success.Set an error in config and return
-1on error.
On success, the string list must be released with
PyInitConfig_FreeStrList(length, items).
-
void PyInitConfig_FreeStrList(size_t length, char **items)¶
Free memory of a string list created by
PyInitConfig_GetStrList().
Set Options¶
The configuration option name parameter must be a non-NULL null-terminated UTF-8 encoded string. See Configuration Options.
Some configuration options have side effects on other options. This logic is
only implemented when Py_InitializeFromInitConfig() is called, not by the
“Set” functions below. For example, setting dev_mode to 1 does not set
faulthandler to 1.
-
int PyInitConfig_SetInt(PyInitConfig *config, const char *name, int64_t value)¶
Set an integer configuration option.
Return
0on success.Set an error in config and return
-1on error.
-
int PyInitConfig_SetStr(PyInitConfig *config, const char *name, const char *value)¶
Set a string configuration option from a null-terminated UTF-8 encoded string. The string is copied.
Return
0on success.Set an error in config and return
-1on error.
-
int PyInitConfig_SetStrList(PyInitConfig *config, const char *name, size_t length, char *const *items)¶
Set a string list configuration option from an array of null-terminated UTF-8 encoded strings. The string list is copied.
Return
0on success.Set an error in config and return
-1on error.
Module¶
-
int PyInitConfig_AddModule(PyInitConfig *config, const char *name, PyObject *(*initfunc)(void))¶
Add a built-in extension module to the table of built-in modules.
The new module can be imported by the name name, and uses the function initfunc as the initialization function called on the first attempted import.
Return
0on success.Set an error in config and return
-1on error.
If Python is initialized multiple times,
PyInitConfig_AddModule()must be called at each Python initialization.Similar to the
PyImport_AppendInittab()function.
Initialize Python¶
-
int Py_InitializeFromInitConfig(PyInitConfig *config)¶
Initialize Python from the initialization configuration.
Return
0on success.Set an error in config and return
-1on error.Set an exit code in config and return
-1if Python wants to exit.
See
PyInitConfig_GetExitcode()for the exit code case.
Configuration Options¶
Option |
PyConfig/PyPreConfig member |
Type |
Visibility |
|---|---|---|---|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Read-only |
|
|
|
Public |
|
|
|
Public |
|
|
|
Public |
|
|
|
Read-only |
Visibility:
Public: Can by get by
PyConfig_Get()and set byPyConfig_Set().Read-only: Can by get by
PyConfig_Get(), but cannot be set byPyConfig_Set().
Runtime Python configuration API¶
At runtime, it’s possible to get and set configuration options using
PyConfig_Get() and PyConfig_Set() functions.
The configuration option name parameter must be a non-NULL null-terminated UTF-8 encoded string. See Configuration Options.
Some options are read from the sys attributes. For example, the option
"argv" is read from sys.argv.
-
PyObject *PyConfig_Get(const char *name)¶
Get the current runtime value of a configuration option as a Python object.
Return a new reference on success.
Set an exception and return
NULLon error.
The object type depends on the configuration option. It can be:
boolintstrlist[str]dict[str, str]
The caller must have an attached thread state. The function cannot be called before Python initialization nor after Python finalization.
Added in version 3.14.
-
int PyConfig_GetInt(const char *name, int *value)¶
Similar to
PyConfig_Get(), but get the value as a C int.Return
0on success.Set an exception and return
-1on error.
Added in version 3.14.
-
PyObject *PyConfig_Names(void)¶
Get all configuration option names as a
frozenset.Return a new reference on success.
Set an exception and return
NULLon error.
The caller must have an attached thread state. The function cannot be called before Python initialization nor after Python finalization.
Added in version 3.14.
-
int PyConfig_Set(const char *name, PyObject *value)¶
Set the current runtime value of a configuration option.
Raise a
ValueErrorif there is no option name.Raise a
ValueErrorif value is an invalid value.Raise a
ValueErrorif the option is read-only (cannot be set).Raise a
TypeErrorif value has not the proper type.
The caller must have an attached thread state. The function cannot be called before Python initialization nor after Python finalization.
Raises an auditing event
cpython.PyConfig_Setwith argumentsname,value.Added in version 3.14.
PyConfig C API¶
Added in version 3.8.
Python can be initialized with Py_InitializeFromConfig() and the
PyConfig structure. It can be preinitialized with
Py_PreInitialize() and the PyPreConfig structure.
There are two kinds of configuration:
The Python Configuration can be used to build a customized Python which behaves as the regular Python. For example, environment variables and command line arguments are used to configure Python.
The Isolated Configuration can be used to embed Python into an application. It isolates Python from the system. For example, environment variables are ignored, the LC_CTYPE locale is left unchanged and no signal handler is registered.
The Py_RunMain() function can be used to write a customized Python
program.
See also Initialization, Finalization, and Threads.
See also
PEP 587 “Python Initialization Configuration”.
Example¶
Example of customized Python always running in isolated mode:
int main(int argc, char **argv)
{
PyStatus status;
PyConfig config;
PyConfig_InitPythonConfig(&config);
config.isolated = 1;
/* Decode command line arguments.
Implicitly preinitialize Python (in isolated mode). */
status = PyConfig_SetBytesArgv(&config, argc, argv);
if (PyStatus_Exception(status)) {
goto exception;
}
status = Py_InitializeFromConfig(&config);
if (PyStatus_Exception(status)) {
goto exception;
}
PyConfig_Clear(&config);
return Py_RunMain();
exception:
PyConfig_Clear(&config);
if (PyStatus_IsExit(status)) {
return status.exitcode;
}
/* Display the error message and exit the process with
non-zero exit code */
Py_ExitStatusException(status);
}
PyWideStringList¶
-
type PyWideStringList¶
List of
wchar_t*strings.If length is non-zero, items must be non-
NULLand all strings must be non-NULL.Methods:
-
PyStatus PyWideStringList_Append(PyWideStringList *list, const wchar_t *item)¶
Append item to list.
Python must be preinitialized to call this function.
-
PyStatus PyWideStringList_Insert(PyWideStringList *list, Py_ssize_t index, const wchar_t *item)¶
Insert item into list at index.
If index is greater than or equal to list length, append item to list.
index must be greater than or equal to
0.Python must be preinitialized to call this function.
Structure fields:
-
Py_ssize_t length¶
List length.
-
wchar_t **items¶
List items.
-
PyStatus PyWideStringList_Append(PyWideStringList *list, const wchar_t *item)¶
PyStatus¶
-
type PyStatus¶
Structure to store an initialization function status: success, error or exit.
For an error, it can store the C function name which created the error.
Structure fields:
-
int exitcode¶
Exit code. Argument passed to
exit().
-
const char *err_msg¶
Error message.
-
const char *func¶
Name of the function which created an error, can be
NULL.
Functions to create a status:
-
PyStatus PyStatus_Error(const char *err_msg)¶
Initialization error with a message.
err_msg must not be
NULL.
Functions to handle a status:
-
int PyStatus_Exception(PyStatus status)¶
Is the status an error or an exit? If true, the exception must be handled; by calling
Py_ExitStatusException()for example.
-
int exitcode¶
Note
Internally, Python uses macros which set PyStatus.func,
whereas functions to create a status set func to NULL.
Example:
PyStatus alloc(void **ptr, size_t size)
{
*ptr = PyMem_RawMalloc(size);
if (*ptr == NULL) {
return PyStatus_NoMemory();
}
return PyStatus_Ok();
}
int main(int argc, char **argv)
{
void *ptr;
PyStatus status = alloc(&ptr, 16);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
}
PyMem_Free(ptr);
return 0;
}
PyPreConfig¶
-
type PyPreConfig¶
Structure used to preinitialize Python.
Function to initialize a preconfiguration:
-
void PyPreConfig_InitPythonConfig(PyPreConfig *preconfig)¶
Initialize the preconfiguration with Python Configuration.
-
void PyPreConfig_InitIsolatedConfig(PyPreConfig *preconfig)¶
Initialize the preconfiguration with Isolated Configuration.
Structure fields:
-
int allocator¶
Name of the Python memory allocators:
PYMEM_ALLOCATOR_NOT_SET(0): don’t change memory allocators (use defaults).PYMEM_ALLOCATOR_DEFAULT(1): default memory allocators.PYMEM_ALLOCATOR_DEBUG(2): default memory allocators with debug hooks.PYMEM_ALLOCATOR_MALLOC(3): usemalloc()of the C library.PYMEM_ALLOCATOR_MALLOC_DEBUG(4): force usage ofmalloc()with debug hooks.PYMEM_ALLOCATOR_PYMALLOC(5): Python pymalloc memory allocator.PYMEM_ALLOCATOR_PYMALLOC_DEBUG(6): Python pymalloc memory allocator with debug hooks.PYMEM_ALLOCATOR_MIMALLOC(6): usemimalloc, a fast malloc replacement.PYMEM_ALLOCATOR_MIMALLOC_DEBUG(7): usemimalloc, a fast malloc replacement with debug hooks.
PYMEM_ALLOCATOR_PYMALLOCandPYMEM_ALLOCATOR_PYMALLOC_DEBUGare not supported if Python isconfigured using --without-pymalloc.PYMEM_ALLOCATOR_MIMALLOCandPYMEM_ALLOCATOR_MIMALLOC_DEBUGare not supported if Python isconfigured using --without-mimallocor if the underlying atomic support isn’t available.See Memory Management.
Default:
PYMEM_ALLOCATOR_NOT_SET.
-
int configure_locale¶
Set the LC_CTYPE locale to the user preferred locale.
If equals to
0, setcoerce_c_localeandcoerce_c_locale_warnmembers to0.See the locale encoding.
Default:
1in Python config,0in isolated config.
-
int coerce_c_locale¶
If equals to
2, coerce the C locale.If equals to
1, read the LC_CTYPE locale to decide if it should be coerced.See the locale encoding.
Default:
-1in Python config,0in isolated config.
-
int coerce_c_locale_warn¶
If non-zero, emit a warning if the C locale is coerced.
Default:
-1in Python config,0in isolated config.
-
int dev_mode¶
Python Development Mode: see
PyConfig.dev_mode.Default:
-1in Python mode,0in isolated mode.
-
int isolated¶
Isolated mode: see
PyConfig.isolated.Default:
0in Python mode,1in isolated mode.
-
int legacy_windows_fs_encoding¶
If non-zero:
Set
PyPreConfig.utf8_modeto0,Set
PyConfig.filesystem_encodingto"mbcs",Set
PyConfig.filesystem_errorsto"replace".
Initialized from the
PYTHONLEGACYWINDOWSFSENCODINGenvironment variable value.Only available on Windows.
#ifdef MS_WINDOWSmacro can be used for Windows specific code.Default:
0.
-
int parse_argv¶
If non-zero,
Py_PreInitializeFromArgs()andPy_PreInitializeFromBytesArgs()parse theirargvargument the same way the regular Python parses command line arguments: see Command Line Arguments.Default:
1in Python config,0in isolated config.
-
int use_environment¶
Use environment variables? See
PyConfig.use_environment.Default:
1in Python config and0in isolated config.
-
int utf8_mode¶
If non-zero, enable the Python UTF-8 Mode.
Set to
0or1by the-X utf8command line option and thePYTHONUTF8environment variable.Also set to
1if theLC_CTYPElocale isCorPOSIX.Default:
-1in Python config and0in isolated config.
-
void PyPreConfig_InitPythonConfig(PyPreConfig *preconfig)¶
Preinitialize Python with PyPreConfig¶
The preinitialization of Python:
Set the Python memory allocators (
PyPreConfig.allocator)Configure the LC_CTYPE locale (locale encoding)
Set the Python UTF-8 Mode (
PyPreConfig.utf8_mode)
The current preconfiguration (PyPreConfig type) is stored in
_PyRuntime.preconfig.
Functions to preinitialize Python:
-
PyStatus Py_PreInitialize(const PyPreConfig *preconfig)¶
Preinitialize Python from preconfig preconfiguration.
preconfig must not be
NULL.
-
PyStatus Py_PreInitializeFromBytesArgs(const PyPreConfig *preconfig, int argc, char *const *argv)¶
Preinitialize Python from preconfig preconfiguration.
Parse argv command line arguments (bytes strings) if
parse_argvof preconfig is non-zero.preconfig must not be
NULL.
-
PyStatus Py_PreInitializeFromArgs(const PyPreConfig *preconfig, int argc, wchar_t *const *argv)¶
Preinitialize Python from preconfig preconfiguration.
Parse argv command line arguments (wide strings) if
parse_argvof preconfig is non-zero.preconfig must not be
NULL.
The caller is responsible to handle exceptions (error or exit) using
PyStatus_Exception() and Py_ExitStatusException().
For Python Configuration
(PyPreConfig_InitPythonConfig()), if Python is initialized with
command line arguments, the command line arguments must also be passed to
preinitialize Python, since they have an effect on the pre-configuration
like encodings. For example, the -X utf8 command line option
enables the Python UTF-8 Mode.
PyMem_SetAllocator() can be called after Py_PreInitialize() and
before Py_InitializeFromConfig() to install a custom memory allocator.
It can be called before Py_PreInitialize() if
PyPreConfig.allocator is set to PYMEM_ALLOCATOR_NOT_SET.
Python memory allocation functions like PyMem_RawMalloc() must not be
used before the Python preinitialization, whereas calling directly malloc()
and free() is always safe. Py_DecodeLocale() must not be called
before the Python preinitialization.
Example using the preinitialization to enable the Python UTF-8 Mode:
PyStatus status;
PyPreConfig preconfig;
PyPreConfig_InitPythonConfig(&preconfig);
preconfig.utf8_mode = 1;
status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
}
/* at this point, Python speaks UTF-8 */
Py_Initialize();
/* ... use Python API here ... */
Py_Finalize();
PyConfig¶
-
type PyConfig¶
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.Preinitialize Python if needed.
-
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.Preinitialize Python if needed.
-
PyStatus PyConfig_SetArgv(PyConfig *config, int argc, wchar_t *const *argv)¶
Set command line arguments (
argvmember of config) from the argv list of wide character strings.Preinitialize Python if needed.
-
PyStatus PyConfig_SetBytesArgv(PyConfig *config, int argc, char *const *argv)¶
Set command line arguments (
argvmember of config) from the argv list of bytes strings. Decode bytes usingPy_DecodeLocale().Preinitialize Python if needed.
-
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.
Preinitialize Python if needed.
-
PyStatus PyConfig_Read(PyConfig *config)¶
Read all Python configuration.
Fields which are already initialized are left unchanged.
Fields for path configuration are no longer calculated or modified when calling this function, as of Python 3.11.
The
PyConfig_Read()function only parsesPyConfig.argvarguments once:PyConfig.parse_argvis set to2after arguments are parsed. Since Python arguments are stripped fromPyConfig.argv, parsing arguments twice would parse the application options as Python options.Preinitialize Python if needed.
Changed in version 3.10: The
PyConfig.argvarguments are now only parsed once,PyConfig.parse_argvis set to2after arguments are parsed, and arguments are only parsed ifPyConfig.parse_argvequals1.Changed in version 3.11:
PyConfig_Read()no longer calculates all paths, and so fields listed under Python Path Configuration may no longer be updated untilPy_InitializeFromConfig()is called.
Most
PyConfigmethods preinitialize Python if needed. In that case, the Python preinitialization configuration (PyPreConfig) in based on thePyConfig. If configuration fields which are in common withPyPreConfigare tuned, they must be set before calling aPyConfigmethod:Moreover, if
PyConfig_SetArgv()orPyConfig_SetBytesArgv()is used, this method must be called before other methods, since the preinitialization configuration depends on command line arguments (ifparse_argvis non-zero).The caller of these methods is responsible to handle exceptions (error or exit) using
PyStatus_Exception()andPy_ExitStatusException().Structure fields:
-
PyWideStringList argv¶
Set
sys.argvcommand line arguments based onargv. These parameters are similar to those passed to the program’smain()function with the difference that the first entry should refer to the script file to be executed rather than the executable hosting the Python interpreter. If there isn’t a script that will be run, the first entry inargvcan be an empty string.Set
parse_argvto1to parseargvthe same way the regular Python parses Python command line arguments and then to strip Python arguments fromargv.If
argvis empty, an empty string is added to ensure thatsys.argvalways exists and is never empty.Default:
NULL.See also the
orig_argvmember.
-
int safe_path¶
If equals to zero,
Py_RunMain()prepends a potentially unsafe path tosys.pathat startup:If
argv[0]is equal toL"-m"(python -m module), prepend the current working directory.If running a script (
python script.py), prepend the script’s directory. If it’s a symbolic link, resolve symbolic links.Otherwise (
python -c codeandpython), prepend an empty string, which means the current working directory.
Set to
1by the-Pcommand line option and thePYTHONSAFEPATHenvironment variable.Default:
0in Python config,1in isolated config.Added in version 3.11.
-
wchar_t *base_exec_prefix¶
-
Default:
NULL.Part of the Python Path Configuration output.
See also
PyConfig.exec_prefix.
-
wchar_t *base_executable¶
Python base executable:
sys._base_executable.Set by the
__PYVENV_LAUNCHER__environment variable.Set from
PyConfig.executableifNULL.Default:
NULL.Part of the Python Path Configuration output.
See also
PyConfig.executable.
-
wchar_t *base_prefix¶
-
Default:
NULL.Part of the Python Path Configuration output.
See also
PyConfig.prefix.
-
int buffered_stdio¶
If equals to
0andconfigure_c_stdiois non-zero, disable buffering on the C streams stdout and stderr.Set to
0by the-ucommand line option and thePYTHONUNBUFFEREDenvironment variable.stdin is always opened in buffered mode.
Default:
1.
-
int bytes_warning¶
If equals to
1, issue a warning when comparingbytesorbytearraywithstr, or comparingbyteswithint.If equal or greater to
2, raise aBytesWarningexception in these cases.Incremented by the
-bcommand line option.Default:
0.
-
int warn_default_encoding¶
If non-zero, emit a
EncodingWarningwarning whenio.TextIOWrapperuses its default encoding. See Opt-in EncodingWarning for details.Default:
0.Added in version 3.10.
-
int code_debug_ranges¶
If equals to
0, disables the inclusion of the end line and column mappings in code objects. Also disables traceback printing carets to specific error locations.Set to
0by thePYTHONNODEBUGRANGESenvironment variable and by the-X no_debug_rangescommand line option.Default:
1.Added in version 3.11.
-
wchar_t *check_hash_pycs_mode¶
Control the validation behavior of hash-based
.pycfiles: value of the--check-hash-based-pycscommand 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_stdioequals zero, disable buffering of stdin, stdout and stderr streams.If
interactiveis non-zero, enable stream buffering on stdin and stdout (only stdout on Windows).
Default:
1in Python config,0in isolated config.
-
int dev_mode¶
If non-zero, enable the Python Development Mode.
Set to
1by the-X devoption and thePYTHONDEVMODEenvironment variable.Default:
-1in Python mode,0in isolated mode.
-
int dump_refs¶
Dump Python references?
If non-zero, dump all objects which are still alive at exit.
Set to
1by thePYTHONDUMPREFSenvironment variable.Needs a special build of Python with the
Py_TRACE_REFSmacro defined: see theconfigure --with-trace-refs option.Default:
0.
-
wchar_t *dump_refs_file¶
Filename where to dump Python references.
Set by the
PYTHONDUMPREFSFILEenvironment variable.Default:
NULL.Added in version 3.11.
-
wchar_t *exec_prefix¶
The site-specific directory prefix where the platform-dependent Python files are installed:
sys.exec_prefix.Default:
NULL.Part of the Python Path Configuration output.
See also
PyConfig.base_exec_prefix.
-
wchar_t *executable¶
The absolute path of the executable binary for the Python interpreter:
sys.executable.Default:
NULL.Part of the Python Path Configuration output.
See also
PyConfig.base_executable.
-
int faulthandler¶
Enable faulthandler?
If non-zero, call
faulthandler.enable()at startup.Set to
1by-X faulthandlerand thePYTHONFAULTHANDLERenvironment variable.Default:
-1in Python mode,0in isolated mode.
-
wchar_t *filesystem_encoding¶
Filesystem encoding:
sys.getfilesystemencoding().On macOS, Android and VxWorks: use
"utf-8"by default.On Windows: use
"utf-8"by default, or"mbcs"iflegacy_windows_fs_encodingofPyPreConfigis non-zero.Default encoding on other platforms:
"utf-8"ifPyPreConfig.utf8_modeis non-zero."ascii"if Python detects thatnl_langinfo(CODESET)announces the ASCII encoding, whereas thembstowcs()function decodes from a different encoding (usually Latin1)."utf-8"ifnl_langinfo(CODESET)returns an empty string.Otherwise, use the locale encoding:
nl_langinfo(CODESET)result.
At Python startup, the encoding name is normalized to the Python codec name. For example,
"ANSI_X3.4-1968"is replaced with"ascii".See also the
filesystem_errorsmember.
-
wchar_t *filesystem_errors¶
Filesystem error handler:
sys.getfilesystemencodeerrors().On Windows: use
"surrogatepass"by default, or"replace"iflegacy_windows_fs_encodingofPyPreConfigis 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_encodingmember.
-
int use_frozen_modules¶
If non-zero, use frozen modules.
Set by the
PYTHON_FROZEN_MODULESenvironment variable.Default:
1in a release build, or0in a debug build.
-
unsigned long hash_seed¶
-
int use_hash_seed¶
Randomized hash function seed.
If
use_hash_seedis zero, a seed is chosen randomly at Python startup, andhash_seedis ignored.Set by the
PYTHONHASHSEEDenvironment variable.Default use_hash_seed value:
-1in Python mode,0in isolated mode.
-
wchar_t *home¶
Set the default Python “home” directory, that is, the location of the standard Python libraries (see
PYTHONHOME).Set by the
PYTHONHOMEenvironment variable.Default:
NULL.Part of the Python Path Configuration input.
-
int import_time¶
If
1, profile import time. If2, include additional output that indicates when an imported module has already been loaded.Set by the
-X importtimeoption and thePYTHONPROFILEIMPORTTIMEenvironment variable.Default:
0.Changed in version 3.14: Added support for
import_time = 2
-
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 whensys.stdindoes not appear to be a terminal.Incremented by the
-icommand line option. Set to1if thePYTHONINSPECTenvironment variable is non-empty.Default:
0.
-
int install_signal_handlers¶
Install Python signal handlers?
Default:
1in Python mode,0in isolated mode.
-
int interactive¶
If greater than
0, enable the interactive mode (REPL).Incremented by the
-icommand line option.Default:
0.
-
int int_max_str_digits¶
Configures the integer string conversion length limitation. An initial value of
-1means the value will be taken from the command line or environment or otherwise default to 4300 (sys.int_info.default_max_str_digits). A value of0disables the limitation. Values greater than zero but less than 640 (sys.int_info.str_digits_check_threshold) are unsupported and will produce an error.Configured by the
-X int_max_str_digitscommand line flag or thePYTHONINTMAXSTRDIGITSenvironment variable.Default:
-1in Python mode. 4300 (sys.int_info.default_max_str_digits) in isolated mode.Added in version 3.12.
- int cpu_count
-
void PyConfig_InitPythonConfig(PyConfig *config)¶