Skip to content

Fix Python ownership detection and stabilize GIL handling for binding… #652

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
marvinoe21 merged 1 commit into from
May 7, 2026
Merged

Fix Python ownership detection and stabilize GIL handling for binding… #652

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
48 changes: 40 additions & 8 deletions src/module/utilities/gtpy_contextmanager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,38 @@
namespace
{

void ensurePythonOwnerEnvVar()
{
if (qEnvironmentVariableIsSet(gtpy::constants::env::PYTHON_OWNER_ENV_VAR))
{
return;
}

auto exeBaseName = QFileInfo(QCoreApplication::applicationFilePath())
.completeBaseName()
.toLower();

bool gtlabOwnsPython = (exeBaseName == QStringLiteral("gtlab") ||
exeBaseName == QStringLiteral("gtlabconsole"));

qputenv(gtpy::constants::env::PYTHON_OWNER_ENV_VAR,
gtlabOwnsPython
? gtpy::constants::env::PYTHON_OWNER_GTLAB
: gtpy::constants::env::PYTHON_OWNER_EXTERNAL);
}

bool isGtlabPythonOwner()
{
ensurePythonOwnerEnvVar();

auto owner = qEnvironmentVariable(
gtpy::constants::env::PYTHON_OWNER_ENV_VAR)
.trimmed()
.toLower();

return owner == QLatin1String(gtpy::constants::env::PYTHON_OWNER_GTLAB);
}

GtpyContext::ContextType contextTypeEnumConvert(
GtpyContextManager::Context type)
{
Expand Down Expand Up @@ -140,15 +172,15 @@ GtpyContextManager::GtpyContextManager(QObject* parent) :
dlopen(PYTHON_LIBRARY, RTLD_LAZY | RTLD_GLOBAL);
#endif

// In the embedded case, we are owning the python interpreter, so we
// need to create it first.
//
// When the python module is running from inside a normal python interpreter
// we are not allowed to reinit. Also, we don't want to redirect std out in this case
const bool pythonAlreadyInitialized = (Py_IsInitialized() != 0);
m_ownsPythonInterpreter = !pythonAlreadyInitialized;
// Determine interpreter ownership via GTLAB_PYTHON_INTERPRETER_OWNER.
// Ownership controls whether we initialize Python in embedded mode
// or attach to an externally hosted Python interpreter.
m_ownsPythonInterpreter = isGtlabPythonOwner();

int pythonQtFlags = m_ownsPythonInterpreter ? PythonQt::RedirectStdOut : PythonQt::PythonAlreadyInitialized;
const bool pythonAlreadyInitialized = (Py_IsInitialized() != 0);
int pythonQtFlags = pythonAlreadyInitialized
? PythonQt::PythonAlreadyInitialized
: PythonQt::RedirectStdOut;

PythonQt::init(pythonQtFlags);

Expand Down
8 changes: 8 additions & 0 deletions src/module/utilities/gtpy_globals.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ constexpr const char* COLLECTION_CAT = "category";
constexpr const char* COLLECTION_SUBCAT = "subcategory";
constexpr const char* PROJ_PY_SCRIPTS_DIR = "scripts/python";

/// Environment
namespace env
{
constexpr const char* PYTHON_OWNER_ENV_VAR = "GTLAB_PYTHON_INTERPRETER_OWNER";
constexpr const char* PYTHON_OWNER_GTLAB = "gtlab";
constexpr const char* PYTHON_OWNER_EXTERNAL = "external";
}

} // namespace constants

} // namespace gtpy
Expand Down