Class: QgsProcessingAlgRunnerTask

class qgis.core.QgsProcessingAlgRunnerTask

Bases: QgsTask

QgsTask task which runs a QgsProcessingAlgorithm in a background task.

New in version 3.0.

QgsProcessingAlgRunnerTask(algorithm: QgsProcessingAlgorithm, parameters: Dict[str, Any], context: QgsProcessingContext, feedback: QgsProcessingFeedback = None) Constructor for QgsProcessingAlgRunnerTask. Takes an algorithm, algorithm parameters and processing context.

Methods

cancel

childEvent

connectNotify

customEvent

disconnectNotify

finished

param result

isSignalConnected

receivers

run

rtype

bool

sender

senderSignalIndex

setProgress

Sets the task's current progress.

timerEvent

Signals

executed

Emitted when the algorithm has finished execution.

cancel(self)
childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
executed

Emitted when the algorithm has finished execution. If the algorithm completed execution without errors then successful will be True. The results argument contains the results reported by the algorithm. [signal]

Parameters
  • successful (bool) –

  • results (Dict[str) –

finished(self, result: bool)
Parameters

result (bool) –

isSignalConnected(self, QMetaMethod) bool
receivers(self, PYQT_SIGNAL) int
run(self) bool
Return type

bool

sender(self) QObject
senderSignalIndex(self) int
setProgress(self, progress: float)

Sets the task’s current progress. The derived class should call this method whenever the task wants to update its progress. Calling will automatically emit the progressChanged signal.

Parameters

progress – percent of progress, from 0.0 - 100.0

timerEvent(self, QTimerEvent)