17. Writing a Processing plugin

Depending on the kind of plugin that you are going to develop, it might be a better option to add its functionality as a Processing algorithm (or a set of them). That would provide a better integration within QGIS, additional functionality (since it can be run in the components of Processing, such as the modeler or the batch processing interface), and a quicker development time (since Processing will take of a large part of the work).

To distribute those algorithms, you should create a new plugin that adds them to the Processing Toolbox. The plugin should contain an algorithm provider, which has to be registered when the plugin is instantiated.

17.1. Creating from scratch

To create a plugin from scratch which contains an algorithm provider, you can follow these steps using the Plugin Builder:

  1. Install the Plugin Builder plugin

  2. Create a new plugin using the Plugin Builder. When the Plugin Builder asks you for the template to use, select “Processing provider”.

  3. The created plugin contains a provider with a single algorithm. Both the provider file and the algorithm file are fully commented and contain information about how to modify the provider and add additional algorithms. Refer to them for more information.

17.2. Updating a plugin

If you want to add your existing plugin to Processing, you need to add some code.

  1. In your metadata.txt file, you need to add a variable:

    hasProcessingProvider=yes

  2. In the Python file where your plugin is setup with the initGui method, you need to adapt some lines like this:

     1from qgis.core import QgsApplication
 2from .processing_provider.provider import Provider
 3
 4class YourPluginName:
 5
 6    def __init__(self):
 7        self.provider = None
 8
 9    def initProcessing(self):
10        self.provider = Provider()
11        QgsApplication.processingRegistry().addProvider(self.provider)
12
13    def initGui(self):
14        self.initProcessing()
15
16    def unload(self):
17        QgsApplication.processingRegistry().removeProvider(self.provider)

  3. You can create a folder processing_provider with three files in it:

    • __init__.py with nothing in it. This is necessary to make a valid Python package.

    • provider.py which will create the Processing provider and expose your algorithms.

       1from qgis.core import QgsProcessingProvider
 2from qgis.PyQt.QtGui import QIcon
 3
 4from .example_processing_algorithm import ExampleProcessingAlgorithm
 5
 6
 7class Provider(QgsProcessingProvider):
 8
 9    """ The provider of our plugin. """
10
11    def loadAlgorithms(self):
12        """ Load each algorithm into the current provider. """
13        self.addAlgorithm(ExampleProcessingAlgorithm())
14        # add additional algorithms here
15        # self.addAlgorithm(MyOtherAlgorithm())
16
17    def id(self) -> str:
18        """The ID of your plugin, used for identifying the provider.
19
20        This string should be a unique, short, character only string,
21        eg "qgis" or "gdal". This string should not be localised.
22        """
23        return 'yourplugin'
24
25    def name(self) -> str:
26        """The human friendly name of your plugin in Processing.
27
28        This string should be as short as possible (e.g. "Lastools", not
29        "Lastools version 1.0.1 64-bit") and localised.
30        """
31        return self.tr('Your plugin')
32
33    def icon(self) -> QIcon:
34        """Should return a QIcon which is used for your provider inside
35        the Processing toolbox.
36        """
37        return QgsProcessingProvider.icon(self)

    • example_processing_algorithm.py which contains the example algorithm file. Copy/paste the content of the script template file and update it according to your needs.

You should have a tree similar to this :

1└── your_plugin_root_folder
2   ├── __init__.py
3   ├── LICENSE
4   ├── metadata.txt
5   └── processing_provider
6         ├── example_processing_algorithm.py
7         ├── __init__.py
8         └── provider.py

  1. Now you can reload your plugin in QGIS and you should see your example script in the Processing toolbox and modeler.