Class: QgsCopyFileTask

class qgis.core.QgsCopyFileTask

Bases: QgsTask

Task to copy a file on disk

New in version 3.22.

QgsCopyFileTask(source: str, destination: str) Creates a task that copy source file to destination

Methods

childEvent

connectNotify

customEvent

destination

It could be different from the original one.

disconnectNotify

errorString

Returns errorString if an error occurred, else returns null QString

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.

timerEvent

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
destination(self) str

It could be different from the original one. If original destination was a directory the returned destination is now the absolute file path of the copied file

Return type

str

disconnectNotify(self, QMetaMethod)
errorString(self) str

Returns errorString if an error occurred, else returns null QString

Return type

str

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

timerEvent(self, QTimerEvent)