Merge branch 'main' of https://github.com/matplotlib/matplotlib into main

timhoffm · timhoffm · commit 3b600e5d1d8d · 2022-04-05T21:03:58.000+02:00
diff --git a/.github/workflows/nightlies.yml b/.github/workflows/nightlies.yml
@@ -54,11 +54,12 @@ jobs:
         run: |
           python -m pip install --upgrade pip setuptools wheel
           # c.f. https://github.com/Anaconda-Platform/anaconda-client/issues/540
-          python -m pip install git+https://github.com/Anaconda-Server/anaconda-client
+          python -m pip install git+https://github.com/Anaconda-Server/anaconda-client@be1e14936a8e947da94d026c990715f0596d7043
           python -m pip list
 
       - name: Upload wheels to Anaconda Cloud as nightlies
         run: |
           anaconda --token ${{ secrets.ANACONDA_ORG_UPLOAD_TOKEN }} upload \
             --user scipy-wheels-nightly \
+            --skip-existing \
             dist/matplotlib-*.whl
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -130,13 +130,17 @@ stages:
         displayName: 'Install dependencies with pip'
 
       - bash: |
-          python -m pip install -ve . ||
+          # Due to https://github.com/pypa/setuptools/pull/2896
+          SETUPTOOLS_USE_DISTUTILS=stdlib python -m pip install -ve . ||
             [[ "$PYTHON_VERSION" = 'Pre' ]]
         displayName: "Install self"
 
       - script: env
         displayName: 'print env'
 
+      - script: pip list
+        displayName: 'print pip'
+
       - bash: |
           PYTHONFAULTHANDLER=1 python -m pytest --junitxml=junit/test-results.xml -raR --maxfail=50 --timeout=300 --durations=25 --cov-report= --cov=lib -n 2 ||
             [[ "$PYTHON_VERSION" = 'Pre' ]]
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -729,7 +729,7 @@ gets interpolated into the docstring.
 Note that this scheme does not work for decorating an Artist's ``__init__``, as
 the subclass and its properties are not defined yet at that point.  Instead,
 ``@_docstring.interpd`` can be used to decorate the class itself -- at that
-point, `.kwdoc` can list the properties and interpolate them into
+point, `.artist.kwdoc` can list the properties and interpolate them into
 ``__init__.__doc__``.
 
 
diff --git a/doc/users/installing/index.rst b/doc/users/installing/index.rst
@@ -92,7 +92,12 @@ as the package index to query:
 
 .. code-block:: sh
 
-  python -m pip install --upgrade --index-url https://pypi.anaconda.org/scipy-wheels-nightly/simple matplotlib
+  python -m pip install \
+    --upgrade \
+    --pre \
+    --index-url https://pypi.anaconda.org/scipy-wheels-nightly/simple \
+    --extra-index-url https://pypi.org/simple \
+    matplotlib
 
 ======================
 Installing from source
diff --git a/examples/lines_bars_and_markers/csd_demo.py b/examples/lines_bars_and_markers/csd_demo.py
@@ -38,5 +38,5 @@
 ax1.grid(True)
 
 cxy, f = ax2.csd(s1, s2, 256, 1. / dt)
-ax2.set_ylabel('CSD (db)')
+ax2.set_ylabel('CSD (dB)')
 plt.show()
diff --git a/examples/mplot3d/projections.py b/examples/mplot3d/projections.py
@@ -16,15 +16,15 @@
 
 You can calculate focal length from a FOV via the equation:
 
-.. mathmpl::
+.. math::
 
-    1 / \tan (FOV / 2)
+    1 / \\tan (\\mathrm{FOV} / 2)
 
 Or vice versa:
 
-.. mathmpl::
+.. math::
 
-    FOV = 2 * \atan (1 / focal length)
+    \\mathrm{FOV} = 2 \\arctan (1 / \\mathrm{focal length})
 
 """
 
diff --git a/examples/scales/asinh_demo.py b/examples/scales/asinh_demo.py
@@ -15,13 +15,13 @@
 
 .. math::
 
-    a \\rightarrow a + {\\cal O}(a^3)
+    a \\rightarrow a + \\mathcal{O}(a^3)
 
 but for larger values (i.e. :math:`|a| \\gg a_0`, this is asymptotically
 
 .. math::
 
-    a \\rightarrow a_0 \\, {\\rm sgn}(a) \\ln |a| + {\\cal O}(1)
+    a \\rightarrow a_0 \\, \\mathrm{sgn}(a) \\ln |a| + \\mathcal{O}(1)
 
 As with the `symlog <.scale.SymmetricalLogScale>` scaling,
 this allows one to plot quantities
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -18,7 +18,7 @@
 import numpy as np
 
 from matplotlib import _api, artist as martist
-from matplotlib.backend_bases import _get_renderer
+from matplotlib._tight_layout import get_renderer
 import matplotlib.transforms as mtransforms
 import matplotlib._layoutgrid as mlayoutgrid
 
@@ -92,7 +92,7 @@ def do_constrained_layout(fig, h_pad, w_pad,
     layoutgrid : private debugging structure
     """
 
-    renderer = _get_renderer(fig)
+    renderer = get_renderer(fig)
     # make layoutgrid tree...
     layoutgrids = make_layoutgrids(fig, None)
     if not layoutgrids['hasgrids']:
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -17,6 +17,7 @@
 #   * Can blit be enabled for movies?
 # * Need to consider event sources to allow clicking through multiple figures
 
+
 import abc
 import base64
 import contextlib
@@ -468,14 +469,15 @@ def grab_frame(self, **savefig_kwargs):
     def finish(self):
         # Call run here now that all frame grabbing is done. All temp files
         # are available to be assembled.
-        self._run()
-        super().finish()  # Will call clean-up
-
-    def _cleanup(self):  # Inline to finish() once cleanup() is removed.
-        super()._cleanup()
-        if self._tmpdir:
-            _log.debug('MovieWriter: clearing temporary path=%s', self._tmpdir)
-            self._tmpdir.cleanup()
+        try:
+            self._run()
+            super().finish()
+        finally:
+            if self._tmpdir:
+                _log.debug(
+                    'MovieWriter: clearing temporary path=%s', self._tmpdir
+                )
+                self._tmpdir.cleanup()
 
 
 @writers.register('pillow')
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2948,9 +2948,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
         Plot a pie chart.
 
         Make a pie chart of array *x*.  The fractional area of each wedge is
-        given by ``x/sum(x)``.  If ``sum(x) < 1``, then the values of *x* give
-        the fractional area directly and the array will not be normalized. The
-        resulting pie will have an empty wedge of size ``1 - sum(x)``.
+        given by ``x/sum(x)``.
 
         The wedges are plotted counterclockwise, by default starting from the
         x-axis.
diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -206,9 +206,11 @@ def remove_tool(self, name):
         """
 
         tool = self.get_tool(name)
-        _api.deprecate_method_override(
+        destroy = _api.deprecate_method_override(
             backend_tools.ToolBase.destroy, tool, since="3.6",
-            alternative="tool_removed_event")()
+            alternative="tool_removed_event")
+        if destroy is not None:
+            destroy()
 
         # If it's a toggle tool and toggled, untoggle
         if getattr(tool, 'toggled', False):
diff --git a/lib/matplotlib/backends/_backend_gtk.py b/lib/matplotlib/backends/_backend_gtk.py
@@ -295,8 +295,7 @@ def remove_rubberband(self):
 
 class ConfigureSubplotsGTK(backend_tools.ConfigureSubplotsBase):
     def trigger(self, *args):
-        _NavigationToolbar2GTK.configure_subplots(
-            self._make_classic_style_pseudo_toolbar(), None)
+        _NavigationToolbar2GTK.configure_subplots(self, None)
 
 
 class _BackendGTK(_Backend):
diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -934,8 +934,7 @@ def trigger(self, *args):
 @backend_tools._register_tool_class(FigureCanvasTk)
 class ConfigureSubplotsTk(backend_tools.ConfigureSubplotsBase):
     def trigger(self, *args):
-        NavigationToolbar2Tk.configure_subplots(
-            self._make_classic_style_pseudo_toolbar())
+        NavigationToolbar2Tk.configure_subplots(self)
 
 
 @backend_tools._register_tool_class(FigureCanvasTk)
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -1700,8 +1700,13 @@ def _writeImg(self, data, id, smask=None):
                 # Convert to indexed color if there are 256 colors or fewer
                 # This can significantly reduce the file size
                 num_colors = len(img_colors)
-                img = img.convert(mode='P', dither=Image.NONE,
-                                  palette=Image.ADAPTIVE, colors=num_colors)
+                # These constants were converted to IntEnums and deprecated in
+                # Pillow 9.2
+                dither = getattr(Image, 'Dither', Image).NONE
+                pmode = getattr(Image, 'Palette', Image).ADAPTIVE
+                img = img.convert(
+                    mode='P', dither=dither, palette=pmode, colors=num_colors
+                )
                 png_data, bit_depth, palette = self._writePng(img)
                 if bit_depth is None or palette is None:
                     raise RuntimeError("invalid PNG header")
diff --git a/lib/matplotlib/backends/backend_qt.py b/lib/matplotlib/backends/backend_qt.py
@@ -985,9 +985,12 @@ def set_message(self, s):
 
 @backend_tools._register_tool_class(FigureCanvasQT)
 class ConfigureSubplotsQt(backend_tools.ConfigureSubplotsBase):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._subplot_dialog = None
+
     def trigger(self, *args):
-        NavigationToolbar2QT.configure_subplots(
-            self._make_classic_style_pseudo_toolbar())
+        NavigationToolbar2QT.configure_subplots(self)
 
 
 @backend_tools._register_tool_class(FigureCanvasQT)
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -1242,8 +1242,7 @@ def set_message(self, s):
 @backend_tools._register_tool_class(_FigureCanvasWxBase)
 class ConfigureSubplotsWx(backend_tools.ConfigureSubplotsBase):
     def trigger(self, *args):
-        NavigationToolbar2Wx.configure_subplots(
-            self._make_classic_style_pseudo_toolbar())
+        NavigationToolbar2Wx.configure_subplots(self)
 
 
 @backend_tools._register_tool_class(_FigureCanvasWxBase)
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -1617,7 +1617,7 @@ def make_axes_gridspec(parent, *, location=None, orientation=None,
             aspect = 1 / aspect
 
     parent.set_subplotspec(ss_main)
-    parent.set_anchor(panchor)
+    parent.set_anchor(loc_settings["panchor"])
 
     fig = parent.get_figure()
     cax = fig.add_subplot(ss_cb, label="<colorbar>")
diff --git a/lib/matplotlib/layout_engine.py b/lib/matplotlib/layout_engine.py
@@ -22,7 +22,8 @@
 from matplotlib._constrained_layout import do_constrained_layout
 from matplotlib._tight_layout import (get_subplotspec_list,
                                       get_tight_layout_figure)
-from matplotlib.backend_bases import _get_renderer
+# from matplotlib.backend_bases import _get_renderer
+from matplotlib._tight_layout import get_renderer
 
 
 class LayoutEngine:
@@ -153,7 +154,7 @@ def execute(self, fig):
             _api.warn_external("This figure includes Axes that are not "
                                "compatible with tight_layout, so results "
                                "might be incorrect.")
-        renderer = _get_renderer(fig)
+        renderer = get_renderer(fig)
         with getattr(renderer, "_draw_disabled", nullcontext)():
             kwargs = get_tight_layout_figure(
                 fig, fig.axes, subplotspec_list, renderer,
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -60,7 +60,7 @@
 
 def window_hanning(x):
     """
-    Return x times the hanning window of len(x).
+    Return *x* times the Hanning (or Hann) window of len(*x*).
 
     See Also
     --------
@@ -71,7 +71,7 @@ def window_hanning(x):
 
 def window_none(x):
     """
-    No window function; simply return x.
+    No window function; simply return *x*.
 
     See Also
     --------
@@ -82,7 +82,7 @@ def window_none(x):
 
 def detrend(x, key=None, axis=None):
     """
-    Return x with its trend removed.
+    Return *x* with its trend removed.
 
     Parameters
     ----------
@@ -131,7 +131,7 @@ def detrend(x, key=None, axis=None):
 
 def detrend_mean(x, axis=None):
     """
-    Return x minus the mean(x).
+    Return *x* minus the mean(*x*).
 
     Parameters
     ----------
@@ -140,7 +140,7 @@ def detrend_mean(x, axis=None):
         Can have any dimensionality
 
     axis : int
-        The axis along which to take the mean.  See numpy.mean for a
+        The axis along which to take the mean.  See `numpy.mean` for a
         description of this argument.
 
     See Also
@@ -159,7 +159,7 @@ def detrend_mean(x, axis=None):
 
 def detrend_none(x, axis=None):
     """
-    Return x: no detrending.
+    Return *x*: no detrending.
 
     Parameters
     ----------
@@ -181,7 +181,7 @@ def detrend_none(x, axis=None):
 
 def detrend_linear(y):
     """
-    Return x minus best fit line; 'linear' detrending.
+    Return *x* minus best fit line; 'linear' detrending.
 
     Parameters
     ----------
@@ -216,7 +216,7 @@ def detrend_linear(y):
 @_api.deprecated("3.6")
 def stride_windows(x, n, noverlap=None, axis=0):
     """
-    Get all windows of x with length n as a single array,
+    Get all windows of *x* with length *n* as a single array,
     using strides to avoid data duplication.
 
     .. warning::
@@ -497,8 +497,8 @@ def _single_spectrum_helper(
     the FFT.  While not increasing the actual resolution of the spectrum (the
     minimum distance between resolvable peaks), this can give more points in
     the plot, allowing for more detail. This corresponds to the *n* parameter
-    in the call to fft().  The default is None, which sets *pad_to* equal to
-    the length of the input signal (i.e. no padding).""",
+    in the call to `~numpy.fft.fft`.  The default is None, which sets *pad_to*
+    equal to the length of the input signal (i.e. no padding).""",
 
     PSD="""\
 pad_to : int, optional
@@ -507,8 +507,8 @@ def _single_spectrum_helper(
     of data points used.  While not increasing the actual resolution of the
     spectrum (the minimum distance between resolvable peaks), this can give
     more points in the plot, allowing for more detail. This corresponds to
-    the *n* parameter in the call to fft(). The default is None, which sets
-    *pad_to* equal to *NFFT*
+    the *n* parameter in the call to `~numpy.fft.fft`. The default is None,
+    which sets *pad_to* equal to *NFFT*
 
 NFFT : int, default: 256
     The number of data points used in each block for the FFT.  A power 2 is
@@ -526,7 +526,7 @@ def _single_spectrum_helper(
 
 scale_by_freq : bool, default: True
     Whether the resulting density values should be scaled by the scaling
-    frequency, which gives density in units of Hz^-1.  This allows for
+    frequency, which gives density in units of 1/Hz.  This allows for
     integration over the returned frequency values.  The default is True for
     MATLAB compatibility.""")
 
@@ -714,11 +714,11 @@ def specgram(x, NFFT=None, Fs=None, detrend=None, window=None,
     """
     Compute a spectrogram.
 
-    Compute and plot a spectrogram of data in x.  Data are split into
-    NFFT length segments and the spectrum of each section is
-    computed.  The windowing function window is applied to each
+    Compute and plot a spectrogram of data in *x*.  Data are split into
+    *NFFT* length segments and the spectrum of each section is
+    computed.  The windowing function *window* is applied to each
     segment, and the amount of overlap of each segment is
-    specified with noverlap.
+    specified with *noverlap*.
 
     Parameters
     ----------
@@ -760,13 +760,13 @@ def specgram(x, NFFT=None, Fs=None, detrend=None, window=None,
     --------
     psd : differs in the overlap and in the return values.
     complex_spectrum : similar, but with complex valued frequencies.
-    magnitude_spectrum : similar single segment when mode is 'magnitude'.
-    angle_spectrum : similar to single segment when mode is 'angle'.
-    phase_spectrum : similar to single segment when mode is 'phase'.
+    magnitude_spectrum : similar single segment when *mode* is 'magnitude'.
+    angle_spectrum : similar to single segment when *mode* is 'angle'.
+    phase_spectrum : similar to single segment when *mode* is 'phase'.
 
     Notes
     -----
-    detrend and scale_by_freq only apply when *mode* is set to 'psd'.
+    *detrend* and *scale_by_freq* only apply when *mode* is set to 'psd'.
 
     """
     if noverlap is None:
diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
diff --git a/lib/matplotlib/tests/test_colorbar.py b/lib/matplotlib/tests/test_colorbar.py
diff --git a/setup.py b/setup.py
