Deprecate frameon kwarg and rcParam to savefig. · matplotlib/matplotlib@8a519c6 · GitHub
Skip to content

Commit 8a519c6

Browse files
anntzeranntzer
committed
Deprecate frameon kwarg and rcParam to savefig.
``frameon = False`` has *never* worked since its introduction in 2013 due to the buggy implementation that only took it into account if True: if frameon: original_frameon = self.get_frameon() self.set_frameon(frameon) (despite the doc stating otherwise). One can also set the facecolor kwarg or savefig.facecolor rcParam to fully transparent for the same effect.
1 parent 4769f7b commit 8a519c6

6 files changed

Lines changed: 16 additions & 13 deletions

File tree

‎doc/users/next_whats_new/2018-07-18-AL.rst‎

Lines changed: 7 additions & 0 deletions

‎lib/matplotlib/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -787,12 +787,12 @@ def gen_candidates():
787787

788788
# rcParams deprecated; can use None to suppress warnings; remain actually
789789
# listed in the rcParams (not included in _all_deprecated).
790-
# Values are typles of (version,)
790+
# Values are tuples of (version,)
791791
_deprecated_remain_as_none = {
792-
'axes.hold': ('2.1',),
793792
'backend.qt4': ('2.2',),
794793
'backend.qt5': ('2.2',),
795794
'text.latex.unicode': ('3.0',),
795+
'savefig.frameon': ('3.1',),
796796
}
797797

798798

‎lib/matplotlib/figure.py‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1934,7 +1934,7 @@ def add_axobserver(self, func):
19341934
"""Whenever the axes state change, ``func(self)`` will be called."""
19351935
self._axobservers.append(func)
19361936

1937-
def savefig(self, fname, *, frameon=None, transparent=None, **kwargs):
1937+
def savefig(self, fname, *, transparent=None, **kwargs):
19381938
"""
19391939
Save the current figure.
19401940
@@ -2005,11 +2005,6 @@ def savefig(self, fname, *, frameon=None, transparent=None, **kwargs):
20052005
transparency of these patches will be restored to their
20062006
original values upon exit of this function.
20072007
2008-
frameon : bool
2009-
If *True*, the figure patch will be colored, if *False*, the
2010-
figure background will be transparent. If not provided, the
2011-
rcParam 'savefig.frameon' will be used.
2012-
20132008
bbox_inches : str or `~matplotlib.transforms.Bbox`, optional
20142009
Bbox in inches. Only the given portion of the figure is
20152010
saved. If 'tight', try to figure out the tight bbox of
@@ -2025,8 +2020,12 @@ def savefig(self, fname, *, frameon=None, transparent=None, **kwargs):
20252020
20262021
"""
20272022
kwargs.setdefault('dpi', rcParams['savefig.dpi'])
2028-
if frameon is None:
2029-
frameon = rcParams['savefig.frameon']
2023+
if frameon in kwargs:
2024+
cbook.warn_deprecated("3.1", name="frameon", obj_type="kwarg",
2025+
alternative="facecolor")
2026+
frameon = kwargs.pop("frameon")
2027+
if frameon is None:
2028+
frameon = dict.__getitem__(rcParams, 'savefig.frameon')
20302029
if transparent is None:
20312030
transparent = rcParams['savefig.transparent']
20322031

‎lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,6 @@ savefig.pad_inches : 0.1 # Padding to be used when bbox is set to 'tight'
418418
savefig.jpeg_quality: 95 # when a jpeg is saved, the default quality parameter.
419419
savefig.transparent : False # setting that controls whether figures are saved with a
420420
# transparent background by default
421-
savefig.frameon : True
422421
savefig.orientation : portrait
423422

424423
# ps backend params

‎lib/matplotlib/mpl-data/stylelib/classic.mplstyle‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,6 @@ savefig.pad_inches : 0.1 # Padding to be used when bbox is set to 'tight'
422422
savefig.jpeg_quality: 95 # when a jpeg is saved, the default quality parameter.
423423
savefig.transparent : False # setting that controls whether figures are saved with a
424424
# transparent background by default
425-
savefig.frameon : True
426425
savefig.orientation : portrait
427426

428427
# ps backend params

‎matplotlibrc.template‎

Lines changed: 0 additions & 1 deletion

0 commit comments

Comments
 (0)