QGIS API Documentation 3.43.0-Master (58029bba303)
qgspythonrunner.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgspythonrunner.cpp
3 ---------------------
4 begin : May 2011
5 copyright : (C) 2011 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#include "qgspythonrunner.h"
16#include "qgslogger.h"
17
19
21// static methods
22
24{
25 return nullptr != sInstance;
26}
27
28bool QgsPythonRunner::run( const QString &command, const QString &messageOnError )
29{
30 if ( sInstance )
31 {
32 QgsDebugMsgLevel( "Running " + command, 3 );
33 return sInstance->runCommand( command, messageOnError );
34 }
35 else
36 {
37 QgsDebugError( QStringLiteral( "Unable to run Python command: runner not available!" ) );
38 return false;
39 }
40}
41
42bool QgsPythonRunner::runFile( const QString &filename, const QString &messageOnError )
43{
44 if ( sInstance )
45 {
46 QgsDebugMsgLevel( "Running " + filename, 3 );
47 return sInstance->runFileCommand( filename, messageOnError );
48 }
49 else
50 {
51 QgsDebugError( QStringLiteral( "Unable to run Python command: runner not available!" ) );
52 return false;
53 }
54}
55
56bool QgsPythonRunner::eval( const QString &command, QString &result )
57{
58 if ( sInstance )
59 {
60 return sInstance->evalCommand( command, result );
61 }
62 else
63 {
64 QgsDebugError( QStringLiteral( "Unable to run Python command: runner not available!" ) );
65 return false;
66 }
67}
68
69bool QgsPythonRunner::setArgv( const QStringList &arguments, const QString &messageOnError )
70{
71 if ( sInstance )
72 {
73 return sInstance->setArgvCommand( arguments, messageOnError );
74 }
75 else
76 {
77 QgsDebugError( QStringLiteral( "Unable to run Python command: runner not available!" ) );
78 return false;
79 }
80}
81
83{
84 delete sInstance;
85 sInstance = runner;
86}
87
Utility class for running Python commands from various parts of QGIS.
static bool setArgv(const QStringList &arguments, const QString &messageOnError=QString())
Set sys.argv.
static bool run(const QString &command, const QString &messageOnError=QString())
Execute a Python statement.
virtual bool evalCommand(QString command, QString &result)=0
Evaluates the given expression, producing a result.
virtual bool runFileCommand(const QString &filename, const QString &messageOnError=QString())=0
Runs the code from the given file.
static void setInstance(QgsPythonRunner *runner)
Assign an instance of Python runner so that run() can be used.
static bool eval(const QString &command, QString &result)
Eval a Python statement.
virtual bool runCommand(QString command, QString messageOnError=QString())=0
Runs the given statement.
virtual bool setArgvCommand(const QStringList &arguments, const QString &messageOnError=QString())=0
Sets sys.argv to the given arguments.
static QgsPythonRunner * sInstance
static bool runFile(const QString &filename, const QString &messageOnError=QString())
Execute a Python filename, showing an error message if one occurred.
static bool isValid()
Returns true if the runner has an instance (and thus is able to run commands)
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:41
#define QgsDebugError(str)
Definition qgslogger.h:40