Skip to content
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

bpo-32030: Add _PyCoreConfig.module_search_path_env #4504

Merged
merged 1 commit into from
Nov 22, 2017
Merged

bpo-32030: Add _PyCoreConfig.module_search_path_env #4504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions Include/pylifecycle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ PyAPI_FUNC(wchar_t *) Py_GetProgramFullPath(void);
PyAPI_FUNC(wchar_t *) Py_GetPrefix(void);
PyAPI_FUNC(wchar_t *) Py_GetExecPrefix(void);
PyAPI_FUNC(wchar_t *) Py_GetPath(void);
#ifdef Py_BUILD_CORE
PyAPI_FUNC(wchar_t *) _Py_GetPathWithConfig(_PyCoreConfig *config);
#endif
PyAPI_FUNC(void) Py_SetPath(const wchar_t *);
#ifdef MS_WINDOWS
int _Py_CheckPython3();
Expand Down
9 changes: 7 additions & 2 deletions Include/pystate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ typedef struct {
unsigned long hash_seed;
int _disable_importlib; /* Needed by freeze_importlib */
const char *allocator; /* Memory allocator: _PyMem_SetupAllocators() */
wchar_t *module_search_path_env; /* PYTHONPATH environment variable */
int dev_mode; /* -X dev */
int faulthandler; /* -X faulthandler */
int tracemalloc; /* -X tracemalloc=N */
Expand All @@ -39,11 +40,13 @@ typedef struct {
} _PyCoreConfig;

#define _PyCoreConfig_INIT \
{.ignore_environment = 0, \
(_PyCoreConfig){\
.ignore_environment = 0, \
.use_hash_seed = -1, \
.hash_seed = 0, \
._disable_importlib = 0, \
.allocator = NULL, \
.module_search_path_env = NULL, \
.dev_mode = 0, \
.faulthandler = 0, \
.tracemalloc = 0, \
Expand All @@ -61,7 +64,9 @@ typedef struct {
int install_signal_handlers;
} _PyMainInterpreterConfig;

#define _PyMainInterpreterConfig_INIT {-1}
#define _PyMainInterpreterConfig_INIT \
(_PyMainInterpreterConfig){\
.install_signal_handlers = -1}

typedef struct _is {

Expand Down
61 changes: 43 additions & 18 deletions Modules/getpath.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,14 +456,12 @@ search_for_exec_prefix(wchar_t *argv0_path, wchar_t *home,
}

static void
calculate_path(void)
calculate_path(_PyCoreConfig *core_config)
{
extern wchar_t *Py_GetProgramName(void);

static const wchar_t delimiter[2] = {DELIM, '\0'};
static const wchar_t separator[2] = {SEP, '\0'};
char *_rtpypath = Py_GETENV("PYTHONPATH"); /* XXX use wide version on Windows */
wchar_t *rtpypath = NULL;
wchar_t *home = Py_GetPythonHome();
char *_path = getenv("PATH");
wchar_t *path_buffer = NULL;
Expand Down Expand Up @@ -707,11 +705,22 @@ calculate_path(void)
*/
bufsz = 0;

if (_rtpypath && _rtpypath[0] != '\0') {
size_t rtpypath_len;
rtpypath = Py_DecodeLocale(_rtpypath, &rtpypath_len);
if (rtpypath != NULL)
bufsz += rtpypath_len + 1;
wchar_t *env_path = NULL;
if (core_config) {
if (core_config->module_search_path_env) {
bufsz += wcslen(core_config->module_search_path_env) + 1;
}
}
else {
char *env_pathb = Py_GETENV("PYTHONPATH");
if (env_pathb && env_pathb[0] != '\0') {
size_t env_path_len;
env_path = Py_DecodeLocale(env_pathb, &env_path_len);
/* FIXME: handle decoding and memory error */
if (env_path != NULL) {
bufsz += env_path_len + 1;
}
}
}

defpath = _pythonpath;
Expand Down Expand Up @@ -742,12 +751,20 @@ calculate_path(void)
}

/* Run-time value of $PYTHONPATH goes first */
if (rtpypath) {
wcscpy(buf, rtpypath);
wcscat(buf, delimiter);
buf[0] = '\0';
if (core_config) {
if (core_config->module_search_path_env) {
wcscpy(buf, core_config->module_search_path_env);
wcscat(buf, delimiter);
}
}
else
buf[0] = '\0';
else {
if (env_path) {
wcscpy(buf, env_path);
wcscat(buf, delimiter);
}
}
PyMem_RawFree(env_path);

/* Next is the default zip path */
wcscat(buf, zip_path);
Expand Down Expand Up @@ -818,7 +835,6 @@ calculate_path(void)
PyMem_RawFree(_prefix);
PyMem_RawFree(_exec_prefix);
PyMem_RawFree(lib_python);
PyMem_RawFree(rtpypath);
}


Expand All @@ -841,35 +857,44 @@ Py_SetPath(const wchar_t *path)
}
}

wchar_t *
_Py_GetPathWithConfig(_PyCoreConfig *core_config)
{
if (!module_search_path) {
calculate_path(core_config);
}
return module_search_path;
}

wchar_t *
Py_GetPath(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return module_search_path;
}

wchar_t *
Py_GetPrefix(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return prefix;
}

wchar_t *
Py_GetExecPrefix(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return exec_prefix;
}

wchar_t *
Py_GetProgramFullPath(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return progpath;
}

Expand Down
74 changes: 63 additions & 11 deletions Modules/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,7 @@ typedef struct {
_PyInitError err;
/* PYTHONWARNINGS env var */
_Py_OptList env_warning_options;
/* PYTHONPATH env var */
int argc;
wchar_t **argv;
} _PyMain;
Expand Down Expand Up @@ -441,6 +442,8 @@ pymain_free_impl(_PyMain *pymain)
Py_CLEAR(pymain->main_importer_path);
PyMem_RawFree(pymain->program_name);

PyMem_RawFree(pymain->core_config.module_search_path_env);

#ifdef __INSURE__
/* Insure++ is a memory analysis tool that aids in discovering
* memory leaks and other memory problems. On Python exit, the
Expand Down Expand Up @@ -502,23 +505,30 @@ pymain_run_main_from_importer(_PyMain *pymain)


static wchar_t*
pymain_strdup(_PyMain *pymain, wchar_t *str)
pymain_wstrdup(_PyMain *pymain, wchar_t *str)
{
size_t len = wcslen(str) + 1; /* +1 for NUL character */
wchar_t *str2 = PyMem_RawMalloc(sizeof(wchar_t) * len);
if (len > (size_t)PY_SSIZE_T_MAX / sizeof(wchar_t)) {
pymain->err = INIT_NO_MEMORY();
return NULL;
}

size_t size = len * sizeof(wchar_t);
wchar_t *str2 = PyMem_RawMalloc(size);
if (str2 == NULL) {
pymain->err = INIT_NO_MEMORY();
return NULL;
}
memcpy(str2, str, len * sizeof(wchar_t));

memcpy(str2, str, size);
return str2;
}


static int
pymain_optlist_append(_PyMain *pymain, _Py_OptList *list, wchar_t *str)
{
wchar_t *str2 = pymain_strdup(pymain, str);
wchar_t *str2 = pymain_wstrdup(pymain, str);
if (str2 == NULL) {
return -1;
}
Expand Down Expand Up @@ -762,14 +772,12 @@ pymain_warnings_envvar(_PyMain *pymain)
wchar_t *wp;

if ((wp = _wgetenv(L"PYTHONWARNINGS")) && *wp != L'\0') {
wchar_t *buf, *warning, *context = NULL;
wchar_t *warning, *context = NULL;

buf = (wchar_t *)PyMem_RawMalloc((wcslen(wp) + 1) * sizeof(wchar_t));
wchar_t *buf = pymain_wstrdup(pymain, wp);
if (buf == NULL) {
pymain->err = INIT_NO_MEMORY();
return -1;
}
wcscpy(buf, wp);
for (warning = wcstok_s(buf, L",", &context);
warning != NULL;
warning = wcstok_s(NULL, L",", &context)) {
Expand Down Expand Up @@ -805,12 +813,11 @@ pymain_warnings_envvar(_PyMain *pymain)
if (len == (size_t)-2) {
pymain->err = _Py_INIT_ERR("failed to decode "
"PYTHONWARNINGS");
return -1;
}
else {
pymain->err = INIT_NO_MEMORY();
return -1;
}
return -1;
}
if (pymain_optlist_append(pymain, &pymain->env_warning_options,
warning) < 0) {
Expand Down Expand Up @@ -929,7 +936,7 @@ pymain_get_program_name(_PyMain *pymain)

if (pymain->program_name == NULL) {
/* Use argv[0] by default */
pymain->program_name = pymain_strdup(pymain, pymain->argv[0]);
pymain->program_name = pymain_wstrdup(pymain, pymain->argv[0]);
if (pymain->program_name == NULL) {
return -1;
}
Expand Down Expand Up @@ -1362,6 +1369,48 @@ pymain_set_flags_from_env(_PyMain *pymain)
}


static int
pymain_init_pythonpath(_PyMain *pymain)
{
if (Py_IgnoreEnvironmentFlag) {
return 0;
}

#ifdef MS_WINDOWS
wchar_t *path = _wgetenv(L"PYTHONPATH");
if (!path || path[0] == '\0') {
return 0;
}

wchar_t *path2 = pymain_wstrdup(pymain, path);
if (path2 == NULL) {
return -1;
}

pymain->core_config.module_search_path_env = path2;
#else
char *path = pymain_get_env_var("PYTHONPATH");
if (!path) {
return 0;
}

size_t len;
wchar_t *wpath = Py_DecodeLocale(path, &len);
if (!wpath) {
if (len == (size_t)-2) {
pymain->err = _Py_INIT_ERR("failed to decode PYTHONHOME");
}
else {
pymain->err = INIT_NO_MEMORY();
}
return -1;
}
pymain->core_config.module_search_path_env = wpath;
#endif
return 0;
}


static int
pymain_parse_envvars(_PyMain *pymain)
{
Expand All @@ -1383,6 +1432,9 @@ pymain_parse_envvars(_PyMain *pymain)
return -1;
}
core_config->allocator = Py_GETENV("PYTHONMALLOC");
if (pymain_init_pythonpath(pymain) < 0) {
return -1;
}

/* -X options */
if (pymain_get_xoption(pymain, L"showrefcount")) {
Expand Down
27 changes: 19 additions & 8 deletions PC/getpathp.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ read_pth_file(const wchar_t *path, wchar_t *prefix, int *isolated, int *nosite)


static void
calculate_path(void)
calculate_path(_PyCoreConfig *core_config)
{
wchar_t argv0_path[MAXPATHLEN+1];
wchar_t *buf;
Expand All @@ -637,8 +637,13 @@ calculate_path(void)
wchar_t *userpath = NULL;
wchar_t zip_path[MAXPATHLEN+1];

if (!Py_IgnoreEnvironmentFlag) {
if (core_config) {
envpath = core_config->module_search_path_env;
}
else if (!Py_IgnoreEnvironmentFlag) {
envpath = _wgetenv(L"PYTHONPATH");
if (envpath && *envpath == '\0')
envpath = NULL;
}

get_progpath();
Expand Down Expand Up @@ -709,9 +714,6 @@ calculate_path(void)
else
wcscpy_s(prefix, MAXPATHLEN+1, pythonhome);

if (envpath && *envpath == '\0')
envpath = NULL;


skiphome = pythonhome==NULL ? 0 : 1;
#ifdef Py_ENABLE_SHARED
Expand Down Expand Up @@ -896,19 +898,28 @@ Py_SetPath(const wchar_t *path)
}
}

wchar_t *
_Py_GetPathWithConfig(_PyCoreConfig *core_config)
{
if (!module_search_path) {
calculate_path(core_config);
}
return module_search_path;
}

wchar_t *
Py_GetPath(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return module_search_path;
}

wchar_t *
Py_GetPrefix(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return prefix;
}

Expand All @@ -922,7 +933,7 @@ wchar_t *
Py_GetProgramFullPath(void)
{
if (!module_search_path)
calculate_path();
calculate_path(NULL);
return progpath;
}

Expand Down
Loading