Improve deprecation warnings, remove figure setters

Author: lukelbd

proplot/axes/__init__.py

@@ -10,8 +10,11 @@
 from .geo import GeoAxes  # noqa: F401
 from .geo import BasemapAxes, CartopyAxes
 from ..internals import warnings
-XYAxes = warnings._rename_obj('XYAxes', CartesianAxes)
-ProjAxes = warnings._rename_obj('ProjAxes', GeoAxes)
+XYAxes, ProjAxes = warnings._rename_objs(
+    '0.6',
+    XYAxes=CartesianAxes,
+    ProjAxes=GeoAxes,
+)
 
 import matplotlib.projections as mproj
 mproj.register_projection(CartesianAxes)

proplot/axes/base.py

@@ -722,7 +722,7 @@ def _update_title_position(self, renderer):
             )
 
     @staticmethod
-    @warnings._rename_kwargs(mode='rc_mode')
+    @warnings._rename_kwargs('0.6', mode='rc_mode')
     def _parse_format(rc_kw=None, rc_mode=None, **kwargs):
         """
         Separate `~proplot.config.rc` setting name value pairs from

proplot/axes/plot.py

@@ -956,7 +956,7 @@ def _deprecate_add_errorbars(func):
     for _rename_kwargs. Use a decorator to avoid call signature pollution.
     """
     @functools.wraps(func)
-    def _wrapper(
+    def wrapper(
         *args,
         bars=None, boxes=None, barstd=None, boxstd=None, barrange=None, boxrange=None,
         **kwargs
@@ -966,9 +966,9 @@ def _wrapper(
         ):
             if b is not None or std is not None or span is not None:
                 warnings._warn_proplot(
-                    f'Keyword args "{prefix}s", "{prefix}std", and "{prefix}range" '
+                    f"Keyword args '{prefix}s', '{prefix}std', and '{prefix}range' "
                     'are deprecated and will be removed in a future version. '
-                    f'Please use "{prefix}stds" or "{prefix}pctiles" instead.'
+                    f"Please use '{prefix}stds' or '{prefix}pctiles' instead."
                 )
             if span is None and b:  # means 'use the default range'
                 span = b
@@ -977,7 +977,7 @@ def _wrapper(
             else:
                 kwargs.setdefault(prefix + 'pctiles', span)
         return func(*args, **kwargs)
-    return _wrapper
+    return wrapper
 
 
 @_deprecate_add_errorbars
@@ -2636,7 +2636,7 @@ def _build_discrete_norm(
     return norm, cmap, levels, ticks
 
 
-@warnings._rename_kwargs(centers='values')
+@warnings._rename_kwargs('0.6', centers='values')
 @docstring.add_snippets
 def cmap_changer(
     self, func, *args, extend='neither',
@@ -3783,13 +3783,13 @@ def _basemap_redirect(func):
     name = func.__name__
 
     @functools.wraps(func)
-    def _wrapper(self, *args, **kwargs):
+    def wrapper(self, *args, **kwargs):
         if getattr(self, 'name', '') == 'basemap':
             return getattr(self.projection, name)(*args, ax=self, **kwargs)
         else:
             return func(self, *args, **kwargs)
-    _wrapper.__doc__ = None
-    return _wrapper
+    wrapper.__doc__ = None
+    return wrapper
 
 
 def _basemap_norecurse(func):
@@ -3801,14 +3801,14 @@ def _basemap_norecurse(func):
     func._called_from_basemap = False
 
     @functools.wraps(func)
-    def _wrapper(self, *args, **kwargs):
+    def wrapper(self, *args, **kwargs):
         if func._called_from_basemap:
             result = getattr(maxes.Axes, name)(self, *args, **kwargs)
         else:
             with _state_context(func, _called_from_basemap=True):
                 result = func(self, *args, **kwargs)
         return result
-    return _wrapper
+    return wrapper
 
 
 def _generate_decorator(driver):
@@ -3827,11 +3827,11 @@ def decorator(func):
         # Define wrapper and suppress documentation
         # We only document wrapper functions, not the methods they wrap
         @functools.wraps(func)
-        def _wrapper(self, *args, **kwargs):
+        def wrapper(self, *args, **kwargs):
             return driver(self, func, *args, **kwargs)
         name = func.__name__
         if name not in proplot_methods:
-            _wrapper.__doc__ = None
+            wrapper.__doc__ = None
 
         # List wrapped methods in the driver function docstring
         # Prevents us from having to both explicitly apply decorators in
@@ -3852,7 +3852,7 @@ def _wrapper(self, *args, **kwargs):
                     + methods[-1]
                 )
                 driver.__doc__ = docstring.format(methods=string)
-        return _wrapper
+        return wrapper
     return decorator
 
 

proplot/colors.py

@@ -1176,10 +1176,13 @@ def from_list(cls, name, colors, ratios=None, **kwargs):
         return cls(name, cdict, **kwargs)
 
     # Rename methods
-    concatenate = warnings._rename_obj('concatenate', append)
-    punched = warnings._rename_obj('punched', cut)
-    truncated = warnings._rename_obj('truncated', truncate)
-    updated = warnings._rename_obj('updated', copy)
+    concatenate, punched, truncated, updated = warnings._rename_objs(
+        '0.6',
+        concatenate=append,
+        punched=cut,
+        truncated=truncate,
+        updated=copy,
+    )
 
 
 class ListedColormap(mcolors.ListedColormap, _Colormap):
@@ -1375,9 +1378,12 @@ def from_file(cls, path, warn_on_failure=False):
         return cls._from_file(path, warn_on_failure=warn_on_failure)
 
     # Rename methods
-    concatenate = warnings._rename_obj('concatenate', append)
-    truncated = warnings._rename_obj('truncated', truncate)
-    updated = warnings._rename_obj('updated', copy)
+    concatenate, truncated, updated = warnings._rename_objs(
+        '0.6',
+        concatenate=append,
+        truncated=truncate,
+        updated=copy,
+    )
 
 
 class PerceptuallyUniformColormap(LinearSegmentedColormap, _Colormap):
@@ -2377,7 +2383,10 @@ def _sanitize_key(self, key, mirror=True):
     setattr(mcm, _cmap_database_attr, _cmap_database)
 
 # Deprecations
-CmapDict = warnings._rename_obj('CmapDict', ColormapDatabase)
-ColorDict = warnings._rename_obj('ColorDict', ColorDatabase)
-MidpointNorm = warnings._rename_obj('MidpointNorm', DivergingNorm)
-BinNorm = warnings._rename_obj('BinNorm', DiscreteNorm)
+CmapDict, ColorDict, MidpointNorm, BinNorm = warnings._rename_objs(
+    '0.6',
+    CmapDict=ColormapDatabase,
+    ColorDict=ColorDatabase,
+    MidpointNorm=DivergingNorm,
+    BinNorm=DiscreteNorm
+)

proplot/config.py

@@ -1581,5 +1581,8 @@ def _validate_fontsize_None(s):
         cmap.N = lut
 
 # Deprecated
-inline_backend_fmt = warnings._rename_obj('inline_backend_fmt', config_inline_backend)
-rc_configurator = warnings._rename_obj('RcConfigurator', config_inline_backend)
+inline_backend_fmt, rc_configurator = warnings._rename_objs(
+    '0.6',
+    inline_backend_fmt=config_inline_backend,
+    RcConfigurator=config_inline_backend,
+)

proplot/figure.py

@@ -6,7 +6,6 @@
 import numpy as np
 import matplotlib.figure as mfigure
 import matplotlib.transforms as mtransforms
-from numbers import Integral
 from . import axes as paxes
 from . import gridspec as pgridspec
 from .config import rc
@@ -237,12 +236,28 @@ def __init__(
             warnings._warn_proplot('"aligny" has no effect when spany=True.')
         alignx = _not_none(alignx, align, rc['subplots.align'])
         aligny = _not_none(aligny, align, rc['subplots.align'])
-        self.set_alignx(alignx)
-        self.set_aligny(aligny)
-        self.set_sharex(sharex)
-        self.set_sharey(sharey)
-        self.set_spanx(spanx)
-        self.set_spany(spany)
+        if int(sharex) not in range(4):
+            raise ValueError(
+                'Invalid sharing level sharex={value!r}. '
+                'Axis sharing level can be 0 (share nothing), '
+                '1 (hide axis labels), '
+                '2 (share limits and hide axis labels), or '
+                '3 (share limits and hide axis and tick labels).'
+            )
+        if int(sharey) not in range(4):
+            raise ValueError(
+                'Invalid sharing level sharey={sharey!r}. '
+                'Axis sharing level can be 0 (share nothing), '
+                '1 (hide axis labels), '
+                '2 (share limits and hide axis labels), or '
+                '3 (share limits and hide axis and tick labels).'
+            )
+        self._alignx = bool(alignx)
+        self._aligny = bool(aligny)
+        self._sharex = int(sharex)
+        self._sharey = int(sharey)
+        self._spanx = bool(spanx)
+        self._spany = bool(spany)
 
         # Various other attributes
         gridspec_kw = gridspec_kw or {}
@@ -1293,102 +1308,48 @@ def set_size_inches(self, w, h=None, forward=True, auto=False):
         with context():
             super().set_size_inches(width, height, forward=forward)
 
-    def get_alignx(self):
+    @property
+    def alignx(self):
         """
-        Return the *x* axis label alignment mode.
+        The *x* axis label alignment mode.
         """
         return self._alignx
 
-    def get_aligny(self):
+    @property
+    def aligny(self):
         """
-        Return the *y* axis label alignment mode.
+        The *y* axis label alignment mode.
         """
         return self._aligny
 
-    def get_sharex(self):
+    @property
+    def sharex(self):
         """
-        Return the *x* axis sharing level.
+        The *x* axis sharing level.
         """
         return self._sharex
 
-    def get_sharey(self):
+    @property
+    def sharey(self):
         """
-        Return the *y* axis sharing level.
+        The *y* axis sharing level.
         """
         return self._sharey
 
-    def get_spanx(self):
+    @property
+    def spanx(self):
         """
-        Return the *x* axis label spanning mode.
+        The *x* axis label spanning mode.
         """
         return self._spanx
 
-    def get_spany(self):
+    @property
+    def spany(self):
         """
-        Return the *y* axis label spanning mode.
+        The *y* axis label spanning mode.
         """
         return self._spany
 
-    def set_alignx(self, value):
-        """
-        Set the *x* axis label alignment mode.
-        """
-        self.stale = True
-        self._alignx = bool(value)
-
-    def set_aligny(self, value):
-        """
-        Set the *y* axis label alignment mode.
-        """
-        self.stale = True
-        self._aligny = bool(value)
-
-    def set_sharex(self, value):
-        """
-        Set the *x* axis sharing level.
-        """
-        value = int(value)
-        if value not in range(4):
-            raise ValueError(
-                'Invalid sharing level sharex={value!r}. '
-                'Axis sharing level can be 0 (share nothing), '
-                '1 (hide axis labels), '
-                '2 (share limits and hide axis labels), or '
-                '3 (share limits and hide axis and tick labels).'
-            )
-        self.stale = True
-        self._sharex = value
-
-    def set_sharey(self, value):
-        """
-        Set the *y* axis sharing level.
-        """
-        value = int(value)
-        if value not in range(4):
-            raise ValueError(
-                'Invalid sharing level sharey={value!r}. '
-                'Axis sharing level can be 0 (share nothing), '
-                '1 (hide axis labels), '
-                '2 (share limits and hide axis labels), or '
-                '3 (share limits and hide axis and tick labels).'
-            )
-        self.stale = True
-        self._sharey = value
-
-    def set_spanx(self, value):
-        """
-        Set the *x* axis label spanning mode.
-        """
-        self.stale = True
-        self._spanx = bool(value)
-
-    def set_spany(self, value):
-        """
-        Set the *y* axis label spanning mode.
-        """
-        self.stale = True
-        self._spany = bool(value)
-
     @property
     def gridspec(self):
         """
@@ -1405,16 +1366,7 @@ def ref(self):
         `~proplot.ui.figure` arguments are applied to this axes, and
         aspect ratio is conserved for this axes in tight layout adjustment.
         """
-        return self._ref
-
-    @ref.setter
-    def ref(self, ref):
-        if not isinstance(ref, Integral) or ref < 1:
-            raise ValueError(
-                f'Invalid axes number {ref!r}. Must be integer >=1.'
-            )
-        self.stale = True
-        self._ref = ref
+        return self._ref_num
 
     def _iter_axes(self, hidden=False, children=False):
         """
@@ -1438,3 +1390,13 @@ def _iter_axes(self, hidden=False, children=False):
             if not hidden and ax._panel_hidden:
                 continue  # ignore hidden panel and its colorbar/legend child
             yield from ax._iter_axes(hidden=hidden, children=children)
+
+    # Deprecations
+    # NOTE: None of these even *worked* after drawing the figure. And not sure
+    # what value (if any) they add even if we do get them to work.
+    get_alignx, set_alignx = warnings._read_only_property('0.6', 'alignx')
+    get_aligny, set_aligny = warnings._read_only_property('0.6', 'aligny')
+    get_sharex, set_sharex = warnings._read_only_property('0.6', 'sharex')
+    get_sharey, set_sharey = warnings._read_only_property('0.6', 'sharey')
+    get_spanx, set_spanx = warnings._read_only_property('0.6', 'spanx')
+    get_spany, set_spany = warnings._read_only_property('0.6', 'spany')