bpo-38304: Remove PyConfig.struct_size (GH-16500)
For now, we'll rely on the fact that the config structures aren't covered by the stable ABI.
We may revisit this in the future if we further explore the idea of offering a stable embedding API.
diff --git a/Python/frozenmain.c b/Python/frozenmain.c
index 76309e9..c56938a 100644
--- a/Python/frozenmain.c
+++ b/Python/frozenmain.c
@@ -40,7 +40,6 @@
}
PyConfig config;
- config.struct_size = sizeof(PyConfig);
status = PyConfig_InitPythonConfig(&config);
if (PyStatus_Exception(status)) {
PyConfig_Clear(&config);
diff --git a/Python/initconfig.c b/Python/initconfig.c
index fb04b4a..9164c7c 100644
--- a/Python/initconfig.c
+++ b/Python/initconfig.c
@@ -529,17 +529,6 @@
: _PyStatus_NO_MEMORY())
-static PyStatus
-config_check_struct_size(const PyConfig *config)
-{
- if (config->struct_size != sizeof(PyConfig)) {
- return _PyStatus_ERR("unsupported PyConfig structure size "
- "(Python version mismatch?)");
- }
- return _PyStatus_OK();
-}
-
-
/* Free memory allocated in config, but don't clear all attributes */
void
PyConfig_Clear(PyConfig *config)
@@ -583,15 +572,7 @@
PyStatus
_PyConfig_InitCompatConfig(PyConfig *config)
{
- size_t struct_size = config->struct_size;
memset(config, 0, sizeof(*config));
- config->struct_size = struct_size;
-
- PyStatus status = config_check_struct_size(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
config->_config_init = (int)_PyConfig_INIT_COMPAT;
config->isolated = -1;
@@ -775,18 +756,6 @@
{
PyStatus status;
- status = config_check_struct_size(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
-
- status = config_check_struct_size(config2);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
-
PyConfig_Clear(config);
#define COPY_ATTR(ATTR) config->ATTR = config2->ATTR
@@ -2275,7 +2244,6 @@
}
PyPreConfig preconfig;
- preconfig.struct_size = sizeof(PyPreConfig);
status = _PyPreConfig_InitFromPreConfig(&preconfig, &_PyRuntime.preconfig);
if (_PyStatus_EXCEPTION(status)) {
@@ -2428,12 +2396,6 @@
PyStatus status;
PyWideStringList orig_argv = _PyWideStringList_INIT;
- status = config_check_struct_size(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
-
status = _Py_PreInitializeFromConfig(config, NULL);
if (_PyStatus_EXCEPTION(status)) {
return status;
diff --git a/Python/pathconfig.c b/Python/pathconfig.c
index 41ef7d2..ff4bbf2 100644
--- a/Python/pathconfig.c
+++ b/Python/pathconfig.c
@@ -434,7 +434,6 @@
{
PyStatus status;
PyConfig config;
- config.struct_size = sizeof(PyConfig);
status = _PyConfig_InitCompatConfig(&config);
if (_PyStatus_EXCEPTION(status)) {
diff --git a/Python/preconfig.c b/Python/preconfig.c
index 01c72f5..89a6227 100644
--- a/Python/preconfig.c
+++ b/Python/preconfig.c
@@ -269,29 +269,10 @@
/* --- PyPreConfig ----------------------------------------------- */
-static PyStatus
-preconfig_check_struct_size(PyPreConfig *config)
-{
- if (config->struct_size != sizeof(PyPreConfig)) {
- return _PyStatus_ERR("unsupported PyPreConfig structure size "
- "(Python version mismatch?)");
- }
- return _PyStatus_OK();
-}
-
-
-PyStatus
+void
_PyPreConfig_InitCompatConfig(PyPreConfig *config)
{
- size_t struct_size = config->struct_size;
memset(config, 0, sizeof(*config));
- config->struct_size = struct_size;
-
- PyStatus status = preconfig_check_struct_size(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
config->_config_init = (int)_PyConfig_INIT_COMPAT;
config->parse_argv = 0;
@@ -313,18 +294,13 @@
#ifdef MS_WINDOWS
config->legacy_windows_fs_encoding = -1;
#endif
- return _PyStatus_OK();
}
-PyStatus
+void
PyPreConfig_InitPythonConfig(PyPreConfig *config)
{
- PyStatus status = _PyPreConfig_InitCompatConfig(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
+ _PyPreConfig_InitCompatConfig(config);
config->_config_init = (int)_PyConfig_INIT_PYTHON;
config->isolated = 0;
@@ -339,18 +315,13 @@
#ifdef MS_WINDOWS
config->legacy_windows_fs_encoding = 0;
#endif
- return _PyStatus_OK();
}
-PyStatus
+void
PyPreConfig_InitIsolatedConfig(PyPreConfig *config)
{
- PyStatus status = _PyPreConfig_InitCompatConfig(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
+ _PyPreConfig_InitCompatConfig(config);
config->_config_init = (int)_PyConfig_INIT_ISOLATED;
config->configure_locale = 0;
@@ -361,7 +332,6 @@
#ifdef MS_WINDOWS
config->legacy_windows_fs_encoding = 0;
#endif
- return _PyStatus_OK();
}
@@ -369,47 +339,35 @@
_PyPreConfig_InitFromPreConfig(PyPreConfig *config,
const PyPreConfig *config2)
{
- PyStatus status = PyPreConfig_InitPythonConfig(config);
- if (_PyStatus_EXCEPTION(status)) {
- return status;
- }
-
+ PyPreConfig_InitPythonConfig(config);
preconfig_copy(config, config2);
return _PyStatus_OK();
}
-PyStatus
+void
_PyPreConfig_InitFromConfig(PyPreConfig *preconfig, const PyConfig *config)
{
- PyStatus status;
_PyConfigInitEnum config_init = (_PyConfigInitEnum)config->_config_init;
switch (config_init) {
case _PyConfig_INIT_PYTHON:
- status = PyPreConfig_InitPythonConfig(preconfig);
+ PyPreConfig_InitPythonConfig(preconfig);
break;
case _PyConfig_INIT_ISOLATED:
- status = PyPreConfig_InitIsolatedConfig(preconfig);
+ PyPreConfig_InitIsolatedConfig(preconfig);
break;
case _PyConfig_INIT_COMPAT:
default:
- status = _PyPreConfig_InitCompatConfig(preconfig);
- }
-
- if (_PyStatus_EXCEPTION(status)) {
- return status;
+ _PyPreConfig_InitCompatConfig(preconfig);
}
_PyPreConfig_GetConfig(preconfig, config);
- return _PyStatus_OK();
}
static void
preconfig_copy(PyPreConfig *config, const PyPreConfig *config2)
{
- assert(config->struct_size == sizeof(PyPreConfig));
-
#define COPY_ATTR(ATTR) config->ATTR = config2->ATTR
COPY_ATTR(_config_init);
@@ -829,12 +787,6 @@
return status;
}
- status = preconfig_check_struct_size(config);
- if (_PyStatus_EXCEPTION(status)) {
- _PyStatus_UPDATE_FUNC(status);
- return status;
- }
-
preconfig_get_global_vars(config);
/* Copy LC_CTYPE locale, since it's modified later */
@@ -849,7 +801,6 @@
/* Save the config to be able to restore it if encodings change */
PyPreConfig save_config;
- save_config.struct_size = sizeof(PyPreConfig);
status = _PyPreConfig_InitFromPreConfig(&save_config, config);
if (_PyStatus_EXCEPTION(status)) {
@@ -976,7 +927,6 @@
_PyPreConfig_Write(const PyPreConfig *src_config)
{
PyPreConfig config;
- config.struct_size = sizeof(PyPreConfig);
PyStatus status = _PyPreConfig_InitFromPreConfig(&config, src_config);
if (_PyStatus_EXCEPTION(status)) {
diff --git a/Python/pylifecycle.c b/Python/pylifecycle.c
index c154d06..5174f74 100644
--- a/Python/pylifecycle.c
+++ b/Python/pylifecycle.c
@@ -731,7 +731,6 @@
runtime->preinitializing = 1;
PyPreConfig config;
- config.struct_size = sizeof(PyPreConfig);
status = _PyPreConfig_InitFromPreConfig(&config, src_config);
if (_PyStatus_EXCEPTION(status)) {
@@ -795,12 +794,8 @@
}
PyPreConfig preconfig;
- preconfig.struct_size = sizeof(PyPreConfig);
- status = _PyPreConfig_InitFromConfig(&preconfig, config);
- if (_PyStatus_EXCEPTION(status)) {
- return status;
- }
+ _PyPreConfig_InitFromConfig(&preconfig, config);
if (!config->parse_argv) {
return Py_PreInitialize(&preconfig);
@@ -848,7 +843,6 @@
}
PyConfig config;
- config.struct_size = sizeof(PyConfig);
status = _PyConfig_InitCompatConfig(&config);
if (_PyStatus_EXCEPTION(status)) {
@@ -1076,7 +1070,6 @@
}
PyConfig config;
- config.struct_size = sizeof(PyConfig);
status = _PyConfig_InitCompatConfig(&config);
if (_PyStatus_EXCEPTION(status)) {
diff --git a/Python/pystate.c b/Python/pystate.c
index f0662fa..098280d 100644
--- a/Python/pystate.c
+++ b/Python/pystate.c
@@ -61,11 +61,7 @@
_PyGC_Initialize(&runtime->gc);
_PyEval_Initialize(&runtime->ceval);
- runtime->preconfig.struct_size = sizeof(PyPreConfig);
- PyStatus status = PyPreConfig_InitPythonConfig(&runtime->preconfig);
- if (_PyStatus_EXCEPTION(status)) {
- return status;
- }
+ PyPreConfig_InitPythonConfig(&runtime->preconfig);
runtime->gilstate.check_enabled = 1;
@@ -210,7 +206,6 @@
interp->id_refcount = -1;
interp->check_interval = 100;
- interp->config.struct_size = sizeof(PyConfig);
PyStatus status = PyConfig_InitPythonConfig(&interp->config);
if (_PyStatus_EXCEPTION(status)) {
/* Don't report status to caller: PyConfig_InitPythonConfig()