Class: QgsProcessingAlgRunnerTask

class qgis.core.QgsProcessingAlgRunnerTask(algorithm: QgsProcessingAlgorithm, parameters: Dict[str, Any], context: QgsProcessingContext, feedback: QgsProcessingFeedback = None)

Bases: QgsTask

Constructor for QgsProcessingAlgRunnerTask. Takes an algorithm, algorithm parameters and processing context.

QgsTask task which runs a QgsProcessingAlgorithm in a background task.

New in version 3.0.

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

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]

  • successful (bool) –

  • results (Dict[str) –

finished(self, result: bool)

result (bool) –

isCanceled(self) → bool

Will return True if task should terminate ASAP. If the task reports the CanCancel flag, then derived classes’ run() methods should periodically check this and terminate in a safe manner.

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


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.


progress – percent of progress, from 0.0 - 100.0

timerEvent(self, QTimerEvent)