13. Comunicarse con el usuario

Consejo

Los fragmentos de código en esta página necesitan las siguientes adiciones si está fuera de la consola de pyqgis:

from qgis.core import (
    QgsMessageLog,
    QgsGeometry,
)

from qgis.gui import (
    QgsMessageBar,
)

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

Esta sección muestra algunos métodos y elementos que deberían utilizarse para comunicarse con el usuario, con el objetivo de mantener la consistencia en la Interfaz del Usuario.

13.1. Mostrando mensajes. La clase QgsMessageBar

Utilizar las bandejas de mensajes puede ser una mala idea desde el punto de vista de la experiencia de un usuario. Para mostrar una pequeña línea de información o mensajes de advertencia/error, la barrar de mensajes de QGIS suele ser una mejor opción.

Utilizar la referencia a la interfaz objeto de QGIS, puede mostrar un mensaje en la barra de mensajes con el siguiente código

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

Figura 13.10 Barra de Mensajes de QGIS

Se puede establecer una duración para mostrarlo en un tiempo limitado

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

Figura 13.11 Barra de Mensajes de QGIS con temporizador

Los ejemplos anteriores muestran una barra de error, pero el parámetro level se puede usar para crear mensajes de advertencia o mensajes de información, utilizando la enumeración Qgis.MessageLevel. Puede usar hasta 4 niveles diferentes:

0. Información

1. Advertencia

2. Critica

3. Éxito

Figura 13.12 Barra de Mensajes de QGIS (información)

Se puede añadir complementos a la barra de mensajes, como por ejemplo un botón para mostrar más información

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

Figura 13.13 Barra de Mensajes de QGIS con un botón

Incluso puedes utilizar una barra de mensajes en tu propio cuadro de diálogo para no tener que mostrar la bandeja de mensajes o si no tiene sentido mostrarla en la pantalla principal de QGIS.

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

Figura 13.14 Barra de Mensajes de QGIS con un cuadro de diálogo personalizado

13.2. Mostrando el progreso

Las barras de progreso también pueden ponerse en la barra de Mensajes de QGIS, ya que, como hemos visto, admite complementos. Este es un ejemplo que puedes probar en la consola.

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...

Además, puede usar el constructor en la barra de estado para comunicar progreso, como en el siguiente ejemplo:

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. Registro

Hay tres tipos diferentes de registro disponible en QGIS para registrar y guardar toda la información sobre la ejecución de su código. Cada uno tiene una ubicación de salida específica. Por favor considere el uso de la forma correcta de registro para su propósito:

• QgsMessageLog es para que los mensajes comuniquen problemas al usuario. La salida del QgsMessageLog es mostrada en el Panel de Mensajes de Registro.

• El python construido en el módilo registro es para depuración en el nivel de la API Python QGIS (PyQGIS). Es recomendado para desarrolladores de script Python que necesitan depurar su código python, e.g. ids o geometría de objeto espacial

• QgsLogger es para mensajes para depuración / desarrolladores internos QGIS (i.e. usted sospecha que algo es gatillado por algún código dañado). Los mensajes sólo están visibles con versiones desarrollador de QGIS.

Ejemplos para los diferentes tipos de registro son mostrados en las siguientes secciones abajo.

Advertencia

El uso de la declaración print Python no es segura en ningún código que sea multihilos y ralentiza extremadamente el algoritmo. Esto incluye funciones de expresión, representadores, capas de símbolo y algoritmos Procesos (entre otros). En estos casos usted siempre debería usar en vez el módulo python registro o clases seguras de hilo (QgsLogger o QgsMessageLog).

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!

Nota

Puede ver la salida de la QgsMessageLog en el Panel de mensajes de registro

13.3.2. El python construído en el módulo de registro

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

El método basicConfig configura la definición básica del registro. En el código de arriba el nombre de archivo, nivel de registro y el formato son definidos. El nombre de archivo se refiere a donde escribir el archivo de registro, el nivel de registro define qué niveles imprimir y el formato define el formato en el que cada mensaje es impreso.

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

Si quiere borrar el archivo de registro cada vez que ejecuta su script usted puede hacer algo como:

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

Mayores recursos sobre cómo usar la instalación de registro python están disponibles en:

• 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

Advertencia

Por favor tome nota que sin registrar a un archivo al definir el nombre de archivo, el registro podría darse en multihilos lo que ralentiza fuertemente la salida.