Class: QgsProcessingMultiStepFeedback

Processing feedback object for multi-step operations.

A processing feedback object which proxies its calls to an underlying feedback object, but scales overall progress reports to account for a number of child steps which each report their own feedback.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsProcessingFeedback	Base class for providing feedback from a processing algorithm.
QgsFeedback	Base class for feedback objects to be used for cancellation of something running in a worker thread.
QObject

Subclasses

QgsProcessingBatchFeedback

Processing feedback subclass for use when batch processing.

Methods

setCurrentStep	Sets the step which is being executed.
setStepWeights	Sets the relative weights for each step.

class qgis.core.QgsProcessingMultiStepFeedback

Bases: QgsProcessingFeedback

__init__(steps: int, feedback: QgsProcessingFeedback | None)

Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps. This feedback object will proxy calls to the specified feedback object.

Parameters:

• steps (int)

• feedback (Optional[QgsProcessingFeedback])

setCurrentStep(self, step: int)

Sets the step which is being executed. This is used to scale the current progress to account for progress through the overall process.

Parameters:

step (int)

setStepWeights(self, weights: Iterable[float])

Sets the relative weights for each step.

The weights list size must match the number of steps defined in the constructor. Weights are normalized internally, so they do not need to sum to 1.0 or 100.0.

If this is not called, all steps are assumed to have equal weight.

Warning

step weights must be set in advance before the feedback is used to report any progress

Added in version 4.0.

Parameters:

weights (Iterable[float])