Class: QgsProxyProgressTask

class qgis.core.QgsProxyProgressTask

Bases: QgsTask

A QgsTask shell which proxies progress reports.

Simple task shell which runs until finalized and reports progress only. This is usually used to expose a blocking operation’s progress via task manager.

New in version 3.4.

QgsProxyProgressTask(description: str) Constructor for QgsProxyProgressTask, with the specified description.

Methods

childEvent

connectNotify

customEvent

disconnectNotify

finalize

Finalizes the task, with the specified result.

finished

If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination).

isCanceled

Will return True if task should terminate ASAP.

isSignalConnected

receivers

run

rtype

bool

sender

senderSignalIndex

setProgress

Sets the task’s current progress.

setProxyProgress

Sets the progress (from 0 to 100) for the proxied operation.

timerEvent

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
finalize(self, result: bool)

Finalizes the task, with the specified result.

This should be called when the operation being proxied has completed, to remove this proxy task from the task manager.

Parameters

result (bool) –

finished(self, result: bool)

If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination). The result argument reflects whether the task was successfully completed or not. This method is always called from the main thread, so it is safe to create widgets and perform other operations which require the main thread. However, the GUI will be blocked for the duration of this method so tasks should avoid performing any lengthy operations here.

isCanceled(self)bool

Will return True if task should terminate ASAP. If the task reports the CanCancel flag, then derived classes’ run() methods should periodically check this and terminate in a safe manner.

isSignalConnected(self, QMetaMethod)bool
receivers(self, PYQT_SIGNAL)int
run(self)bool
Return type

bool

sender(self)QObject
senderSignalIndex(self)int
setProgress(self, progress: float)

Sets the task’s current progress. The derived class should call this method whenever the task wants to update its progress. Calling will automatically emit the progressChanged signal.

Parameters

progress – percent of progress, from 0.0 - 100.0

setProxyProgress(self, progress: float)

Sets the progress (from 0 to 100) for the proxied operation.

This method is safe to call from the main thread.

Parameters

progress (float) –

timerEvent(self, QTimerEvent)