How to write log message in QGIS's script algorithms GUI tab?

Question

I want to write some log in the log tab of processing algorithm User Interface.

I tried this :

from qgis.core import QgsMessageLog

QgsMessageLog.logMessage("test")

but when I launch the script "test" is not logged.

How to write a log in the processing User Interface ?

the processing guide log's chapter doesn't tell much about writing a log in this tab.

If i use :

from qgis.core import QgsMessageLog
QgsMessageLog.logMessage("test", tag="Processing", level=QgsMessageLog.INFO)

the log result is wrote under the console log panel called "Processing", but not in the processing GUI log tab.

onietosi · Accepted Answer · 2020-07-10 16:42:18Z

9

For QGIS 3.x you can use the pushInfo() method on a feedback object:

feedback.pushInfo('This is a log message')

See the scripts section of the user's manual for other relevant methods.

answered Jul 10, 2020 at 16:42

onietosi

5596 silver badges7 bronze badges

how do you create or acquire the feedback object in the first place? with QgsProcessingFeedback.pushInfo('a message') I get the error "TypeError: QgsProcessingFeedback.pushInfo(): first argument of unbound method must have type 'QgsProcessingFeedback'"
– matt wilkie
Commented Jan 30, 2021 at 21:56
have you tried the following feedback.pushInfo('This is a log message') ?
– onietosi
Commented Feb 1, 2021 at 9:01

Add a comment |

Hugo Roussaffa · Accepted Answer · 2017-10-30 10:23:16Z

3

You can do this with global variable progress. see the user manual, processing chapter

progress.setText('Youpi')

Will print 'Youpi' in the processing log.

It supports html formatting:

progress.setText('<b>Youpi</b>')

to print in bold...

progress come also with setPercentage() methods to control the progress bar

Hugo Roussaffa

2,23116 silver badges40 bronze badges

answered Oct 28, 2017 at 16:25

YoLecomte

3,34016 silver badges30 bronze badges

that's exactly what I am looking for ! thanks a lot
– Hugo Roussaffa
Commented Oct 30, 2017 at 8:53
Unfortunately I will get an error: "NameError: name 'progress' is not defined" Do I have to import a special module?
– Vaiaro
Commented Oct 16, 2019 at 16:00
1

@Vaiaro I wrote this answer long time ago and the api of processing has change a lot... You probably need to check the doc for qgis3 to see the new way of doing that.
– YoLecomte
Commented Oct 17, 2019 at 18:32

Add a comment |

2 Answers 2