Class: QgsVectorFileWriterTask

QgsTask task which performs a QgsVectorFileWriter layer saving operation as a background task.

This can be used to save a vector layer out to a file without blocking the QGIS interface.

See also

QgsVectorLayerExporterTask

See also

QgsRasterFileWriterTask

Class Hierarchy

Inheritance diagram of qgis.core.QgsVectorFileWriterTask

Base classes

QgsTask

Abstract base class for long running background tasks.

QObject
class qgis.core.QgsVectorFileWriterTask[source]

Bases: QgsTask

__init__(layer: QgsVectorLayer | None, fileName: str | None, options: QgsVectorFileWriter.SaveVectorOptions, sinkFlags: QgsFeatureSink.SinkFlags | QgsFeatureSink.SinkFlag = QgsFeatureSink.SinkFlags())

Constructor for QgsVectorFileWriterTask. Takes a source layer, destination fileName and save options.

Since QGIS 3.40 the sinkFlags can be specified.

Parameters:
signal errorOccurred[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal writeComplete[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.