Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Group figure.subplot.* rc to a single rcParam. #11231

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 1 commit into from
Closed

Group figure.subplot.* rc to a single rcParam. #11231

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
3 changes: 3 additions & 0 deletions doc/api/next_api_changes/2018-02-15-AL-deprecations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,7 @@ The following classes, methods, functions, and attributes are deprecated:
- ``text.Annotation.arrow``,

The following rcParams are deprecated:

- ``figure.subplot.left``, ``figure.subplot.right``, etc (instead, set the
single ``figure.subplot`` rcParam to the appropriate dict value).
- ``pgf.debug`` (the pgf backend relies on logging),
5 changes: 5 additions & 0 deletions lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,11 @@ def __getitem__(self, key):
mplDeprecation)
return None

elif key.startswith('figure.subplot.'):
cbook.warn_deprecated(
"3.0",
"{} is deprecated; use figure.subplot instead".format(key))

val = dict.__getitem__(self, key)
if inverse_alt is not None:
return inverse_alt(val)
Expand Down
7 changes: 5 additions & 2 deletions lib/matplotlib/cbook/deprecation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def _generate_deprecation_message(

def warn_deprecated(
since, message='', name='', alternative='', pending=False,
obj_type='attribute', addendum='', *, removal=''):
obj_type='attribute', addendum='', *, removal='', stacklevel=2):
"""
Used to display deprecation warning in a standard way.

Expand Down Expand Up @@ -88,6 +88,9 @@ def warn_deprecated(
addendum : str, optional
Additional text appended directly to the final message.

stacklevel : int, optional
The stack level used by the `warnings.warn` call.

Examples
--------

Expand All @@ -100,7 +103,7 @@ def warn_deprecated(
"""
message = _generate_deprecation_message(
since, message, name, alternative, pending, obj_type, removal=removal)
warnings.warn(message, mplDeprecation, stacklevel=2)
warnings.warn(message, mplDeprecation, stacklevel=stacklevel)


def deprecated(since, message='', name='', alternative='', pending=False,
Expand Down
20 changes: 11 additions & 9 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,20 +228,18 @@ def reset():
self.hspace = thishspace

if self.validate:
if self.left >= self.right:
if not self.left < self.right:
reset()
raise ValueError('left cannot be >= right')

if self.bottom >= self.top:
raise ValueError('One must have right < left')
if not self.bottom < self.top:
reset()
raise ValueError('bottom cannot be >= top')
raise ValueError('One must have bottom < top')

def _update_this(self, s, val):
if val is None:
val = getattr(self, s, None)
if val is None:
key = 'figure.subplot.' + s
val = rcParams[key]
val = rcParams['figure.subplot'][s]

setattr(self, s, val)

Expand Down Expand Up @@ -1406,8 +1404,11 @@ def clf(self, keep_observers=False):
"""
Clear the figure.

Set *keep_observers* to True if, for example,
a gui widget is tracking the axes in the figure.
Parameters
----------
keep_observers : bool, optional
Set *keep_observers* to True if, for example,
a gui widget is tracking the axes in the figure.
"""
self.suppressComposite = None
self.callbacks = cbook.CallbackRegistry()
Expand All @@ -1429,6 +1430,7 @@ def clf(self, keep_observers=False):
if not keep_observers:
self._axobservers = []
self._suptitle = None
self.subplotpars.update(**rcParams['figure.subplot'])
if self.get_constrained_layout():
layoutbox.nonetree(self._layoutbox)
self.stale = True
Expand Down
12 changes: 2 additions & 10 deletions lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,16 +307,8 @@ figure.autolayout : False # When True, automatically adjust subplot
# parameters to make the plot fit the figure
figure.frameon : True

# The figure subplot parameters. All dimensions are a fraction of the
# figure width or height
figure.subplot.left : 0.125 # the left side of the subplots of the figure
figure.subplot.right : 0.9 # the right side of the subplots of the figure
figure.subplot.bottom : 0.1 # the bottom of the subplots of the figure
figure.subplot.top : 0.9 # the top of the subplots of the figure
figure.subplot.wspace : 0.2 # the amount of width reserved for space between subplots,
# expressed as a fraction of the average axis width
figure.subplot.hspace : 0.2 # the amount of height reserved for space between subplots,
# expressed as a fraction of the average axis height
# The figure subplot parameters (see matplotlib.figure.SubplotParams).
figure.subplot : {"left": 0.125, "right": 0.9, "bottom": 0.1, "top": 0.9, "wspace": 0.2, "hspace": 0.2}

### IMAGES
image.aspect : equal # equal | auto | a number
Expand Down
12 changes: 2 additions & 10 deletions lib/matplotlib/mpl-data/stylelib/classic.mplstyle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,16 +311,8 @@ figure.autolayout : False # When True, automatically adjust subplot
# parameters to make the plot fit the figure
figure.frameon : True

# The figure subplot parameters. All dimensions are a fraction of the
# figure width or height
figure.subplot.left : 0.125 # the left side of the subplots of the figure
figure.subplot.right : 0.9 # the right side of the subplots of the figure
figure.subplot.bottom : 0.1 # the bottom of the subplots of the figure
figure.subplot.top : 0.9 # the top of the subplots of the figure
figure.subplot.wspace : 0.2 # the amount of width reserved for space between subplots,
# expressed as a fraction of the average axis width
figure.subplot.hspace : 0.2 # the amount of height reserved for space between subplots,
# expressed as a fraction of the average axis height
# The figure subplot parameters (see matplotlib.figure.SubplotParams).
figure.subplot : {"left": 0.125, "right": 0.9, "bottom": 0.1, "top": 0.9, "wspace": 0.2, "hspace": 0.2}

### IMAGES
image.aspect : equal # equal | auto | a number
Expand Down
4 changes: 1 addition & 3 deletions lib/matplotlib/mpl-data/stylelib/fivethirtyeight.mplstyle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,5 @@ font.size:14.0
savefig.edgecolor: f0f0f0
savefig.facecolor: f0f0f0

figure.subplot.left: 0.08
figure.subplot.right: 0.95
figure.subplot.bottom: 0.07
figure.subplot : {"left": 0.08, "right": 0.95, "bottom": 0.07}
figure.facecolor: f0f0f0
70 changes: 54 additions & 16 deletions lib/matplotlib/rcsetup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@
"""
import six

import ast
from collections import Iterable, Mapping
from functools import reduce
import operator
import os
import warnings
import re
import warnings

from matplotlib import cbook
from matplotlib.cbook import mplDeprecation, deprecated, ls_mapper
from matplotlib.fontconfig_pattern import parse_fontconfig_pattern
from matplotlib.colors import is_color_like
from matplotlib.fontconfig_pattern import parse_fontconfig_pattern

# Don't let the original cycler collide with our validating cycler
from cycler import Cycler, cycler as ccycler
Expand Down Expand Up @@ -926,7 +926,8 @@ def validate_webagg_address(s):
# ls_mapper, and a list of possible strings read from Line2D.set_linestyle
_validate_named_linestyle = ValidateInStrings(
'linestyle',
[*ls_mapper.keys(), *ls_mapper.values(), 'None', 'none', ' ', ''],
[*cbook.ls_mapper.keys(), *cbook.ls_mapper.values(),
'None', 'none', ' ', ''],
ignorecase=True)


Expand Down Expand Up @@ -971,6 +972,45 @@ def _validate_linestyle(ls):
"sequence.".format(ls))


def _validate_subplot(s):
d = ast.literal_eval(s) if isinstance(s, str) else s
try:
# These imports must be delayed because they are not available at
# startup (so we just assume that the default we provide ourselves are
# valid).
from matplotlib import rcParams
from matplotlib.figure import SubplotParams
except ImportError:
pass
else:
d = {**rcParams["figure.subplot"], **d}
SubplotParams(**d)
for key, value in d.items():
dict.__setitem__(rcParams, "figure.subplot.{}".format(key), value)
return d


def _validate_subplot_key(key):
def validator(s):
val = ast.literal_eval(s) if isinstance(s, str) else s
try:
# See above re: delayed imports.
from matplotlib import rcParams
from matplotlib.figure import SubplotParams
except ImportError:
pass
else:
cbook.warn_deprecated(
"3.0", "figure.subplot.{} is deprecated; set the "
"corresponding key in figure.subplot instead.".format(key),
stacklevel=4)
d = {**rcParams["figure.subplot"], key: val}
SubplotParams(**d)
dict.__setitem__(rcParams, "figure.subplot", d)
return val
return validator


# a map from key -> value, converter
defaultParams = {
'backend': ['Agg', validate_backend], # agg is certainly
Expand Down Expand Up @@ -1317,18 +1357,16 @@ def _validate_linestyle(ls):
'figure.autolayout': [False, validate_bool],
'figure.max_open_warning': [20, validate_int],

'figure.subplot.left': [0.125, ValidateInterval(0, 1, closedmin=True,
closedmax=True)],
'figure.subplot.right': [0.9, ValidateInterval(0, 1, closedmin=True,
closedmax=True)],
'figure.subplot.bottom': [0.11, ValidateInterval(0, 1, closedmin=True,
closedmax=True)],
'figure.subplot.top': [0.88, ValidateInterval(0, 1, closedmin=True,
closedmax=True)],
'figure.subplot.wspace': [0.2, ValidateInterval(0, 1, closedmin=True,
closedmax=False)],
'figure.subplot.hspace': [0.2, ValidateInterval(0, 1, closedmin=True,
closedmax=False)],
'figure.subplot': [{'left': 0.125, 'right': 0.9,
'bottom': 0.11, 'top': 0.88,
'wspace': 0.2, 'hspace': 0.2},
_validate_subplot],
'figure.subplot.left': [0.125, _validate_subplot_key('left')],
'figure.subplot.right': [0.9, _validate_subplot_key('right')],
'figure.subplot.bottom': [0.11, _validate_subplot_key('bottom')],
'figure.subplot.top': [0.88, _validate_subplot_key('top')],
'figure.subplot.wspace': [0.2, _validate_subplot_key('wspace')],
'figure.subplot.hspace': [0.2, _validate_subplot_key('hspace')],

# do constrained_layout.
'figure.constrained_layout.use': [False, validate_bool],
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/testing/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def _do_cleanup(original_units_registry, original_settings):
plt.close('all')

mpl.rcParams.clear()
mpl.rcParams.update(original_settings)
dict.update(mpl.rcParams, original_settings)
matplotlib.units.registry.clear()
matplotlib.units.registry.update(original_units_registry)
warnings.resetwarnings() # reset any warning filters set in tests
Expand Down
8 changes: 8 additions & 0 deletions lib/matplotlib/tests/test_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,3 +383,11 @@ def test_fspath(fmt, tmpdir):
# All the supported formats include the format name (case-insensitive)
# in the first 100 bytes.
assert fmt.encode("ascii") in file.read(100).lower()


def test_clf_subplotpars():
fig = plt.figure()
orig_subplot_vars = vars(fig.subplotpars).copy()
fig.subplots_adjust(left=0.1)
fig.clf()
assert vars(fig.subplotpars) == orig_subplot_vars
2 changes: 1 addition & 1 deletion lib/matplotlib/tests/test_rcparams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ def test_if_rctemplate_is_up_to_date():
continue
if k in deprecated:
continue
if "verbose" in k:
if "verbose" in k or "figure.subplot." in k:
continue
found = False
for line in rclines:
Expand Down
11 changes: 2 additions & 9 deletions matplotlibrc.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,15 +436,8 @@ backend : $TEMPLATE_BACKEND
#figure.max_open_warning : 20 ## The maximum number of figures to open through
## the pyplot interface before emitting a warning.
## If less than one this feature is disabled.
## The figure subplot parameters. All dimensions are a fraction of the
#figure.subplot.left : 0.125 ## the left side of the subplots of the figure
#figure.subplot.right : 0.9 ## the right side of the subplots of the figure
#figure.subplot.bottom : 0.11 ## the bottom of the subplots of the figure
#figure.subplot.top : 0.88 ## the top of the subplots of the figure
#figure.subplot.wspace : 0.2 ## the amount of width reserved for space between subplots,
## expressed as a fraction of the average axis width
#figure.subplot.hspace : 0.2 ## the amount of height reserved for space between subplots,
## expressed as a fraction of the average axis height
## The figure subplot parameters (see matplotlib.figure.SubplotParams).
#figure.subplot : {"left": 0.125, "right": 0.9, "bottom": 0.1, "top": 0.9, "wspace": 0.2, "hspace": 0.2}

## Figure layout
#figure.autolayout : False ## When True, automatically adjust subplot
Expand Down