Return filename from save_figure function

Zybulon · Zybulon · commit 9b3eb2e43b61 · 2024-02-10T10:56:52.000+01:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3224,7 +3224,14 @@ def on_tool_fig_close(e):
         return self.subplot_tool
 
     def save_figure(self, *args):
-        """Save the current figure."""
+        """
+        Save the current figure.
+
+        Returns
+        -------
+        str or `None`
+            The filepath of the saved figure. For GTK4 and Web backends it returns None.
+        """
         raise NotImplementedError
 
     def update(self):
diff --git a/lib/matplotlib/backend_bases.pyi b/lib/matplotlib/backend_bases.pyi
@@ -441,7 +441,7 @@ class NavigationToolbar2:
     def push_current(self) -> None: ...
     subplot_tool: widgets.SubplotTool
     def configure_subplots(self, *args): ...
-    def save_figure(self, *args) -> None: ...
+    def save_figure(self, *args) -> str | None: ...
     def update(self) -> None: ...
     def set_history_buttons(self) -> None: ...
 
diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -884,6 +884,7 @@ def save_figure(self, *args):
             self.canvas.figure.savefig(fname, format=extension)
         except Exception as e:
             tkinter.messagebox.showerror("Error saving file", str(e))
+        return fname
 
     def set_history_buttons(self):
         state_map = {True: tk.NORMAL, False: tk.DISABLED}
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -383,6 +383,7 @@ def on_notify_filter(*args):
                 type=Gtk.MessageType.ERROR, buttons=Gtk.ButtonsType.OK)
             dialog.run()
             dialog.destroy()
+        return fname
 
 
 class ToolbarGTK3(ToolContainerBase, Gtk.Box):
diff --git a/lib/matplotlib/backends/backend_macosx.py b/lib/matplotlib/backends/backend_macosx.py
@@ -146,6 +146,7 @@ def save_figure(self, *args):
         if mpl.rcParams['savefig.directory']:
             mpl.rcParams['savefig.directory'] = os.path.dirname(filename)
         self.canvas.figure.savefig(filename)
+        return filename
 
 
 class FigureManagerMac(_macosx.FigureManager, FigureManagerBase):
diff --git a/lib/matplotlib/backends/backend_qt.py b/lib/matplotlib/backends/backend_qt.py
@@ -839,6 +839,7 @@ def save_figure(self, *args):
                     self, "Error saving file", str(e),
                     QtWidgets.QMessageBox.StandardButton.Ok,
                     QtWidgets.QMessageBox.StandardButton.NoButton)
+            return fname
 
     def set_history_buttons(self):
         can_backward = self._nav_stack._pos > 0
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -1120,6 +1120,7 @@ def save_figure(self, *args):
                     caption='Matplotlib error')
                 dialog.ShowModal()
                 dialog.Destroy()
+            return path
 
     def draw_rubberband(self, event, x0, y0, x1, y1):
         height = self.canvas.figure.bbox.height
