Add use_style func and style setting

lukelbd · lukelbd · commit edc6f3c9da88 · 2020-05-09T04:57:08.000-06:00
diff --git a/proplot/config.py b/proplot/config.py
@@ -34,6 +34,7 @@ def get_ipython():
 __all__ = [
     'rc', 'rc_configurator',
     'register_cmaps', 'register_cycles', 'register_colors', 'register_fonts',
+    'config_inline_backend', 'use_style',
     'inline_backend_fmt',  # deprecated
 ]
 
@@ -465,6 +466,11 @@ def _get_param_dicts(self, key, value):
         if key == 'inlinefmt':
             config_inline_backend(value)
 
+        # Special key: apply stylesheet
+        elif key == 'style':
+            if value is not None:
+                kw_params, kw_added = _get_style_dicts(value, infer=True)
+
         # Cycler
         elif key in ('cycle', 'rgbcycle'):
             colors = _update_color_cycle(key, value)
@@ -1163,6 +1169,29 @@ def _infer_added_params(kw_params):
     return kw_added
 
 
+def use_style(style):
+    """
+    Apply the `matplotlib style(s) \
+<https://matplotlib.org/tutorials/introductory/customizing.html>`__
+    with `matplotlib.style.use`. This function is
+    called when you modify the :rcraw:`style` property.
+
+    Parameters
+    ----------
+    style : str, dict, or list thereof
+        The matplotlib style name(s) or stylesheet filename(s), or dictionary(s)
+        of settings. Use ``'default'`` to apply matplotlib default settings and
+        ``'original'`` to include settings from your user ``matplotlibrc`` file.
+    """
+    # NOTE: This function is not really necessary but makes proplot's
+    # stylesheet-supporting features obvious. Plus changing the style does
+    # so much *more* than changing rc params or quick settings, so it is
+    # nice to have dedicated function instead of just another rc_param name.
+    kw_params, kw_added = _get_style_dicts(style, infer=True)
+    rc_params.update(kw_params)
+    rc_added.update(kw_added)
+
+
 @docstring.add_snippets
 def register_cmaps(user=True, default=False):
     """
diff --git a/proplot/internals/defaults.py b/proplot/internals/defaults.py
@@ -44,6 +44,7 @@
     'share': 3,
     'small': 9,
     'span': True,
+    'style': None,
     'tickdir': 'out',
     'ticklen': 4.0,
     'ticklenratio': 0.5,
