WIP

[ci skip]

Author: ccordoba12

spyder/plugins/remoteclient/plugin.py

@@ -71,7 +71,7 @@ class RemoteClient(SpyderPluginV2):
     """
 
     NAME = "remoteclient"
-    OPTIONAL = [Plugins.IPythonConsole, Plugins.MainMenu]
+    OPTIONAL = [Plugins.MainMenu]
     CONF_SECTION = NAME
     CONTAINER_CLASS = RemoteClientContainer
     CONF_FILE = False
@@ -90,6 +90,20 @@ class RemoteClient(SpyderPluginV2):
 
     sig_version_mismatch = Signal(str, str)
 
+    # For remote envs
+    sig_import_env_requested = Signal(str, str, str)
+    """
+    Signal to request importing an environment in the remote machine.
+
+    Parameters
+    ----------
+    config_id: str
+        Machine identifier.
+    import_file_path: str
+        Path to the file that will be used to import the environment.
+    env_name: str
+        Environment name.
+    """
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -120,6 +134,9 @@ def on_initialize(self):
         container.sig_stop_server_requested.connect(self.sig_server_stopped)
         container.sig_server_renamed.connect(self.sig_server_renamed)
         container.sig_server_changed.connect(self.sig_server_changed)
+        container.sig_import_env_requested.connect(
+            self.sig_import_env_requested
+        )
 
         # Plugin signals
         self.sig_connection_status_changed.connect(

spyder/plugins/remoteclient/widgets/connectiondialog.py

@@ -52,6 +52,7 @@ class ConnectionDialog(SidebarDialog):
     sig_stop_server_requested = Signal(str)
     sig_server_renamed = Signal(str)
     sig_connections_changed = Signal()
+    sig_import_env_requested = Signal(str, str, str)
 
     def __init__(self, parent=None):
         self.ICON = ima.icon('remote_server')
@@ -187,9 +188,11 @@ def _save_connection_info(self):
         """Save the connection info stored in a page."""
         page = self.get_page()
 
-        # Validate info
-        if not page.validate_page():
-            return
+        # Validation is done in _on_button_next_clicked in this case
+        if not(ENV_MANAGER and page.NEW_CONNECTION):
+            # Validate info
+            if not page.validate_page():
+                return
 
         if page.NEW_CONNECTION:
             # Save info provided by users
@@ -265,7 +268,10 @@ def _start_server(self):
         page = self.get_page()
 
         # Validate info
-        if not page.validate_page():
+        if ENV_MANAGER and page.NEW_CONNECTION:
+            if not self._new_connection_page.validate_env_creation():
+                return
+        elif not page.validate_page():
             return
 
         # This uses the current host_id in case users want to start a
@@ -280,7 +286,23 @@ def _start_server(self):
             # TODO: Handle the case when the connection info is active and
             # users change its info.
 
-        self.sig_start_server_requested.emit(host_id)
+        if ENV_MANAGER and page.NEW_CONNECTION:
+            if page.selected_env_creation_method() == CreateEnvMethods.NewEnv:
+                # TODO! Implement later
+                pass
+            elif (
+                page.selected_env_creation_method()
+                == CreateEnvMethods.ImportEnv
+            ):
+                import_file_path, env_name = page.get_create_env_info()
+                print(import_file_path, env_name)
+                self.sig_import_env_requested.emit(
+                    host_id, import_file_path, env_name
+                )
+            elif page.selected_env_creation_method() == CreateEnvMethods.NoEnv:
+                self.sig_start_server_requested.emit(host_id)
+        else:
+            self.sig_start_server_requested.emit(host_id)
 
     def _stop_server(self):
         """Stop the server corresponding to a given page."""

spyder/plugins/remoteclient/widgets/connectionpages.py

@@ -49,7 +49,7 @@
 from spyder.widgets.helperwidgets import MessageLabel, TipWidget
 
 try:
-    import spyder_env_manager  # noqa
+    from spyder_env_manager.spyder.widgets.new_environment import NewEnvironment
     ENV_MANAGER = True
 except Exception:
     ENV_MANAGER = False
@@ -707,6 +707,13 @@ def get_name(self):
         return _("New connection")
 
     def setup_page(self):
+        # Attributes
+        self.env_method_group = QButtonGroup(self)
+        self._radio_buttons_to_info_widgets: dict[
+            CreateEnvMethods, QWidget
+        ] = {}
+
+        # Widgets
         self.ssh_info_widget = self.create_ssh_connection_info_widget()
         jupyterhub_info_widget = self.create_jupyterhub_connection_info_widget()
 
@@ -807,6 +814,29 @@ def is_ssh_info_widget_shown(self) -> bool:
     def selected_env_creation_method(self) -> CreateEnvMethods:
         return self.env_method_group.checkedId()
 
+    def validate_env_creation(self):
+        method_id = self.env_method_group.checkedId()
+        if method_id != CreateEnvMethods.NoEnv:
+            env_method_widget = self._radio_buttons_to_info_widgets[method_id]
+            if env_method_widget.validate_page(env_names=[]):
+                return True
+            else:
+                return False
+
+        return True
+
+    def get_create_env_info(self):
+        method_id = self.env_method_group.checkedId()
+        env_method_widget = self._radio_buttons_to_info_widgets[method_id]
+        if method_id == CreateEnvMethods.NewEnv:
+            # TODO! Implement later
+            pass
+        elif method_id == CreateEnvMethods.ImportEnv:
+            return (
+                env_method_widget.get_zip_file(),
+                env_method_widget.get_env_name()
+            )
+
     # ---- Private API
     # -------------------------------------------------------------------------
     def _create_env_creation_widget(self):
@@ -842,7 +872,9 @@ def _create_env_creation_widget(self):
         # Available methods
         methods_group = QGroupBox(_("Available methods"))
 
-        self.env_method_group = QButtonGroup(self)
+        self.env_method_group.idToggled.connect(
+            self._on_env_creation_method_changed
+        )
 
         new_env_radio = self.create_radiobutton(
             _("Create a new environment"),
@@ -863,15 +895,60 @@ def _create_env_creation_widget(self):
             id_=CreateEnvMethods.NoEnv,
         )
 
-        new_env_radio.radiobutton.setChecked(True)
-
         methods_layout = QVBoxLayout()
         methods_layout.addSpacing(3)
         methods_layout.addWidget(new_env_radio)
         methods_layout.addWidget(import_env_radio)
         methods_layout.addWidget(no_env_radio)
         methods_group.setLayout(methods_layout)
 
+        # Required info
+        info_group = QGroupBox(_("Required information"))
+
+        new_env_info = NewEnvironment(
+            self,
+            max_width_for_content=470,
+            show_in_remote_connections_dialog=True
+        )
+        new_env_info.setMaximumWidth(470)
+
+        import_env_info = NewEnvironment(
+            self,
+            max_width_for_content=470,
+            import_env=True,
+            show_in_remote_connections_dialog=True
+        )
+        import_env_info.setMaximumWidth(470)
+
+        no_env_info = QLabel(
+            _(
+                "You can set up an environment later by going to the menu "
+                "entry <i>Tools > Environment manager</i>."
+            )
+        )
+        no_env_info.setWordWrap(True)
+
+        info_layout = QVBoxLayout()
+        info_layout.addWidget(new_env_info)
+        info_layout.addWidget(import_env_info)
+        info_layout.addWidget(no_env_info)
+        info_group.setLayout(info_layout)
+
+        # Hide all info widgets to show
+        for widget in [new_env_info, import_env_info, no_env_info]:
+            widget.setVisible(False)
+
+        # Use the following mapping to show/hide info widgets when the
+        # corresponding radio button is toggled
+        self._radio_buttons_to_info_widgets = {
+            CreateEnvMethods.NewEnv: new_env_info,
+            CreateEnvMethods.ImportEnv: import_env_info,
+            CreateEnvMethods.NoEnv: no_env_info,
+        }
+
+        # Set new env as the default method
+        new_env_radio.radiobutton.setChecked(True)
+
         # Final layout
         layout = QVBoxLayout()
         layout.setContentsMargins(
@@ -880,13 +957,19 @@ def _create_env_creation_widget(self):
         layout.addLayout(intro_layout)
         layout.addSpacing(8 * AppStyle.MarginSize)
         layout.addWidget(methods_group)
+        layout.addWidget(info_group)
         layout.addStretch()
 
         env_creation_widget = QWidget(self)
         env_creation_widget.setLayout(layout)
 
         return env_creation_widget
 
+    def _on_env_creation_method_changed(
+        self, id_: CreateEnvMethods, checked: bool
+    ):
+        self._radio_buttons_to_info_widgets[id_].setVisible(checked)
+
 
 class ConnectionPage(BaseConnectionPage):
     """Page to display connection status and info for a remote machine."""

spyder/plugins/remoteclient/widgets/container.py

@@ -10,7 +10,6 @@
 # Standard library imports
 from __future__ import annotations
 from collections import deque
-import functools
 
 # Third-party imports
 from qtpy.QtCore import Signal
@@ -31,6 +30,7 @@
 
 
 class RemoteClientContainer(PluginMainContainer):
+
     sig_start_server_requested = Signal(str)
     """
     This signal is used to request starting a remote server.
@@ -88,6 +88,20 @@ class RemoteClientContainer(PluginMainContainer):
         Dictionary that contains the log message and its metadata.
     """
 
+    sig_import_env_requested = Signal(str, str, str)
+    """
+    Signal to request importing an environment in the remote machine.
+
+    Parameters
+    ----------
+    config_id: str
+        Machine identifier.
+    import_file_path: str
+        Path to the file that will be used to import the environment.
+    env_name: str
+        Environment name.
+    """
+
     # ---- PluginMainContainer API
     # -------------------------------------------------------------------------
     def setup(self):
@@ -153,6 +167,9 @@ def _show_connection_dialog(self):
             self.sig_server_changed
         )
         connection_dialog.sig_server_renamed.connect(self.sig_server_renamed)
+        connection_dialog.sig_import_env_requested.connect(
+            self.sig_import_env_requested
+        )
 
         connection_dialog.show()
 

spyder/widgets/config.py

@@ -549,7 +549,11 @@ def create_radiobutton(self, text, option, default=NoDefault,
         radiobutton = QRadioButton(text)
         layout.addWidget(radiobutton)
 
-        if section is not None and section != self.CONF_SECTION:
+        if (
+            option is not None
+            and section is not None
+            and section != self.CONF_SECTION
+        ):
             self.cross_section_options[option] = section
 
         if button_group is None:
@@ -562,7 +566,8 @@ def create_radiobutton(self, text, option, default=NoDefault,
         else:
             button_group.addButton(radiobutton, id=id_)
 
-        self.radiobuttons[radiobutton] = (section, option, default)
+        if option is not None:
+            self.radiobuttons[radiobutton] = (section, option, default)
 
         if msg_warning is not None or msg_info is not None:
             def show_message(is_checked):