Class: QgsProcessingFeatureSourceDefinition

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

Enums

Flag	alias of ProcessingFeatureSourceDefinitionFlag

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

featureLimit	If set to a value > 0, places a limit on the maximum number of features which will be read from the source.
filterExpression	Optional expression filter to use for filtering features which will be read from the source.
flags	Flags which dictate source behavior.
geometryCheck	Geometry check method to apply to this source.
selectedFeaturesOnly	True if only selected features in the source should be used by algorithms.
source	Source definition.

class qgis.core.QgsProcessingFeatureSourceDefinition

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:

• source (Optional[str] = '')

• selectedFeaturesOnly (bool = False)

• featureLimit (int = -1)

• flags (Union[Qgis.ProcessingFeatureSourceDefinitionFlags, Qgis.ProcessingFeatureSourceDefinitionFlag] = Qgis.ProcessingFeatureSourceDefinitionFlags())

• geometryCheck (Qgis.InvalidGeometryCheck = Qgis.InvalidGeometryCheck.AbortOnInvalid)

• filterExpression (Optional[str] = '')

__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:

• source (QgsProperty)

• selectedFeaturesOnly (bool = False)

• featureLimit (int = -1)

• flags (Union[Qgis.ProcessingFeatureSourceDefinitionFlags, Qgis.ProcessingFeatureSourceDefinitionFlag] = Qgis.ProcessingFeatureSourceDefinitionFlags())

• geometryCheck (Qgis.InvalidGeometryCheck = Qgis.InvalidGeometryCheck.AbortOnInvalid)

• filterExpression (Optional[str] = '')

__init__(a0: QgsProcessingFeatureSourceDefinition)

Parameters:

a0 (QgsProcessingFeatureSourceDefinition)

Flag

alias of ProcessingFeatureSourceDefinitionFlag

Flags

alias of ProcessingFeatureSourceDefinitionFlags

featureLimit

If set to a value > 0, places a limit on the maximum number of features which will be read from the source.

Added in version 3.14.

filterExpression

Optional expression filter to use for filtering features which will be read from the source.

Added in version 3.32.

flags

Flags which dictate source behavior.

Added in version 3.14.

geometryCheck

Geometry check method to apply to this source. This setting is only utilized if the Qgis.ProcessingFeatureSourceDefinitionFlag.OverrideDefaultGeometryCheck is set in QgsProcessingFeatureSourceDefinition.flags.

Added in version 3.14.

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.

See also

toVariant()

Added in version 3.14.

Parameters:

map (Dict[str, Any])

Return type:

bool

selectedFeaturesOnly

True if only selected features in the source should be used by algorithms.

source

Source definition. Usually a static property set to a source layer’s ID or file name.

toVariant(self) → Any

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