Skip to content

[lldb] Use Py_InitializeFromConfig with Python >= 3.8 (NFC) #114112

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

Merged
merged 3 commits into from
Oct 30, 2024
Merged

[lldb] Use Py_InitializeFromConfig with Python >= 3.8 (NFC) #114112

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c584381
[lldb] Use Py_InitializeFromConfig with Python >= 3.8 (NFC)
JDevlieghere Oct 29, 2024
35d76ac
Fix formatting
JDevlieghere Oct 29, 2024
97b6b53
Add missing PY_MAJOR_VERSION > 3 in LLDB_EMBED_PYTHON_HOME
JDevlieghere Oct 30, 2024
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
68 changes: 40 additions & 28 deletions lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,38 @@ namespace {
struct InitializePythonRAII {
public:
InitializePythonRAII() {
InitializePythonHome();
#if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 8) || (PY_MAJOR_VERSION > 3)
PyConfig config;
PyConfig_InitPythonConfig(&config);
#endif

#if LLDB_EMBED_PYTHON_HOME
typedef wchar_t *str_type;
static str_type g_python_home = []() -> str_type {
const char *lldb_python_home = LLDB_PYTHON_HOME;
const char *absolute_python_home = nullptr;
llvm::SmallString<64> path;
if (llvm::sys::path::is_absolute(lldb_python_home)) {
absolute_python_home = lldb_python_home;
} else {
FileSpec spec = HostInfo::GetShlibDir();
if (!spec)
return nullptr;
spec.GetPath(path);
llvm::sys::path::append(path, lldb_python_home);
absolute_python_home = path.c_str();
}
size_t size = 0;
return Py_DecodeLocale(absolute_python_home, &size);
}();
if (g_python_home != nullptr) {
#if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 8) || (PY_MAJOR_VERSION > 3)
PyConfig_SetBytesString(&config, &config.home, g_python_home);
#else
Py_SetPythonHome(g_python_home);
#endif
}
#endif

// The table of built-in modules can only be extended before Python is
// initialized.
Expand All @@ -117,15 +148,22 @@ struct InitializePythonRAII {
PyImport_AppendInittab("_lldb", LLDBSwigPyInit);
}

#if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 8) || (PY_MAJOR_VERSION > 3)
config.install_signal_handlers = 0;
Py_InitializeFromConfig(&config);
PyConfig_Clear(&config);
InitializeThreadsPrivate();
#else
// Python < 3.2 and Python >= 3.2 reversed the ordering requirements for
// calling `Py_Initialize` and `PyEval_InitThreads`. < 3.2 requires that you
// call `PyEval_InitThreads` first, and >= 3.2 requires that you call it last.
#if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 2) || (PY_MAJOR_VERSION > 3)
#if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 2)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this now do the wrong thing for a hypothetical 4.x? I thought that's what the || (PY_MAJOR_VERSION > 3) was there for.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#if PY_VERSION_HEX>=0x03020000 ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DavidSpickett The hypothetical Python 4 case is covered above and goes down the Py_InitializeFromConfig path.

@labath Happy to use that but everything else in this file uses the same check I have here, so I'll simplify the defines in a separate patch/PR.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you're right I was struggling to read the nested ifdefs. This 3.2 code will be removed once the 20 branch happens so it's fine as is.

Py_InitializeEx(0);
InitializeThreadsPrivate();
#else
InitializeThreadsPrivate();
Py_InitializeEx(0);
#endif
#endif
}

Expand All @@ -142,32 +180,6 @@ struct InitializePythonRAII {
}

private:
void InitializePythonHome() {
#if LLDB_EMBED_PYTHON_HOME
typedef wchar_t *str_type;
static str_type g_python_home = []() -> str_type {
const char *lldb_python_home = LLDB_PYTHON_HOME;
const char *absolute_python_home = nullptr;
llvm::SmallString<64> path;
if (llvm::sys::path::is_absolute(lldb_python_home)) {
absolute_python_home = lldb_python_home;
} else {
FileSpec spec = HostInfo::GetShlibDir();
if (!spec)
return nullptr;
spec.GetPath(path);
llvm::sys::path::append(path, lldb_python_home);
absolute_python_home = path.c_str();
}
size_t size = 0;
return Py_DecodeLocale(absolute_python_home, &size);
}();
if (g_python_home != nullptr) {
Py_SetPythonHome(g_python_home);
}
#endif
}

void InitializeThreadsPrivate() {
// Since Python 3.7 `Py_Initialize` calls `PyEval_InitThreads` inside itself,
// so there is no way to determine whether the embedded interpreter
Expand Down
Loading