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, flags: Union[QgsTask.Flags, QgsTask.Flag] = QgsTask.CanCancel) Constructor for QgsProcessingAlgRunnerTask. Takes an algorithm, algorithm parameters and processing context.

Since QGIS 3.26, the flags argument allows control over task flags.

Methods

algorithmCanceled

Returns True if the algorithm was canceled.

cancel

childEvent

connectNotify

customEvent

disconnectNotify

finished

param result

isCanceled

Will return True if task should terminate ASAP.

isSignalConnected

receivers

run

rtype

bool

sender

senderSignalIndex

setProgress

Sets the task's current progress.

timerEvent

Signals

executed

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

algorithmCanceled(self) bool

Returns True if the algorithm was canceled.

New in version 3.26.

Return type

bool

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

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

finished(self, result: bool)
Parameters

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

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)