Class: QgsProcessingRegistry

class qgis.core.QgsProcessingRegistry(parent: QObject = None)

Bases: PyQt5.QtCore.QObject

Constructor for QgsProcessingRegistry.

Registry for various processing components, including providers, algorithms and various parameters and outputs.

QgsProcessingRegistry is not usually directly created, but rather accessed through QgsApplication.processingRegistry()

New in version 3.0: Methods

addParameterType Register a new parameter type for processing.
addProvider Add a processing provider to the registry.
algorithmById Finds an algorithm by its ID.
algorithms Returns a list of all available algorithms from registered providers.
childEvent
connectNotify
createAlgorithmById Creates a new instance of an algorithm by its ID.
customEvent
disconnectNotify
isSignalConnected
parameterType Returns the parameter type registered for id.
parameterTypes Returns a list with all known parameter types.
providerById Returns a matching provider by provider ID.
providers Gets list of available providers.
receivers
removeParameterType Unregister a custom parameter type from processing.
removeProvider Removes a provider implementation from the registry (the provider object is deleted).
sender
senderSignalIndex
timerEvent

Signals

parameterTypeAdded Emitted when a new parameter type has been added to the registry.
parameterTypeRemoved Emitted when a parameter type has been removed from the registry and is about to be deleted.
providerAdded Emitted when a provider has been added to the registry.
providerRemoved Emitted when a provider is removed from the registry [signal]

Attributes

addParameterType(self, type: QgsProcessingParameterType) → bool

Register a new parameter type for processing. Ownership is transferred to the registry. Will emit parameterTypeAdded.

New in version 3.2.

addProvider(self, provider: QgsProcessingProvider) → bool

Add a processing provider to the registry. Ownership of the provider is transferred to the registry, and the provider’s parent will be set to the registry. Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists in the registry). Adding a provider to the registry automatically triggers the providers QgsProcessingProvider.load() method to populate the provider with algorithms.

See also

removeProvider()

algorithmById(self, id: str) → QgsProcessingAlgorithm

Finds an algorithm by its ID. If no matching algorithm is found, a None is returned.

See also

algorithms()

algorithms(self) → List[QgsProcessingAlgorithm]

Returns a list of all available algorithms from registered providers.

See also

algorithmById()

childEvent()
connectNotify()
createAlgorithmById(self, id: str, configuration: Dict[str, Any] = {}) → QgsProcessingAlgorithm

Creates a new instance of an algorithm by its ID. If no matching algorithm is found, a None is returned. Callers take responsibility for deleting the returned object.

The configuration argument allows passing of a map of configuration settings to the algorithm, allowing it to dynamically adjust its initialized parameters and outputs according to this configuration. This is generally used only for algorithms in a model, allowing them to adjust their behavior at run time according to some user configuration.

See also

algorithms()

See also

algorithmById()

customEvent()
disconnectNotify()
isSignalConnected()
parameterType(self, id: str) → QgsProcessingParameterType

Returns the parameter type registered for id.

New in version 3.2.

parameterTypeAdded

Emitted when a new parameter type has been added to the registry.

New in version 3.2: [signal]

parameterTypeRemoved

Emitted when a parameter type has been removed from the registry and is about to be deleted.

New in version 3.2: [signal]

parameterTypes(self) → object

Returns a list with all known parameter types.

New in version 3.2.

providerAdded

Emitted when a provider has been added to the registry. [signal]

providerById(self, id: str) → QgsProcessingProvider

Returns a matching provider by provider ID.

providerRemoved

Emitted when a provider is removed from the registry [signal]

providers(self) → object

Gets list of available providers.

receivers()
removeParameterType(self, type: QgsProcessingParameterType)

Unregister a custom parameter type from processing. The type will be deleted. Will emit parameterTypeRemoved.

New in version 3.2.

removeProvider(self, provider: QgsProcessingProvider) → bool

Removes a provider implementation from the registry (the provider object is deleted). Returns false if the provider could not be removed (eg provider does not exist in the registry).

See also

addProvider()

removeProvider(self, providerId: str) -> bool Removes a provider implementation from the registry (the provider object is deleted). Returns false if the provider could not be removed (eg provider does not exist in the registry).

See also

addProvider()

sender()
senderSignalIndex()
timerEvent()