Use nicely formatted results in processing logs

YoannQDQ · Jan 9, 2024 · 3c17921 · 3c17921
1 parent 3e10cf9
commit 3c17921
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 4 deletions.
diff --git a/python/PyQt6/core/auto_generated/processing/qgsprocessingfeedback.sip.in b/python/PyQt6/core/auto_generated/processing/qgsprocessingfeedback.sip.in
@@ -153,6 +153,13 @@ report the output from executing an external command or subprocess.
 Pushes a summary of the QGIS (and underlying library) version information to the log.
 
 .. versionadded:: 3.4.7
+%End
+
+    void pushFormattedResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results );
+%Docstring
+Pushes a summary of the execution ``results`` to the log
+
+.. versionadded:: 3.36
 %End
 
     virtual QString htmlLog() const;

diff --git a/python/core/auto_generated/processing/qgsprocessingfeedback.sip.in b/python/core/auto_generated/processing/qgsprocessingfeedback.sip.in
@@ -153,6 +153,13 @@ report the output from executing an external command or subprocess.
 Pushes a summary of the QGIS (and underlying library) version information to the log.
 
 .. versionadded:: 3.4.7
+%End
+
+    void pushFormattedResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results );
+%Docstring
+Pushes a summary of the execution ``results`` to the log
+
+.. versionadded:: 3.36
 %End
 
     virtual QString htmlLog() const;

diff --git a/python/plugins/processing/gui/AlgorithmDialog.py b/python/plugins/processing/gui/AlgorithmDialog.py
@@ -19,7 +19,6 @@
 __date__ = 'August 2012'
 __copyright__ = '(C) 2012, Victor Olaya'
 
-from pprint import pformat
 import datetime
 import time
 
@@ -283,9 +282,7 @@ def on_complete(ok, results):
                     if ok:
                         self.feedback.pushInfo(
                             self.tr(elapsed_time(start_time, 'Execution completed in')))
-                        self.feedback.pushInfo(self.tr('Results:'))
-                        r = {k: v for k, v in results.items() if k not in ('CHILD_RESULTS', 'CHILD_INPUTS')}
-                        self.feedback.pushCommandInfo(pformat(r))
+                        self.feedback.pushFormattedResults(self.algorithm(), self.context, results)
                     else:
                         self.feedback.reportError(
                             self.tr(elapsed_time(start_time, 'Execution failed after')))

diff --git a/src/core/processing/qgsprocessingfeedback.cpp b/src/core/processing/qgsprocessingfeedback.cpp
@@ -148,6 +148,34 @@ void QgsProcessingFeedback::pushVersionInfo( const QgsProcessingProvider *provid
   }
 }
 
+void QgsProcessingFeedback::pushFormattedResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results )
+{
+  if ( results.empty() )
+    return;
+
+  pushInfo( tr( "Results:" ) );
+
+  const QList< const QgsProcessingOutputDefinition * > outputs = algorithm->outputDefinitions();
+  for ( const QgsProcessingOutputDefinition *output : outputs )
+  {
+    const QString outputName = output->name();
+    if ( outputName == QLatin1String( "CHILD_RESULTS" ) || outputName == QLatin1String( "CHILD_INPUTS" ) )
+      continue;
+
+    if ( !results.contains( outputName ) )
+      continue;
+
+    bool ok = false;
+    const QString textValue = output->valueAsString( results.value( output->name() ), context, ok );
+    const QString formattedValue = output->valueAsFormattedString( results.value( output->name() ), context, ok );
+    if ( ok )
+    {
+      pushFormattedMessage( QStringLiteral( "<code>&nbsp;&nbsp;%1: %2</code>" ).arg( output->name(), formattedValue ),
+                            QStringLiteral( "  %1: %2" ).arg( output->name(), textValue ) );
+    }
+  }
+}
+
 QString QgsProcessingFeedback::htmlLog() const
 {
   return mHtmlLog;

diff --git a/src/core/processing/qgsprocessingfeedback.h b/src/core/processing/qgsprocessingfeedback.h
@@ -23,6 +23,8 @@
 #include "qgsmessagelog.h"
 
 class QgsProcessingProvider;
+class QgsProcessingAlgorithm;
+class QgsProcessingContext;
 
 /**
  * \class QgsProcessingFeedback
@@ -141,6 +143,13 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback
      */
     void pushVersionInfo( const QgsProcessingProvider *provider = nullptr );
 
+    /**
+     * Pushes a summary of the execution \a results to the log
+     *
+     * \since QGIS 3.36
+     */
+    void pushFormattedResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results );
+
     /**
      * Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object.
      *