Skip to content

MEP27 Decouple pyplot from backends (refactoring Gcf out of backend code) #4143

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

Closed
wants to merge 55 commits into from
Closed

MEP27 Decouple pyplot from backends (refactoring Gcf out of backend code) #4143

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
24caf2b
Refactor pass 1. Refactoring Gcf out of specific backend (backend_gt…
OceanWolf Feb 21, 2015
2b05d38
Refactor Pass 2. Refactored Gcf out of all backend code.
OceanWolf Feb 22, 2015
f4fc354
Quick fix to figure for safe unpickling.
OceanWolf Feb 25, 2015
0b31e3a
GTK3Agg
OceanWolf Feb 26, 2015
6fb452e
Refactored making `FigureManager` a *figure* manager, plus added miss…
OceanWolf Feb 27, 2015
0a868a2
keyword
OceanWolf Feb 27, 2015
61ba2b4
Make add_element more general, and make sure the code complies with it.
OceanWolf Feb 27, 2015
f0eb84c
Better destroy order.
OceanWolf Feb 27, 2015
8fe9cd7
GTK simplifications
OceanWolf Feb 28, 2015
494e5f1
Added doc and cleaned backend_managers, don't want our new file dirty.
OceanWolf Mar 3, 2015
ed16178
Improve layout!
OceanWolf Apr 6, 2015
21b8f58
Move knowledge of the backend to the manager.
OceanWolf Apr 7, 2015
cf42e3b
Incorporate MEP22 into MEP27
OceanWolf Apr 12, 2015
f027b16
Improved new toolbar and updated tool_manager example accoridingly.
OceanWolf Apr 12, 2015
24b7b73
fullscreen
OceanWolf Apr 13, 2015
bc99129
MEP update
OceanWolf Apr 14, 2015
7f7f05e
Finish MEP22 conversion
OceanWolf Apr 14, 2015
713abcb
rename window method
OceanWolf Apr 17, 2015
80adaaf
Add backend anme to widgets
OceanWolf Apr 17, 2015
4e5f69d
Handle FigureManager destroy internaly without pyplot.
OceanWolf Jun 4, 2015
160ef57
Make functionality more consistant for embedded applications
OceanWolf Jun 7, 2015
b6d6acc
Backend getter method for FigureManager
OceanWolf Jun 13, 2015
ecd5038
Improve example after new method
OceanWolf Jun 13, 2015
f8e83fe
Clean up the code a bit
OceanWolf Jun 13, 2015
c53b79a
Remove old code from backend_managers
OceanWolf Jun 15, 2015
34c6b12
Cleanup
OceanWolf Jun 22, 2015
8a4268a
Explicity get set manager as None if appropiate.
OceanWolf Jun 22, 2015
44df199
figure attribute and canvas property
fariza Jun 22, 2015
860a8ed
Fix FigureCanvasBase
OceanWolf Jun 23, 2015
c44e744
super
OceanWolf Jun 25, 2015
2fe9215
figure setter
fariza Jun 25, 2015
3b434ef
Improve MEP22 Tool Searching Structure
OceanWolf Jun 25, 2015
490629f
adding example file
fariza Jun 25, 2015
8eb987b
super dooper
OceanWolf Jun 26, 2015
224a4f3
Revert old example and fix new one.
OceanWolf Jun 26, 2015
cdbd51b
Improve MEP22 tool-searching method.
OceanWolf Jun 27, 2015
50e3719
MEP22 Save Figure Tool
OceanWolf Jun 27, 2015
85be519
pep8
OceanWolf Jun 27, 2015
7edaf5a
Make ToolConfigureSubplots a generic tool
OceanWolf Jun 28, 2015
8e6e252
Improve flow handling and make it a lot more generic
OceanWolf Jun 28, 2015
72575cb
Missing resize method
OceanWolf Jun 28, 2015
4a78246
Convert to new structure for finding tools
OceanWolf Jun 28, 2015
e300707
doc
OceanWolf Jun 29, 2015
ee76451
Add ExpandableBase
OceanWolf Jun 29, 2015
6f0c7ab
Template Backend plus fix FigManager for non-GUI backends and add gen…
OceanWolf Jun 29, 2015
ae9bf5b
rcParam and Travis
OceanWolf Jul 19, 2015
fb004e0
test
OceanWolf Jul 20, 2015
1d2095b
test always MEP27
OceanWolf Jul 20, 2015
24e43b3
Fix FigureManager to allow pyplot to work for non GUI backends
OceanWolf Jul 27, 2015
208c3be
Fix Gcf.show_all()
OceanWolf Jul 27, 2015
a44ebd9
doc
OceanWolf Jul 27, 2015
f8f9cf2
pep8
OceanWolf Jul 27, 2015
0e09a54
remove show_popup
OceanWolf Jul 27, 2015
a38b6d7
AttributeError
OceanWolf Sep 22, 2015
64f0c61
Fixes for MEP27
OceanWolf Aug 3, 2016
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
Prev Previous commit
Next Next commit
Incorporate MEP22 into MEP27
  • Loading branch information
@OceanWolf
OceanWolf committed Aug 3, 2016
commit cf42e3b69c892a64d7991a8b25956c5645bce965
28 changes: 26 additions & 2 deletions lib/matplotlib/backend_managers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
"""
`FigureManager`
Class that pulls all of the standard GUI elements together, and manages
the interaction between them.

`ToolManager`
Class that makes the bridge between user interaction (key press,
toolbar clicks, ..) and the actions in response to the user inputs.
Expand Down Expand Up @@ -86,7 +90,17 @@ def __init__(self, figure, num):

self.window.add_element_to_window(self.canvas, True, True, 0, 'center')

self.toolmanager = self._get_toolmanager()
self.toolbar = self._get_toolbar()

if self.toolmanager:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How will this ever not be True?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, atm another leftover relic, but talk over in OceanWolf#4 about perhaps adding a rcParam for this. Tl;dr @fariza refers to a discussion some time ago about that sees adding keyboard shortcuts without an rcParam as a bug, but we have had this as default behaviour (pre MEP22) for quite some time.

I think we both feel happy about removing this now and discussing rcParams later, right @fariza?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I agree, everything is in the right place to add those rcParams later and just modify the FigureManager class

tools.add_tools_to_manager(self.toolmanager)
if self.toolbar:
tools.add_tools_to_container(self.toolbar)
self.statusbar = self._backend.Statusbar(self.toolmanager)
h += self.window.add_element_to_window(self.statusbar, False,
False, 0, 'south')

if self.toolbar is not None:
h += self.window.add_element_to_window(self.toolbar,
False, False, 0, 'south')
Expand All @@ -98,7 +112,7 @@ def __init__(self, figure, num):

def notify_axes_change(fig):
'this will be called whenever the current axes is changed'
if self.toolbar is not None:
if self.toolmanager is None and self.toolbar is not None:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the add_axobserver? it is already handled by toolmanager and as far as I know MEP27 is going to be used exclusively with toolmanager.

self.toolbar.update()
self.canvas.figure.add_axobserver(notify_axes_change)

Expand Down Expand Up @@ -157,12 +171,22 @@ def set_window_title(self, title):
def _get_toolbar(self):
# must be inited after the window, drawingArea and figure
# attrs are set
if rcParams['toolbar'] == 'toolbar2':
if rcParams['toolbar'] == 'toolmanager':
toolbar = self._backend.Toolbar(self.toolmanager)
elif rcParams['toolbar'] == 'toolbar2':
toolbar = self._backend.Toolbar2(self.canvas, self.window)
else:
toolbar = None
return toolbar

def _get_toolmanager(self):
# must be initialised after toolbar has been setted
if rcParams['toolbar'] != 'toolbar2':
toolmanager = ToolManager(self.canvas)
else:
toolmanager = None
return toolmanager

def show_popup(self, msg):
"""
Display message in a popup -- GUI only
Expand Down
12 changes: 11 additions & 1 deletion lib/matplotlib/backends/backend_gtk3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,10 @@ def stop_event_loop(self):
FigureCanvasBase.stop_event_loop_default(self)
stop_event_loop.__doc__=FigureCanvasBase.stop_event_loop_default.__doc__


_flow = [Gtk.Orientation.HORIZONTAL, Gtk.Orientation.VERTICAL]


class Window(WindowBase, Gtk.Window):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't keep the name something like WindowGTK3 and at the end of the file Window=WindowGTK3

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I don't really see what difference it makes apart from taking up extra hard drive and memory space.

At the moment we have backend_gtk3.Window why do we need backend_gtk3.WindowGTK3 as well? By renaming Window to WindowGTK3 and adding Window = WindowGTK3 we create both names which as I say feels like overkill to me. Note also that under the API that we deprecate here Show also does it like this, we don't have ShowGTK3.

I don't mind renaming it, I just don't see any need for it...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of agree with you, but in that case, why don't we remove all the xxxGTK3 stuff? and leave just xxx like FigureManager, Toolbar, etc...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 On making the GUI specific classes have the framework name in them and doing Window = WindowGTK3 at the end. It helps to keep the code a bit more organized. I have poked around in some projects that aggressively shadow names between modules and it gets bad.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess "bad" beats "ugly" (ugly in terms of a list of housekeeping aliases at end of each file. I can't imagine how it could get bad, (on the other hand I found debugging that transform logic a nightmare with multiple layers of transforms to go through and understand what they what they were doing and why they were failing), so meh.

def __init__(self, title):
WindowBase.__init__(self, title)
Expand Down Expand Up @@ -426,14 +430,19 @@ def _setup_box(self, name, orientation, grow, parent):

def add_element_to_window(self, element, expand, fill, pad, place):
element.show()

flow = _flow[not _flow.index(self._layout[place].get_orientation())]
separator = Gtk.Separator(orientation=flow)
if place in ['north', 'west', 'center']:
self._layout[place].pack_start(element, expand, fill, pad)
self._layout[place].pack_start(separator, False, False, 0)
elif place in ['south', 'east']:
self._layout[place].pack_end(element, expand, fill, pad)
self._layout[place].pack_end(separator, False, False, 0)
else:
raise KeyError('Unknown value for place, %s' % place)
size_request = element.size_request()
return size_request.height
return size_request.height + separator.size_request().height

def set_default_size(self, width, height):
Gtk.Window.set_default_size(self, width, height)
Expand Down Expand Up @@ -1047,5 +1056,6 @@ def error_msg_gtk(msg, parent=None):
backend_tools.ToolRubberband = RubberbandGTK3

Toolbar = ToolbarGTK3
Statusbar = StatusbarGTK3
FigureCanvas = FigureCanvasGTK3
FigureManager = FigureManagerGTK3
2 changes: 2 additions & 0 deletions lib/matplotlib/backends/backend_gtk3agg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ def new_figure_manager_given_figure(num, figure):
FigureCanvas = FigureCanvasGTK3Agg
FigureManager = FigureManagerGTK3Agg
Window = backend_gtk3.Window
Toolbar = backend_gtk3.Toolbar
Statusbar = backend_gtk3.Statusbar
Toolbar2 = backend_gtk3.NavigationToolbar2GTK3
MainLoop = backend_gtk3.MainLoop
show = backend_gtk3.show
2 changes: 2 additions & 0 deletions lib/matplotlib/backends/backend_gtk3cairo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ def new_figure_manager_given_figure(num, figure):
FigureCanvas = FigureCanvasGTK3Cairo
FigureManager = FigureManagerGTK3Cairo
Window = backend_gtk3.Window
Toolbar = backend_gtk3.Toolbar
Statusbar = backend_gtk3.Statusbar
Toolbar2 = backend_gtk3.NavigationToolbar2GTK3
MainLoop = backend_gtk3.MainLoop
show = backend_gtk3.show