Subgroup: Processing

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

`blockSignals`
`cancel`	Tells the internal routines that the current operation should be canceled.
`childEvent`
`children`
`connectNotify`
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`inherits`
`installEventFilter`
`isCanceled`	Tells whether the operation has been canceled already
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`metaObject`
`moveToThread`
`objectName`
`parent`
`progress`	Returns the current progress reported by the feedback object.
`property`
`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.
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`reportError`	Reports that the algorithm encountered an error which prevented it from successfully executing.
`sender`
`senderSignalIndex`
`setObjectName`
`setParent`
`setProgress`	Sets the current progress for the feedback object.
`setProgressText`	Sets a progress report text string.
`setProperty`
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`

Attributes

`canceled`	Internal routines can connect to this signal if they use event loop [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`progressChanged`	Emitted when the feedback object reports a progress change.
`staticMetaObject`

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()

See also

pushConsoleInfo()

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()

See also

pushCommandInfo()

pushDebugInfo(self, info: str)¶: Pushes an informational message containing debugging helpers from the algorithm.

See also

pushInfo()

See also

pushCommandInfo()

See also

pushConsoleInfo()

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

pushCommandInfo()

See also

pushDebugInfo()

See also

pushConsoleInfo()

receivers()¶

reportError(self, error: str)¶: Reports that the algorithm encountered an error which prevented it from successfully 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()¶