Skip to content

Simplifications to ToolManager.{add,remove}_tool. #22509

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

Merged
merged 1 commit into from
Mar 11, 2022
Merged

Simplifications to ToolManager.{add,remove}_tool. #22509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions doc/api/next_api_changes/deprecations/22509-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
``ToolBase.destroy``
~~~~~~~~~~~~~~~~~~~~
... is deprecated. To run code upon tool removal, connect to the
``tool_removed_event`` event.
18 changes: 8 additions & 10 deletions lib/matplotlib/backend_managers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,17 +206,18 @@ def remove_tool(self, name):
"""

tool = self.get_tool(name)
tool.destroy()
_api.deprecate_method_override(
backend_tools.ToolBase.destroy, tool, since="3.6",
alternative="tool_removed_event")()

# If it's a toggle tool and toggled, untoggle
if getattr(tool, 'toggled', False):
self.trigger_tool(tool, 'toolmanager')

self._remove_keys(name)

s = 'tool_removed_event'
event = ToolEvent(s, self, tool)
self._callbacks.process(s, event)
event = ToolEvent('tool_removed_event', self, tool)
self._callbacks.process(event.name, event)

del self._tools[name]

Expand Down Expand Up @@ -284,13 +285,10 @@ def add_tool(self, name, tool, *args, **kwargs):
self._handle_toggle(tool_obj, None, None, None)
tool_obj.set_figure(self.figure)

self._tool_added_event(tool_obj)
return tool_obj
event = ToolEvent('tool_added_event', self, tool_obj)
self._callbacks.process(event.name, event)

def _tool_added_event(self, tool):
s = 'tool_added_event'
event = ToolEvent(s, self, tool)
self._callbacks.process(s, event)
return tool_obj

def _handle_toggle(self, tool, sender, canvasevent, data):
"""
Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/backend_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ def trigger(self, sender, event, data=None):
"""
pass

@_api.deprecated("3.6", alternative="tool_removed_event")
def destroy(self):
"""
Destroy the tool.
Expand Down