Merge pull request #24826 from hlouzada/fix/remoteclient/config

PR: Update connection info after editing it and fix some bugs with remote consoles and file explorer (Remote client/IPython console/Files)

Author: ccordoba12

spyder/app/mainwindow.py

@@ -1120,7 +1120,8 @@ def closing(self, cancelable=False, close_immediately=False):
         if self.already_closed or self.is_starting_up:
             return True
 
-        self.layouts.save_visible_plugins()
+        if self.layouts is not None:
+            self.layouts.save_visible_plugins()
 
         self.plugin_registry = PLUGIN_REGISTRY
 

spyder/plugins/explorer/plugin.py

@@ -242,6 +242,11 @@ def on_application_available(self):
         application = self.get_plugin(Plugins.Application)
         self.sig_open_file_requested.connect(application.open_file_in_plugin)
 
+    @on_plugin_available(plugin=Plugins.RemoteClient)
+    def on_remote_client_available(self):
+        remoteclient = self.get_plugin(Plugins.RemoteClient)
+        remoteclient.sig_server_stopped.connect(self._on_server_stopped)
+
     @on_plugin_teardown(plugin=Plugins.Editor)
     def on_editor_teardown(self):
         editor = self.get_plugin(Plugins.Editor)
@@ -282,12 +287,8 @@ def on_application_teardown(self):
 
     @on_plugin_teardown(plugin=Plugins.RemoteClient)
     def on_remote_client_teardown(self):
-        if len(self._file_managers):
-            for file_manager in self._file_managers.values():
-                AsyncDispatcher(
-                    loop=file_manager.session._loop, early_return=False
-                )(file_manager.close)()
-            self._file_managers = {}
+        remoteclient = self.get_plugin(Plugins.RemoteClient)
+        remoteclient.sig_server_stopped.disconnect(self._on_server_stopped)
 
     def on_close(self, cancelable=False):
         if len(self._file_managers):
@@ -297,20 +298,6 @@ def on_close(self, cancelable=False):
                 )(file_manager.close)()
             self._file_managers = {}
 
-    # ---- Private API
-    # ------------------------------------------------------------------------
-    @AsyncDispatcher(loop="explorer")
-    async def _get_remote_files_manager(self, server_id):
-        remoteclient = self.get_plugin(Plugins.RemoteClient, error=False)
-        if not remoteclient:
-            return
-        if server_id not in self._file_managers:
-            self._file_managers[server_id] = remoteclient.get_file_api(
-                server_id
-            )()
-            await self._file_managers[server_id].connect()
-        return self._file_managers.get(server_id, None)
-
     # ---- Public API
     # ------------------------------------------------------------------------
     def chdir(self, directory, emit=True, server_id=None):
@@ -368,3 +355,25 @@ def _chdir_from_working_directory(
         if sender_plugin != self.NAME:
             self.chdir(directory, emit=False, server_id=server_id)
             self.refresh(directory)
+
+    @AsyncDispatcher(loop="explorer")
+    async def _get_remote_files_manager(self, server_id):
+        remoteclient = self.get_plugin(Plugins.RemoteClient, error=False)
+        if not remoteclient:
+            return
+        if server_id not in self._file_managers:
+            self._file_managers[server_id] = remoteclient.get_file_api(
+                server_id
+            )()
+            await self._file_managers[server_id].connect()
+        return self._file_managers.get(server_id, None)
+
+    def _on_server_stopped(self, server_id):
+        file_manager = self._file_managers.get(server_id)
+        if file_manager:
+            AsyncDispatcher(
+                loop=file_manager.session._loop, early_return=False
+            )(file_manager.close)()
+            self._file_managers.pop(server_id)
+
+        self.get_widget().reset_remote_treewidget(server_id)

spyder/plugins/explorer/widgets/main_widget.py

@@ -11,7 +11,6 @@
 # Standard library imports
 import logging
 import os.path as osp
-import sys
 
 # Third-party imports
 from qtpy.QtCore import Qt, Signal, Slot
@@ -506,6 +505,8 @@ def update_history(self, directory):
         """
         self.treewidget.update_history(directory)
 
+    def reset_remote_treewidget(self, server_id):
+        self.remote_treewidget.reset(server_id)
 
 # =============================================================================
 # Tests

spyder/plugins/explorer/widgets/remote_explorer.py

@@ -108,8 +108,8 @@ def __init__(self, parent=None, class_parent=None, files=None):
 
         # General attributes
         self.remote_files_manager = None
-        self.server_id = None
-        self.root_prefix = ""
+        self.server_id: str | None = None
+        self.root_prefix: dict[str, str] = {}
 
         self.background_files_load = set()
         self.extra_files = []
@@ -559,7 +559,7 @@ async def _do_remote_upload_file(self, local_path):
             return
 
         remote_file = posixpath.join(
-            self.root_prefix, os.path.basename(local_path)
+            self.root_prefix[self.server_id], os.path.basename(local_path)
         )
         file_content = None
 
@@ -607,7 +607,9 @@ async def _do_remote_ls(self, path, server_id):
             init_files_display = self.get_conf("init_files_display")
             generator = self.remote_files_manager.ls(path)
             async for file in generator:
-                file_name = os.path.relpath(file["name"], self.root_prefix)
+                file_name = os.path.relpath(
+                    file["name"], self.root_prefix[self.server_id]
+                )
                 file_type = file["type"]
                 if len(files) < init_files_display:
                     if not self.get_conf(
@@ -655,7 +657,9 @@ async def _get_extra_files(self, generator, already_added):
                 self.more_files_available = True
                 break
 
-            file_name = os.path.relpath(file["name"], self.root_prefix)
+            file_name = os.path.relpath(
+                file["name"], self.root_prefix[self.server_id]
+            )
             file_type = file["type"]
             if not self.get_conf("show_hidden") and file_name.startswith("."):
                 continue
@@ -679,7 +683,7 @@ async def _get_extra_files(self, generator, already_added):
         )
 
     def _new_item(self, new_name, for_file=False, with_content=False):
-        new_path = posixpath.join(self.root_prefix, new_name)
+        new_path = posixpath.join(self.root_prefix[self.server_id], new_name)
         if not with_content:
             self._do_remote_new(new_path, for_file=for_file).connect(
                 self._on_remote_new
@@ -725,11 +729,12 @@ def chdir(
                 self.history.append(directory)
             self.histindex = len(self.history) - 1
 
-        if directory == self.root_prefix:
+        if directory == self.root_prefix.get(server_id):
             return
-        self.root_prefix = directory
+
         if server_id:
             self.server_id = server_id
+        self.root_prefix[self.server_id] = directory
         if remote_files_manager:
             self.remote_files_manager = remote_files_manager
         self.refresh(force_current=True)
@@ -762,7 +767,7 @@ def set_files(self, files, reset=True):
 
             for file in files:
                 path = file["name"]
-                name = os.path.relpath(path, self.root_prefix)
+                name = os.path.relpath(path, self.root_prefix[self.server_id])
 
                 file_type = file["type"]
                 icon = ima.icon("FileIcon")
@@ -827,16 +832,16 @@ def fetch_more_files(self):
         )
 
     def set_current_folder(self, folder):
-        self.root_prefix = folder
+        self.root_prefix[self.server_id] = folder
         return self.model.invisibleRootItem()
 
     def get_current_folder(self):
-        return self.root_prefix
+        return self.root_prefix[self.server_id]
 
     def go_to_parent_directory(self):
-        parent_directory = os.path.dirname(self.root_prefix)
+        parent_directory = os.path.dirname(self.root_prefix[self.server_id])
         logger.debug(
-            f"Going to parent directory of {self.root_prefix}: "
+            f"Going to parent directory of {self.root_prefix[self.server_id]}: "
             f"{parent_directory}"
         )
         self.chdir(parent_directory)
@@ -859,7 +864,7 @@ def go_to_next_directory(self):
     def refresh(self, new_path=None, force_current=False):
         if force_current:
             if new_path is None:
-                new_path = self.root_prefix
+                new_path = self.root_prefix.get(self.server_id)
             self._do_remote_ls(new_path, self.server_id).connect(
                 self._on_remote_ls
             )
@@ -941,7 +946,9 @@ def copy_paste_item(self):
         data = self.model.data(data_index, Qt.UserRole + 1)
         if data:
             old_path = data["name"]
-            relpath = os.path.relpath(old_path, self.root_prefix)
+            relpath = os.path.relpath(
+                old_path, self.root_prefix[self.server_id]
+            )
             new_relpath, valid = QInputDialog.getText(
                 self,
                 _("Copy and Paste"),
@@ -950,7 +957,9 @@ def copy_paste_item(self):
                 relpath,
             )
             if valid:
-                new_path = posixpath.join(self.root_prefix, new_relpath)
+                new_path = posixpath.join(
+                    self.root_prefix[self.server_id], new_relpath
+                )
                 self._do_remote_copy_paste(old_path, new_path).connect(
                     self._on_remote_copy_paste
                 )
@@ -968,12 +977,16 @@ def rename_item(self):
         data = self.model.data(data_index, Qt.UserRole + 1)
         if data:
             old_path = data["name"]
-            relpath = os.path.relpath(old_path, self.root_prefix)
+            relpath = os.path.relpath(
+                old_path, self.root_prefix[self.server_id]
+            )
             new_relpath, valid = QInputDialog.getText(
                 self, _("Rename"), _("New name:"), QLineEdit.Normal, relpath
             )
             if valid:
-                new_path = posixpath.join(self.root_prefix, new_relpath)
+                new_path = posixpath.join(
+                    self.root_prefix[self.server_id], new_relpath
+                )
                 self._do_remote_rename(old_path, str(new_path)).connect(
                     self._on_remote_rename
                 )
@@ -984,7 +997,7 @@ def copy_path(self):
             not self.view.currentIndex()
             or not self.view.currentIndex().isValid()
         ):
-            path = self.root_prefix
+            path = self.root_prefix[self.server_id]
         else:
             source_index = self.proxy_model.mapToSource(
                 self.view.currentIndex()
@@ -1009,7 +1022,7 @@ def delete_item(self):
         data = self.model.data(data_index, Qt.UserRole + 1)
         if data:
             path = data["name"]
-            filename = os.path.relpath(path, self.root_prefix)
+            filename = os.path.relpath(path, self.root_prefix[self.server_id])
             result = QMessageBox.warning(
                 self,
                 _("Delete"),
@@ -1037,7 +1050,7 @@ def download_item(self):
         data = self.model.data(data_index, Qt.UserRole + 1)
         if data:
             path = data["name"]
-            filename = os.path.relpath(path, self.root_prefix)
+            filename = os.path.relpath(path, self.root_prefix[self.server_id])
             is_file = data["type"] == "file"
             remote_filename = filename if is_file else f"{filename}.zip"
 
@@ -1068,3 +1081,6 @@ def upload_file(self):
                 self._on_remote_upload_file
             )
             self.sig_start_spinner_requested.emit()
+
+    def reset(self, server_id):
+        self.root_prefix[server_id] = None

spyder/plugins/ipythonconsole/widgets/client.py

@@ -673,7 +673,7 @@ def finish_close(self, is_last_client, close_console, debugging):
         self.shutdown(is_last_client, close_console=close_console)
 
         # Close jupyter api regardless of the kernel state
-        if self.is_remote():
+        if self.is_remote() and not self._jupyter_api.closed:
             AsyncDispatcher(
                 loop=self._jupyter_api.session._loop, early_return=False
             )(self._jupyter_api.close)()

spyder/plugins/ipythonconsole/widgets/main_widget.py

@@ -2186,13 +2186,20 @@ def get_related_clients(self, client, clients_list=None):
         """
         Get all other clients that are connected to the same kernel as `client`
         """
+        # At the moment it's not possible to have two clients connected to the
+        # same remote kernel.
+        if client.is_remote():
+            return []
+
         if clients_list is None:
             clients_list = self.clients
+
         related_clients = []
         for cl in clients_list:
             if (cl.connection_file == client.connection_file and
                     cl is not client):
                 related_clients.append(cl)
+
         return related_clients
 
     def close_related_clients(self, client):
@@ -2762,7 +2769,8 @@ def setup_remote_consoles_submenu(self, render=True):
 
         if self._remote_consoles_menu is None:
             self._remote_consoles_menu = self.create_menu(
-                RemoteConsolesMenus.RemoteConsoles, _("New console in remote server")
+                RemoteConsolesMenus.RemoteConsoles,
+                _("New console in remote server")
             )
 
         self._remote_consoles_menu.clear_actions()

spyder/plugins/remoteclient/api/manager/base.py

@@ -93,7 +93,7 @@ def __init__(
         if not get_debug_level():
             self.logger.setLevel(logging.DEBUG)
 
-        if self._plugin is not None:
+        if self._plugin is not None and not self.logger.hasHandlers():
             self.logger.addHandler(SpyderRemoteAPILoggerHandler(self))
 
     @AsyncDispatcher(loop="asyncssh", early_return=False)

spyder/plugins/remoteclient/api/modules/base.py

@@ -7,17 +7,12 @@
 from __future__ import annotations
 
 import asyncio
-import contextlib
-import json
 import logging
-import struct
 import typing
 from abc import abstractmethod
-import uuid
 
 import aiohttp
 import yarl
-import zmq.asyncio
 
 from spyder.api.asyncdispatcher import AsyncDispatcher
 from spyder.api.utils import ABCMeta, abstract_attribute