Remove 3.8 cbook deprecations

Author: QuLogic

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

@@ -61,6 +61,19 @@ which should cover most use cases.
 ... with no replacement.
 
 
+``cbook`` API changes
+~~~~~~~~~~~~~~~~~~~~~
+
+``cbook.Stack`` has been removed with no replacement.
+
+``Grouper.clean()`` has been removed with no replacement. The Grouper class now cleans
+itself up automatically.
+
+The *np_load* parameter of ``cbook.get_sample_data`` has been removed; `.get_sample_data`
+now auto-loads numpy arrays. Use ``get_sample_data(..., asfileobj=False)`` instead to get
+the filename of the data file, which can then be passed to `open`, if desired.
+
+
 ``axes_grid1`` API changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

lib/matplotlib/cbook.py

@@ -543,9 +543,7 @@ def is_scalar_or_string(val):
     return isinstance(val, str) or not np.iterable(val)
 
 
-@_api.delete_parameter(
-    "3.8", "np_load", alternative="open(get_sample_data(..., asfileobj=False))")
-def get_sample_data(fname, asfileobj=True, *, np_load=True):
+def get_sample_data(fname, asfileobj=True):
     """
     Return a sample data file.  *fname* is a path relative to the
     :file:`mpl-data/sample_data` directory.  If *asfileobj* is `True`
@@ -564,10 +562,7 @@ def get_sample_data(fname, asfileobj=True, *, np_load=True):
         if suffix == '.gz':
             return gzip.open(path)
         elif suffix in ['.npy', '.npz']:
-            if np_load:
-                return np.load(path)
-            else:
-                return path.open('rb')
+            return np.load(path)
         elif suffix in ['.csv', '.xrc', '.txt']:
             return path.open('r')
         else:
@@ -607,113 +602,6 @@ def flatten(seq, scalarp=is_scalar_or_string):
             yield from flatten(item, scalarp)
 
 
-@_api.deprecated("3.8")
-class Stack:
-    """
-    Stack of elements with a movable cursor.
-
-    Mimics home/back/forward in a web browser.
-    """
-
-    def __init__(self, default=None):
-        self.clear()
-        self._default = default
-
-    def __call__(self):
-        """Return the current element, or None."""
-        if not self._elements:
-            return self._default
-        else:
-            return self._elements[self._pos]
-
-    def __len__(self):
-        return len(self._elements)
-
-    def __getitem__(self, ind):
-        return self._elements[ind]
-
-    def forward(self):
-        """Move the position forward and return the current element."""
-        self._pos = min(self._pos + 1, len(self._elements) - 1)
-        return self()
-
-    def back(self):
-        """Move the position back and return the current element."""
-        if self._pos > 0:
-            self._pos -= 1
-        return self()
-
-    def push(self, o):
-        """
-        Push *o* to the stack at current position.  Discard all later elements.
-
-        *o* is returned.
-        """
-        self._elements = self._elements[:self._pos + 1] + [o]
-        self._pos = len(self._elements) - 1
-        return self()
-
-    def home(self):
-        """
-        Push the first element onto the top of the stack.
-
-        The first element is returned.
-        """
-        if not self._elements:
-            return
-        self.push(self._elements[0])
-        return self()
-
-    def empty(self):
-        """Return whether the stack is empty."""
-        return len(self._elements) == 0
-
-    def clear(self):
-        """Empty the stack."""
-        self._pos = -1
-        self._elements = []
-
-    def bubble(self, o):
-        """
-        Raise all references of *o* to the top of the stack, and return it.
-
-        Raises
-        ------
-        ValueError
-            If *o* is not in the stack.
-        """
-        if o not in self._elements:
-            raise ValueError('Given element not contained in the stack')
-        old_elements = self._elements.copy()
-        self.clear()
-        top_elements = []
-        for elem in old_elements:
-            if elem == o:
-                top_elements.append(elem)
-            else:
-                self.push(elem)
-        for _ in top_elements:
-            self.push(o)
-        return o
-
-    def remove(self, o):
-        """
-        Remove *o* from the stack.
-
-        Raises
-        ------
-        ValueError
-            If *o* is not in the stack.
-        """
-        if o not in self._elements:
-            raise ValueError('Given element not contained in the stack')
-        old_elements = self._elements.copy()
-        self.clear()
-        for elem in old_elements:
-            if elem != o:
-                self.push(elem)
-
-
 class _Stack:
     """
     Stack of elements with a movable cursor.
@@ -913,10 +801,6 @@ def __setstate__(self, state):
     def __contains__(self, item):
         return item in self._mapping
 
-    @_api.deprecated("3.8", alternative="none, you no longer need to clean a Grouper")
-    def clean(self):
-        """Clean dead weak references from the dictionary."""
-
     def join(self, a, *args):
         """
         Join given arguments into the same set.  Accepts one or more arguments.

lib/matplotlib/cbook.pyi

@@ -74,38 +74,15 @@ def open_file_cm(
 def is_scalar_or_string(val: Any) -> bool: ...
 @overload
 def get_sample_data(
-    fname: str | os.PathLike, asfileobj: Literal[True] = ..., *, np_load: Literal[True]
-) -> np.ndarray: ...
+    fname: str | os.PathLike, asfileobj: Literal[True] = ...
+) -> np.ndarray | IO: ...
 @overload
-def get_sample_data(
-    fname: str | os.PathLike,
-    asfileobj: Literal[True] = ...,
-    *,
-    np_load: Literal[False] = ...,
-) -> IO: ...
-@overload
-def get_sample_data(
-    fname: str | os.PathLike, asfileobj: Literal[False], *, np_load: bool = ...
-) -> str: ...
+def get_sample_data(fname: str | os.PathLike, asfileobj: Literal[False]) -> str: ...
 def _get_data_path(*args: Path | str) -> Path: ...
 def flatten(
     seq: Iterable[Any], scalarp: Callable[[Any], bool] = ...
 ) -> Generator[Any, None, None]: ...
 
-class Stack(Generic[_T]):
-    def __init__(self, default: _T | None = ...) -> None: ...
-    def __call__(self) -> _T: ...
-    def __len__(self) -> int: ...
-    def __getitem__(self, ind: int) -> _T: ...
-    def forward(self) -> _T: ...
-    def back(self) -> _T: ...
-    def push(self, o: _T) -> _T: ...
-    def home(self) -> _T: ...
-    def empty(self) -> bool: ...
-    def clear(self) -> None: ...
-    def bubble(self, o: _T) -> _T: ...
-    def remove(self, o: _T) -> None: ...
-
 def safe_masked_invalid(x: ArrayLike, copy: bool = ...) -> np.ndarray: ...
 def print_cycles(
     objects: Iterable[Any], outstream: IO = ..., show_progress: bool = ...
@@ -114,7 +91,6 @@ def print_cycles(
 class Grouper(Generic[_T]):
     def __init__(self, init: Iterable[_T] = ...) -> None: ...
     def __contains__(self, item: _T) -> bool: ...
-    def clean(self) -> None: ...
     def join(self, a: _T, *args: _T) -> None: ...
     def joined(self, a: _T, b: _T) -> bool: ...
     def remove(self, a: _T) -> None: ...