Don't add 'exec(Path(...))' entries to console history when running s…

…cripts These just clutter the history
qgis · Mar 28, 2023 · b9b06b0 · b9b06b0
1 parent 85d4001
commit b9b06b0
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/python/console/console_sci.py b/python/console/console_sci.py
@@ -303,7 +303,7 @@ def runFile(self, filename):
 
         try:
             # Run the file
-            self.runCommand("exec(Path('{0}').read_text())".format(filename))
+            self.runCommand("exec(Path('{0}').read_text())".format(filename), skipHistory=True)
         finally:
             # Remove the directory from the path and delete the __file__ variable
             self._interpreter.execCommandImpl("del __file__", False)

diff --git a/python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in b/python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in
@@ -329,12 +329,15 @@ is in the QgsCodeEditor.Mode.CommandInput mode.
 
   public slots:
 
-    void runCommand( const QString &command );
+    void runCommand( const QString &command, bool skipHistory = false );
 %Docstring
 Runs a command in the editor.
 
 An :py:func:`~QgsCodeEditor.interpreter` must be set.
 
+Since QGIS 3.32, if ``skipHistory`` is ``True`` then the command will not be automatically
+added to the widget's history.
+
 .. versionadded:: 3.30
 %End
 

diff --git a/src/gui/codeeditors/qgscodeeditor.cpp b/src/gui/codeeditors/qgscodeeditor.cpp
@@ -758,9 +758,10 @@ QStringList QgsCodeEditor::history() const
   return mHistory;
 }
 
-void QgsCodeEditor::runCommand( const QString &command )
+void QgsCodeEditor::runCommand( const QString &command, bool skipHistory )
 {
-  updateHistory( { command } );
+  if ( !skipHistory )
+    updateHistory( { command } );
 
   if ( mInterpreter )
     mInterpreter->exec( command );

diff --git a/src/gui/codeeditors/qgscodeeditor.h b/src/gui/codeeditors/qgscodeeditor.h
@@ -366,9 +366,12 @@ class GUI_EXPORT QgsCodeEditor : public QsciScintilla
      *
      * An interpreter() must be set.
      *
+     * Since QGIS 3.32, if \a skipHistory is TRUE then the command will not be automatically
+     * added to the widget's history.
+     *
      * \since QGIS 3.30
      */
-    void runCommand( const QString &command );
+    void runCommand( const QString &command, bool skipHistory = false );
 
     /**
      * Moves the cursor to the start of the document and scrolls to ensure