Indicate dirty notebooks with * in tab

If a notebook is dirty (meaning that it has been changed since
the last save), then add an asterix `*` to the file name in the
title of the tab. This mirrors the behaviour of the editor.

Author: jitseniesen

spyder_notebook/widgets/client.py

@@ -322,6 +322,16 @@ class NotebookClient(QFrame):
 
     CONF_SECTION = CONF_SECTION
 
+    sig_dirty_changed = Signal(bool)
+    """
+    This signal is emitted when the notebook becomes dirty or non-dirty.
+
+    Parameters
+    ----------
+    new_value : bool
+        Whether the notebook is now dirty.
+    """
+
     def __init__(self, parent, filename, actions=None, ini_message=None):
         """
         Constructor.
@@ -349,6 +359,7 @@ def __init__(self, parent, filename, actions=None, ini_message=None):
         self.file_url = None
         self.server_url = None
         self.path = None
+        self.dirty = False
 
         self.notebookwidget = NotebookWidget(self, actions)
         if ini_message:
@@ -358,6 +369,8 @@ def __init__(self, parent, filename, actions=None, ini_message=None):
             self.notebookwidget.show_blank()
             self.static = False
 
+        self.notebookwidget.sig_dirty_changed.connect(
+            self._handle_dirty_changed)
         self.notebookwidget.sig_focus_in_event.connect(
             lambda: self._apply_stylesheet(focus=True))
         self.notebookwidget.sig_focus_out_event.connect(
@@ -527,6 +540,14 @@ def _apply_stylesheet(self, focus=False):
 
         self.setStyleSheet(css.toString())
 
+    def _handle_dirty_changed(self, new_value: bool) -> None:
+        """
+        Handle signal that a notebook became dirty or not.
+
+        Store the new value and emit the signal again.
+        """
+        self.dirty = new_value
+        self.sig_dirty_changed.emit(new_value)
 
 # -----------------------------------------------------------------------------
 # Tests

spyder_notebook/widgets/notebooktabwidget.py

@@ -207,6 +207,7 @@ def create_new_client(self, filename=None):
 
         client = NotebookClient(self, filename, self.actions)
         self.add_tab(client)
+        client.sig_dirty_changed.connect(self.handle_dirty_changed)
         interpreter = self.get_interpreter()
         server_info = self.server_manager.get_server(
             filename, interpreter, start=True)
@@ -490,6 +491,27 @@ def add_tab(self, widget):
         self.setCurrentIndex(index)
         self.setTabToolTip(index, widget.get_filename())
 
+    def handle_dirty_changed(self, new_value: bool) -> None:
+        """
+        Handle signal that a notebook became dirty or not.
+
+        Append a `*` to the filename of the notebook in the tab title if the
+        notebook is dirty.
+
+        Parameters
+        ----------
+        new_value : bool
+            Whether the notebook is now dirty.
+        """
+        notebook_client = self.sender()
+        index = self.indexOf(notebook_client)
+        if index == -1:
+            logger.warn('handle_dirty_changed: Client not found!')
+        else:
+            suffix = '*' if new_value else ''
+            self.setTabText(index, notebook_client.get_short_name() + suffix)
+            self.setTabToolTip(index, notebook_client.get_filename() + suffix)
+
     def handle_server_started(self, process):
         """
         Handle signal that a notebook server has started.