|
""" Core functions and attributes for the matplotlib style library:
``use`` Select style sheet to override the current matplotlib settings. ``context`` Context manager to use a style sheet temporarily. ``available`` List available style sheets. ``library`` A dictionary of style names and matplotlib settings. """
# Users may want multiple library paths, so store a list of paths.
# A list of rcParams that should not be applied from styles 'interactive', 'backend', 'backend.qt4', 'webagg.port', 'webagg.address', 'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback', 'toolbar', 'timezone', 'datapath', 'figure.max_open_warning', 'savefig.directory', 'tk.window_focus', 'docstring.hardcopy'}
o = {} for key, val in d.items(): if key in STYLE_BLACKLIST: if warn: warnings.warn( "Style includes a parameter, '{0}', that is not related " "to style. Ignoring".format(key), stacklevel=3) else: o[key] = val return o
"""Return True if the filename looks like a style file."""
mpl.rcParams.update(_remove_blacklisted_style_params(d, warn=warn))
"""Use matplotlib style settings from a style specification.
The style name of 'default' is reserved for reverting back to the default style settings.
Parameters ---------- style : str, dict, or list A style specification. Valid options are:
+------+-------------------------------------------------------------+ | str | The name of a style or a path/URL to a style file. For a | | | list of available style names, see `style.available`. | +------+-------------------------------------------------------------+ | dict | Dictionary with valid key/value pairs for | | | `matplotlib.rcParams`. | +------+-------------------------------------------------------------+ | list | A list of style specifiers (str or dict) applied from first | | | to last in the list. | +------+-------------------------------------------------------------+
""" style_alias = {'mpl20': 'default', 'mpl15': 'classic'} if isinstance(style, str) or hasattr(style, 'keys'): # If name is a single str or dict, make it a single element list. styles = [style] else: styles = style
styles = (style_alias.get(s, s) if isinstance(s, str) else s for s in styles) for style in styles: if not isinstance(style, str): _apply_style(style) elif style == 'default': # Deprecation warnings were already handled when creating # rcParamsDefault, no need to reemit them here. with warnings.catch_warnings(): warnings.simplefilter("ignore", MatplotlibDeprecationWarning) _apply_style(rcParamsDefault, warn=False) elif style in library: _apply_style(library[style]) else: try: rc = rc_params_from_file(style, use_default_template=False) _apply_style(rc) except IOError: raise IOError( "{!r} not found in the style library and input is not a " "valid URL or path; see `style.available` for list of " "available styles".format(style))
"""Context manager for using style settings temporarily.
Parameters ---------- style : str, dict, or list A style specification. Valid options are:
+------+-------------------------------------------------------------+ | str | The name of a style or a path/URL to a style file. For a | | | list of available style names, see `style.available`. | +------+-------------------------------------------------------------+ | dict | Dictionary with valid key/value pairs for | | | `matplotlib.rcParams`. | +------+-------------------------------------------------------------+ | list | A list of style specifiers (str or dict) applied from first | | | to last in the list. | +------+-------------------------------------------------------------+
after_reset : bool If True, apply style after resetting settings to their defaults; otherwise, apply style on top of the current settings. """ with mpl.rc_context(): if after_reset: mpl.rcdefaults() use(style) yield
"""Load style library defined in this package."""
yield stylelib_path
"""Update style library with user-defined rc files""" styles = read_style_directory(stylelib_path) update_nested_dict(library, styles)
"""Yield file path and name of styles in the given directory."""
"""Return dictionary of styles defined in `style_dir`.""" use_default_template=False)
message = 'In %s: %s' % (path, w.message) warnings.warn(message, stacklevel=2)
"""Update nested dict (only level of nesting) with new values.
Unlike dict.update, this assumes that the values of the parent dict are dicts (or dict-like), so you shouldn't replace the nested dict if it already exists. Instead you should update the sub-dict. """ # update named styles specified by user for name, rc_dict in new_dict.items(): main_dict.setdefault(name, {}).update(rc_dict) return main_dict
# Load style library # ==================
"""Reload style library.""" global library |