PythonManager.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifdef PYTHON_BINDING
 
#ifndef __PYTHON_MANAGER__
#define __PYTHON_MANAGER__
 
#include "CamiTKAPI.h"
 
#include <QDir>
#include <QProcess>
 
#pragma push_macro("slots")
#undef slots
#include <pybind11/embed.h>
#pragma pop_macro("slots")
 
namespace py = pybind11;
 
namespace camitk {
 
class CAMITK_API PythonManager {
 
public:
    static bool initPython();
 
    static QString getPythonStatus();
 
    static py::module_ lockContext(QString virtualEnvPath, QString scriptPath);
 
    static QMap<QString, QVariant> runScript(QString virtualEnvPath, const QString& pythonScript, QString& pythonError);
 
    static void unlock();
 
    static QString getPythonVersion();
 
    static QString pythonEnvironmentDebugInfo();
 
    static void dump(py::dict dict);
 
    static QVariant fromPython(const py::handle& value);
 
    static bool checkVirtualEnvPath(QString virtualEnvRootPath, bool silent = true);
 
    static bool createVirtualEnv(QString virtualEnvRootPath);
 
    static bool installPackages(QString virtualEnvPath, QStringList packages, int progressMinimum = 0, int progressMaximum = 100);
 
    static void setPythonPointer(QObject* qObject, py::object pythonPointer);
 
    static void backupPythonState(QObject* qObject);
 
    static void restorePythonState(QObject* qObject);
 
private:
    static void resolvePythonSharedLibPathAndVersion();
 
    static bool loadPythonSharedLibrary();
 
    static QString findPythonModule(const QString& moduleName);
 
    static bool insertIfNotAlreadyInList(py::list* list, const QString& value);
 
    static void checkPythonPackageConflicts();
 
    static QString findPythonExecutable();
 
    static py::module_ importOrReload(const QString& moduleName, bool clearAll = false);
 
    static bool setupPython(QString virtualEnvPath, QString scriptPath = QString());
 
    static QString pythonStatusString;
 
    static QDir pythonCamitkModulePath;
 
    static QString pythonSoLib;
 
    static QString pythonVersion;
 
    static QString systemPythonExecutable;
 
    static bool isLocked;
 
    static QMap<QObject*, QPair<py::object, py::dict>> pythonStateMap;
 
    static QString currentVirtualEnvPath;
    static QString currentScriptPath;
    static py::module_ currentModule;
 
};
 
} // namespace camitk
 
#endif // __PYTHON_MANAGER__
#endif // PYTHON_BINDING