Refactor Python for 3.12 integration (#1807)

* Correct JS requestConfig call

* Update requestWriteConfig to new API format

* Add hyperion-light and bare-minimum preset scenarios

* Refactor Python

* Windows add bcrypt until mbedtls  is fixed
(https://github.com/Mbed-TLS/mbedtls/pull/9554)

* Corrections

* Use ScreenCaptureKit under macOS 15 and above

* ReSigning macOS package

* Python 3.11.10 test

* Revert "Python 3.11.10 test"

This reverts commit ee921e4f12.

* Handle defined exits from python scripts

* Update change.log

* CodeQL findings

---------

Co-authored-by: Paulchen-Panther <16664240+Paulchen-Panther@users.noreply.github.com>

libsrc/effectengine/Effect.cpp

@@ -13,7 +13,7 @@
 // python utils
 #include <python/PythonProgram.h>
 
-Effect::Effect(Hyperion *hyperion, int priority, int timeout, const QString &script, const QString &name, const QJsonObject &args, const QString &imageData)
+Effect::Effect(Hyperion* hyperion, int priority, int timeout, const QString& script, const QString& name, const QJsonObject& args, const QString& imageData)
 	: QThread()
 	, _hyperion(hyperion)
 	, _priority(priority)
@@ -26,7 +26,7 @@ Effect::Effect(Hyperion *hyperion, int priority, int timeout, const QString &scr
 	, _endTime(-1)
 	, _interupt(false)
 	, _imageSize(hyperion->getLedGridSize())
-	, _image(_imageSize,QImage::Format_ARGB32_Premultiplied)
+	, _image(_imageSize, QImage::Format_ARGB32_Premultiplied)
 {
 	_colors.resize(_hyperion->getLedCount());
 	_colors.fill(ColorRgb::BLACK);
@@ -61,41 +61,81 @@ int Effect::getRemaining() const
 
 	if (timeout >= 0)
 	{
-		timeout = static_cast<int>( _endTime - QDateTime::currentMSecsSinceEpoch());
+		timeout = static_cast<int>(_endTime - QDateTime::currentMSecsSinceEpoch());
 	}
 	return timeout;
 }
 
-void Effect::setModuleParameters()
+bool Effect::setModuleParameters()
 {
 	// import the buildtin Hyperion module
-	PyObject * module = PyImport_ImportModule("hyperion");
+	PyObject* module = PyImport_ImportModule("hyperion");
 
-	// add a capsule containing 'this' to the module to be able to retrieve the effect from the callback function
-	PyModule_AddObject(module, "__effectObj", PyCapsule_New((void*)this, "hyperion.__effectObj", nullptr));
+	if (module == nullptr) {
+		PyErr_Print();  // Print error if module import fails
+		return false;
+	}
 
-	// add ledCount variable to the interpreter
+	// Add a capsule containing 'this' to the module for callback access
+	PyObject* capsule = PyCapsule_New((void*)this, "hyperion.__effectObj", nullptr);
+	if (capsule == nullptr || PyModule_AddObject(module, "__effectObj", capsule) < 0) {
+		PyErr_Print();  // Print error if adding capsule fails
+		Py_XDECREF(module);  // Clean up if capsule addition fails
+		Py_XDECREF(capsule);
+		return false;
+	}
+
+	// Add ledCount variable to the interpreter
 	int ledCount = 0;
 	QMetaObject::invokeMethod(_hyperion, "getLedCount", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, ledCount));
-	PyObject_SetAttrString(module, "ledCount", Py_BuildValue("i", ledCount));
+	PyObject* ledCountObj = Py_BuildValue("i", ledCount);
+	if (PyObject_SetAttrString(module, "ledCount", ledCountObj) < 0) {
+		PyErr_Print();  // Print error if setting attribute fails
+	}
+	Py_XDECREF(ledCountObj);
 
-	// add minimumWriteTime variable to the interpreter
+	// Add minimumWriteTime variable to the interpreter
 	int latchTime = 0;
 	QMetaObject::invokeMethod(_hyperion, "getLatchTime", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, latchTime));
-	PyObject_SetAttrString(module, "latchTime", Py_BuildValue("i", latchTime));
+	PyObject* latchTimeObj = Py_BuildValue("i", latchTime);
+	if (PyObject_SetAttrString(module, "latchTime", latchTimeObj) < 0) {
+		PyErr_Print();  // Print error if setting attribute fails
+	}
+	Py_XDECREF(latchTimeObj);
 
-	// add a args variable to the interpreter
-	PyObject_SetAttrString(module, "args", EffectModule::json2python(_args));
+	// Add args variable to the interpreter
+	PyObject* argsObj = EffectModule::json2python(_args);
+	if (PyObject_SetAttrString(module, "args", argsObj) < 0) {
+		PyErr_Print();  // Print error if setting attribute fails
+	}
+	Py_XDECREF(argsObj);
 
-	// decref the module
+	// Decrement module reference
 	Py_XDECREF(module);
+
+	return true;
 }
 
 void Effect::run()
 {
 	PythonProgram program(_name, _log);
 
-	setModuleParameters();
+#if (PY_VERSION_HEX < 0x030C0000)
+	PyThreadState* prev_thread_state = PyThreadState_Swap(program);
+#endif
+
+	if (!setModuleParameters())
+	{
+		Error(_log, "Failed to set Module parameters. Effect will not be executed.");
+#if (PY_VERSION_HEX < 0x030C0000)
+		PyThreadState_Swap(prev_thread_state);
+#endif
+		return;
+	}
+
+#if (PY_VERSION_HEX < 0x030C0000)
+	PyThreadState_Swap(prev_thread_state);
+#endif
 
 	// Set the end time if applicable
 	if (_timeout > 0)
@@ -104,7 +144,7 @@ void Effect::run()
 	}
 
 	// Run the effect script
-	QFile file (_script);
+	QFile file(_script);
 	if (file.open(QIODevice::ReadOnly))
 	{
 		program.execute(file.readAll());

libsrc/grabber/osx/CMakeLists.txt

@@ -1,10 +1,28 @@
 add_library(osx-grabber
 	${CMAKE_SOURCE_DIR}/include/grabber/osx/OsxFrameGrabber.h
 	${CMAKE_SOURCE_DIR}/include/grabber/osx/OsxWrapper.h
-	${CMAKE_SOURCE_DIR}/libsrc/grabber/osx/OsxFrameGrabber.cpp
+	${CMAKE_SOURCE_DIR}/libsrc/grabber/osx/OsxFrameGrabber.mm
 	${CMAKE_SOURCE_DIR}/libsrc/grabber/osx/OsxWrapper.cpp
 )
 
 target_link_libraries(osx-grabber
 	hyperion
+	"$<LINK_LIBRARY:FRAMEWORK,CoreGraphics.framework>"
 )
+
+file(WRITE ${CMAKE_BINARY_DIR}/tmp/SDK15Available.c
+	"#include <AvailabilityMacros.h>
+	#if __MAC_OS_X_VERSION_MAX_ALLOWED < 150000
+	#error __MAC_OS_X_VERSION_MAX_ALLOWED < 150000
+	#endif
+	int main(int argc, char** argv)
+	{
+		return 0;
+	}"
+)
+
+try_compile(SDK_15_AVAILABLE ${CMAKE_BINARY_DIR} SOURCES ${CMAKE_BINARY_DIR}/tmp/SDK15Available.c)
+if(SDK_15_AVAILABLE)
+	target_compile_definitions(osx-grabber PRIVATE SDK_15_AVAILABLE)
+	target_link_libraries(osx-grabber "$<LINK_LIBRARY:WEAK_FRAMEWORK,ScreenCaptureKit.framework>")
+endif()

libsrc/grabber/osx/OsxFrameGrabber.mm

@@ -1,10 +1,16 @@
 // STL includes
 #include <cassert>
 #include <iostream>
+#include <mutex>
 
-// Local includes
+// Header
 #include <grabber/osx/OsxFrameGrabber.h>
 
+// ScreenCaptureKit
+#if defined(SDK_15_AVAILABLE)
+#include <ScreenCaptureKit/ScreenCaptureKit.h>
+#endif
+
 //Qt
 #include <QJsonObject>
 #include <QJsonArray>
@@ -15,9 +21,70 @@ namespace {
 const bool verbose = false;
 } //End of constants
 
+#if defined(SDK_15_AVAILABLE)
+	static CGImageRef capture15(CGDirectDisplayID id, CGRect diIntersectDisplayLocal)
+	{
+		dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
+		__block CGImageRef image1 = nil;
+		[SCShareableContent getShareableContentWithCompletionHandler:^(SCShareableContent* content, NSError* error)
+		{
+			@autoreleasepool
+			{
+				if (error || !content)
+				{
+					dispatch_semaphore_signal(semaphore);
+					return;
+				}
+
+				SCDisplay* target = nil;
+				for (SCDisplay *display in content.displays)
+				{
+					if (display.displayID == id)
+					{
+						target = display;
+						break;
+					}
+				}
+				if (!target)
+				{
+					dispatch_semaphore_signal(semaphore);
+					return;
+				}
+
+				SCContentFilter* filter = [[SCContentFilter alloc] initWithDisplay:target excludingWindows:@[]];
+				SCStreamConfiguration* config = [[SCStreamConfiguration alloc] init];
+				config.queueDepth = 5;
+				config.sourceRect = diIntersectDisplayLocal;
+				config.scalesToFit = false;
+				config.captureResolution = SCCaptureResolutionBest;
+
+				CGDisplayModeRef modeRef = CGDisplayCopyDisplayMode(id);
+				double sysScale = CGDisplayModeGetPixelWidth(modeRef) / CGDisplayModeGetWidth(modeRef);
+				config.width = diIntersectDisplayLocal.size.width * sysScale;
+				config.height = diIntersectDisplayLocal.size.height * sysScale;
+
+				[SCScreenshotManager captureImageWithFilter:filter
+					configuration:config
+					completionHandler:^(CGImageRef img, NSError* error)
+					{
+						if (!error)
+						{
+							image1 = CGImageCreateCopyWithColorSpace(img, CGColorSpaceCreateDeviceRGB());
+						}
+						dispatch_semaphore_signal(semaphore);
+				}];
+			}
+		}];
+
+		dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
+		dispatch_release(semaphore);
+		return image1;
+	}
+#endif
+
 OsxFrameGrabber::OsxFrameGrabber(int display)
 	: Grabber("GRABBER-OSX")
-	  , _screenIndex(display)
+	, _screenIndex(display)
 {
 	_isEnabled = false;
 	_useImageResampler = true;
@@ -31,6 +98,15 @@ bool OsxFrameGrabber::setupDisplay()
 {
 	bool rc (false);
 
+#if defined(SDK_15_AVAILABLE)
+	if (!CGPreflightScreenCaptureAccess())
+	{
+		if(!CGRequestScreenCaptureAccess())
+			Error(_log, "Screen capture permission required to start the grabber");
+			return false;
+	}
+#endif
+
 	rc = setDisplayIndex(_screenIndex);
 
 	return rc;
@@ -41,39 +117,38 @@ int OsxFrameGrabber::grabFrame(Image<ColorRgb> & image)
 	int rc = 0;
 	if (_isEnabled && !_isDeviceInError)
 	{
-
 		CGImageRef dispImage;
-		CFDataRef imgData;
-		unsigned char * pImgData;
-		unsigned dspWidth;
-		unsigned dspHeight;
 
-		dispImage = CGDisplayCreateImage(_display);
+		#if defined(SDK_15_AVAILABLE)
+			dispImage = capture15(_display, CGDisplayBounds(_display));
+		#else
+			dispImage = CGDisplayCreateImageForRect(_display, CGDisplayBounds(_display));
+		#endif
 
 		// display lost, use main
 		if (dispImage == nullptr && _display != 0)
 		{
-			dispImage = CGDisplayCreateImage(kCGDirectMainDisplay);
-			// no displays connected, return
-			if (dispImage == nullptr)
-			{
-				Error(_log, "No display connected...");
-				return -1;
-			}
+			#if defined(SDK_15_AVAILABLE)
+				dispImage = capture15(kCGDirectMainDisplay, CGDisplayBounds(kCGDirectMainDisplay));
+			#else
+				dispImage = CGDisplayCreateImageForRect(kCGDirectMainDisplay, CGDisplayBounds(kCGDirectMainDisplay));
+			#endif
 		}
-		imgData   = CGDataProviderCopyData(CGImageGetDataProvider(dispImage));
-		pImgData  = (unsigned char*) CFDataGetBytePtr(imgData);
-		dspWidth  = CGImageGetWidth(dispImage);
-		dspHeight = CGImageGetHeight(dispImage);
 
-		_imageResampler.processImage( pImgData,
-									  static_cast<int>(dspWidth),
-									  static_cast<int>(dspHeight),
-									  static_cast<int>(CGImageGetBytesPerRow(dispImage)),
-									  PixelFormat::BGR32,
-									  image);
+		// no displays connected, return
+		if (dispImage == nullptr)
+		{
+			Error(_log, "No display connected...");
+			return -1;
+		}
+
+		CFDataRef imgData = CGDataProviderCopyData(CGImageGetDataProvider(dispImage));
+		if (imgData != nullptr)
+		{
+			_imageResampler.processImage((uint8_t *)CFDataGetBytePtr(imgData), static_cast<int>(CGImageGetWidth(dispImage)), static_cast<int>(CGImageGetHeight(dispImage)), static_cast<int>(CGImageGetBytesPerRow(dispImage)), PixelFormat::BGR32, image);
+			CFRelease(imgData);
+		}
 
-		CFRelease(imgData);
 		CGImageRelease(dispImage);
 
 	}
@@ -108,7 +183,12 @@ bool OsxFrameGrabber::setDisplayIndex(int index)
 				{
 					_display = activeDspys[_screenIndex];
 
-					image = CGDisplayCreateImage(_display);
+					#if defined(SDK_15_AVAILABLE)
+						image = capture15(_display, CGDisplayBounds(_display));
+					#else
+						image = CGDisplayCreateImageForRect(_display, CGDisplayBounds(_display));
+					#endif
+
 					if(image == nullptr)
 					{
 						setEnabled(false);

libsrc/leddevice/CMakeLists.txt

@@ -115,7 +115,11 @@ if(ENABLE_DEV_NETWORK)
 	if(NOT DEFAULT_USE_SYSTEM_MBEDTLS_LIBS)
 		if(MBEDTLS_LIBRARIES)
 			include_directories(${MBEDTLS_INCLUDE_DIR})
-			target_link_libraries(leddevice ${MBEDTLS_LIBRARIES})
+			target_link_libraries(
+				leddevice
+				${MBEDTLS_LIBRARIES}
+				$<$<BOOL:${WIN32}>:bcrypt.lib>
+			)
 			target_include_directories(leddevice PRIVATE ${MBEDTLS_INCLUDE_DIR})
 		endif (MBEDTLS_LIBRARIES)
 	endif()

libsrc/python/PythonInit.cpp

@@ -18,7 +18,7 @@
 #include <HyperionConfig.h>
 
 #ifdef _WIN32
-	#include <stdexcept>
+#include <stdexcept>
 #endif
 
 #define STRINGIFY2(x) #x
@@ -44,14 +44,14 @@ PythonInit::PythonInit()
 #if (PY_VERSION_HEX >= 0x03080000)
 	status = PyConfig_SetString(&config, &config.program_name, programName);
 	if (PyStatus_Exception(status)) {
-		goto exception;
+		handlePythonError(status, config);
+		return;
 	}
-	else
 #else
 	Py_SetProgramName(programName);
 #endif
 	{
-		// set Python module path when exists
+		// set Python module path when it exists
 		QString py_path = QDir::cleanPath(qApp->applicationDirPath() + "/../lib/python" + STRINGIFY(PYTHON_VERSION_MAJOR) + "." + STRINGIFY(PYTHON_VERSION_MINOR));
 		QString py_file = QDir::cleanPath(qApp->applicationDirPath() + "/python" + STRINGIFY(PYTHON_VERSION_MAJOR) + STRINGIFY(PYTHON_VERSION_MINOR) + ".zip");
 		QString py_framework = QDir::cleanPath(qApp->applicationDirPath() + "/../Frameworks/Python.framework/Versions/Current/lib/python" + STRINGIFY(PYTHON_VERSION_MAJOR) + "." + STRINGIFY(PYTHON_VERSION_MINOR));
@@ -59,21 +59,23 @@ PythonInit::PythonInit()
 		if (QFile(py_file).exists() || QDir(py_path).exists() || QDir(py_framework).exists())
 		{
 #if (PY_VERSION_HEX >= 0x030C0000)
-            config.site_import = 0;
+			config.site_import = 0;
 #else
-            Py_NoSiteFlag++;
+			Py_NoSiteFlag++;
 #endif
 			if (QFile(py_file).exists()) // Windows
 			{
 #if (PY_VERSION_HEX >= 0x03080000)
 				status = PyConfig_SetBytesString(&config, &config.home, QSTRING_CSTR(py_file));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 				config.module_search_paths_set = 1;
 				status = PyWideStringList_Append(&config.module_search_paths, const_cast<wchar_t*>(py_file.toStdWString().c_str()));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 #else
 				Py_SetPythonHome(Py_DecodeLocale(py_file.toLatin1().data(), nullptr));
@@ -85,18 +87,21 @@ PythonInit::PythonInit()
 #if (PY_VERSION_HEX >= 0x03080000)
 				status = PyConfig_SetBytesString(&config, &config.home, QSTRING_CSTR(QDir::cleanPath(qApp->applicationDirPath() + "/../")));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 
 				config.module_search_paths_set = 1;
 				status = PyWideStringList_Append(&config.module_search_paths, const_cast<wchar_t*>(QDir(py_path).absolutePath().toStdWString().c_str()));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 
 				status = PyWideStringList_Append(&config.module_search_paths, const_cast<wchar_t*>(QDir(py_path + "/lib-dynload").absolutePath().toStdWString().c_str()));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 #else
 				QStringList python_paths;
@@ -114,18 +119,21 @@ PythonInit::PythonInit()
 #if (PY_VERSION_HEX >= 0x03080000)
 				status = PyConfig_SetBytesString(&config, &config.home, QSTRING_CSTR(QDir::cleanPath(qApp->applicationDirPath() + "/../Frameworks/Python.framework/Versions/Current")));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 
 				config.module_search_paths_set = 1;
 				status = PyWideStringList_Append(&config.module_search_paths, const_cast<wchar_t*>(QDir(py_framework).absolutePath().toStdWString().c_str()));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 
 				status = PyWideStringList_Append(&config.module_search_paths, const_cast<wchar_t*>(QDir(py_framework + "/lib-dynload").absolutePath().toStdWString().c_str()));
 				if (PyStatus_Exception(status)) {
-					goto exception;
+					handlePythonError(status, config);
+					return;
 				}
 #else
 				QStringList python_paths;
@@ -146,7 +154,8 @@ PythonInit::PythonInit()
 #if (PY_VERSION_HEX >= 0x03080000)
 	status = Py_InitializeFromConfig(&config);
 	if (PyStatus_Exception(status)) {
-		goto exception;
+		handlePythonError(status, config);
+		return;
 	}
 	PyConfig_Clear(&config);
 #endif
@@ -154,7 +163,8 @@ PythonInit::PythonInit()
 	// init Python
 	Debug(Logger::getInstance("DAEMON"), "Initializing Python interpreter");
 	Py_InitializeEx(0);
-	if ( !Py_IsInitialized() )
+
+	if (!Py_IsInitialized())
 	{
 		throw std::runtime_error("Initializing Python failed!");
 	}
@@ -165,20 +175,28 @@ PythonInit::PythonInit()
 #endif
 
 	mainThreadState = PyEval_SaveThread();
-	return;
+}
 
+// Error handling function to replace goto exception
 #if (PY_VERSION_HEX >= 0x03080000)
-exception:
+void PythonInit::handlePythonError(PyStatus status, PyConfig& config)
+{
 	Error(Logger::getInstance("DAEMON"), "Initializing Python config failed with error [%s]", status.err_msg);
 	PyConfig_Clear(&config);
-
 	throw std::runtime_error("Initializing Python failed!");
-#endif
 }
+#endif
 
 PythonInit::~PythonInit()
 {
 	Debug(Logger::getInstance("DAEMON"), "Cleaning up Python interpreter");
+
+#if (PY_VERSION_HEX < 0x030C0000)
 	PyEval_RestoreThread(mainThreadState);
-	Py_Finalize();
+#else
+	PyThreadState_Swap(mainThreadState);
+#endif
+
+	int rc = Py_FinalizeEx();
+	Debug(Logger::getInstance("DAEMON"), "Cleaning up Python interpreter %s", rc == 0 ? "succeeded" : "failed");
 }

libsrc/python/PythonProgram.cpp

@@ -1,173 +1,238 @@
 #include <python/PythonProgram.h>
 #include <python/PythonUtils.h>
+
 #include <utils/Logger.h>
 
 #include <QThread>
 
 PyThreadState* mainThreadState;
 
-PythonProgram::PythonProgram(const QString & name, Logger * log) :
-	_name(name), _log(log), _tstate(nullptr)
+PythonProgram::PythonProgram(const QString& name, Logger* log) :
+	_name(name)
+	, _log(log)
+	, _tstate(nullptr)
 {
 	// we probably need to wait until mainThreadState is available
-	while(mainThreadState == nullptr){};
+	QThread::msleep(10);
+	while (mainThreadState == nullptr)
+	{
+		QThread::msleep(10);  // Wait with delay to avoid busy waiting
+	}
 
+	// Create a new subinterpreter for this thread
+#if (PY_VERSION_HEX < 0x030C0000)
 	// get global lock
 	PyEval_RestoreThread(mainThreadState);
-
-	// Initialize a new thread state
 	_tstate = Py_NewInterpreter();
-	if(_tstate == nullptr)
-	{
-#if (PY_VERSION_HEX >= 0x03020000)
-		PyThreadState_Swap(mainThreadState);
-		PyEval_SaveThread();
 #else
-		PyEval_ReleaseLock();
+	PyThreadState* prev = PyThreadState_Swap(NULL);
+
+	// Create a new interpreter configuration object
+	PyInterpreterConfig config{};
+
+	// Set configuration options
+	config.use_main_obmalloc = 0;
+	config.allow_fork = 0;
+	config.allow_exec = 0;
+	config.allow_threads = 1;
+	config.allow_daemon_threads = 0;
+	config.check_multi_interp_extensions = 1;
+	config.gil = PyInterpreterConfig_OWN_GIL;
+	Py_NewInterpreterFromConfig(&_tstate, &config);
 #endif
-		Error(_log, "Failed to get thread state for %s",QSTRING_CSTR(_name));
+
+	if (_tstate == nullptr)
+	{
+		PyThreadState_Swap(mainThreadState);
+#if (PY_VERSION_HEX < 0x030C0000)
+		PyEval_SaveThread();
+#endif
+		Error(_log, "Failed to get thread state for %s", QSTRING_CSTR(_name));
 		return;
 	}
+#if (PY_VERSION_HEX < 0x030C0000)
 	PyThreadState_Swap(_tstate);
+#endif
 }
 
 PythonProgram::~PythonProgram()
 {
 	if (!_tstate)
-		return;
-
-	// stop sub threads if needed
-	for (PyThreadState* s = PyInterpreterState_ThreadHead(_tstate->interp), *old = nullptr; s;)
 	{
-		if (s == _tstate)
-		{
-			s = s->next;
-			continue;
-		}
-		if (old != s)
-		{
-			Debug(_log,"ID %s: Waiting on thread %u", QSTRING_CSTR(_name), s->thread_id);
-			old = s;
-		}
-
-		Py_BEGIN_ALLOW_THREADS;
-		QThread::msleep(100);
-		Py_END_ALLOW_THREADS;
-
-		s = PyInterpreterState_ThreadHead(_tstate->interp);
+		return;
 	}
 
+#if (PY_VERSION_HEX < 0x030C0000)
+	PyThreadState* prev_thread_state = PyThreadState_Swap(_tstate);
+#endif
+
 	// Clean up the thread state
 	Py_EndInterpreter(_tstate);
-#if (PY_VERSION_HEX >= 0x03020000)
-	PyThreadState_Swap(mainThreadState);
+
+#if (PY_VERSION_HEX < 0x030C0000)
+	PyThreadState_Swap(prev_thread_state);
 	PyEval_SaveThread();
-#else
-	PyEval_ReleaseLock();
 #endif
 }
 
-void PythonProgram::execute(const QByteArray & python_code)
+void PythonProgram::execute(const QByteArray& python_code)
 {
 	if (!_tstate)
+	{
 		return;
+	}
+#if (PY_VERSION_HEX < 0x030C0000)
+	PyThreadState_Swap(_tstate);
+#else
+	PyThreadState* prev_thread_state = PyThreadState_Swap(_tstate);
+#endif
+	PyObject* main_module = PyImport_ImportModule("__main__");
+	if (!main_module)
+	{
+		// Restore the previous thread state
+#if (PY_VERSION_HEX < 0x030C0000)
+		PyThreadState_Swap(mainThreadState);
+#else
+		PyThreadState_Swap(prev_thread_state);
+#endif
+		return;
+	}
 
-	PyObject *main_module = PyImport_ImportModule("__main__"); // New Reference
-	PyObject *main_dict = PyModule_GetDict(main_module); // Borrowed reference
-	Py_INCREF(main_dict); // Incref "main_dict" to use it in PyRun_String(), because PyModule_GetDict() has decref "main_dict"
-	Py_DECREF(main_module); // // release "main_module" when done
-	PyObject *result = PyRun_String(python_code.constData(), Py_file_input, main_dict, main_dict); // New Reference
-
+	PyObject* main_dict = PyModule_GetDict(main_module);  // Borrowed reference to globals
+	PyObject* result = PyRun_String(python_code.constData(), Py_file_input, main_dict, main_dict);
 	if (!result)
 	{
-		if (PyErr_Occurred()) // Nothing needs to be done for a borrowed reference
+		if (PyErr_Occurred())
 		{
-			Error(_log,"###### PYTHON EXCEPTION ######");
-			Error(_log,"## In effect '%s'", QSTRING_CSTR(_name));
-			/* Objects all initialized to NULL for Py_XDECREF */
-			PyObject *errorType = NULL, *errorValue = NULL, *errorTraceback = NULL;
+			PyObject* errorType = NULL, * errorValue = NULL, * errorTraceback = NULL;
 
-			PyErr_Fetch(&errorType, &errorValue, &errorTraceback); // New Reference or NULL
+			PyErr_Fetch(&errorType, &errorValue, &errorTraceback);
 			PyErr_NormalizeException(&errorType, &errorValue, &errorTraceback);
 
-			// Extract exception message from "errorValue"
-			if(errorValue)
-			{
-				QString message;
-				if(PyObject_HasAttrString(errorValue, "__class__"))
-				{
-					PyObject *classPtr = PyObject_GetAttrString(errorValue, "__class__"); // New Reference
-					PyObject *class_name = NULL; /* Object "class_name" initialized to NULL for Py_XDECREF */
-					class_name = PyObject_GetAttrString(classPtr, "__name__"); // New Reference or NULL
+			// Check if the exception is a SystemExit
+			PyObject* systemExitType = PyExc_SystemExit;
+			bool isSystemExit = PyObject_IsInstance(errorValue, systemExitType);
 
-					if(class_name && PyUnicode_Check(class_name))
+			if (isSystemExit)
+			{
+				// Extract the exit argument
+				PyObject* exitArg = PyObject_GetAttrString(errorValue, "code");
+
+				if (exitArg)
+				{
+					QString logErrorText;
+					if (PyTuple_Check(exitArg)) {
+						PyObject* errorMessage = PyTuple_GetItem(exitArg, 0); // Borrowed reference
+						PyObject* exitCode = PyTuple_GetItem(exitArg, 1);     // Borrowed reference
+
+						if (exitCode && PyLong_Check(exitCode))
+						{
+							logErrorText = QString("[%1]: ").arg(PyLong_AsLong(exitCode));
+						}
+
+						if (errorMessage && PyUnicode_Check(errorMessage)) {
+							logErrorText.append(PyUnicode_AsUTF8(errorMessage));
+						}
+					}
+					else if (PyUnicode_Check(exitArg)) {
+						// If the code is just a string, treat it as an error message
+						logErrorText.append(PyUnicode_AsUTF8(exitArg));
+					}
+					else if (PyLong_Check(exitArg)) {
+						// If the code is just an integer, treat it as an exit code
+						logErrorText = QString("[%1]").arg(PyLong_AsLong(exitArg));
+					}
+
+					Error(_log, "Effect '%s' failed with error %s", QSTRING_CSTR(_name), QSTRING_CSTR(logErrorText));
+
+					Py_DECREF(exitArg); // Release the reference
+				}
+				else
+				{
+					Debug(_log, "No 'code' attribute found on SystemExit exception.");
+				}
+				// Clear the error so it won't propagate
+				PyErr_Clear();
+
+				Py_DECREF(systemExitType);
+				return;
+			}
+			Py_DECREF(systemExitType);
+
+			if (errorValue)
+			{
+				Error(_log, "###### PYTHON EXCEPTION ######");
+				Error(_log, "## In effect '%s'", QSTRING_CSTR(_name));
+
+				QString message;
+				if (PyObject_HasAttrString(errorValue, "__class__"))
+				{
+					PyObject* classPtr = PyObject_GetAttrString(errorValue, "__class__");
+					PyObject* class_name = classPtr ? PyObject_GetAttrString(classPtr, "__name__") : NULL;
+
+					if (class_name && PyUnicode_Check(class_name))
 						message.append(PyUnicode_AsUTF8(class_name));
 
-					Py_DECREF(classPtr); // release "classPtr" when done
-					Py_XDECREF(class_name); // Use Py_XDECREF() to ignore NULL references
+					Py_XDECREF(class_name);
+					Py_DECREF(classPtr);
 				}
 
-				// Object "class_name" initialized to NULL for Py_XDECREF
-				PyObject *valueString = NULL;
-				valueString = PyObject_Str(errorValue); // New Reference or NULL
+				PyObject* valueString = PyObject_Str(errorValue);
 
-				if(valueString && PyUnicode_Check(valueString))
+				if (valueString && PyUnicode_Check(valueString))
 				{
-					if(!message.isEmpty())
+					if (!message.isEmpty())
 						message.append(": ");
-
 					message.append(PyUnicode_AsUTF8(valueString));
 				}
-				Py_XDECREF(valueString); // Use Py_XDECREF() to ignore NULL references
+				Py_XDECREF(valueString);
 
 				Error(_log, "## %s", QSTRING_CSTR(message));
 			}
 
-			// Extract exception message from "errorTraceback"
-			if(errorTraceback)
+			if (errorTraceback)
 			{
-				// Object "tracebackList" initialized to NULL for Py_XDECREF
-				PyObject *tracebackModule = NULL, *methodName = NULL, *tracebackList = NULL;
-				QString tracebackMsg;
+				PyObject* tracebackModule = PyImport_ImportModule("traceback");
+				PyObject* methodName = PyUnicode_FromString("format_exception");
+				PyObject* tracebackList = tracebackModule && methodName
+					? PyObject_CallMethodObjArgs(tracebackModule, methodName, errorType, errorValue, errorTraceback, NULL)
+					: NULL;
 
-				tracebackModule = PyImport_ImportModule("traceback"); // New Reference or NULL
-				methodName = PyUnicode_FromString("format_exception"); // New Reference or NULL
-				tracebackList = PyObject_CallMethodObjArgs(tracebackModule, methodName, errorType, errorValue, errorTraceback, NULL); // New Reference or NULL
-
-				if(tracebackList)
+				if (tracebackList)
 				{
-					PyObject* iterator = PyObject_GetIter(tracebackList); // New Reference
-
+					PyObject* iterator = PyObject_GetIter(tracebackList);
 					PyObject* item;
-					while( (item = PyIter_Next(iterator)) ) // New Reference
+					while ((item = PyIter_Next(iterator)))
 					{
-						Error(_log, "## %s",QSTRING_CSTR(QString(PyUnicode_AsUTF8(item)).trimmed()));
-						Py_DECREF(item); // release "item" when done
+						Error(_log, "## %s", QSTRING_CSTR(QString(PyUnicode_AsUTF8(item)).trimmed()));
+						Py_DECREF(item);
 					}
-					Py_DECREF(iterator);  // release "iterator" when done
+					Py_DECREF(iterator);
 				}
 
-				// Use Py_XDECREF() to ignore NULL references
 				Py_XDECREF(tracebackModule);
 				Py_XDECREF(methodName);
 				Py_XDECREF(tracebackList);
 
-				// Give the exception back to python and print it to stderr in case anyone else wants it.
-				Py_XINCREF(errorType);
-				Py_XINCREF(errorValue);
-				Py_XINCREF(errorTraceback);
-
 				PyErr_Restore(errorType, errorValue, errorTraceback);
-				//PyErr_PrintEx(0); // Remove this line to switch off stderr output
 			}
-			Error(_log,"###### EXCEPTION END ######");
+			Error(_log, "###### EXCEPTION END ######");
 		}
+		// Clear the error so it won't propagate
+		PyErr_Clear();
 	}
 	else
 	{
-		Py_DECREF(result);  // release "result" when done
+		Py_DECREF(result);  // Release result when done
 	}
 
-	Py_DECREF(main_dict);  // release "main_dict" when done
+	Py_DECREF(main_module);
+
+	// Restore the previous thread state
+#if (PY_VERSION_HEX < 0x030C0000)
+	PyThreadState_Swap(mainThreadState);
+#else
+	PyThreadState_Swap(prev_thread_state);
+#endif
 }