Skip to content

gh-102567: Add -X importtime=2 for logging an importtime message for already-loaded modules #133443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AA-Turner wants to merge 6 commits into from
Closed

gh-102567: Add -X importtime=2 for logging an importtime message for already-loaded modules #133443

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dcd6010
Add -X importtime=2 for logging an importtime message for already-loa…
noahbkim May 6, 2024
673008c
Print importtime header before first cached import
AA-Turner May 3, 2025
65eadf0
_pyrepl style changes
AA-Turner May 3, 2025
43c12ec
Simplify config->import_time initialisation
AA-Turner May 3, 2025
414e61d
Update tests, add a few more cases
AA-Turner May 3, 2025
581cd70
Documentation
AA-Turner May 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Simplify config->import_time initialisation
  • Loading branch information
@AA-Turner
AA-Turner committed May 5, 2025
commit 43c12ec2b981936e1f17049c29de9b74f4d725fd
81 changes: 29 additions & 52 deletions Python/initconfig.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1005,6 +1005,7 @@ _PyConfig_InitCompatConfig(PyConfig *config)
memset(config, 0, sizeof(*config));

config->_config_init = (int)_PyConfig_INIT_COMPAT;
config->import_time = -1;
config->isolated = -1;
config->use_environment = -1;
config->dev_mode = -1;
Expand Down Expand Up @@ -2247,61 +2248,36 @@ config_init_run_presite(PyConfig *config)
}
#endif

/* Set `config->import_time` based on `value` from `-Ximporttime(=.*)?`. */
static PyStatus
config_set_import_time(PyConfig *config, const wchar_t *value)
config_init_import_time(PyConfig *config)
{
int numeric_value;
int importtime = 0;

// If no value is specified or the value is not an integer, use 1.
if (*value == 0 || config_wstr_to_int(value, &numeric_value) != 0) {
config->import_time = 1;
}

/* -Ximporttime=1 incurs the default behavior. -Ximporttime=2 also
* prints import cache hits. All other numeric values are reserved.
*/
else if (0 <= numeric_value && numeric_value <= 2) {
config->import_time = numeric_value;
}

else {
return _PyStatus_ERR(
"-X importtime: numeric values other than 1 or 2 are "
"reserved for future use");
}

return _PyStatus_OK();
}

/* Configure `config->import_time` by checking -Ximporttime then the
* PYTHONPROFILEIMPORTTIME environment variable. Defaults to 0.
*/
static PyStatus
config_read_import_time(PyConfig *config)
{
/* Check the -X option first. */
const wchar_t *xoption_value = NULL;
xoption_value = config_get_xoption_value(config, L"importtime");
if (xoption_value != NULL) {
return config_set_import_time(config, xoption_value);
const char *env = config_get_env(config, "PYTHONPROFILEIMPORTTIME");
if (env) {
if (_Py_str_to_int(env, &importtime) != 0) {
importtime = 1;
}
if (importtime < 0 || importtime > 2) {
return _PyStatus_ERR(
"PYTHONPROFILEIMPORTTIME: numeric values other than 1 and 2 "
"are reserved for future use.");
}
}

/* If there's no -Ximporttime, look for ENV flag */
wchar_t *env_value = NULL;
/* `CONFIG_GET_ENV_DUP` requires dest to be initialized to `NULL`. */
PyStatus status = CONFIG_GET_ENV_DUP(config, &env_value,
L"PYTHONPROFILEIMPORTTIME",
"PYTHONPROFILEIMPORTTIME");
if (_PyStatus_EXCEPTION(status)) {
return status;
}
if (env_value != NULL) {
status = config_set_import_time(config, env_value);
PyMem_RawFree(env_value);
return status;
const wchar_t *x_value = config_get_xoption_value(config, L"importtime");
if (x_value) {
if (*x_value == 0 || config_wstr_to_int(x_value, &importtime) != 0) {
importtime = 1;
}
if (importtime < 0 || importtime > 2) {
return _PyStatus_ERR(
"-X importtime: values other than 1 and 2 "
"are reserved for future use.");
}
}

config->import_time = importtime;
return _PyStatus_OK();
}

Expand All @@ -2321,10 +2297,11 @@ config_read_complex_options(PyConfig *config)
}

PyStatus status;

status = config_read_import_time(config);
if (_PyStatus_EXCEPTION(status)) {
return status;
if (config->import_time < 0) {
status = config_init_import_time(config);
if (_PyStatus_EXCEPTION(status)) {
return status;
}
}

if (config->tracemalloc < 0) {
Expand Down