Merge pull request matplotlib#18522 from QuLogic/delete-deprecations

Remove mlab, toolkits, and misc deprecations

Author: timhoffm

doc/api/figure_api.rst

@@ -16,7 +16,6 @@ Classes
    :template: autosummary.rst
    :nosignatures:
 
-   AxesStack
    Figure
    SubplotParams
 

doc/api/next_api_changes/removals/18522-ES.rst

@@ -0,0 +1,39 @@
+``matplotlib.mlab``
+~~~~~~~~~~~~~~~~~~~
+``mlab.apply_window`` and ``mlab.stride_repeat`` have been removed.
+
+Axes3D
+~~~~~~
+``axes3d.unit_bbox`` has been removed; use ``Bbox.unit`` instead.
+
+axisartist
+~~~~~~~~~~
+``mpl_toolkits.axisartist.grid_finder.GridFinderBase`` has been removed; use
+`.GridFinder` instead.
+
+``axisartist.axis_artist.BezierPath`` has been removed; use
+`.patches.PathPatch` instead.
+
+Returning a factor equal to None from axisartist Locators (which are **not**
+the same as "standard" tick Locators), or passing a factor equal to None
+to axisartist Formatters (which are **not** the same as "standard" tick
+Formatters) is no longer supported. Pass a factor equal to 1 instead.
+
+Misc
+~~~~
+``matplotlib.get_home`` has been removed; use standard library instead.
+
+``matplotlib.compare_versions`` has been removed; use comparison of
+``distutils.version.LooseVersion``\s instead.
+
+``matplotlib.checkdep_ps_distiller`` has been removed.
+
+``matplotlib.figure.AxesStack`` has been removed.
+
+``BboxBase.is_unit`` has been removed; check the `.Bbox` extents if needed.
+
+``Affine2DBase.matrix_from_values(...)`` has been removed; use (for example)
+``Affine2D.from_values(...).get_matrix()`` instead.
+
+``style.core.is_style_file`` and ``style.core.iter_style_files`` have been
+removed.

doc/api/prev_api_changes/api_changes_2.1.0.rst

@@ -329,7 +329,7 @@ a previous axes instance currently reuses the earlier instance.  This
 behavior has been deprecated in Matplotlib 2.1. In a future version, a
 *new* instance will always be created and returned.  Meanwhile, in such
 a situation, a deprecation warning is raised by
-:class:`~matplotlib.figure.AxesStack`.
+``matplotlib.figure.AxesStack``.
 
 This warning can be suppressed, and the future behavior ensured, by passing
 a *unique* label to each axes instance.  See the docstring of

doc/users/prev_whats_new/whats_new_1.4.rst

@@ -114,13 +114,13 @@ Support for detrending and windowing 2D arrays in mlab
 Todd Jennings added support for 2D arrays in the
 :func:`~matplotlib.mlab.detrend_mean`, :func:`~matplotlib.mlab.detrend_none`,
 and :func:`~matplotlib.mlab.detrend`, as well as adding
-:func:`~matplotlib.mlab.apply_window` which support windowing 2D arrays.
+``matplotlib.mlab.apply_window`` which support windowing 2D arrays.
 
 Support for strides in mlab
 ```````````````````````````
-Todd Jennings added some functions to mlab to make it easier to use numpy
+Todd Jennings added some functions to mlab to make it easier to use NumPy
 strides to create memory-efficient 2D arrays.  This includes
-:func:`~matplotlib.mlab.stride_repeat`, which repeats an array to create a 2D
+``matplotlib.mlab.stride_repeat``, which repeats an array to create a 2D
 array, and :func:`~matplotlib.mlab.stride_windows`, which uses a moving window
 to create a 2D array from a 1D array.
 

lib/matplotlib/__init__.py

@@ -135,23 +135,6 @@
 }"""
 
 
-@cbook.deprecated("3.2")
-def compare_versions(a, b):
-    """Return whether version *a* is greater than or equal to version *b*."""
-    if isinstance(a, bytes):
-        cbook.warn_deprecated(
-            "3.0", message="compare_versions arguments should be strs.")
-        a = a.decode('ascii')
-    if isinstance(b, bytes):
-        cbook.warn_deprecated(
-            "3.0", message="compare_versions arguments should be strs.")
-        b = b.decode('ascii')
-    if a:
-        return LooseVersion(a) >= LooseVersion(b)
-    else:
-        return False
-
-
 def _check_versions():
 
     # Quickfix to ensure Microsoft Visual C++ redistributable
@@ -382,26 +365,6 @@ def impl(args, regex, min_ver=None, ignore_exit_code=False):
         raise ValueError("Unknown executable: {!r}".format(name))
 
 
-@cbook.deprecated("3.2")
-def checkdep_ps_distiller(s):
-    if not s:
-        return False
-    try:
-        _get_executable_info("gs")
-    except ExecutableNotFoundError:
-        _log.warning(
-            "Setting rcParams['ps.usedistiller'] requires ghostscript.")
-        return False
-    if s == "xpdf":
-        try:
-            _get_executable_info("pdftops")
-        except ExecutableNotFoundError:
-            _log.warning(
-                "Setting rcParams['ps.usedistiller'] to 'xpdf' requires xpdf.")
-            return False
-    return s
-
-
 def checkdep_usetex(s):
     if not s:
         return False
@@ -421,20 +384,6 @@ def checkdep_usetex(s):
     return True
 
 
-@cbook.deprecated("3.2", alternative="os.path.expanduser('~')")
-@_logged_cached('$HOME=%s')
-def get_home():
-    """
-    Return the user's home directory.
-
-    If the user's home directory cannot be found, return None.
-    """
-    try:
-        return str(Path.home())
-    except Exception:
-        return None
-
-
 def _get_xdg_config_dir():
     """
     Return the XDG configuration directory, according to the XDG base

lib/matplotlib/figure.py

@@ -152,11 +152,6 @@ def __contains__(self, a):
         return a in self.as_list()
 
 
-@cbook.deprecated("3.2")
-class AxesStack(_AxesStack):
-    pass
-
-
 class SubplotParams:
     """
     A class to hold the parameters for a subplot.

lib/matplotlib/mlab.py

@@ -45,12 +45,6 @@
 
 `stride_windows`
     Get all windows in an array in a memory-efficient manner
-
-`stride_repeat`
-    Repeat an array in a memory-efficient manner
-
-`apply_window`
-    Apply a window along a given axis
 """
 
 import functools
@@ -85,63 +79,6 @@ def window_none(x):
     return x
 
 
-@cbook.deprecated("3.2")
-def apply_window(x, window, axis=0, return_window=None):
-    """
-    Apply the given window to the given 1D or 2D array along the given axis.
-
-    Parameters
-    ----------
-    x : 1D or 2D array or sequence
-        Array or sequence containing the data.
-
-    window : function or array.
-        Either a function to generate a window or an array with length
-        *x*.shape[*axis*]
-
-    axis : int
-        The axis over which to do the repetition.
-        Must be 0 or 1.  The default is 0
-
-    return_window : bool
-        If true, also return the 1D values of the window that was applied
-    """
-    x = np.asarray(x)
-
-    if x.ndim < 1 or x.ndim > 2:
-        raise ValueError('only 1D or 2D arrays can be used')
-    if axis+1 > x.ndim:
-        raise ValueError('axis(=%s) out of bounds' % axis)
-
-    xshape = list(x.shape)
-    xshapetarg = xshape.pop(axis)
-
-    if np.iterable(window):
-        if len(window) != xshapetarg:
-            raise ValueError('The len(window) must be the same as the shape '
-                             'of x for the chosen axis')
-        windowVals = window
-    else:
-        windowVals = window(np.ones(xshapetarg, dtype=x.dtype))
-
-    if x.ndim == 1:
-        if return_window:
-            return windowVals * x, windowVals
-        else:
-            return windowVals * x
-
-    xshapeother = xshape.pop()
-
-    otheraxis = (axis+1) % 2
-
-    windowValsRep = stride_repeat(windowVals, xshapeother, axis=otheraxis)
-
-    if return_window:
-        return windowValsRep * x, windowVals
-    else:
-        return windowValsRep * x
-
-
 def detrend(x, key=None, axis=None):
     """
     Return x with its trend removed.
@@ -343,62 +280,6 @@ def stride_windows(x, n, noverlap=None, axis=0):
     return np.lib.stride_tricks.as_strided(x, shape=shape, strides=strides)
 
 
-@cbook.deprecated("3.2")
-def stride_repeat(x, n, axis=0):
-    """
-    Repeat the values in an array in a memory-efficient manner.  Array x is
-    stacked vertically n times.
-
-    .. warning::
-
-        It is not safe to write to the output array.  Multiple
-        elements may point to the same piece of memory, so
-        modifying one value may change others.
-
-    Parameters
-    ----------
-    x : 1D array or sequence
-        Array or sequence containing the data.
-
-    n : int
-        The number of time to repeat the array.
-
-    axis : int
-        The axis along which the data will run.
-
-    References
-    ----------
-    `stackoverflow: Repeat NumPy array without replicating data?
-    <http://stackoverflow.com/a/5568169>`_
-    """
-    if axis not in [0, 1]:
-        raise ValueError('axis must be 0 or 1')
-    x = np.asarray(x)
-    if x.ndim != 1:
-        raise ValueError('only 1-dimensional arrays can be used')
-
-    if n == 1:
-        if axis == 0:
-            return np.atleast_2d(x)
-        else:
-            return np.atleast_2d(x).T
-    if n < 1:
-        raise ValueError('n cannot be less than 1')
-
-    # np.lib.stride_tricks.as_strided easily leads to memory corruption for
-    # non integer shape and strides, i.e. n. See #3845.
-    n = int(n)
-
-    if axis == 0:
-        shape = (n, x.size)
-        strides = (0, x.strides[0])
-    else:
-        shape = (x.size, n)
-        strides = (x.strides[0], 0)
-
-    return np.lib.stride_tricks.as_strided(x, shape=shape, strides=strides)
-
-
 def _spectral_helper(x, y=None, NFFT=None, Fs=None, detrend_func=None,
                      window=None, noverlap=None, pad_to=None,
                      sides=None, scale_by_freq=None, mode=None):

lib/matplotlib/style/core.py

@@ -55,12 +55,6 @@ def _remove_blacklisted_style_params(d, warn=True):
     return o
 
 
-@cbook.deprecated("3.2")
-def is_style_file(filename):
-    """Return True if the filename looks like a style file."""
-    return STYLE_FILE_PATTERN.match(filename) is not None
-
-
 def _apply_style(d, warn=True):
     mpl.rcParams.update(_remove_blacklisted_style_params(d, warn=warn))
 
@@ -182,17 +176,6 @@ def update_user_library(library):
     return library
 
 
-@cbook.deprecated("3.2")
-def iter_style_files(style_dir):
-    """Yield file path and name of styles in the given directory."""
-    for path in os.listdir(style_dir):
-        filename = os.path.basename(path)
-        if is_style_file(filename):
-            match = STYLE_FILE_PATTERN.match(filename)
-            path = os.path.abspath(os.path.join(style_dir, path))
-            yield path, match.group(1)
-
-
 def read_style_directory(style_dir):
     """Return dictionary of styles defined in *style_dir*."""
     styles = dict()