Skip to content

MNT: Deprecate figure callbacks #22813

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
Apr 17, 2022
Merged

MNT: Deprecate figure callbacks #22813

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
5 changes: 5 additions & 0 deletions doc/api/next_api_changes/deprecations/22813-GL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
``figure.callbacks`` is deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The figure callbacks property is deprecated. The only signal was
"dpi_changed", which can be replaced by connecting to the "resize_event"
on the canvas ``figure.canvas.mpl_connect("resize_event", func)`` instead.
21 changes: 13 additions & 8 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1976,6 +1976,10 @@ class SubFigure(FigureBase):

See :doc:`/gallery/subplots_axes_and_figures/subfigures`
"""
callbacks = _api.deprecated(
"3.6", alternative=("the 'resize_event' signal in "
"Figure.canvas.callbacks")
)(property(lambda self: self._fig_callbacks))

def __init__(self, parent, subplotspec, *,
facecolor=None,
Expand Down Expand Up @@ -2024,7 +2028,7 @@ def __init__(self, parent, subplotspec, *,
self._subplotspec = subplotspec
self._parent = parent
self.figure = parent.figure
self.callbacks = parent.callbacks
self._fig_callbacks = parent._fig_callbacks

# subfigures use the parent axstack
self._axstack = parent._axstack
Expand Down Expand Up @@ -2156,11 +2160,6 @@ class Figure(FigureBase):
"""
The top level container for all the plot elements.

The Figure instance supports callbacks through a *callbacks* attribute
which is a `.CallbackRegistry` instance. The events you can connect to
are 'dpi_changed', and the callback will be called with ``func(fig)`` where
fig is the `Figure` instance.

Attributes
----------
patch
Expand All @@ -2171,6 +2170,12 @@ class Figure(FigureBase):
depending on the renderer option_image_nocomposite function. If
*suppressComposite* is a boolean, this will override the renderer.
"""
# Remove the self._fig_callbacks properties on figure and subfigure
# after the deprecation expires.
callbacks = _api.deprecated(
"3.6", alternative=("the 'resize_event' signal in "
"Figure.canvas.callbacks")
)(property(lambda self: self._fig_callbacks))

def __str__(self):
return "Figure(%gx%g)" % tuple(self.bbox.size)
Expand Down Expand Up @@ -2303,7 +2308,7 @@ def __init__(self,
# everything is None, so use default:
self.set_layout_engine(layout=layout)

self.callbacks = cbook.CallbackRegistry(signals=["dpi_changed"])
self._fig_callbacks = cbook.CallbackRegistry(signals=["dpi_changed"])
# Callbacks traditionally associated with the canvas (and exposed with
# a proxy property), but that actually need to be on the figure for
# pickling.
Expand Down Expand Up @@ -2502,7 +2507,7 @@ def _set_dpi(self, dpi, forward=True):
self.dpi_scale_trans.clear().scale(dpi)
w, h = self.get_size_inches()
self.set_size_inches(w, h, forward=forward)
self.callbacks.process('dpi_changed', self)
self._fig_callbacks.process('dpi_changed', self)

dpi = property(_get_dpi, _set_dpi, doc="The resolution in dots per inch.")

Expand Down