bpo-38304: Add PyConfig.struct_size (GH-16451) (GH-16453)
Add a new struct_size field to PyPreConfig and PyConfig structures to
allow to modify these structures in the future without breaking the
backward compatibility.
* Replace private _config_version field with public struct_size field
in PyPreConfig and PyConfig.
* Public PyPreConfig_InitIsolatedConfig() and
PyPreConfig_InitPythonConfig()
return type becomes PyStatus, instead of void.
* Internal _PyConfig_InitCompatConfig(),
_PyPreConfig_InitCompatConfig(), _PyPreConfig_InitFromConfig(),
_PyPreConfig_InitFromPreConfig() return type becomes PyStatus,
instead of void.
* Remove _Py_CONFIG_VERSION
* Update the Initialization Configuration documentation.
(cherry picked from commit 441b10cf2855955c86565f8d59e72c2efc0f0a57)
diff --git a/Programs/_testembed.c b/Programs/_testembed.c
index 83c266b..a375945 100644
--- a/Programs/_testembed.c
+++ b/Programs/_testembed.c
@@ -385,7 +385,12 @@
if (preinit) {
PyPreConfig preconfig;
- _PyPreConfig_InitCompatConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = _PyPreConfig_InitCompatConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) {
@@ -394,7 +399,13 @@
}
PyConfig config;
- _PyConfig_InitCompatConfig(&config);
+ config.struct_size = sizeof(PyConfig);
+
+ status = _PyConfig_InitCompatConfig(&config);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
+
config_set_program_name(&config);
init_from_config_clear(&config);
@@ -470,7 +481,12 @@
PyStatus status;
PyPreConfig preconfig;
- _PyPreConfig_InitCompatConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = _PyPreConfig_InitCompatConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
putenv("PYTHONMALLOC=malloc_debug");
preconfig.allocator = PYMEM_ALLOCATOR_MALLOC;
@@ -485,7 +501,12 @@
}
PyConfig config;
- _PyConfig_InitCompatConfig(&config);
+ config.struct_size = sizeof(PyConfig);
+
+ status = _PyConfig_InitCompatConfig(&config);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
config.install_signal_handlers = 0;
/* FIXME: test use_environment */
@@ -617,6 +638,8 @@
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -702,6 +725,8 @@
set_all_env_vars();
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -755,6 +780,8 @@
/* Test PyConfig.isolated=1 */
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -779,7 +806,13 @@
PyStatus status;
PyPreConfig preconfig;
- _PyPreConfig_InitCompatConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = _PyPreConfig_InitCompatConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
+
preconfig.isolated = 1;
status = Py_PreInitialize(&preconfig);
@@ -788,7 +821,12 @@
}
PyConfig config;
- _PyConfig_InitCompatConfig(&config);
+ config.struct_size = sizeof(PyConfig);
+
+ status = _PyConfig_InitCompatConfig(&config);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
config_set_program_name(&config);
set_all_env_vars();
init_from_config_clear(&config);
@@ -805,7 +843,13 @@
PyStatus status;
PyPreConfig preconfig;
- _PyPreConfig_InitCompatConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = _PyPreConfig_InitCompatConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
+
preconfig.isolated = 0;
status = Py_PreInitialize(&preconfig);
@@ -815,7 +859,11 @@
/* Test PyConfig.isolated=1 */
PyConfig config;
- _PyConfig_InitCompatConfig(&config);
+ config.struct_size = sizeof(PyConfig);
+ status = _PyConfig_InitCompatConfig(&config);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
Py_IsolatedFlag = 0;
config.isolated = 1;
@@ -835,7 +883,12 @@
PyStatus status;
PyPreConfig preconfig;
- PyPreConfig_InitIsolatedConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = PyPreConfig_InitIsolatedConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
preconfig.isolated = 0;
@@ -852,6 +905,7 @@
}
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
status = PyConfig_InitIsolatedConfig(&config);
if (PyStatus_Exception(status)) {
@@ -877,6 +931,7 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
@@ -934,7 +989,12 @@
if (preinit) {
PyPreConfig preconfig;
- PyPreConfig_InitIsolatedConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = PyPreConfig_InitIsolatedConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) {
@@ -947,6 +1007,8 @@
}
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitIsolatedConfig(&config);
if (PyStatus_Exception(status)) {
PyConfig_Clear(&config);
@@ -996,7 +1058,12 @@
if (preinit) {
PyPreConfig preconfig;
- PyPreConfig_InitPythonConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = PyPreConfig_InitPythonConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) {
@@ -1005,6 +1072,8 @@
}
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -1035,7 +1104,13 @@
PyStatus status;
PyPreConfig preconfig;
- PyPreConfig_InitPythonConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = PyPreConfig_InitPythonConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
+
preconfig.configure_locale = 0;
preconfig.coerce_c_locale = 1;
preconfig.coerce_c_locale_warn = 1;
@@ -1046,6 +1121,8 @@
}
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -1063,6 +1140,8 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -1286,6 +1365,8 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -1334,6 +1415,8 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -1382,6 +1465,8 @@
PySys_AddWarnOption(L"ignore:::sysadd_warnoption");
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
PyStatus status;
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
@@ -1450,7 +1535,12 @@
{
PyStatus status;
PyPreConfig preconfig;
- PyPreConfig_InitPythonConfig(&preconfig);
+ preconfig.struct_size = sizeof(PyPreConfig);
+
+ status = PyPreConfig_InitPythonConfig(&preconfig);
+ if (PyStatus_Exception(status)) {
+ Py_ExitStatusException(status);
+ }
/* Explicitly preinitializes with Python preconfiguration to avoid
Py_SetPath() implicit preinitialization with compat preconfiguration. */
@@ -1474,6 +1564,7 @@
putenv("TESTPATH=");
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
@@ -1531,6 +1622,8 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
+
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
Py_ExitStatusException(status);
@@ -1546,6 +1639,7 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
@@ -1577,6 +1671,7 @@
{
PyStatus status;
PyConfig config;
+ config.struct_size = sizeof(PyConfig);
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {