Immediately write out the console history file BEFORE running commands

nyalldawson · nyalldawson · commit 03e1d90b3919 · 2023-03-28T15:04:39.000+10:00
This prevents loss of history when a user enters a Python command
which results in a QGIS crash
diff --git a/python/console/console_sci.py b/python/console/console_sci.py
@@ -137,7 +137,11 @@ def promptForState(self, state):
 class ShellScintilla(QgsCodeEditorPython):
 
     def __init__(self, parent=None):
-        super().__init__(parent, [], QgsCodeEditor.Mode.CommandInput)
+        # We set the ImmediatelyUpdateHistory flag here, as users can easily
+        # crash QGIS by entering a Python command, and we don't want the
+        # history leading to the crash lost..
+        super().__init__(parent, [], QgsCodeEditor.Mode.CommandInput,
+                         flags=QgsCodeEditor.Flags(QgsCodeEditor.Flag.CodeFolding | QgsCodeEditor.Flag.ImmediatelyUpdateHistory))
 
         self.parent = parent
         self._interpreter = PythonInterpreter()
diff --git a/python/gui/auto_additions/qgscodeeditor.py b/python/gui/auto_additions/qgscodeeditor.py
@@ -21,7 +21,8 @@
 QgsCodeEditor.MarginRole.baseClass = QgsCodeEditor
 # monkey patching scoped based enum
 QgsCodeEditor.Flag.CodeFolding.__doc__ = "Indicates that code folding should be enabled for the editor"
-QgsCodeEditor.Flag.__doc__ = 'Flags controlling behavior of code editor\n\n.. versionadded:: 3.28\n\n' + '* ``CodeFolding``: ' + QgsCodeEditor.Flag.CodeFolding.__doc__
+QgsCodeEditor.Flag.ImmediatelyUpdateHistory.__doc__ = "Indicates that the history file should be immediately updated whenever a command is executed, instead of the default behavior of only writing the history on widget close. Since QGIS 3.32."
+QgsCodeEditor.Flag.__doc__ = 'Flags controlling behavior of code editor\n\n.. versionadded:: 3.28\n\n' + '* ``CodeFolding``: ' + QgsCodeEditor.Flag.CodeFolding.__doc__ + '\n' + '* ``ImmediatelyUpdateHistory``: ' + QgsCodeEditor.Flag.ImmediatelyUpdateHistory.__doc__
 # --
 QgsCodeEditor.Flag.baseClass = QgsCodeEditor
 QgsCodeEditor.Flags.baseClass = QgsCodeEditor
diff --git a/python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in b/python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in
@@ -99,6 +99,7 @@ A text editor based on QScintilla2.
     enum class Flag
     {
       CodeFolding,
+      ImmediatelyUpdateHistory,
     };
 
     typedef QFlags<QgsCodeEditor::Flag> Flags;
diff --git a/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in b/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in
@@ -31,13 +31,14 @@ code autocompletion.
 
 
     QgsCodeEditorPython( QWidget *parent /TransferThis/ = 0, const QList<QString> &filenames = QList<QString>(),
-                         QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor );
+                         QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor, QgsCodeEditor::Flags flags = QgsCodeEditor::Flag::CodeFolding );
 %Docstring
 Construct a new Python editor.
 
 :param parent: The parent QWidget
 :param filenames: The list of apis files to load for the Python lexer
 :param mode: code editor mode (since QGIS 3.30)
+:param flags: code editor flags (since QGIS 3.32)
 
 .. versionadded:: 2.6
 %End
diff --git a/src/gui/codeeditors/qgscodeeditor.cpp b/src/gui/codeeditors/qgscodeeditor.cpp
@@ -761,7 +761,11 @@ QStringList QgsCodeEditor::history() const
 void QgsCodeEditor::runCommand( const QString &command, bool skipHistory )
 {
   if ( !skipHistory )
+  {
     updateHistory( { command } );
+    if ( mFlags & QgsCodeEditor::Flag::ImmediatelyUpdateHistory )
+      writeHistoryFile();
+  }
 
   if ( mInterpreter )
     mInterpreter->exec( command );
diff --git a/src/gui/codeeditors/qgscodeeditor.h b/src/gui/codeeditors/qgscodeeditor.h
@@ -139,6 +139,7 @@ class GUI_EXPORT QgsCodeEditor : public QsciScintilla
     enum class Flag : int
     {
       CodeFolding = 1 << 0, //!< Indicates that code folding should be enabled for the editor
+      ImmediatelyUpdateHistory = 1 << 1, //!< Indicates that the history file should be immediately updated whenever a command is executed, instead of the default behavior of only writing the history on widget close. Since QGIS 3.32.
     };
     Q_ENUM( Flag )
 
diff --git a/src/gui/codeeditors/qgscodeeditorpython.cpp b/src/gui/codeeditors/qgscodeeditorpython.cpp
@@ -51,12 +51,13 @@ const QgsSettingsEntryBool *QgsCodeEditorPython::settingBlackNormalizeQuotes = n
 ///@endcond PRIVATE
 
 
-QgsCodeEditorPython::QgsCodeEditorPython( QWidget *parent, const QList<QString> &filenames, Mode mode )
+QgsCodeEditorPython::QgsCodeEditorPython( QWidget *parent, const QList<QString> &filenames, Mode mode, Flags flags )
   : QgsCodeEditor( parent,
                    QString(),
                    false,
                    false,
-                   QgsCodeEditor::Flag::CodeFolding, mode )
+                   flags,
+                   mode )
   , mAPISFilesList( filenames )
 {
   if ( !parent )
diff --git a/src/gui/codeeditors/qgscodeeditorpython.h b/src/gui/codeeditors/qgscodeeditorpython.h
@@ -71,10 +71,11 @@ class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor
      * \param parent The parent QWidget
      * \param filenames The list of apis files to load for the Python lexer
      * \param mode code editor mode (since QGIS 3.30)
+     * \param flags code editor flags (since QGIS 3.32)
      * \since QGIS 2.6
      */
     QgsCodeEditorPython( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QList<QString> &filenames = QList<QString>(),
-                         QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor );
+                         QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor, QgsCodeEditor::Flags flags = QgsCodeEditor::Flag::CodeFolding );
 
     Qgis::ScriptLanguage language() const override;
     Qgis::ScriptLanguageCapabilities languageCapabilities() const override;

Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ A text editor based on QScintilla2.`
`99`	`99`	`enum class Flag`
`100`	`100`	`{`
`101`	`101`	`CodeFolding,`
	`102`	`+ ImmediatelyUpdateHistory,`
`102`	`103`	`};`
`103`	`104`
`104`	`105`	`typedef QFlags<QgsCodeEditor::Flag> Flags;`
Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,7 @@ class GUI_EXPORT QgsCodeEditor : public QsciScintilla`
`139`	`139`	`enum class Flag : int`
`140`	`140`	`{`
`141`	`141`	`CodeFolding = 1 << 0, //!< Indicates that code folding should be enabled for the editor`
	`142`	`+ ImmediatelyUpdateHistory = 1 << 1, //!< Indicates that the history file should be immediately updated whenever a command is executed, instead of the default behavior of only writing the history on widget close. Since QGIS 3.32.`
`142`	`143`	`};`
`143`	`144`	`Q_ENUM( Flag )`
`144`	`145`