Use QMessageBox to prompt user to install spyder-kernels.

Author: mrclary

spyder/plugins/ipythonconsole/widgets/client.py

@@ -26,7 +26,7 @@
 
 # Third party imports (qtpy)
 from qtpy.QtCore import QUrl, QTimer, Signal, Slot
-from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+from qtpy.QtWidgets import QApplication, QMessageBox, QVBoxLayout, QWidget
 
 # Local imports
 from spyder.api.asyncdispatcher import AsyncDispatcher
@@ -43,16 +43,19 @@
 from spyder.utils.qthelpers import DialogManager
 from spyder.plugins.ipythonconsole import (
     SpyderKernelError,
-    SpyderKernelVersionError,
+    SPYDER_KERNELS_VERSION,
 )
 from spyder.plugins.ipythonconsole.utils.kernel_handler import (
     KernelConnectionState,
     KernelHandler
 )
 from spyder.plugins.ipythonconsole.widgets import ShellWidget
+from spyder.plugins.ipythonconsole.widgets.install_spyder_kernels import (
+    SpyderKernelInstallWidget,
+    INSTALL_TEXT,
+)
 from spyder.widgets.collectionseditor import CollectionsEditor
 from spyder.widgets.mixins import SaveHistoryMixin
-from spyder.plugins.ipythonconsole.widgets import SpyderKernelInstallWidget
 
 if typing.TYPE_CHECKING:
     from spyder.plugins.remoteclient.api.modules import JupyterAPI
@@ -175,7 +178,8 @@ def __init__(
         self.infowidget = self.container.infowidget
         self.blank_page = self._create_blank_page()
         self.kernel_loading_page = self._create_loading_page()
-        self.env_loading_page = self._create_loading_page(env=True)
+        self.env_loading_page = self._create_loading_page(kind="env")
+        self.spyk_installing_page = self._create_loading_page(kind="install")
 
         if self.is_remote():
             # Keep a reference
@@ -207,6 +211,15 @@ def __init__(
         self.__remote_restart_requested = False
         self.__remote_reconnect_requested = False
 
+        # --- Install spyder-kernels message box
+        self.install_mbox = QMessageBox(self)
+        self.install_mbox.setIcon(QMessageBox.Icon.Question)
+        self.install_mbox.setWindowTitle(self.container._plugin.get_name())
+        self.install_mbox.setStandardButtons(
+            QMessageBox.Yes | QMessageBox.Cancel
+        )
+        self.install_mbox.button(QMessageBox.Yes).setText(_("Install"))
+
     # ---- Private methods
     # -------------------------------------------------------------------------
     def _when_kernel_is_ready(self):
@@ -245,16 +258,20 @@ def _when_kernel_is_ready(self):
         if self.give_focus:
             self.shellwidget._control.setFocus()
 
-    def _create_loading_page(self, env=False):
+    def _create_loading_page(self, kind=None):
         """Create html page to show while the kernel is starting"""
         loading_template = Template(LOADING)
         loading_img = get_image_path('loading_sprites')
         if os.name == 'nt':
             loading_img = loading_img.replace('\\', '/')
-        message = _("Connecting to kernel...")
 
-        if env:
+        if kind is None:
+            message = _("Connecting to kernel...")
+        elif kind == "env":
             message = _("Retrieving environment variables...")
+        elif kind == "install":
+            message = _("Installing spyder-kernels...")
+
         page = loading_template.substitute(
             css_path=self.css_path,
             loading_img=loading_img,
@@ -385,8 +402,35 @@ def _set_initial_cwd_in_kernel(self):
                     cwd_path, emit_cwd_change=emit_cwd_change
                 )
 
+    @Slot()
+    def _install_spyder_kernels(self, pyexec):
+        # TODO: Disable create new client with same environment
+
+        # Store existing error page for reuse later, if necessary
+        self.installwidget.info_page = self.info_page
+
+        self._show_loading_page(self.spyk_installing_page)
+        self.installwidget.show()
+
+        # Install spyder kernels...
+        self.installwidget.install_spyder_kernels(pyexec)
+
     # ---- Public API
     # -------------------------------------------------------------------------
+    def show_install_mbox(self, pyexec):
+        self.install_mbox.setText(
+            INSTALL_TEXT.format(
+                SPYDER_KERNELS_VERSION.replace(">", ">").replace(
+                    "<", "&lt;"
+                ),
+                pyexec,
+            ),
+        )
+        self.install_mbox.accepted.connect(
+            functools.partial(self._install_spyder_kernels, pyexec)
+        )
+        self.install_mbox.show()
+
     @property
     def connection_file(self):
         if self.kernel_handler is None:
@@ -517,22 +561,29 @@ def stop_button_click_handler(self):
         else:
             self.shellwidget.pdb_execute_command('exit')
 
-    def show_kernel_install(self):
-        self._hide_loading_page()
-        self.shellwidget.hide()
-        self.installwidget.show()
-
-    def connect_after_kernel_install(self):
-        self._show_loading_page(self.env_loading_page)
-        self.sig_connect_after_kernel_install.emit()
+    def process_kernel_install(self, exit_code, exit_status, output=None):
+        # TODO: Re-enable create new client with same environment
+
+        if exit_code == 0 and exit_status == 0:
+            # Success!
+            self._show_loading_page(self.env_loading_page)
+            self.sig_connect_after_kernel_install.emit()
+        elif exit_code == 15 and exit_status == 1:
+            # Cancelled by user, just display previous kernel error page
+            self._show_loading_page(self.installwidget.info_page)
+        elif exit_code != 0 and exit_status == 0:
+            # An error occurred during install
+            self.show_kernel_error(f"<tt>{output}</tt>", install=True)
+        else:
+            # Unknown error
+            logger.info(
+                "Unknown installer error. "
+                f"Exit code: {exit_code}; exit status: {exit_status}"
+            )
 
-    def show_kernel_error(self, error):
+    def show_kernel_error(self, error, install=False):
         """Show kernel initialization errors in infowidget."""
-        if isinstance(error, SpyderKernelVersionError):
-            self.installwidget.kernel_error = error
-            self.show_kernel_install()
-            return
-        elif isinstance(error, SpyderKernelError):
+        if isinstance(error, SpyderKernelError):
             error = error.args[0]
         elif isinstance(error, Exception):
             error = _("The error is:<br><br>"
@@ -557,7 +608,10 @@ def show_kernel_error(self, error):
         error = error.replace('-', '&#8209;')
 
         # Create error page
-        message = _("An error occurred while starting the kernel")
+        if install:
+            message = _("An error occurred while installing spyder-kernls")
+        else:
+            message = _("An error occurred while starting the kernel")
         kernel_error_template = Template(KERNEL_ERROR)
         self.info_page = kernel_error_template.substitute(
             css_path=self.css_path,
@@ -680,6 +734,7 @@ def set_color_scheme(self, color_scheme, reset=True):
 
     def close_client(self, is_last_client, close_console=False):
         """Close the client."""
+        self.install_mbox.reject()
         self.__on_close = lambda: None
         debugging = False
 

spyder/plugins/ipythonconsole/widgets/install_spyder_kernels.py

@@ -15,7 +15,6 @@
 from qtpy.QtGui import QTextCursor
 from qtpy.QtWidgets import (
     QDialogButtonBox,
-    QLabel,
     QPlainTextEdit,
     QVBoxLayout,
     QWidget,
@@ -28,11 +27,7 @@
 from spyder.api.widgets.mixins import SpyderWidgetMixin
 from spyder.api.widgets.dialogs import SpyderDialogButtonBox
 from spyder.config.base import _
-from spyder.plugins.ipythonconsole import (
-    SpyderKernelError,
-    SpyderKernelVersionError,
-    SPYDER_KERNELS_VERSION,
-)
+from spyder.plugins.ipythonconsole import SPYDER_KERNELS_VERSION
 
 logger = logging.getLogger(__name__)
 
@@ -41,6 +36,8 @@
     "<tt>{}</tt><br>environment in order to work with Spyder.<br><br>"
     "Do you want Spyder to install it for you?"
 )
+SHOW_DETAILS = _("Show details")
+HIDE_DETAILS = _("Hide details")
 
 
 class SpyderKernelInstallWidget(QWidget, SpyderWidgetMixin, SpyderFontsMixin):
@@ -52,14 +49,12 @@ def __init__(self, parent=None):
 
         self.ipyclient = parent
 
-        self._kernel_error = None
+        self.info_page = None
 
         self.bbox = SpyderDialogButtonBox(
             QDialogButtonBox.Ok | QDialogButtonBox.Cancel
         )
-
-        self._text_label = QLabel()
-        self._text_label.setWordWrap(True)
+        self.bbox.button(QDialogButtonBox.Ok).setText(SHOW_DETAILS)
 
         # Process to run the installation scripts
         self._process = QProcess(self)
@@ -69,19 +64,16 @@ def __init__(self, parent=None):
             lambda: self._update_details(error=True)
         )
         self._process.finished.connect(self._handle_process_finished)
-        self._process.errorOccurred.connect(self._handle_error)
 
         # Area to show stdout/stderr streams of the process that performs the
         # update
         self._streams_area = QPlainTextEdit(self)
-        self._streams_area.setMinimumHeight(300)
         self._streams_area.setReadOnly(True)
         self._streams_area.setLineWrapMode(QPlainTextEdit.NoWrap)
         self._streams_area.setFont(self.get_font(SpyderFontType.Monospace))
         self._streams_area.hide()
 
         layout = QVBoxLayout()
-        layout.addWidget(self._text_label)
         layout.addWidget(self._streams_area)
         layout.addWidget(self.bbox)
         self.setLayout(layout)
@@ -92,20 +84,15 @@ def __init__(self, parent=None):
     # ---- Qt methods
     # -------------------------------------------------------------------------
     def accepted(self):
-        self._text_label.hide()
-        self.bbox.hide()
-        self._streams_area.show()
-
-        # Install spyder kernels...
-        self.install_spyder_kernels(self.kernel_error.pyexec)
+        if self._streams_area.isVisible():
+            self._hide_details()
+        else:
+            self._show_details()
 
     def rejected(self):
-        # pass through kernel error
-        if isinstance(self.kernel_error, SpyderKernelVersionError):
-            # Recast to avoid recursion.
-            self.kernel_error.__class__ = SpyderKernelError
-
-        self.ipyclient.show_kernel_error(self.kernel_error)
+        self._process.terminate()
+        logger.info("Install spyder-kernels cancelled by user.")
+        # Note: QProcess.finished is still emitted
 
     # ---- Private API
     # -------------------------------------------------------------------------
@@ -131,54 +118,31 @@ def _update_details(self, error=False):
         text = str(qba.data(), "utf-8")
         self._add_text_to_streams_area(text)
 
+    def _show_details(self):
+        self.ipyclient.infowidget.hide()
+        self._streams_area.show()
+        self.bbox.button(QDialogButtonBox.Ok).setText(HIDE_DETAILS)
+
+    def _hide_details(self):
+        self._streams_area.hide()
+        self.ipyclient.infowidget.show()
+        self.bbox.button(QDialogButtonBox.Ok).setText(SHOW_DETAILS)
+
     def _handle_process_finished(self, exit_code, exit_status):
+        output = self._streams_area.toPlainText()
         logger.info(
             "Install spyder-kernels QProcess finished. "
             f"Exit code: {exit_code}; exit status: {exit_status}"
         )
         logger.debug(
             "Install spyder-kernels output:\n"
-            f"{self._streams_area.toPlainText()}"
+            f"{output}"
         )
 
-        if exit_code != 0:
-            return
-
-        self._streams_area.hide()
-        self._streams_area.clear()
-        self._text_label.show()
-        self.bbox.show()
-
-        self.ipyclient.connect_after_kernel_install()
-
-    def _handle_error(self, error):
-        if error == QProcess.FailedToStart:
-            text = "The process failed to start."
-        elif error == QProcess.Crashed:
-            text = "The process crashed."
-        else:
-            text = "Unknown error."
-
-        self._add_text_to_streams_area(text)
+        self.ipyclient.process_kernel_install(exit_code, exit_status, output)
 
     # ---- Public API
     # -------------------------------------------------------------------------
-    @property
-    def kernel_error(self):
-        return self._kernel_error
-
-    @kernel_error.setter
-    def kernel_error(self, kernel_error):
-        self._kernel_error = kernel_error
-        self._text_label.setText(
-            INSTALL_TEXT.format(
-                SPYDER_KERNELS_VERSION.replace(">", "&gt;").replace(
-                    "<", "&lt;"
-                ),
-                kernel_error.pyexec,
-            )
-        )
-
     def install_spyder_kernels(self, pyexec):
         """Install spyder-kernels"""
 

spyder/plugins/ipythonconsole/widgets/main_widget.py

@@ -38,6 +38,7 @@
 from spyder.api.widgets.main_widget import PluginMainWidget
 from spyder.config.base import get_home_dir, running_under_pytest
 from spyder.plugins.application.api import ApplicationActions
+from spyder.plugins.ipythonconsole import SpyderKernelVersionError
 from spyder.plugins.ipythonconsole.api import (
     ClientContextMenuActions,
     IPythonConsoleWidgetActions,
@@ -1440,6 +1441,10 @@ def _connect_new_client_to_kernel(
             )
             kernel_spec.env = future.result()
             kernel_handler = self.get_cached_kernel(kernel_spec, cache=cache)
+        except SpyderKernelVersionError as e:
+            client.show_kernel_error(e)
+            client.show_install_mbox(e.pyexec)
+            return
         except Exception as e:
             client.show_kernel_error(e)
             return