PR: Hook into file actions

.github/workflows/run-tests.yml

@@ -15,7 +15,7 @@ jobs:
       matrix:
         OS: ['ubuntu', 'macos', 'windows']
         PYTHON_VERSION: ['3.9', '3.11', '3.12']
-        SPYDER_SOURCE: ['conda', 'git']
+        SPYDER_SOURCE: ['git']
     name: ${{ matrix.OS }} py${{ matrix.PYTHON_VERSION }} spyder-from-${{ matrix.SPYDER_SOURCE }}
     runs-on: ${{ matrix.OS }}-latest
     env:
@@ -36,6 +36,7 @@ jobs:
         with:
           miniforge-version: latest
           auto-update-conda: true
+          conda-remove-defaults: "true"
           python-version: ${{ matrix.PYTHON_VERSION }} 
       - name: Checkout Spyder from git
         if: matrix.SPYDER_SOURCE == 'git'
@@ -122,3 +123,10 @@ jobs:
           command: |
             cd spyder-notebook
             pytest spyder_notebook -vv
+      - name: Kill Python (Windows)
+        if: matrix.OS == 'windows'
+        shell: bash -l {0}
+        run: |
+          # This prevents hangs in Post Install Conda
+          tasklist | grep python || true
+          taskkill //im python.exe //f || true

requirements/conda.txt

@@ -1,4 +1,4 @@
-spyder >=6,<7
+spyder >=6.1,<6.2
 jupyter_core
 jupyter_server
 nbformat

setup.py

@@ -73,7 +73,7 @@ def run(self):
 
 
 REQUIREMENTS = [
-    'spyder>=6,<7',
+    'spyder>=6.1,<6.2',
     'nbformat',
     'notebook>=7.3.3,<7.4',
     'psutil',
@@ -94,7 +94,7 @@ def run(self):
     version=get_version(),
     cmdclass={'sdist': my_sdist},
     keywords='spyder jupyter notebook',
-    python_requires='>=3.8',
+    python_requires='>=3.9',
     url='https://github.com/spyder-ide/spyder-notebook',
     license='MIT',
     author='Spyder Development Team',

spyder_notebook/config.py

@@ -12,7 +12,6 @@
     (
         CONF_SECTION,
         {
-            'recent_notebooks': [],    # Items in "Open recent" menu
             'opened_notebooks': [],    # Notebooks to open at start
             'theme': 'same as spyder'  # Notebook theme (light/dark)
         }
@@ -26,4 +25,4 @@
 #    or if you want to *rename* options, then you need to do a MAJOR update in
 #    version, e.g. from 1.0.0 to 2.0.0
 # 3. You don't need to touch this value if you're just adding a new option
-CONF_VERSION = '0.1.0'
+CONF_VERSION = '1.0.0'

spyder_notebook/notebookplugin.py

@@ -8,6 +8,7 @@
 # Standard library imports
 import logging
 import os.path as osp
+from typing import Optional
 
 # Spyder imports
 from spyder.api.plugins import Plugins, SpyderDockablePlugin
@@ -28,7 +29,7 @@ class NotebookPlugin(SpyderDockablePlugin):
     """Spyder Notebook plugin."""
 
     NAME = 'notebook'
-    REQUIRES = [Plugins.Preferences]
+    REQUIRES = [Plugins.Application, Plugins.Preferences]
     OPTIONAL = [Plugins.IPythonConsole, Plugins.Switcher]
     TABIFY = [Plugins.Editor]
     CONF_SECTION = NAME
@@ -37,9 +38,18 @@ class NotebookPlugin(SpyderDockablePlugin):
     WIDGET_CLASS = NotebookMainWidget
     CONF_WIDGET_CLASS = NotebookConfigPage
 
+    # This plugin hooks into File menu actions
+    CAN_HANDLE_FILE_ACTIONS = True
+
+    # This plugin opens files with the .ipynb exetension
+    FILE_EXTENSIONS = ['.ipynb']
+
     # Action "Switch to notebook" gives focus to the plugin
     RAISE_AND_FOCUS = True
 
+    # This plugin requires Qt Web Widgets to function
+    REQUIRE_WEB_WIDGETS = True
+
     # ---- SpyderDockablePlugin API
     # ------------------------------------------------------------------------
     @staticmethod
@@ -62,6 +72,19 @@ def on_initialize(self):
         """Set up the plugin; does nothing."""
         pass
 
+    @on_plugin_available(plugin=Plugins.Application)
+    def on_application_available(self) -> None:
+        # Moving this import to the top of the file somehow interferes with
+        # the tests in test_main_window.py
+        from spyder.plugins.application.api import ApplicationActions
+
+        application = self.get_plugin(Plugins.Application)
+        application.enable_file_action(
+            ApplicationActions.RevertFile, False, self
+        )
+        widget = self.get_widget()
+        widget.sig_new_recent_file.connect(application.add_recent_file)
+
     @on_plugin_available(plugin=Plugins.Preferences)
     def on_preferences_available(self):
         preferences = self.get_plugin(Plugins.Preferences)
@@ -78,6 +101,12 @@ def on_switcher_available(self):
         switcher.sig_mode_selected.connect(self._handle_switcher_modes)
         switcher.sig_item_selected.connect(self._handle_switcher_selection)
 
+    @on_plugin_teardown(plugin=Plugins.Application)
+    def on_application_teardown(self) -> None:
+        application = self.get_plugin(Plugins.Application)
+        widget = self.get_widget()
+        widget.sig_new_recent_file.disconnect(application.add_recent_file)
+
     @on_plugin_teardown(plugin=Plugins.Preferences)
     def on_preferences_teardown(self):
         preferences = self.get_plugin(Plugins.Preferences)
@@ -97,9 +126,78 @@ def on_switcher_teardown(self):
     def on_mainwindow_visible(self):
         self.get_widget().open_previous_session()
 
-    # ------ Public API -------------------------------------------------------
-    def open_notebook(self, filenames=None):
-        self.get_widget().open_notebook(filenames)
+    def create_new_file(self) -> None:
+        """
+        Create a new notebook.
+        """
+        self.get_widget().create_new_client()
+
+    def open_file(self, filename: str) -> None:
+        """
+        Open file inside plugin.
+
+        This method will be called if the user wants to open a notebook.
+
+        Parameters
+        ----------
+        filename: str
+            The name of the file to be opened.
+        """
+        self.get_widget().open_notebook([filename])
+
+    def open_last_closed_file(self) -> None:
+        """
+        Reopens the notebook in the last closed tab.
+        """
+        self.get_widget().open_last_closed_notebook()
+
+    def save_file(self) -> None:
+        """
+        Save the current notebook.
+        """
+        self.get_widget().save_notebook()
+
+    def save_file_as(self) -> None:
+        """
+        Save the current notebook under a different name.
+        """
+        self.get_widget().save_as()
+
+    def save_copy_as(self) -> None:
+        """
+        Save a copy of the current notebook under a different name.
+        """
+        self.get_widget().save_as(close_after_save=False)
+
+    def save_all(self) -> None:
+        """
+        Save all opened notebooks.
+        """
+        self.get_widget().save_all()
+
+    def close_file(self) -> None:
+        """
+        Close the current notebook.
+        """
+        self.get_widget().close_notebook()
+
+    def close_all(self) -> None:
+        """
+        Close all notebook.
+        """
+        self.get_widget().close_all()
+
+    def get_current_filename(self) -> Optional[str]:
+        """
+        Return file name of the notebook that is currently displayed.
+        """
+        return self.get_widget().get_current_filename()
+
+    def current_file_is_temporary(self) -> bool:
+        """
+        Return whether currently displayed file is a temporary file.
+        """
+        return self.get_widget().current_file_is_temporary()
 
     # ------ Private API ------------------------------------------------------
     def _open_console(self, connection_file, tab_name):

spyder_notebook/tests/conftest.py

@@ -79,8 +79,9 @@ def get_plugin(self, plugin_name, error=True):
 class ConfigDialogTester(QWidget):
     def __init__(self, parent, main_class,
                  general_config_plugins, plugins):
-        # This import assumes that an QApplication is already running,
+        # These imports assumes that an QApplication is already running,
         # so we can not put it at the top of the file
+        from spyder.plugins.application.plugin import Application
         from spyder.plugins.preferences.plugin import Preferences
 
         super().__init__(parent)
@@ -107,6 +108,7 @@ def get_plugin(self, plugin_name, error=True):
 
         PLUGIN_REGISTRY.reset()
         PLUGIN_REGISTRY.sig_plugin_ready.connect(self._main.register_plugin)
+        PLUGIN_REGISTRY.register_plugin(self._main, Application)
         PLUGIN_REGISTRY.register_plugin(self._main, Preferences)
 
         if plugins:

spyder_notebook/tests/test_plugin.py

@@ -14,14 +14,12 @@
 from unittest.mock import Mock
 
 # Third-party library imports
-from flaky import flaky
 import pytest
 from qtpy.QtWebEngineWidgets import WEBENGINE
 from qtpy.QtWidgets import QMainWindow
 import requests
 
 # Spyder imports
-from spyder.api.plugins import Plugins
 from spyder.config.manager import CONF
 
 # Local imports
@@ -156,20 +154,18 @@ def test_on_mainwindow_visible_with_opened_notebooks_empty(plugin_no_server):
 
 def test_closing_main_widget(mocker, plugin_no_server):
     """Close the main widget with a welcome tab, a new notebooks and a notebook
-    opened from a file. Check that config variables `recent_notebooks` and
-    `opened_notebook` are correctly set."""
+    opened from a file. Check that config variable `opened_notebook` is
+    correctly set."""
     plugin = plugin_no_server
     main_widget = plugin.get_widget()
-    main_widget.clear_recent_notebooks()
     mock_set_option = mocker.patch.object(main_widget, 'set_conf')
     main_widget.tabwidget.maybe_create_welcome_client()
     main_widget.create_new_client()
     main_widget.open_notebook(['ham.ipynb'])
 
     plugin.get_widget().close()
 
-    expected = [mocker.call('recent_notebooks', ['ham.ipynb']),
-                mocker.call('opened_notebooks', ['ham.ipynb'])]
+    expected = [mocker.call('opened_notebooks', ['ham.ipynb'])]
     assert mock_set_option.call_args_list == expected
 
 

spyder_notebook/utils/templates/welcome-dark.html

@@ -628,8 +628,10 @@
 <h1 id="section"></h1>
 <h1 id="welcome-to-the-notebook-plugin">Welcome to Spyder-Notebook</h1>
 <p>Here you can open, edit and create Jupyter notebooks.</p>
-<p>To create new notebooks, you can right-click and then click on <em>New notebook</em>. You can also click the <span title="Open new notebook"><b>&#xFF0B;</b></span> button on the top right of this pane.</p>
-<p>To open and save notebooks, click the <span title="Options">&#9776;</span> button on the top right too.</p>
+<p>
+   The items in the <em>File</em> menu act on notebooks if this pane is active.
+   For example, <em>File</em> > <em>New file...</em> will create a new notebook.
+</p>
 <p>To resize the text and other elements in a notebook, you can right-click and choose <em>Zoom in</em> or <em>Zoom out</em>.</p>
 
     <HR/>

spyder_notebook/utils/templates/welcome.html

@@ -616,8 +616,10 @@
 <h1 id="section"></h1>
 <h1 id="welcome-to-the-notebook-plugin">Welcome to Spyder-Notebook</h1>
 <p>Here you can open, edit and create Jupyter notebooks.</p>
-<p>To create new notebooks, you can right-click and then click on <em>New notebook</em>. You can also click the <span title="Open new notebook"><b>&#xFF0B;</b></span> button on the top right of this pane.</p>
-<p>To open and save notebooks, click the <span title="Options">&#9776;</span> button on the top right too.</p>
+<p>
+   The items in the <em>File</em> menu act on notebooks if this pane is active.
+   For example, <em>File</em> > <em>New file...</em> will create a new notebook.
+</p>
 <p>To resize the text and other elements in a notebook, you can right-click and choose <em>Zoom in</em> or <em>Zoom out</em>.</p>
 
     <HR/>