Subgroup: Processing

Class: QgsProcessingRegistry¶

class qgis.core.QgsProcessingRegistry¶

Bases: PyQt5.QtCore.QObject

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

`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.
`blockSignals`
`childEvent`
`children`
`connectNotify`
`createAlgorithmById`	Creates a new instance of an algorithm by its ID.
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`inherits`
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`metaObject`
`moveToThread`
`objectName`
`parent`
`property`
`providerById`	Returns a matching provider by provider ID.
`providers`	Get list of available providers.
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`removeProvider`	Removes a provider implementation from the registry (the provider object is deleted).
`sender`
`senderSignalIndex`
`setObjectName`
`setParent`
`setProperty`
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`

Attributes

`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`providerAdded`	Emitted when a provider has been added to the registry.
`providerRemoved`	Emitted when a provider is removed from the registry [signal]
`staticMetaObject`

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()

See also

createAlgorithmById()

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] = QVariantMap()) → 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()¶

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¶: Get list of available providers.

receivers()¶

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()¶