Class: QgsProcessingFeatureSourceDefinition

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

class qgis.core.QgsProcessingFeatureSourceDefinition[source]

Bases: object

__init__(source: str | None = '', selectedFeaturesOnly: bool = False, featureLimit: int = -1, flags: Qgis.ProcessingFeatureSourceDefinitionFlags | Qgis.ProcessingFeatureSourceDefinitionFlag = Qgis.ProcessingFeatureSourceDefinitionFlags(), geometryCheck: Qgis.InvalidGeometryCheck = Qgis.InvalidGeometryCheck.AbortOnInvalid, filterExpression: str | None = '')

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 Qgis.ProcessingFeatureSourceDefinitionFlag.OverrideDefaultGeometryCheck is set in flags, then the value of geometryCheck will override the default geometry check method (as dictated by QgsProcessingContext) for this source.

Parameters:
__init__(source: QgsProperty, selectedFeaturesOnly: bool = False, featureLimit: int = -1, flags: Qgis.ProcessingFeatureSourceDefinitionFlags | Qgis.ProcessingFeatureSourceDefinitionFlag = Qgis.ProcessingFeatureSourceDefinitionFlags(), geometryCheck: Qgis.InvalidGeometryCheck = Qgis.InvalidGeometryCheck.AbortOnInvalid, filterExpression: str | None = '')

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 Qgis.ProcessingFeatureSourceDefinitionFlag.OverrideDefaultGeometryCheck is set in flags, then the value of geometryCheck will override the default geometry check method (as dictated by QgsProcessingContext) for this source.

Parameters:
__init__(a0: QgsProcessingFeatureSourceDefinition)
Parameters:

a0 (QgsProcessingFeatureSourceDefinition)

Flag

alias of ProcessingFeatureSourceDefinitionFlag

Flags

alias of ProcessingFeatureSourceDefinitionFlags

featureLimit: int
filterExpression: str
flags: ProcessingFeatureSourceDefinitionFlags
geometryCheck: InvalidGeometryCheck
loadVariant(self, map: Dict[str, Any]) → bool[source]

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

See also

toVariant()

Added in version 3.14.

Parameters:

map (Dict[str, Any])

Return type:

bool

selectedFeaturesOnly: bool
source: QgsProperty
toVariant(self) → Any[source]

Saves this source definition to a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.writeVariant to save it to an XML document.

See also

loadVariant()

Added in version 3.14.

Return type:

Any