Skip to content

Fix broken "save figure" with GTK4 on mac #26558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
stevezhang1999 wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Fix broken "save figure" with GTK4 on mac #26558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb1a743
rewrite save dialog with FileDialog
stevezhang1999 Aug 20, 2023
e99c741
delete print and revert loading png
stevezhang1999 Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 42 additions & 44 deletions lib/matplotlib/backends/backend_gtk4.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import functools
import io
import os

Expand Down Expand Up @@ -331,66 +330,65 @@ def __init__(self, canvas):
_NavigationToolbar2GTK.__init__(self, canvas)

def save_figure(self, *args):
dialog = Gtk.FileChooserNative(
print(Gtk.MAJOR_VERSION, Gtk.MINOR_VERSION, Gtk.MICRO_VERSION)
dialog = Gtk.FileDialog(
title='Save the figure',
transient_for=self.canvas.get_root(),
action=Gtk.FileChooserAction.SAVE,
modal=True)

self._save_dialog = dialog # Must keep a reference.
filters = Gio.ListStore.new(Gtk.FileFilter)

ff = Gtk.FileFilter()
ff.set_name('All files')
ff.add_pattern('*')
dialog.add_filter(ff)
dialog.set_filter(ff)
filters.append(ff)

formats = []
default_format = None
for i, (name, fmts) in enumerate(
self.canvas.get_supported_filetypes_grouped().items()):
ff = Gtk.FileFilter()
ff.set_name(name)
for fmt in fmts:
ff.add_pattern(f'*.{fmt}')
dialog.add_filter(ff)
formats.append(name)
filters.append(ff)
if self.canvas.get_default_filetype() in fmts:
default_format = i
# Setting the choice doesn't always work, so make sure the default
# format is first.
formats = [formats[default_format], *formats[:default_format],
*formats[default_format+1:]]
dialog.add_choice('format', 'File format', formats, formats)
dialog.set_choice('format', formats[default_format])

dialog.set_current_folder(Gio.File.new_for_path(
dialog.set_default_filter(ff)

dialog.set_filters(filters)

dialog.set_initial_folder(Gio.File.new_for_path(
os.path.expanduser(mpl.rcParams['savefig.directory'])))
dialog.set_current_name(self.canvas.get_default_filename())

@functools.partial(dialog.connect, 'response')
def on_response(dialog, response):
file = dialog.get_file()
fmt = dialog.get_choice('format')
fmt = self.canvas.get_supported_filetypes_grouped()[fmt][0]
dialog.destroy()
self._save_dialog = None
if response != Gtk.ResponseType.ACCEPT:
return
# Save dir for next time, unless empty str (which means use cwd).
if mpl.rcParams['savefig.directory']:
parent = file.get_parent()
mpl.rcParams['savefig.directory'] = parent.get_path()
dialog.set_initial_name(self.canvas.get_default_filename())

def dialog_save_callback(dialog, result):
try:
self.canvas.figure.savefig(file.get_path(), format=fmt)
except Exception as e:
msg = Gtk.MessageDialog(
transient_for=self.canvas.get_root(),
message_type=Gtk.MessageType.ERROR,
buttons=Gtk.ButtonsType.OK, modal=True,
text=str(e))
msg.show()

dialog.show()
file = dialog.save_finish(result)
print(file)
if file is not None:
# we only use file name to save the figure.
# let savefig decide if the format extension isn't in the name
print(f"File path is {file.get_path()}")
# Save dir for next time, unless empty str (which means use cwd).
if mpl.rcParams['savefig.directory']:
parent = file.get_parent()
mpl.rcParams['savefig.directory'] = parent.get_path()
try:
self.canvas.figure.savefig(file.get_path())
self.canvas.draw() # canvas may become blank after saving

except Exception as e:
msg = Gtk.MessageDialog(
transient_for=self.canvas.get_root(),
message_type=Gtk.MessageType.ERROR,
buttons=Gtk.ButtonsType.OK, modal=True,
text=str(e))
msg.show()

except GLib.Error as error:
print(f"Error opening file: {error.message}")

# self.canvas.draw_idle()

dialog.save(None, None, dialog_save_callback)


class ToolbarGTK4(ToolContainerBase, Gtk.Box):
Expand Down