Class: QgsProcessingFeedback

class qgis.core.QgsProcessingFeedback

Bases: qgis._core.QgsFeedback

Base class for providing feedback from a processing algorithm.

This base class implementation silently ignores all feedback reported by algorithms. Subclasses of QgsProcessingFeedback can be used to log this feedback or report it to users via the GUI.

New in version 3.0: Methods

childEvent
connectNotify
customEvent
disconnectNotify
isSignalConnected
pushCommandInfo Pushes an informational message containing a command from the algorithm.
pushConsoleInfo Pushes a console feedback message from the algorithm.
pushDebugInfo Pushes an informational message containing debugging helpers from the algorithm.
pushInfo Pushes a general informational message from the algorithm.
receivers
reportError Reports that the algorithm encountered an error while executing.
sender
senderSignalIndex
setProgressText Sets a progress report text string.
timerEvent

Signals

Attributes

childEvent()
connectNotify()
customEvent()
disconnectNotify()
isSignalConnected()
pushCommandInfo(self, info: str)

Pushes an informational message containing a command from the algorithm. This is usually used to report commands which are executed in an external application or as subprocesses.

See also

pushInfo()

See also

pushDebugInfo()

pushConsoleInfo(self, info: str)

Pushes a console feedback message from the algorithm. This is used to report the output from executing an external command or subprocess.

See also

pushInfo()

See also

pushDebugInfo()

pushDebugInfo(self, info: str)

Pushes an informational message containing debugging helpers from the algorithm.

See also

pushInfo()

pushInfo(self, info: str)

Pushes a general informational message from the algorithm. This can be used to report feedback which is neither a status report or an error, such as “Found 47 matching features”.

See also

pushDebugInfo()

receivers()
reportError(self, error: str, fatalError: bool = False)

Reports that the algorithm encountered an error while executing.

If fatalError is true then the error prevented the algorithm from executing.

sender()
senderSignalIndex()
setProgressText(self, text: str)

Sets a progress report text string. This can be used in conjunction with setProgress() to provide detailed progress reports, such as “Transformed 4 of 5 layers”.

See also

setProgress()

timerEvent()