13. Communiceren met de gebruiker

Hint

De codesnippers op deze pagina hebben de volgende import nodig als u buiten de console van PyQGIS bent:

from qgis.core import (
    QgsMessageLog,
    QgsGeometry,
)

from qgis.gui import (
    QgsMessageBar,
)

from qgis.PyQt.QtWidgets import (
    QSizePolicy,
    QPushButton,
    QDialog,
    QGridLayout,
    QDialogButtonBox,
)

Dit gedeelte geeft enkele methoden en elementen weer die zouden moeten worden gebruikt om te communiceren met de gebruiker, om consistentie in de gebruikersinterface te behouden.

13.1. Berichten weergeven. De klasse QgsMessageBar

Het gebruiken van berichtenvakken kan een slecht idee zijn vanuit het gezichtspunt van de gebruiker. Voor het weergeven van een korte regel met informatie of een waarschuwing/foutberichten, is de QGIS berichtenbalk gewoonlijk een betere optie.

U kunt, met behulp van de verwijzing naar het interface-object van QGIS, een bericht weergeven in de berichtenbalk met de volgende code

from qgis.core import Qgis
iface.messageBar().pushMessage("Error", "I'm sorry Dave, I'm afraid I can't do that", level=Qgis.Critical)

Messages(2): Error : I'm sorry Dave, I'm afraid I can't do that

Fig. 13.10 QGIS berichtenbalk

U kunt een duur instellen om het voor een beperkte tijd weer te geven

iface.messageBar().pushMessage("Ooops", "The plugin is not working as it should", level=Qgis.Critical, duration=3)

Messages(2): Ooops : The plugin is not working as it should

Fig. 13.11 QGIS berichtenbalk met timer

Het voorbeeld hierboven geeft een foutenbalk weer, maar de parameter level kan worden gebruikt om waarschuwingen of informatie-berichten te maken, respectievelijk met behulp van de enumeratie Qgis.MessageLevel. U kunt tot maximaal 4 verschillende niveaus gebruiken.

0. Informatie

1. Waarschuwing

2. Kritisch

3. Succes

Fig. 13.12 QGIS berichtenbalk (info)

Widgets kunnen aan de berichtenbalk worden toegevoegd, zoals bijvoorbeeld een knop om meer informatie weer te geven

def showError():
    pass

widget = iface.messageBar().createMessage("Missing Layers", "Show Me")
button = QPushButton(widget)
button.setText("Show Me")
button.pressed.connect(showError)
widget.layout().addWidget(button)
iface.messageBar().pushWidget(widget, Qgis.Warning)

Messages(1): Missing Layers : Show Me

Fig. 13.13 QGIS berichtenbalk met een knop

U kunt zelfs een berichtenbalk in uw eigen dialoogvenster gebruiken zodat u geen berichtenvak hoeft weer te geven, of als het geen zin heeft om het in het hoofdvenster van QGIS weer te geven

class MyDialog(QDialog):
    def __init__(self):
        QDialog.__init__(self)
        self.bar = QgsMessageBar()
        self.bar.setSizePolicy( QSizePolicy.Minimum, QSizePolicy.Fixed )
        self.setLayout(QGridLayout())
        self.layout().setContentsMargins(0, 0, 0, 0)
        self.buttonbox = QDialogButtonBox(QDialogButtonBox.Ok)
        self.buttonbox.accepted.connect(self.run)
        self.layout().addWidget(self.buttonbox, 0, 0, 2, 1)
        self.layout().addWidget(self.bar, 0, 0, 1, 1)
    def run(self):
        self.bar.pushMessage("Hello", "World", level=Qgis.Info)

myDlg = MyDialog()
myDlg.show()

Fig. 13.14 QGIS berichtenbalk in aangepast dialoogvenster

13.2. Voortgang weergeven

Voortgangsbalken kunnen ook worden opgenomen in de berichtenbalk van QGIS, omdat, zoals we al hebben gezien, die widgets accepteert. Hier is een voorbeeld dat u kunt proberen in de console.

import time
from qgis.PyQt.QtWidgets import QProgressBar
from qgis.PyQt.QtCore import *
progressMessageBar = iface.messageBar().createMessage("Doing something boring...")
progress = QProgressBar()
progress.setMaximum(10)
progress.setAlignment(Qt.AlignLeft|Qt.AlignVCenter)
progressMessageBar.layout().addWidget(progress)
iface.messageBar().pushWidget(progressMessageBar, Qgis.Info)

for i in range(10):
    time.sleep(1)
    progress.setValue(i + 1)

iface.messageBar().clearWidgets()

Messages(0): Doing something boring...

U kunt ook de ingebouwde statusbalk gebruiken om de voortgang weer te geven, zoals in het volgende voorbeeld:

vlayer = iface.activeLayer()

count = vlayer.featureCount()
features = vlayer.getFeatures()

for i, feature in enumerate(features):
    # do something time-consuming here
    print('.') # printing should give enough time to present the progress

    percent = i / float(count) * 100
    # iface.mainWindow().statusBar().showMessage("Processed {} %".format(int(percent)))
    iface.statusBarIface().showMessage("Processed {} %".format(int(percent)))

iface.statusBarIface().clearMessage()

13.3. Loggen

Er zijn in QGIS drie verschillende soorten loggen beschikbaar om alle informatie over het uitvoeren van uw code te loggen en op te slaan. Elk heeft zijn eigen specifieke locatie voor de uitvoer. Bepaal eerst de juiste manier van loggen voor uw doel:

• QgsMessageLog is voor het communiceren met gebruikers van problemen. De uitvoer van het QgsMessageLog wordt weergegeven in het paneel Logboekberichten.

• De ingebouwde module van Python voor logging is voor het debuggen op het niveau van de QGIS Python API (PyQGIS). Het wordt aanbevolen aan scriptontwikkelaars in Python die hun code voor Python moeten debuggen, bijv. object-ID’s of geometrieën

• QgsLogger is voor berichten voor QGIS intern debuggen / ontwikkelaars d.i. als u vermoedt dat zij worden veroorzaakt door een beschadigde code). Berichten zijn alleen zichtbaar in ontwikkelversies van QGIS.

Voorbeelden voor de verschillende typen van loggen worden weergegeven in de volgende gedeelten hieronder.

Waarschuwing

Gebruiken van het argument print in Python is niet veilig om in enige code te gebruiken die multithreaded zou kunnen zijn en vertraagt het algoritme extreem. Dit omvat functies voor expressies, renderers, symboollagen en algoritmes voor Processing (naast andere). In deze gevallen zou u in plaats daarvan altijd de module van Python logging of thread-veilige klassen (QgsLogger of QgsMessageLog) moeten gebruiken.

13.3.1. QgsMessageLog

# You can optionally pass a 'tag' and a 'level' parameters
QgsMessageLog.logMessage("Your plugin code has been executed correctly", 'MyPlugin', level=Qgis.Info)
QgsMessageLog.logMessage("Your plugin code might have some problems", level=Qgis.Warning)
QgsMessageLog.logMessage("Your plugin code has crashed!", level=Qgis.Critical)

MyPlugin(0): Your plugin code has been executed correctly
(1): Your plugin code might have some problems
(2): Your plugin code has crashed!

Notitie

U kunt de uitvoer van QgsMessageLog zien in het Paneel Logboekmeldingen

13.3.2. De ingebouwde module voor loggen in Python

import logging
formatter = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
logfilename=r'c:\temp\example.log'
logging.basicConfig(filename=logfilename, level=logging.DEBUG, format=formatter)
logging.info("This logging info text goes into the file")
logging.debug("This logging debug text goes into the file as well")

De methode basicConfig configureert de basis instelling van het loggen. In de bovenstaande code worden de bestandsnaam, het niveau van loggen en de indeling gedefinieerd. De bestandsnaam verwijst naar waar het logbestand moet worden weggeschreven, het niveau van loggen definieert welke niveaus moeten worden uitgevoerd en de indeling definieert de indeling waarin elk bericht wordt uitgevoerd.

2020-10-08 13:14:42,998 - root - INFO - This logging text goes into the file
2020-10-08 13:14:42,998 - root - DEBUG - This logging debug text goes into the file as well

Als u het logbestand wilt verwijderen, elke keer als u uw script uitvoert, kunt u iets doen als:

if os.path.isfile(logfilename):
    with open(logfilename, 'w') as file:
        pass

Meer bronnen over hoe de mogelijkheden voor loggen in Python te gebruiken zijn beschikbaar op:

• https://docs.python.org/3/library/logging.html

• https://docs.python.org/3/howto/logging.html

• https://docs.python.org/3/howto/logging-cookbook.html

Waarschuwing

Onthoud dat loggen zonder dat naar en bestand te sturen door een bestandsnaam in te stellen het loggen multithreaded zou kunnen zijn, wat de uitvoer in hoge mate vertraagt.