Class: QgsProcessingAlgRunnerTask

QgsTask task which runs a QgsProcessingAlgorithm in a background task.

Class Hierarchy

Base classes

QgsTask	Abstract base class for long running background tasks.
QObject

class qgis.core.QgsProcessingAlgRunnerTask

Bases: QgsTask

__init__(algorithm: QgsProcessingAlgorithm | None, parameters: Dict[str, Any], context: QgsProcessingContext, feedback: QgsProcessingFeedback | None = None, flags: 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.

Parameters:

• algorithm (Optional[QgsProcessingAlgorithm])

• parameters (Dict[str, Any])

• context (QgsProcessingContext)

• feedback (Optional[QgsProcessingFeedback] = None)

• flags (Union[QgsTask.Flags, QgsTask.Flag] = QgsTask.CanCancel)

algorithmCanceled(self) → bool

Returns True if the algorithm was canceled.

Added in version 3.26.

Return type:

bool

signal 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.