Class: QgsProcessingParameterType

class qgis.core.QgsProcessingParameterType

Bases: sip.wrapper

Makes metadata of processing parameters available.

New in version 3.2: Enums

Methods

acceptedPythonTypes

Returns a list of the Python data types accepted as values for the parameter.

create

Creates a new parameter of this type.

description

A human readable and translatable description for this parameter type.

flags

Determines if this parameter is available in the modeler.

id

A static id for this type which will be used for storing this parameter type.

metadata

Metadata for this parameter type.

name

A human readable and translatable short name for this parameter type.

Signals

Attributes

ExposeToModeler

ExposeToModeler = 1
class ParameterFlag

Bases: int

class ParameterFlags

Bases: sip.wrapper

QgsProcessingParameterType.ParameterFlags(Union[QgsProcessingParameterType.ParameterFlags, QgsProcessingParameterType.ParameterFlag]) QgsProcessingParameterType.ParameterFlags(QgsProcessingParameterType.ParameterFlags)

acceptedPythonTypes(self) → List[str]

Returns a list of the Python data types accepted as values for the parameter. E.g. “str”, “QgsVectorLayer”, “QgsMapLayer”, etc.

These values should should match the Python types exactly (e.g. “str” not “string”, “bool” not “boolean”). Extra explanatory help can be used (which must be translated), eg “str: as comma delimited list of numbers”.

create(self, name: str) → QgsProcessingParameterDefinition

Creates a new parameter of this type.

description(self) → str

A human readable and translatable description for this parameter type. This can be a longer description suitable for tooltips and other elements that give the user context for a given parameter.

flags(self) → QgsProcessingParameterType.ParameterFlags

Determines if this parameter is available in the modeler. The default implementation returns true.

id(self) → str

A static id for this type which will be used for storing this parameter type.

metadata(self) → Dict[str, Any]

Metadata for this parameter type. Can be used for example to define custom widgets. The default implementation returns an empty map.

name(self) → str

A human readable and translatable short name for this parameter type. This will be used in comboboxes and list widgets.