python_runner.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef PYTHON_RUNNER_H
#define PYTHON_RUNNER_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "utils_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QObject>
#include <QString>
#include <QStringList>
#include <QProcessEnvironment>
 
#include <functional>
 
//=============================================================================================================
// DEFINE NAMESPACE UTILSLIB
//=============================================================================================================
 
namespace UTILSLIB
{
 
//=============================================================================================================
struct UTILSSHARED_EXPORT PythonRunnerResult
{
    bool success = false;      
    int exitCode = -1;         
    bool timedOut = false;     
    QString stdOut;            
    QString stdErr;            
    float progressPct = -1.0f; 
};
 
//=============================================================================================================
struct UTILSSHARED_EXPORT PythonRunnerConfig
{
    QString pythonExe = QStringLiteral("python3"); 
    QString workingDir;                            
    QStringList extraEnv;                          
    int timeoutMsec = -1;                          
    bool unbuffered = true;                        
    QString venvDir;                               
    QString packageDir;                            
    QString requirementsFile;                      
};
 
//=============================================================================================================
using PythonLineCallback = std::function<void(int channel, const QString& line)>;
 
//=============================================================================================================
using PythonProgressCallback = std::function<void(float pct, const QString& msg)>;
 
//=============================================================================================================
class UTILSSHARED_EXPORT PythonRunner : public QObject
{
    Q_OBJECT
 
public:
    //=========================================================================================================
    explicit PythonRunner(QObject* pParent = nullptr);
 
    //=========================================================================================================
    explicit PythonRunner(const PythonRunnerConfig& config, QObject* pParent = nullptr);
 
    //=========================================================================================================
    void setConfig(const PythonRunnerConfig& config);
 
    //=========================================================================================================
    const PythonRunnerConfig& config() const;
 
    //=========================================================================================================
    void setLineCallback(PythonLineCallback cb);
 
    //=========================================================================================================
    void setProgressCallback(PythonProgressCallback cb);
 
    //=========================================================================================================
    PythonRunnerResult run(const QString& scriptPath,
                           const QStringList& args = {});
 
    //=========================================================================================================
    PythonRunnerResult runCode(const QString& code,
                               const QStringList& args = {});
 
    //=========================================================================================================
    bool isPythonAvailable() const;
 
    //=========================================================================================================
    QString pythonVersion() const;
 
    //=========================================================================================================
    bool isPackageAvailable(const QString& packageName) const;
 
    //=========================================================================================================
    PythonRunnerResult ensureVenv();
 
    //=========================================================================================================
    PythonRunnerResult runInVenv(const QString& scriptPath,
                                 const QStringList& args = {});
 
    //=========================================================================================================
    QString venvPythonPath() const;
 
signals:
    //=========================================================================================================
    void lineReceived(int channel, const QString& line);
 
    //=========================================================================================================
    void progressUpdated(float pct, const QString& msg);
 
    //=========================================================================================================
    void finished(const UTILSLIB::PythonRunnerResult& result);
 
private:
    PythonRunnerConfig m_config;         
    PythonLineCallback m_lineCb;         
    PythonProgressCallback m_progressCb; 
 
    //=========================================================================================================
    PythonRunnerResult execute(const QStringList& fullArgs);
 
    //=========================================================================================================
    bool parseProgressLine(const QString& line, float& pct, QString& msg) const;
};
 
} // namespace UTILSLIB
 
#endif // PYTHON_RUNNER_H