8000 Deprecate cleared kwarg to get_renderer. by anntzer · Pull Request #22245 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Deprecate cleared kwarg to get_renderer. #22245

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
Jan 16, 2022
Merged

Deprecate cleared kwarg to get_renderer. #22245

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/22245-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*cleared* parameter of ``get_renderer``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This parameter, which only existed for agg-based backends, has been deprecated.
Use ``renderer.clear()`` instead to explicitly clear the renderer buffer.
4 changes: 3 additions & 1 deletion lib/matplotlib/backends/backend_agg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,8 @@ def restore_region(self, region, bbox=None, xy=None):

def draw(self):
# docstring inherited
self.renderer = self.get_renderer(cleared=True)
self.renderer = self.get_renderer()
self.renderer.clear()
# Acquire a lock on the shared font cache.
with RendererAgg.lock, \
(self.toolbar._wait_cursor_for_draw_cm() if self.toolbar
Expand All @@ -437,6 +438,7 @@ def draw(self):
# don't forget to call the superclass.
super().draw()

@_api.delete_parameter("3.6", "cleared", alternative="renderer.clear()")
def get_renderer(self, cleared=False):
w, h = self.figure.bbox.size
key = w, h, self.figure.dpi
Expand Down
3 changes: 2 additions & 1 deletion lib/matplotlib/backends/backend_macosx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
B0F9 Expand Up @@ -36,8 +36,9 @@ def set_cursor(self, cursor):
_macosx.set_cursor(cursor)

def _draw(self):
renderer = self.get_renderer(cleared=self.figure.stale)
renderer = self.get_renderer()
if self.figure.stale:
renderer.clear()
self.figure.draw(renderer)
return renderer

Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/backends/backend_webagg_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ def get_diff_image(self):
Image.fromarray(data).save(png, format="png")
return png.getvalue()

@_api.delete_parameter("3.6", "cleared", alternative="renderer.clear()")
def get_renderer(self, cleared=None):
# Mirrors super.get_renderer, but caches the old one so that we can do
# things such as produce a diff image in get_diff_image.
Expand Down
0