AvogadroLibs 1.97.0
Public Slots | Signals | Public Member Functions | Protected Attributes | List of all members
PythonScript Class Reference

The PythonScript class implements a interface for calling short-lived python utility scripts.

#include <pythonscript.h>

Inheritance diagram for PythonScript:

Public Slots

void setDebug (bool d)
 
void processFinished (int exitCode, QProcess::ExitStatus exitStatus)
 

Signals

void finished ()
 

Public Member Functions

bool debug () const
 
QString scriptFilePath () const
 
void setScriptFilePath (const QString &scriptFile)
 
bool hasErrors () const
 
void clearErrors ()
 
QStringList errorList () const
 
void setDefaultPythonInterpretor ()
 
QByteArray execute (const QStringList &args, const QByteArray &scriptStdin=QByteArray())
 
void asyncExecute (const QStringList &args, const QByteArray &scriptStdin=QByteArray())
 
QByteArray asyncResponse ()
 
 PythonScript (const QString &scriptFilePath_, QObject *parent_=nullptr)
 
 PythonScript (QObject *parent_=nullptr)
 

Protected Attributes

bool m_debug
 
QString m_pythonInterpreter
 
QString m_scriptFilePath
 
QStringList m_errors
 
QProcess * m_process
 

Constructor & Destructor Documentation

◆ PythonScript() [1/2]

PythonScript ( const QString &  scriptFilePath_,
QObject *  parent_ = nullptr 
)
explicit

Constructors

Parameters
scriptFilePath_Absolute path to python script.

◆ PythonScript() [2/2]

PythonScript ( QObject *  parent_ = nullptr)
explicit

Constructors

Parameters
scriptFilePath_Absolute path to python script.

Member Function Documentation

◆ debug()

bool debug ( ) const
Returns
True if debugging of python I/O is enabled.

◆ scriptFilePath()

QString scriptFilePath ( ) const
Returns
The path to the generator file.

◆ setScriptFilePath()

void setScriptFilePath ( const QString &  scriptFile)

Set the path to the input generator script file. This will reset any cached data held by this class.

◆ hasErrors()

bool hasErrors ( ) const
Returns
True if an error is set.

◆ clearErrors()

void clearErrors ( )

Reset the error counter.

◆ errorList()

QStringList errorList ( ) const
Returns
A QStringList containing all errors that occurred in the last call to the input generator script.

◆ setDefaultPythonInterpretor()

void setDefaultPythonInterpretor ( )

Reset the python interpretor path. The following are checked, in order:

  • The AVO_PYTHON_INTERPRETER environment variable
  • The "interpreters/python" QSettings value
  • The path specified in avogadropython.h.

◆ execute()

QByteArray execute ( const QStringList &  args,
const QByteArray &  scriptStdin = QByteArray() 
)

Start a new process to execute: "<m_pythonInterpreter> <scriptFilePath()> [args ...]", optionally passing scriptStdin to the processes standard input. Returns the standard output of the process when finished.

◆ asyncExecute()

void asyncExecute ( const QStringList &  args,
const QByteArray &  scriptStdin = QByteArray() 
)

Start a new process to execute asynchronously "<m_pythonInterpreter> <scriptFilePath()> [args ...]", optionally passing scriptStdin to the processes standard input.

Will send asyncFinished() signal when finished

◆ asyncResponse()

QByteArray asyncResponse ( )

Returns the standard output of the asynchronous process when finished.

◆ finished

void finished ( )
signal

The asynchronous execution is finished or timed out

◆ setDebug

void setDebug ( bool  d)
slot

Enable/disable debugging.

◆ processFinished

void processFinished ( int  exitCode,
QProcess::ExitStatus  exitStatus 
)
slot

Handle a finished process;


The documentation for this class was generated from the following file: