Class: QgsProcessingFeedback¶

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.

List of all members, including inherited members

Class Hierarchy¶

Base classes¶

`QgsFeedback`	Base class for feedback objects to be used for cancellation of something running in a worker thread.
QObject

Subclasses¶

QgsProcessingMultiStepFeedback

Processing feedback object for multi-step operations.

Constructor

__init__

Methods

`pushFormattedResults`	Pushes a summary of the execution results to the log
`pushVersionInfo`	Pushes a summary of the QGIS (and underlying library) version information to the log.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsProcessingFeedback. See the FAQ for more details.

`htmlLog`	Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object.
`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.
`pushFormattedMessage`	Pushes a pre-formatted message from the algorithm.
`pushInfo`	Pushes a general informational message from the algorithm.
`pushWarning`	Pushes a warning informational message from the algorithm.
`reportError`	Reports that the algorithm encountered an error while executing.
`setProgressText`	Sets a progress report text string.
`textLog`	Returns the plain text contents of the log, which contains all messages pushed to the feedback object.

Signals

`commandInfoPushed`	Emitted when command information text is pushed.
`consoleInfoPushed`	Emitted when console information text is pushed.
`debugInfoPushed`	Emitted when debug information text is pushed.
`errorReported`	Emitted when an error is reported.
`formattedMessagePushed`	Emitted when a formatted html message is pushed.
`infoPushed`	Emitted when information text is pushed.
`progressTextChanged`	Emitted when the progress text is changed.
`warningPushed`	Emitted when an warning is pushed.

class qgis.core.QgsProcessingFeedback[source]¶

Bases: QgsFeedback

__init__(logFeedback: bool = True)¶

Constructor for QgsProcessingFeedback.

If logFeedback is True, then all feedback received will be directed to QgsMessageLog.

Parameters:: logFeedback (bool = True)

signal commandInfoPushed(text: str)[source]¶

Emitted when command information text is pushed.

See also

pushCommandInfo()

Added in version 4.2.

Parameters:: text (str)

signal consoleInfoPushed(text: str)[source]¶

Emitted when console information text is pushed.

See also

pushConsoleInfo()

Added in version 4.2.

Parameters:: text (str)

signal debugInfoPushed(text: str)[source]¶

Emitted when debug information text is pushed.

See also

pushDebugInfo()

Added in version 4.2.

Parameters:: text (str)

signal errorReported(text: str, fatalError: bool)[source]¶

Emitted when an error is reported.

See also

reportError()

Added in version 4.2.

Parameters:

text (str)
fatalError (bool)

signal formattedMessagePushed(html: str)[source]¶

Emitted when a formatted html message is pushed.

See also

pushFormattedMessage()

Added in version 4.2.

Parameters:: html (str)

virtual htmlLog(self) → str[source]¶

Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object.

See also

textLog()

Added in version 3.14.

Return type:: str

signal infoPushed(text: str)[source]¶

Emitted when information text is pushed.

See also

pushInfo()

Added in version 4.2.

Parameters:: text (str)

signal progressTextChanged(text: str)[source]¶

Emitted when the progress text is changed.

See also

setProgressText()

Added in version 4.2.

Parameters:: text (str)

virtual pushCommandInfo(self, info: str | None)[source]¶

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

See also

See also

See also

See also

Parameters:: info (Optional[str])

virtual pushConsoleInfo(self, info: str | None)[source]¶

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

See also

See also

See also

See also

See also

Parameters:: info (Optional[str])

virtual pushDebugInfo(self, info: str | None)[source]¶

Pushes an informational message containing debugging helpers from the algorithm.

See also

See also

See also

See also

See also

Parameters:: info (Optional[str])

virtual pushFormattedMessage(self, html: str | None, text: str | None)[source]¶

Pushes a pre-formatted message from the algorithm.

This can be used to push formatted HTML messages to the feedback object. A plain text version of the message must also be specified.

See also

formattedMessagePushed

See also

See also

See also

See also

See also

Added in version 3.36.

Parameters:

html (Optional[str])
text (Optional[str])

pushFormattedResults(self, algorithm: QgsProcessingAlgorithm | None, context: QgsProcessingContext, results: dict[str | None, Any])[source]¶

Pushes a summary of the execution results to the log

Added in version 3.36.

Parameters:

algorithm (Optional[QgsProcessingAlgorithm])
context (QgsProcessingContext)
results (dict[Optional[str], Any])

virtual pushInfo(self, info: str | None)[source]¶

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

infoPushed

See also

pushFormattedMessage()

See also

See also

See also

See also

Parameters:: info (Optional[str])

pushVersionInfo(self, provider: QgsProcessingProvider | None = None)[source]¶

Pushes a summary of the QGIS (and underlying library) version information to the log.

Added in version 3.4.7.

Parameters:: provider (Optional[QgsProcessingProvider] = None)

virtual pushWarning(self, warning: str | None)[source]¶

Pushes a warning informational message from the algorithm. This should only be used sparsely as to maintain the importance of visual queues associated to this type of message.

See also

See also

See also

See also

See also

Added in version 3.16.2.

Parameters:: warning (Optional[str])

virtual reportError(self, error: str | None, fatalError: bool = False)[source]¶

Reports that the algorithm encountered an error while executing.

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

See also

errorReported

Parameters:

error (Optional[str])
fatalError (bool = False)

virtual setProgressText(self, text: str | None)[source]¶

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

See also

progressTextChanged