Merge pull request #24269 from mrclary/async-env-var

PR: Get user environment variables asynchronously

Author: ccordoba12

spyder/app/tests/test_mainwindow.py

@@ -812,7 +812,7 @@ def check_cwd():
     sys.platform.startswith("linux") and running_in_ci(),
     reason='Fails sometimes on Linux and CIs'
 )
-@pytest.mark.skipif(sys.platform == "darwin", reason="Fails sometimes on Mac")
+@pytest.mark.close_main_window
 def test_dedicated_consoles(main_window, qtbot):
     """Test running code in dedicated consoles."""
     shell = main_window.ipyconsole.get_current_shellwidget()
@@ -821,7 +821,7 @@ def test_dedicated_consoles(main_window, qtbot):
         timeout=SHELL_TIMEOUT,
     )
 
-    # ---- Load test file ----
+    # --- Load test file ---
     test_file = osp.join(LOCATION, 'script.py')
     main_window.editor.load(test_file)
     code_editor = main_window.editor.get_focus_widget()
@@ -914,7 +914,13 @@ def test_dedicated_consoles(main_window, qtbot):
     # --- Assert runfile text is present after reruns ---
     assert 'runfile' in control.toPlainText()
 
-    # ---- Closing test file and resetting config ----
+    # --- Assert no re-execution when already executing
+    shell.execute("import time; time.sleep(5)")  # Execute something long
+    qtbot.keyClick(code_editor, Qt.Key_F5)  # Try to execute while busy
+    qtbot.wait(6000)  # First exectution should be done
+    assert not shell.is_defined("zz")  # Second execution did not occur
+
+    # --- Closing test file and resetting config ---
     main_window.editor.close_file()
     CONF.set('run', 'configurations', {})
     CONF.set('run', 'last_used_parameters_per_executor', {})
@@ -1006,6 +1012,7 @@ def test_shell_execution(main_window, qtbot, tmpdir):
     reason="Fails frequently on Mac and CI",
 )
 @pytest.mark.order(after="test_debug_unsaved_function")
+@pytest.mark.close_main_window
 def test_connection_to_external_kernel(main_window, qtbot):
     """Test that only Spyder kernels are connected to the Variable Explorer."""
     # Test with a generic kernel
@@ -1070,13 +1077,13 @@ def test_connection_to_external_kernel(main_window, qtbot):
         shell.execute('q')
 
     # Try quitting the kernels
-    shell.execute('quit()')
-    python_shell.execute('quit()')
+    with qtbot.waitSignal(shell.executed):
+        shell.execute('quit()')
+    with qtbot.waitSignal(python_shell.executed):
+        python_shell.execute('quit()')
 
     # Make sure everything quit properly
-    qtbot.waitUntil(lambda: not km.is_alive())
     assert not km.is_alive()
-    qtbot.waitUntil(lambda: not spykm.is_alive())
     assert not spykm.is_alive()
 
     # Close the channels
@@ -1198,6 +1205,7 @@ def test_change_cwd_explorer(main_window, qtbot, tmpdir, test_directory):
      parse(ipy_release.version) == parse('7.11.0')),
     reason="Hard to test on Windows and macOS and fails for IPython 7.11.0")
 @pytest.mark.order(after="test_debug_unsaved_function")
+@pytest.mark.close_main_window
 def test_run_cython_code(main_window, qtbot):
     """Test all the different ways we have to run Cython code"""
     # Wait until the window is fully up
@@ -1217,6 +1225,7 @@ def test_run_cython_code(main_window, qtbot):
 
     # Run file
     qtbot.keyClick(code_editor, Qt.Key_F5)
+    qtbot.wait(1500)
 
     # Get a reference to the namespace browser widget
     nsb = main_window.variableexplorer.current_widget()
@@ -1240,6 +1249,7 @@ def test_run_cython_code(main_window, qtbot):
 
     # Run file
     qtbot.keyClick(code_editor, Qt.Key_F5)
+    qtbot.wait(500)
 
     # Wait until all objects have appeared in the variable explorer
     qtbot.waitUntil(lambda: nsb.editor.source_model.rowCount() == 1,

spyder/plugins/ipythonconsole/tests/conftest.py

@@ -372,6 +372,8 @@ def threads_condition():
         show_diff(init_files, files, "files")
         raise
 
+    window.close()
+
 
 @pytest.fixture
 def mpl_rc_file(tmp_path):

spyder/plugins/ipythonconsole/tests/test_ipythonconsole.py

@@ -1399,7 +1399,10 @@ def test_kernel_kill(ipyconsole, qtbot, external_interpreter):
     shell = ipyconsole.get_current_shellwidget()
 
     # Wait for the restarter to start
-    qtbot.wait(3000)
+    qtbot.waitUntil(
+        lambda: shell._prompt_html is not None, timeout=SHELL_TIMEOUT
+    )
+
     crash_string = 'import os, signal; os.kill(os.getpid(), signal.SIGTERM)'
 
     # Check only one comm is open

spyder/plugins/ipythonconsole/utils/kernelspec.py

@@ -36,7 +36,7 @@
     SPYDER_KERNELS_CONDA, SPYDER_KERNELS_PIP, SPYDER_KERNELS_VERSION,
     SpyderKernelError)
 from spyder.utils.conda import conda_version, find_conda, find_pixi
-from spyder.utils.environ import clean_env, get_user_environment_variables
+from spyder.utils.environ import clean_env
 from spyder.utils.misc import get_python_executable
 from spyder.utils.programs import (
     get_module_version,
@@ -91,15 +91,13 @@ class SpyderKernelSpec(KernelSpec, SpyderConfigurationAccessor):
 
     CONF_SECTION = 'ipython_console'
 
-    def __init__(self, path_to_custom_interpreter=None,
-                 **kwargs):
+    def __init__(self, path_to_custom_interpreter=None, **kwargs):
         super().__init__(**kwargs)
         self.path_to_custom_interpreter = path_to_custom_interpreter
         self.display_name = 'Python 3 (Spyder)'
         self.language = 'python3'
         self.resource_dir = ''
-
-        self.env = get_user_environment_variables()
+        self._env_vars = {}
 
     @property
     def argv(self):
@@ -237,7 +235,8 @@ def argv(self):
     def env(self):
         """Env vars for kernels"""
         default_interpreter = self.get_conf(
-            'default', section='main_interpreter')
+            'default', section='main_interpreter'
+        )
 
         # Ensure that user environment variables are included, but don't
         # override existing environ values

spyder/plugins/ipythonconsole/widgets/client.py

@@ -168,10 +168,15 @@ def __init__(
         )
         self.infowidget = self.container.infowidget
         self.blank_page = self._create_blank_page()
-        self.loading_page = self._create_loading_page()
-        # To keep a reference to the page to be displayed
-        # in infowidget
-        self.info_page = None
+        self.kernel_loading_page = self._create_loading_page()
+        self.env_loading_page = self._create_loading_page(env=True)
+
+        if self.is_remote():
+            # Keep a reference
+            self.info_page = None
+        else:
+            # Initially show environment loading page
+            self.info_page = self.env_loading_page
 
         # Elapsed time
         self.t0 = time.monotonic()
@@ -233,16 +238,22 @@ def _when_kernel_is_ready(self):
         if self.give_focus:
             self.shellwidget._control.setFocus()
 
-    def _create_loading_page(self):
+    def _create_loading_page(self, env=False):
         """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...")
-        page = loading_template.substitute(css_path=self.css_path,
-                                           loading_img=loading_img,
-                                           message=message)
+
+        if env:
+            message = _("Retrieving environment variables...")
+        page = loading_template.substitute(
+            css_path=self.css_path,
+            loading_img=loading_img,
+            message=message
+        )
+
         return page
 
     def _create_blank_page(self):
@@ -251,16 +262,16 @@ def _create_blank_page(self):
         page = loading_template.substitute(css_path=self.css_path)
         return page
 
-    def _show_loading_page(self):
-        """Show animation while the kernel is loading."""
+    def _show_loading_page(self, page=None):
+        """Show animation while loading."""
         if self.infowidget is not None:
             self.shellwidget.hide()
             self.infowidget.show()
-            self.info_page = self.loading_page
+            self.info_page = page if page else self.kernel_loading_page
             self.set_info_page()
 
     def _hide_loading_page(self):
-        """Hide animation shown while the kernel is loading."""
+        """Hide animation shown while loading."""
         if self.infowidget is not None:
             self.infowidget.hide()
             self.info_page = self.blank_page
@@ -363,6 +374,10 @@ def connection_file(self):
 
     def connect_kernel(self, kernel_handler, first_connect=True):
         """Connect kernel to client using our handler."""
+        self._hide_loading_page()
+        if not self.is_remote():
+            self._show_loading_page(self.kernel_loading_page)
+
         self.kernel_handler = kernel_handler
 
         # Connect standard streams.
@@ -377,11 +392,6 @@ def connect_kernel(self, kernel_handler, first_connect=True):
         kernel_handler.sig_kernel_is_ready.connect(
             self._when_kernel_is_ready)
 
-        if self.is_remote():
-            self._hide_loading_page()
-        else:
-            self._show_loading_page()
-
         # Actually do the connection
         self.shellwidget.connect_kernel(kernel_handler, first_connect)