Class: QgsProcessingFeatureSourceDefinition¶

class qgis.core.QgsProcessingFeatureSourceDefinition¶

Bases: sip.wrapper

Encapsulates settings relating to a feature source input to a processing algorithm.

New in version 3.0.

QgsProcessingFeatureSourceDefinition(source: str = ‘’, selectedFeaturesOnly: bool = False, featureLimit: int = -1, flags: Union[QgsProcessingFeatureSourceDefinition.Flags, QgsProcessingFeatureSourceDefinition.Flag] = QgsProcessingFeatureSourceDefinition.Flags(), geometryCheck: QgsFeatureRequest.InvalidGeometryCheck = QgsFeatureRequest.GeometryAbortOnInvalid, filterExpression: str = ‘’) Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source.

If selectedFeaturesOnly is True, then only selected features from the source will be used.

The optional featureLimit can be set to a value > 0 to place a hard limit on the maximum number of features which will be read from the source.

Since QGIS 3.32, the optional filterExpression argument can be used to specify a expression to use to filter the features read from the source.

The flags argument can be used to specify flags which dictate the source behavior.

If the QgsProcessingFeatureSourceDefinition.Flag.FlagOverrideDefaultGeometryCheck is set in flags, then the value of geometryCheck will override the default geometry check method (as dictated by QgsProcessingContext) for this source.

QgsProcessingFeatureSourceDefinition(source: QgsProperty, selectedFeaturesOnly: bool = False, featureLimit: int = -1, flags: Union[QgsProcessingFeatureSourceDefinition.Flags, QgsProcessingFeatureSourceDefinition.Flag] = QgsProcessingFeatureSourceDefinition.Flags(), geometryCheck: QgsFeatureRequest.InvalidGeometryCheck = QgsFeatureRequest.GeometryAbortOnInvalid, filterExpression: str = ‘’) Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source.

If selectedFeaturesOnly is True, then only selected features from the source will be used.

The optional featureLimit can be set to a value > 0 to place a hard limit on the maximum number of features which will be read from the source.

Since QGIS 3.32, the optional filterExpression argument can be used to specify a expression to use to filter the features read from the source.

The flags argument can be used to specify flags which dictate the source behavior.

If the QgsProcessingFeatureSourceDefinition.Flag.FlagOverrideDefaultGeometryCheck is set in flags, then the value of geometryCheck will override the default geometry check method (as dictated by QgsProcessingContext) for this source.

QgsProcessingFeatureSourceDefinition(QgsProcessingFeatureSourceDefinition)

Methods

loadVariant

Loads this source definition from a QVariantMap, wrapped in a QVariant.

toVariant

Saves this source definition to a QVariantMap, wrapped in a QVariant.

Attributes

FlagCreateIndividualOutputPerInputFeature

FlagOverrideDefaultGeometryCheck

class Flag¶: Bases: int

FlagCreateIndividualOutputPerInputFeature = 2¶

FlagOverrideDefaultGeometryCheck = 1¶

class Flags¶
class Flags(Union[QgsProcessingFeatureSourceDefinition.Flags, QgsProcessingFeatureSourceDefinition.Flag])
class Flags(QgsProcessingFeatureSourceDefinition.Flags): Bases: sip.wrapper

featureLimit¶

filterExpression¶

flags¶

geometryCheck¶

loadVariant(self, map: Dict[str, Any]) → bool¶

Loads this source definition from a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.readVariant to load it from an XML document.