Subgroup: Processing

Class: QgsProcessingAlgRunnerTask

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

Bases: qgis._core.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: Methods

cancel
childEvent
connectNotify
customEvent
disconnectNotify
finished
isCanceled
isSignalConnected
receivers
run
sender
senderSignalIndex
setProgress
timerEvent

Signals

executed Emitted when the algorithm has finished execution.

Attributes

cancel(self)
childEvent()
connectNotify()
customEvent()
disconnectNotify()
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]

finished(self, result: bool)
isCanceled()
isSignalConnected()
receivers()
run(self) → bool
sender()
senderSignalIndex()
setProgress()
timerEvent()