Aller au contenu

Processing#

Processing est un framework pour faire des algorithmes dans QGIS.

Toute la boite à outils Traitement dans QGIS sont des basés sur "Processing".

Note, depuis QGIS 3.6, il existe désormais une autre syntaxe pour écrire script Processing à l'aide des décorateurs Python.

Notion sur la POO en Python#

Le framework Processing utilise le concept de la Programmation Orientée Objet. Il existe un tutoriel sur le site d'OpenClassRooms sur le sujet.

Mais depuis le début de la formation, nous l'utilisons sans trop le savoir. Les objets Qgs*, comme QgsVectorLayer utilisent le principe de la POO.

On a pu créer des objets QgsVectorLayer en appelant son constructeur :

1
layer = QgsVectorLayer("C:/chemin/vers/un/fichier.gpkg|layername=communes", "communes", "ogr")

et ensuite on a pu appeler des méthodes sur cet objet, comme :

1
2
layer.setName("Communes")
layer.name()  # Retourne "Communes"

Tip

Vous pouvez relire le passage sur la POO en début de formation.

Exemple#

Nous allons faire un "très" petit exemple rapide. Écrivons notre premier jeu vidéo en console ! 🎮

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
from time import sleep

MAX_ENERGIE = 20


class Personnage:

    """ Classe représentant un personnage du jeu vidéo. """

    def __init__(self, un_nom, energie=MAX_ENERGIE):
        """ Constructeur. """
        self.nom = un_nom
        self.energie = energie

    def marcher(self):
        """ Permet au personnage de marcher.

        Cela dépense de l'énergie.
        """
        cout = 5
        if self.energie >= cout:
            print(f"{self.nom} marche.")
            self.energie -= cout
        else:
            print(f"{self.nom} ne peut pas marcher car il n'a pas assez d'énergie.")

    def courir(self):
        """ Permet au personnage de courir.

        Cela dépense de l'énergie.
        """
        cout = 10
        if self.energie >= cout:
            print(f"{self.nom} court.")
            self.energie -= cout
        else:
            print(f"{self.nom} ne peut pas courir car il n\'a pas assez d\'énergie.")

    def dormir(self):
        """ Permet au personnage de dormir et restaurer le niveau maximum d'énergie."""
        print(f"{self.nom} dort et fait le plein d'énergie.")
        for i in range(2):
            print('...')
            sleep(1)
        self.energie = MAX_ENERGIE

    def manger(self):
        """ Permet au personnage de manger et d'augmenter de 10 points le niveau d'énergie."""
        energie = 10
        print(f"{self.nom} mange et récupère {energie} points d'énergie.")
        if self.energie <= MAX_ENERGIE - energie:
            self.energie += energie
        else:
            self.energie = MAX_ENERGIE

    def __str__(self):
        return f"Je suis {self.nom} et j'ai {self.energie} points d'énergie"

Utilisation de notre classe#

dir est une méthode qui prend une variable en paramètre et qui indique les propriétés/méthodes de notre variable. On peut aussi utiliser help qui est plus présentable.

1
2
3
a = Personnage('Dark Vador')
dir(a)
help(a)

Que remarquons-nous ?

Solution 
1
2
3
4
5
a = Personnage('Dark Vador')
a.courir()
a.dormir()
a.manger()
print(a)

Afficher le nom du personnage (et juste son nom, pas la phrase de présentation)

Ajouter d'autres méthodes#

Ajoutons une méthode dialoguer pour discuter avec un autre personnage.

Tip

1
2
3
def dialoguer(self, autre_personnage):
    """ Permet de dialoguer avec un autre personnage. """
    pass
  1. Écrire le code la fonction à l'aide d'un print pour commencer disant que X dialogue avec Y.
  2. Vérifier le niveau d'énergie, on ne peut pas parler si on est décédé !
  3. Garder son code à gauche, on peut utiliser une instruction return

Nous pouvons désormais utiliser le constructeur afin de créer deux instances de notre classe.

1
2
b = Personnage('Luke')
b.dialoguer(a)
Solution pour la méthode dialoguer() 
1
2
3
4
5
6
def dialoguer(self, autre_personnage):
    if self.energie <= 0:
        print(f"{self.nom} ne peut pas dialoguer car il n'a pas assez d'énergie.")
        return

    print(f"{self.nom} dialogue avec {autre_personnage.nom} et ils échangent des informations secrètes")

Continuons notre classe pour la gestion de son inventaire. Admettons que notre personnage puisse ramasser des objets afin de les mettre dans son sac à dos.

  1. Il va falloir ajouter une nouvelle propriété à notre classe de type list que l'on peut nommer inventaire. Par défaut, son inventaire sera vide.
  2. Ajoutons 3 méthodes : ramasser, deposer et utiliser. Pour le moment, pour faciliter l'exercice, utilisons une chaîne de caractère pour désigner l'objet. Ces méthodes vont interagir avec notre inventaire à l'aide des méthodes remove(), append() que l'on trouve sur une liste.
  3. Pour les méthodes deposer et utiliser, nous pouvons avoir à créer une autre méthode privée afin de vérifier l'existence de l'objet dans l'inventaire. Par convention, nous préfixons la méthode par _ comme _est_dans_inventaire afin de signaler que c'est une méthode dite privée. L'utilisation de cette méthode privée est uniquement à titre pédagogique, on peut vouloir exposer la méthode est_dans_inventaire. Cette méthode doit renvoyer un booléen.
  4. Ajoutons des commentaires et/ou des docstrings, CF mémo Python. On peut utiliser la méthode help.
  5. Pensons aussi annotations Python

Info

Il est important de comprendre que la POO permet de construire une sorte de boîte opaque du point de vue de l'utilisateur de la classe. Un peu comme une voiture, elles ont toutes un capot et une pédale d'accélération. L'appui sur l'accélérateur déclenche plusieurs mécanismes à l'intérieur de la voiture, mais du point de vue utilisateur, c'est plutôt simple.

Il y a des corrections sur les dernières méthodes en bas de ce TP

Tip

On peut vite imaginer d'autres classes, comme Arme, car ramasser un bout de bois ou un sabre laser n'a pas le même impact lors de son utilisation dans un combat. Le dégât qu'inflige une arme sur le niveau d'énergie de l'autre personnage est une propriété de l'arme en question et du niveau du personnage.

Documentation#

Pour l'écriture d'un script Processing, tant en utilisant la POO ou la version avec les décorateurs, il y a une page sur la documentation.

Utiliser Processing en Python avec un algorithme existant#

  • Sur une couche en EPSG:2154, faire un buffer de 10 mètres par exemple.
  • Cliquer sur la petite horloge dans le panneau de Processing/Traitement en haut
  • Cliquer sur le dernier traitement en haut, puis copier/coller la ligne de Python

On peut appeler un traitement en ligne de commande Python :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
processing.run(
    "native:buffer", 
    {
        'INPUT':'/chemin/vers/HYDROGRAPHIE/CANALISATION_EAU.shp',
        'DISTANCE':10,
        'SEGMENTS':5,
        'END_CAP_STYLE':0,
        'JOIN_STYLE':0,
        'MITER_LIMIT':2,
        'DISSOLVE':False,
        'OUTPUT':'TEMPORARY_OUTPUT'
    }
)

Tip

Pour obtenir l'identifiant de l'algorithme, laissez la souris sur le nom de l'algorithme pour avoir son info-bulle dans le panneau traitement.

Lien vers la documentation : https://docs.qgis.org/latest/fr/docs/user_manual/processing/console.html

Pour obtenir la description d'un algorithme : 

1
processing.algorithmHelp("native:buffer")

Exercice, faire une 3 tampons sur la même couche vecteur, distance 10, 20 et 30 mètres, avec une fonction.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
def tampon(distance):
    result = processing.run(
        "native:buffer", 
        {
            'INPUT':'/chemin/vers/HYDROGRAPHIE/BARRAGE.shp',
            'DISTANCE':distance,
            'SEGMENTS':5,
            'END_CAP_STYLE':0,
            'JOIN_STYLE':0,
            'MITER_LIMIT':2,
            'DISSOLVE':False,
            'OUTPUT':'TEMPORARY_OUTPUT'
        }
    )
    QgsProject.instance().addMapLayer(result['OUTPUT'])

for x in [10, 20, 30]:
    tampon(x)

Warning

Attention si utilisation de iface.activeLayer() qui va être modifié si utilisation de QgsProject.instance().addMapLayer(). Il peut être nécessaire d'extraire la sélection de la couche hors de la boucle.

Lancer l'interface graphique de notre algorithme#

Au lieu de processing.run, on peut créer uniquement le dialogue. Il faut alors l'afficher manuellement.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
dialog = processing.createAlgorithmDialog(
    "native:buffer",
    {
        'INPUT': '/data/lines.shp',
        'DISTANCE': 100.0,
        'SEGMENTS': 10,
        'DISSOLVE': True,
        'END_CAP_STYLE': 0,
        'JOIN_STYLE': 0,
        'MITER_LIMIT': 10,
        'OUTPUT': '/data/buffers.shp'
    }
)
dialog.show()

Ou alors directement lancer exécution du dialogue :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
processing.execAlgorithmDialog(
    "native:buffer",
    {
        'INPUT': '/data/lines.shp',
        'DISTANCE': 100.0,
        'SEGMENTS': 10,
        'DISSOLVE': True,
        'END_CAP_STYLE': 0,
        'JOIN_STYLE': 0,
        'MITER_LIMIT': 10,
        'OUTPUT': '/data/buffers.shp'
    }
)

Notre propre script Processing#

  • Nous souhaitons pouvoir créer plusieurs tables vides assez facilement à l'aide des fichiers CSV.
  • Nous avons un dossier avec plusieurs fichiers CSV représentant chacun une table.
  • Le nom du fichier CSV représente le nom de la table.
  • La première ligne représente l'entête des colonnes.
  • La deuxième ligne, si elle s'appelle geom, représente le type de géométrie et sa projection.

Exemple de fichier csv canalisation.csv :

name type length precision alias
geom polygon 2154
id 2 3 0 ID
n 10 10 0 Nom
d 2 3 0 Diamètre
l 2 3 0 Longueur

Préparation#

  • Créer un dossier processing_canalisation à côté du projet avec des fichiers CSV à l'intérieur :

canalisation.csv

1
2
3
4
5
6
name,type,length,precision,alias
geom,line,2154,'',''
id,2,3,0,ID
n,10,10,0,Nom
d,2,3,0,Diamètre
l,2,3,0,Longueur

regard.csv :

1
2
3
4
name,type,length,precision,alias
geom,point,2154,'',''
id,2,3,0,ID
n,10,10,0,Nom rue

Création du cœur de notre script#

  • Commençons par écrire le script en console
  • Il nous faut une fonction qui liste les CSV dans un dossier.
1
2
3
def liste_csv(folder):
    """ Liste les CSV disponibles dans le dossier. """
    pass

Correction du script Python (et non la correction du script Processing) :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
import os
import csv

def liste_csv(folder):
    """ Fonction générique pour liste les CSV dans un dossier. """
    csvs = []
    for root, directories, files in os.walk(folder):
        for file in files:
            if file.lower().endswith('.csv'):
                csvs.append(os.path.join(root, file))
    return csvs

def lire_csv(csv_file):
    """ Fonction générique pour créer une couche vecteur selon la définition d'un CSV. """
    geom = 'None'
    crs = None
    fields = []

    with open(csv_file) as csvfile:
        reader = csv.reader(csvfile)
        for i, row in enumerate(reader):
            if i == 0:
                # Header du CSV
                continue
            elif i == 1 and row[0] == 'geom':
                geom = row[1]
                crs = row[2]
            else:
                field = QgsField()
                field.setName(row[0])
                field.setType(int(row[1]))
                field.setLength(int(row[2]))
                field.setPrecision(int(row[3]))
                field.setAlias(row[4])
                fields.append(field)

    name = os.path.splitext(os.path.basename(csv_file))[0]
    if geom:
        geom += '?crs=epsg:{}'.format(crs)
    layer = QgsVectorLayer(geom, name, 'memory')
    with edit(layer):
        for field in fields:
            layer.addAttribute(field)

    return layer

# Appel des fonctions
folder = os.path.join(QgsProject.instance().homePath(), 'processing_canalisation')
csv_files = liste_csv(folder)
for csv_file in csv_files:
    layer = lire_csv(csv_file)
    QgsProject.instance().addMapLayer(layer)

Nous avons le cœur de notre algorithme, qui fonctionne dans la console Python. Si l'utilisateur souhaite changer de thématique pour la génération des couches (ne pas utiliser processing_canalisation mais plutôt processing_fibre_optique ou processing_plu), il faut qu'il modifie à la main la ligne de Python, ce n'est pas très ergonomique.

Nous allons désormais le transformer en Script Processing afin de rajouter une interface graphique.

  • Partons de l'algorithme d'exemple :
  • Panneau Traitement
  • Python en haut
  • Créer un nouveau script depuis un modèle
  • Modifions les fonctions une par une :
  • name()
  • displayName()
  • ...

Pour le initAlgorithm(), nous devons modifier le paramètre pour afficher un sélecteur de dossier :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    def initAlgorithm(self, config=None):
        self.addParameter(
            QgsProcessingParameterFile(
                self.INPUT,
                self.tr('Répertoire'),
                QgsProcessingParameterFile.Folder,
                optional=False
            )
        )

        self.addOutput(
            QgsProcessingOutputMultipleLayers(
                self.OUTPUT_LAYERS,
                self.tr('Couches de sorties')
            )
        )

Ajoutons les fonctions liste_csv et lire_csv mais :

  • Ajoutons self comme premier paramètre dans la signature de la fonction : def lire_csv(self, ...):
  • Ajoutons self lors de l'appel à la fonction : self.liste_csv(...)

Pour le processAlgorithm, nous allons incorporer le code que l'on a fait avant

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    def processAlgorithm(self, parameters, context, feedback):
        """
        Here is where the processing itself takes place.
        """
        folder = self.parameterAsFile(parameters, self.INPUT, context)
        csv_files = self.liste_csv(folder)

        results = []
        for csv_file in csv_files:
            layer = self.lire_csv(csv_file)
            results.append(layer.id())

            context.temporaryLayerStore().addMapLayer(layer)
            context.addLayerToLoadOnCompletion(
                layer.id(),
                QgsProcessingContext.LayerDetails(
                    layer.name(),
                    context.project(),
                    self.OUTPUT
                )
            )

        return {self.OUTPUT: results}
  • Il faut aussi ajouter les imports manquants.

Solution finale :

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
"""
***************************************************************************
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU General Public License as published by  *
*   the Free Software Foundation; either version 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
***************************************************************************
"""
import os
import csv

from qgis.PyQt.QtCore import QCoreApplication
from qgis.core import (
   edit,
   QgsField,
   QgsProcessingContext,
   QgsProcessingAlgorithm,
   QgsProcessingParameterFile,
   QgsProcessingOutputMultipleLayers,
   QgsVectorLayer,
)


class ExampleProcessingAlgorithm(QgsProcessingAlgorithm):
    """
    This is an example algorithm that takes a vector layer and
    creates a new identical one.

    It is meant to be used as an example of how to create your own
    algorithms and explain methods and variables used to do it. An
    algorithm like this will be available in all elements, and there
    is not need for additional work.

    All Processing algorithms should extend the QgsProcessingAlgorithm
    class.
    """

    # Constants used to refer to parameters and outputs. They will be
    # used when calling the algorithm from another algorithm, or when
    # calling from the QGIS console.

    INPUT = 'INPUT'
    OUTPUT = 'OUTPUT'

    def tr(self, string):
        """
        Returns a translatable string with the self.tr() function.
        """
        return QCoreApplication.translate('Processing', string)

    def createInstance(self):
        return ExampleProcessingAlgorithm()

    def name(self):
        """
        Returns the algorithm name, used for identifying the algorithm. This
        string should be fixed for the algorithm, and must not be localised.
        The name should be unique within each provider. Names should contain
        lowercase alphanumeric characters only and no spaces or other
        formatting characters.
        """
        return 'myscript'

    def displayName(self):
        """
        Returns the translated algorithm name, which should be used for any
        user-visible display of the algorithm name.
        """
        return self.tr('My Script')

    def group(self):
        """
        Returns the name of the group this algorithm belongs to. This string
        should be localised.
        """
        return self.tr('Example scripts')

    def groupId(self):
        """
        Returns the unique ID of the group this algorithm belongs to. This
        string should be fixed for the algorithm, and must not be localised.
        The group id should be unique within each provider. Group id should
        contain lowercase alphanumeric characters only and no spaces or other
        formatting characters.
        """
        return 'examplescripts'

    def shortHelpString(self):
        """
        Returns a localised short helper string for the algorithm. This string
        should provide a basic description about what the algorithm does and the
        parameters and outputs associated with it.
        """
        return self.tr("Example algorithm short description")

    def initAlgorithm(self, config=None):
        """
        Here we define the inputs and output of the algorithm, along
        with some other properties.
        """
        self.addParameter(
            QgsProcessingParameterFile(
                self.INPUT,
                self.tr('Répertoire'),
                QgsProcessingParameterFile.Folder,
                optional=False
            )
        )

        self.addOutput(
            QgsProcessingOutputMultipleLayers(
                self.OUTPUT,
                self.tr('Couches de sorties')
            )
        )

    def liste_csv(self, folder):
        """ Fonction générique pour liste les CSV dans un dossier. """
        csvs = []
        for root, directories, files in os.walk(folder):
            for file in files:
                if file.lower().endswith('.csv'):
                    csvs.append(os.path.join(root, file))
        return csvs

    def lire_csv(self, csv_file):
        """ Fonction générique pour créer une couche vecteur selon la définition d'un CSV. """
        geom = 'None'
        crs = None
        fields = []

        with open(csv_file) as csvfile:
            reader = csv.reader(csvfile)
            for i, row in enumerate(reader):
                if i == 0:
                    # Header du CSV
                    continue
                elif i == 1 and row[0] == 'geom':
                    geom = row[1]
                    crs = row[2]
                else:
                    field = QgsField()
                    field.setName(row[0])
                    field.setType(int(row[1]))
                    field.setLength(int(row[2]))
                    field.setPrecision(int(row[3]))
                    field.setAlias(row[4])
                    fields.append(field)

        name = os.path.splitext(os.path.basename(csv_file))[0]
        if geom:
            geom += '?crs=epsg:{}'.format(crs)
        layer = QgsVectorLayer(geom, name, 'memory')
        with edit(layer):
            for field in fields:
                layer.addAttribute(field)

        return layer

    def processAlgorithm(self, parameters, context, feedback):
        """
        Here is where the processing itself takes place.
        """
        folder = self.parameterAsFile(parameters, self.INPUT, context)
        csv_files = self.liste_csv(folder)

        results = []
        for csv_file in csv_files:
            layer = self.lire_csv(csv_file)
            results.append(layer.id())

            context.temporaryLayerStore().addMapLayer(layer)
            context.addLayerToLoadOnCompletion(
                layer.id(),
                QgsProcessingContext.LayerDetails(
                    layer.name(),
                    context.project(),
                    self.OUTPUT
                )
            )

        return {self.OUTPUT: results}
Nous avons désormais un nouvel algorithme dans la boîte à outils pour générer un modèle de données suivant une thématique.

Introduction aux décorateurs#

Comme mentionné au début de ce chapitre, il est possible de ne pas utiliser la POO pour écrire un Script Processing mais plutôt les décorateurs. Reprenons l'exemple de la documentation.

Le code suivant utilise le décorateur @alg pour :

  • utiliser une couche vectorielle comme entrée
  • compter le nombre d'entités
  • faire une opération buffer
  • créer une couche raster à partir du résultat de l’opération de tampon
  • renvoyer la couche tampon, la couche raster et le nombre d’entités

Dans la documentation QGIS, on trouve la correspondance des décorateurs avec la classe Processing.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
from qgis import processing
from qgis.processing import alg


@alg(name='bufferrasteralg', label='Buffer and export to raster (alg)',
     group='examplescripts', group_label='Example scripts')
# 'INPUT' is the recommended name for the main input parameter
@alg.input(type=alg.SOURCE, name='INPUT', label='Input vector layer')
# 'OUTPUT' is the recommended name for the main output parameter
@alg.input(type=alg.RASTER_LAYER_DEST, name='OUTPUT',
           label='Raster output')
@alg.input(type=alg.VECTOR_LAYER_DEST, name='BUFFER_OUTPUT',
           label='Buffer output')
@alg.input(type=alg.DISTANCE, name='BUFFERDIST', label='BUFFER DISTANCE',
           default=1.0)
@alg.input(type=alg.DISTANCE, name='CELLSIZE', label='RASTER CELL SIZE',
           default=10.0)
@alg.output(type=alg.NUMBER, name='NUMBEROFFEATURES',
            label='Number of features processed')
def bufferrasteralg(instance, parameters, context, feedback, inputs):
   """
   Description of the algorithm.
   (If there is no comment here, you will get an error)
   """
   input_featuresource = instance.parameterAsSource(parameters,
                                                    'INPUT', context)
   numfeatures = input_featuresource.featureCount()
   bufferdist = instance.parameterAsDouble(parameters, 'BUFFERDIST',
                                           context)
   rastercellsize = instance.parameterAsDouble(parameters, 'CELLSIZE',
                                               context)

   if feedback.isCanceled():
      return {}

   params = {
      'INPUT': parameters['INPUT'],
      'OUTPUT': parameters['BUFFER_OUTPUT'],
      'DISTANCE': bufferdist,
      'SEGMENTS': 10,
      'DISSOLVE': True,
      'END_CAP_STYLE': 0,
      'JOIN_STYLE': 0,
      'MITER_LIMIT': 10
   }
   buffer_result = processing.run(
      'native:buffer',
      params,
      is_child_algorithm=True,
      context=context,
      feedback=feedback)

   if feedback.isCanceled():
      return {}

   params = {
      'LAYER': buffer_result['OUTPUT'],
      'EXTENT': buffer_result['OUTPUT'],
      'MAP_UNITS_PER_PIXEL': rastercellsize,
      'OUTPUT': parameters['OUTPUT']
   }
   rasterized_result = processing.run(
      'qgis:rasterize',
      params,
      is_child_algorithm=True, context=context,
      feedback=feedback)

   if feedback.isCanceled():
      return {}

   results = {
      'OUTPUT': rasterized_result['OUTPUT'],
      'BUFFER_OUTPUT': buffer_result['OUTPUT'],
      'NUMBEROFFEATURES': numfeatures,
   }
   return results

Convertir un modèle Processing en python#

Il est possible de convertir un modèle Processing en script Python. On peut alors le modifier avec plus de finesse.

On ne peut pas reconvertir un script Python en modèle.

  • Depuis un modèle, cliquer sur le bouton "Convertir en script Processing".

Utiliser un script Processing dans une action#

On peut utiliser processing.run() dans le code d'une action, pour faire une zone tampon sur un point en particulier par exemple.

On peut lancer, graphiquement depuis la boîte à outil Processing, une zone tampon, avec une sélection. Regardons ensuite dans l'historique Processing pour voir comment QGIS a pu spécifier la sélection dans son appel PyQGIS.

On note l'usage d'une nouvelle classe QgsProcessingFeatureSourceDefinition.

On souhaite donc pouvoir faire une zone tampon personnalisée en cliquant sur un point à l'aide d'une action.

Il faut donc revoir le code dans le chapitre actions pour voir comment créer une action. Pour utiliser la sélection, nous allons faire dans l'action :

1
2
3
4
layer = QgsProject.instance().mapLayer('[% @layer_id %]')
layer.selectByIds([int('[% $id %]')])
# Ajouter ici le code processing.run avec une sélection
layer.removeSelection()

On peut compléter l'action avec un processing.run en utilisant uniquement l'entité en sélection.

Solution 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import processing

layer = QgsProject.instance().mapLayer('[% @layer_id %]')
layer.selectByIds([int('[% $id %]')])

result = processing.run(
    "native:buffer",
    {
        'INPUT':QgsProcessingFeatureSourceDefinition(layer.source(), selectedFeaturesOnly=True),
        'DISTANCE':1000,
        'SEGMENTS':5,
        'END_CAP_STYLE':0,
        'JOIN_STYLE':0,
        'MITER_LIMIT':2,
        'DISSOLVE':False,
        'OUTPUT':'TEMPORARY_OUTPUT'
    }
)
QgsProject.instance().addMapLayer(result['OUTPUT'])

layer.removeSelection()

Solution#

Sur la classe Personnage ci-dessus :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
def _est_dans_inventaire(self, un_objet: str) -> bool:
    return un_objet in self.inventaire

def ramasser(self, un_objet):
    print(f"{self.nom} ramasse {un_objet} et le met dans son inventaire.")
    self.inventaire.append(un_objet)

def utiliser(self, un_objet):
    if self._est_dans_inventaire(un_objet):
        print(f"{self.nom} utilise {un_objet}")
    else:
        print(f"{self.nom} ne possède pas {un_objet}")

def deposer(self, un_objet):
    if self._est_dans_inventaire(un_objet):
        print(f"{self.nom} dépose {un_objet}")
        self.inventaire.remove(un_objet)

def donner(self, autre_personnage, un_objet):
    if self._est_dans_inventaire(un_objet):
        self.inventaire.remove(un_objet)
        autre_personnage.inventaire.append(un_objet)
        print(f"{autre_personnage.nom} reçoit {un_objet} de la part de {self.nom} et le remercie 👍")