Class: QgsProcessingParametersGenerator

An interface for objects which can create sets of parameter values for processing algorithms.

Added in version 3.14.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createProcessingParameters()

Class Hierarchy

Inheritance diagram of qgis.gui.QgsProcessingParametersGenerator

Subclasses

QgsProcessingAlgorithmDialogBase

Base class for processing algorithm dialogs.

QgsProcessingParametersWidget

A widget which allows users to select the value for the parameters for an algorithm.

Enums

Flag

Flags controlling parameter generation.

Abstract Methods

createProcessingParameters

This method needs to be reimplemented in all classes which implement this interface and return a algorithm parameters.
class qgis.gui.QgsProcessingParametersGenerator[source]

Bases: object

class Flag(*values)

Bases: IntEnum

Flags controlling parameter generation.

Added in version 3.24.

  • SkipDefaultValueParameters: Parameters which are unchanged from their default values should not be included

  • SkipValidation: Skip validation of parameters.

    Added in version 3.44.

SkipDefaultValueParameters = 1
SkipValidation = 2
class Flags
class Flags(f: QgsProcessingParametersGenerator.Flags | QgsProcessingParametersGenerator.Flag)
class Flags(a0: QgsProcessingParametersGenerator.Flags)

Bases: object

abstract createProcessingParameters(self, flags: QgsProcessingParametersGenerator.Flags | QgsProcessingParametersGenerator.Flag = QgsProcessingParametersGenerator.Flags()) → Dict[str, Any][source]

This method needs to be reimplemented in all classes which implement this interface and return a algorithm parameters.

Since QGIS 3.24 the optional flags argument can be used to control the behavior of the parameter generation.

Parameters:

flags (Union[QgsProcessingParametersGenerator.Flags, QgsProcessingParametersGenerator.Flag] = QgsProcessingParametersGenerator.Flags())

Return type:

Dict[str, Any]