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 throughQgsApplication.processingRegistry()
New in version 3.0.
- Parameters
parent –
-
addParameterType
(self, type: QgsProcessingParameterType) → bool¶ Register a new parameter type for processing. Ownership is transferred to the registry. Will emit parameterTypeAdded.
See also
New in version 3.2.
- Parameters
type (QgsProcessingParameterType) –
- Return type
bool
-
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
- Parameters
provider (QgsProcessingProvider) –
- Return type
bool
-
algorithmById
(self, id: str) → QgsProcessingAlgorithm¶ Finds an algorithm by its ID. If no matching algorithm is found, a None is returned.
See also
See also
- Parameters
id (str) –
- Return type
-
algorithms
(self) → List[QgsProcessingAlgorithm]¶ Returns a list of all available algorithms from registered providers.
See also
- Return type
List[QgsProcessingAlgorithm]
-
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
See also
- Parameters
id (str) –
configuration (Dict[str) –
- Return type
-
customEvent
()¶
-
disconnectNotify
()¶
-
isSignalConnected
()¶
-
parameterType
(self, id: str) → QgsProcessingParameterType¶ Returns the parameter type registered for
id
.New in version 3.2.
- Parameters
id (str) –
- Return type
-
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.
- Return type
object
-
providerAdded
¶ Emitted when a provider has been added to the registry. [signal]
-
providerById
(self, id: str) → QgsProcessingProvider¶ Returns a matching provider by provider ID.
- Parameters
id (str) –
- Return type
-
providerRemoved
¶ Emitted when a provider is removed from the registry [signal]
-
providers
(self) → object¶ Gets list of available providers.
- Return type
object
-
receivers
()¶
-
removeParameterType
(self, type: QgsProcessingParameterType)¶ Unregister a custom parameter type from processing. The type will be deleted. Will emit parameterTypeRemoved.
See also
New in version 3.2.
- Parameters
type (QgsProcessingParameterType) –
-
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
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
- Parameters
provider (QgsProcessingProvider) –
- Return type
bool
-
sender
()¶
-
senderSignalIndex
()¶
-
timerEvent
()¶