Move responsibility for opening files in external editor to QgsCodeEd…

…itorWidget

This allows the editor to be opened in a proper detached process,
avoiding the editor being closed when QGIS is exited.

Move to a blocklist for terminal text editors instead of the fragile
polling approach (which eg doesn't work if the editor is set to
pycharm)

python/PyQt6/gui/auto_generated/codeeditors/qgscodeeditorwidget.sip.in

@@ -155,6 +155,14 @@ Sets the widget's associated file ``path``.
 
 .. seealso:: :py:func:`filePath`
 %End
+
+    bool openInExternalEditor();
+%Docstring
+Attempts to opens the script from the editor in an external text editor.
+
+This requires that the widget has an associated :py:func:`~QgsCodeEditorWidget.filePath` set.
+
+:return: ``True`` if the file was opened successfully.
 %End
 
   signals:

python/console/console.py

@@ -588,23 +588,7 @@ def reformatCode(self):
 
     def openScriptFileExtEditor(self):
         tabWidget = self.tabEditorWidget.currentWidget()
-        path = tabWidget.file_path()
-
-        editor_command = os.environ.get('EDITOR')
-        if editor_command:
-            child = subprocess.Popen([os.environ['EDITOR'], path])
-            try:
-                # let's see if the EDITOR drops out immediately....
-                child.wait(0.01)
-                rc = child.poll()
-                if rc:
-                    # editor failed, use backup approach
-                    QDesktopServices.openUrl(QUrl.fromLocalFile(path))
-            except subprocess.TimeoutExpired:
-                # looks like EDITOR started up successfully, all is good
-                pass
-        else:
-            QDesktopServices.openUrl(QUrl.fromLocalFile(path))
+        tabWidget.open_in_external_editor()
 
     def openScriptFile(self):
         settings = QgsSettings()

python/console/console_editor.py

@@ -568,6 +568,9 @@ def set_file_path(self, path: str):
     def file_path(self) -> Optional[str]:
         return self._editor_code_widget.filePath()
 
+    def open_in_external_editor(self):
+        self._editor_code_widget.openInExternalEditor()
+
     def modified(self, modified):
         self.tab_widget.tabModified(self, modified)
 

python/gui/auto_generated/codeeditors/qgscodeeditorwidget.sip.in

@@ -155,6 +155,14 @@ Sets the widget's associated file ``path``.
 
 .. seealso:: :py:func:`filePath`
 %End
+
+    bool openInExternalEditor();
+%Docstring
+Attempts to opens the script from the editor in an external text editor.
+
+This requires that the widget has an associated :py:func:`~QgsCodeEditorWidget.filePath` set.
+
+:return: ``True`` if the file was opened successfully.
 %End
 
   signals:

src/gui/codeeditors/qgscodeeditorwidget.cpp

@@ -26,6 +26,10 @@
 #include <QCheckBox>
 #include <QShortcut>
 #include <QGridLayout>
+#include <QDesktopServices>
+#include <QProcess>
+#include <QFileInfo>
+#include <QDir>
 
 QgsCodeEditorWidget::QgsCodeEditorWidget(
   QgsCodeEditor *editor,
@@ -346,6 +350,39 @@ void QgsCodeEditorWidget::setFilePath( const QString &path )
   emit filePathChanged( mFilePath );
 }
 
+bool QgsCodeEditorWidget::openInExternalEditor()
+{
+  if ( mFilePath.isEmpty() )
+    return false;
+
+  const QDir dir = QFileInfo( mFilePath ).dir();
+
+  bool useFallback = true;
+
+  const QString editorCommand = qgetenv( "EDITOR" );
+  if ( !editorCommand.isEmpty() )
+  {
+    const QFileInfo fi( editorCommand );
+    if ( fi.exists( ) )
+    {
+      const QString command = fi.fileName();
+      const bool isTerminalEditor = command.compare( QLatin1String( "nano" ), Qt::CaseInsensitive ) == 0
+                                    || command.contains( QLatin1String( "vim" ), Qt::CaseInsensitive );
+
+      if ( !isTerminalEditor && QProcess::startDetached( editorCommand, {mFilePath}, dir.absolutePath() ) )
+      {
+        useFallback = false;
+      }
+    }
+  }
+
+  if ( useFallback )
+  {
+    QDesktopServices::openUrl( QUrl::fromLocalFile( mFilePath ) );
+  }
+  return true;
+}
+
 bool QgsCodeEditorWidget::findNext()
 {
   return findText( true, false );

src/gui/codeeditors/qgscodeeditorwidget.h

@@ -164,6 +164,15 @@ class GUI_EXPORT QgsCodeEditorWidget : public QgsPanelWidget
      */
     void setFilePath( const QString &path );
 
+    /**
+     * Attempts to opens the script from the editor in an external text editor.
+     *
+     * This requires that the widget has an associated filePath() set.
+     *
+     * \returns TRUE if the file was opened successfully.
+     */
+    bool openInExternalEditor();
+
   signals:
 
     /**