Class: QgsProcessingParameterFeatureSink

class qgis.core.QgsProcessingParameterFeatureSink

Bases: QgsProcessingDestinationParameter

A feature sink output for processing algorithms.

A parameter which represents the destination feature sink for features created by an algorithm.

New in version 3.0.

QgsProcessingParameterFeatureSink(name: str, description: str = ‘’, type: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False, createByDefault: bool = True, supportsAppend: bool = False) Constructor for QgsProcessingParameterFeatureSink.

If createByDefault is False and the parameter is optional, then this destination output will not be created by default.

QgsProcessingParameterFeatureSink(QgsProcessingParameterFeatureSink)

Methods

asPythonString

param outputType:

asScriptCode

rtype:

str

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

createFileFilter

rtype:

str

dataType

Returns the layer type for sinks associated with the parameter.

defaultFileExtension

rtype:

str

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

fromScriptCode

Creates a new parameter using the definition from a script code.

fromVariantMap

param map:

generateTemporaryDestination

param context:

hasGeometry

Returns True if sink is likely to include geometries.

originalProvider

Original (source) provider which this parameter has been derived from.

setDataType

Sets the layer type for the sinks associated with the parameter.

setSupportsAppend

Sets whether the sink supports appending features to an existing table.

supportedOutputVectorLayerExtensions

Returns a list of the vector format file extensions supported by this parameter.

supportsAppend

Returns True if the sink supports appending features to an existing table.

toOutputDefinition

rtype:

QgsProcessingOutputDefinition

toVariantMap

rtype:

Dict[str, Any]

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value:
asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str
Parameters:

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type:

str

asScriptCode(self) → str
Return type:

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
Parameters:
Return type:

bool

clone(self) → QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

createFileFilter(self) → str
Return type:

str

dataType(self) → QgsProcessing.SourceType

Returns the layer type for sinks associated with the parameter.

See also

setDataType()

Return type:

QgsProcessing.SourceType

defaultFileExtension(self) → str
Return type:

str

defaultGuiValueFromSetting(self) → Any

Default gui value for an algorithm parameter from settings

Returns:

default value from settings or invalid QVariant if there is no default value defined in the settings

New in version 3.34.

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFeatureSink

Creates a new parameter using the definition from a script code.

Parameters:

  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type:

QgsProcessingParameterFeatureSink

fromVariantMap(self, map: Dict[str, Any]) → bool
Parameters:

map (Dict[str) –

Return type:

bool

generateTemporaryDestination(self, context: QgsProcessingContext = None) → str
Parameters:

context (QgsProcessingContext = None) –

Return type:

str

hasGeometry(self) → bool

Returns True if sink is likely to include geometries. In cases were presence of geometry cannot be reliably determined in advance, this method will default to returning True.

Return type:

bool

originalProvider(self) → QgsProcessingProvider

Original (source) provider which this parameter has been derived from. In the case of destination parameters which are part of model algorithms, this will reflect the child algorithm’s provider which actually generates the parameter, as opposed to the provider which this parameter belongs to (i.e. the model provider)

New in version 3.2.

setDataType(self, type: QgsProcessing.SourceType)

Sets the layer type for the sinks associated with the parameter.

See also

dataType()

Parameters:

type (QgsProcessing.SourceType) –

setSupportsAppend(self, supportsAppend: bool)

Sets whether the sink supports appending features to an existing table.

Warning

A sink only supports appending if the algorithm implements QgsProcessingAlgorithm.sinkProperties for the sink parameter.

See also

supportsAppend()

New in version 3.14.

Parameters:

supportsAppend (bool) –

supportedOutputVectorLayerExtensions(self) → List[str]

Returns a list of the vector format file extensions supported by this parameter.

See also

defaultFileExtension()

New in version 3.2.

Return type:

List[str]

supportsAppend(self) → bool

Returns True if the sink supports appending features to an existing table.

A sink only supports appending if the algorithm implements QgsProcessingAlgorithm.sinkProperties for the sink parameter.

See also

setSupportsAppend()

New in version 3.14.

Return type:

bool

toOutputDefinition(self) → QgsProcessingOutputDefinition
Return type:

QgsProcessingOutputDefinition

toVariantMap(self) → Dict[str, Any]
Return type:

Dict[str, Any]

type(self) → str
Return type:

str

typeName() → str

Returns the type name for the parameter class.

Return type:

str

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str
Parameters:
Return type:

str