Merge branch 'main' into get-tick-params

Author: stefmolin

.flake8

@@ -60,7 +60,7 @@ per-file-ignores =
     lib/matplotlib/pyplot.py: F401, F811
     lib/matplotlib/tests/test_mathtext.py: E501
     lib/matplotlib/transforms.py: E201, E202, E203
-    lib/matplotlib/tri/triinterpolate.py: E201, E221
+    lib/matplotlib/tri/_triinterpolate.py: E201, E221
     lib/mpl_toolkits/axes_grid1/axes_size.py: E272
     lib/mpl_toolkits/axisartist/__init__.py: F401
     lib/mpl_toolkits/axisartist/angle_helper.py: E221

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,10 +8,13 @@
 - [ ] Is [Flake 8](https://flake8.pycqa.org/en/latest/) compliant (install `flake8-docstrings` and run `flake8 --docstring-convention=all`).
 
 **Documentation**
-- [ ] New features are documented, with examples if plot related.
-- [ ] New features have an entry in `doc/users/next_whats_new/` (follow instructions in README.rst there).
-- [ ] API changes documented in `doc/api/next_api_changes/` (follow instructions in README.rst there).
 - [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error).
+- [ ] New plotting related features are documented with examples.
+
+**Release Notes**
+- [ ] New features are marked with a `.. versionadded::` directive in the docstring and documented in `doc/users/next_whats_new/`
+- [ ] API changes are marked with a `.. versionchanged::` directive in the docstring and documented in `doc/api/next_api_changes/`
+- [ ] Release notes conform with instructions in  `next_whats_new/README.rst` or `next_api_changes/README.rst`
 
 <!--
 Thank you so much for your PR!  To help us review your contribution, please
@@ -22,7 +25,7 @@ consider the following points:
 - Help with git and github is available at
   https://matplotlib.org/devel/gitwash/development_workflow.html.
 
-- Do not create the PR out of main, but out of a separate branch.
+- Create a separate branch for your changes and open the PR from this branch. Please avoid working on `main`.
 
 - The PR title should summarize the changes, for example "Raise ValueError on
   non-numeric input to set_xlim".  Avoid non-descriptive titles such as

.github/workflows/cibuildwheel.yml

@@ -53,7 +53,7 @@ jobs:
           fetch-depth: 0
 
       - name: Build wheels for CPython 3.11
-        uses: pypa/[email protected].1
+        uses: pypa/[email protected].2
         env:
           CIBW_BUILD: "cp311-*"
           CIBW_SKIP: "*-musllinux*"
@@ -66,7 +66,7 @@ jobs:
           CIBW_ARCHS: ${{ matrix.cibw_archs }}
 
       - name: Build wheels for CPython 3.10
-        uses: pypa/[email protected].1
+        uses: pypa/[email protected].2
         env:
           CIBW_BUILD: "cp310-*"
           CIBW_SKIP: "*-musllinux*"
@@ -79,7 +79,7 @@ jobs:
           CIBW_ARCHS: ${{ matrix.cibw_archs }}
 
       - name: Build wheels for CPython 3.9
-        uses: pypa/[email protected].1
+        uses: pypa/[email protected].2
         env:
           CIBW_BUILD: "cp39-*"
           CIBW_SKIP: "*-musllinux*"
@@ -92,7 +92,7 @@ jobs:
           CIBW_ARCHS: ${{ matrix.cibw_archs }}
 
       - name: Build wheels for CPython 3.8
-        uses: pypa/[email protected].1
+        uses: pypa/[email protected].2
         env:
           CIBW_BUILD: "cp38-*"
           CIBW_SKIP: "*-musllinux*"
@@ -105,7 +105,7 @@ jobs:
           CIBW_ARCHS: ${{ matrix.cibw_archs }}
 
       - name: Build wheels for PyPy
-        uses: pypa/[email protected].1
+        uses: pypa/[email protected].2
         env:
           CIBW_BUILD: "pp38-* pp39-*"
           CIBW_SKIP: "*-musllinux*"

.github/workflows/nightlies.yml

@@ -49,7 +49,7 @@ jobs:
 
         # N.B. anaconda-client is only maintained on the main channel
       - name: Install anaconda-client
-        uses: mamba-org/provision-with-micromamba@v13
+        uses: mamba-org/provision-with-micromamba@v14
         with:
           environment-file: false
           environment-name: nightlies

.github/workflows/tests.yml

@@ -162,8 +162,8 @@ jobs:
 
           # Install dependencies from PyPI.
           python -m pip install --upgrade $PRE \
-            'contourpy>=1.0.1' cycler fonttools kiwisolver numpy packaging \
-            pillow pyparsing python-dateutil setuptools-scm \
+            'contourpy>=1.0.1' cycler fonttools kiwisolver importlib_resources \
+            numpy packaging pillow pyparsing python-dateutil setuptools-scm \
             -r requirements/testing/all.txt \
             ${{ matrix.extra-requirements }}
 

SECURITY.md

@@ -17,15 +17,12 @@ versions.
 
 ## Reporting a Vulnerability
 
-If you have found a security vulnerability, in order to keep it confidential,
-please do not report an issue on GitHub.
 
-Please email us details of the vulnerability at [email protected];
-include a description and proof-of-concept that is [short and
-self-contained](http://www.sscce.org/).
+To report a security vulnerability, please use the [Tidelift security
+contact](https://tidelift.com/security).  Tidelift will coordinate the fix and
+disclosure.
 
-You should expect a response within a week of your email. Depending on the
-severity of the issue, this may require some time to draft an immediate bugfix
-release. Less severe issues may be held until the next release.
+If you have found a security vulnerability, in order to keep it confidential,
+please do not report an issue on GitHub.
 
 We do not award bounties for security vulnerabilities.

doc/api/animation_api.rst

@@ -108,7 +108,7 @@ this means that the callable objects you pass in must know what
 artists they should be working on.  There are several approaches to
 handling this, of varying complexity and encapsulation.  The simplest
 approach, which works quite well in the case of a script, is to define the
-artist at a global scope and let Python sort things out.  For example ::
+artist at a global scope and let Python sort things out.  For example::
 
    import numpy as np
    import matplotlib.pyplot as plt
@@ -133,8 +133,36 @@ artist at a global scope and let Python sort things out.  For example ::
                        init_func=init, blit=True)
    plt.show()
 
-The second method is to use `functools.partial` to 'bind' artists to
-function.  A third method is to use closures to build up the required
+The second method is to use `functools.partial` to pass arguments to the
+function::
+
+   import numpy as np
+   import matplotlib.pyplot as plt
+   from matplotlib.animation import FuncAnimation
+   from functools import partial
+
+   fig, ax = plt.subplots()
+   line1, = ax.plot([], [], 'ro')
+
+   def init():
+       ax.set_xlim(0, 2*np.pi)
+       ax.set_ylim(-1, 1)
+       return line1,
+
+   def update(frame, ln, x, y):
+       x.append(frame)
+       y.append(np.sin(frame))
+       ln.set_data(x, y)
+       return ln,
+
+   ani = FuncAnimation(
+       fig, partial(update, ln=line1, x=[], y=[]),
+       frames=np.linspace(0, 2*np.pi, 128),
+       init_func=init, blit=True)
+
+   plt.show()
+
+A third method is to use closures to build up the required
 artists and functions.  A fourth method is to create a class.
 
 Examples

doc/api/blocking_input_api.rst

@@ -105,7 +105,6 @@ Alphabetical list of modules:
    backend_tools_api.rst
    index_backend_api.rst
    bezier_api.rst
-   blocking_input_api.rst
    category_api.rst
    cbook_api.rst
    cm_api.rst

doc/api/index.rst

@@ -0,0 +1,8 @@
+``TrapezoidMapTriFinder`` uses different random number generator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The random number generator used to determine the order of insertion of
+triangle edges in ``TrapezoidMapTriFinder`` has changed. This can result in a
+different triangle index being returned for a point that lies exactly on an
+edge between two triangles. This can also affect triangulation interpolation
+and refinement algorithms that use ``TrapezoidMapTriFinder``.

doc/api/next_api_changes/behavior/24062-tb.rst

@@ -0,0 +1,5 @@
+``matplotlib.tri`` submodules are deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``matplotlib.tri.*`` submodules are deprecated.  All functionality is
+available in ``matplotlib.tri`` directly and should be imported from there.

doc/api/next_api_changes/deprecations/24013-TH.rst

@@ -0,0 +1,5 @@
+``parse_fontconfig_pattern`` will no longer ignore unknown constant names
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Previously, in a fontconfig pattern like ``DejaVu Sans:foo``, the unknown
+``foo`` constant name would be silently ignored.  This now raises a warning,
+and will become an error in the future.

doc/api/next_api_changes/deprecations/24220-AL.rst

@@ -0,0 +1,5 @@
+``SimpleEvent``
+~~~~~~~~~~~~~~~
+The ``SimpleEvent`` nested class (previously accessible via the public
+subclasses of ``ConnectionStyle._Base``, such as `.ConnectionStyle.Arc`, has
+been deprecated.

doc/api/next_api_changes/deprecations/24305-AL.rst

@@ -0,0 +1,2 @@
+importlib_resources>=2.3.0 is now required on Python<3.10
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/api/next_api_changes/development/24257-AL.rst

@@ -0,0 +1,68 @@
+Miscellaneous removals
+~~~~~~~~~~~~~~~~~~~~~~
+
+- ``is_url`` and ``URL_REGEX`` are removed. (They were previously defined in
+  the toplevel :mod:`matplotlib` module.)
+- The ``ArrowStyle.beginarrow`` and ``ArrowStyle.endarrow`` attributes are
+  removed; use the ``arrow`` attribute to define the desired heads and tails
+  of the arrow.
+- ``backend_pgf.LatexManager.str_cache`` is removed.
+- ``backends.qt_compat.ETS`` and ``backends.qt_compat.QT_RC_MAJOR_VERSION`` are
+  removed, with no replacement.
+- The ``blocking_input`` module is removed. Instead, use
+  ``canvas.start_event_loop()`` and ``canvas.stop_event_loop()`` while
+  connecting event callbacks as needed.
+- ``cbook.report_memory`` is removed; use ``psutil.virtual_memory`` instead.
+- ``cm.LUTSIZE`` is removed. Use :rc:`image.lut` instead. This value only
+  affects colormap quantization levels for default colormaps generated at
+  module import time.
+- ``Colorbar.patch`` is removed; this attribute was not correctly updated
+  anymore.
+- ``ContourLabeler.get_label_width`` is removed.
+- ``Dvi.baseline`` is removed (with no replacement).
+- The *format* parameter of ``dviread.find_tex_file`` is removed (with no
+  replacement).
+- ``FancyArrowPatch.get_path_in_displaycoord`` and
+  ``ConnectionPath.get_path_in_displaycoord`` are removed. The path in
+  display coordinates can still be obtained, as for other patches, using
+  ``patch.get_transform().transform_path(patch.get_path())``.
+- The ``font_manager.win32InstalledFonts`` and
+  ``font_manager.get_fontconfig_fonts`` helper functions are removed.
+- All parameters of ``imshow`` starting from *aspect* are keyword-only.
+- ``QuadMesh.convert_mesh_to_paths`` and ``QuadMesh.convert_mesh_to_triangles``
+  are removed. ``QuadMesh.get_paths()`` can be used as an alternative for the
+  former; there is no replacement for the latter.
+- ``ScalarMappable.callbacksSM`` is removed. Use
+  ``ScalarMappable.callbacks`` instead.
+- ``streamplot.get_integrator`` is removed.
+- ``style.core.STYLE_FILE_PATTERN``, ``style.core.load_base_library``, and
+  ``style.core.iter_user_libraries`` are removed.
+- ``SubplotParams.validate`` is removed. Use `.SubplotParams.update` to
+  change `.SubplotParams` while always keeping it in a valid state.
+- The ``grey_arrayd``, ``font_family``, ``font_families``, and ``font_info``
+  attributes of `.TexManager` are removed.
+- ``Text.get_prop_tup`` is removed with no replacements (because the `.Text`
+  class cannot know whether a backend needs to update cache e.g. when the
+  text's color changes).
+- ``Tick.apply_tickdir`` didn't actually update the tick markers on the
+  existing Line2D objects used to draw the ticks and is removed; use
+  `.Axis.set_tick_params` instead.
+- ``tight_layout.auto_adjust_subplotpars`` is removed.
+- The ``grid_info`` attribute of ``axisartist`` classes has been removed.
+- ``axes_grid1.axes_grid.CbarAxes`` and ``axisartist.axes_grid.CbarAxes`` are
+  removed (they are now dynamically generated based on the owning axes
+  class).
+- The ``axes_grid1.Divider.get_vsize_hsize`` and
+  ``axes_grid1.Grid.get_vsize_hsize`` methods are removed.
+- ``AxesDivider.append_axes(..., add_to_figure=False)`` is removed. Use
+  ``ax.remove()`` to remove the Axes from the figure if needed.
+- ``FixedAxisArtistHelper.change_tick_coord`` is removed with no
+  replacement.
+- ``floating_axes.GridHelperCurveLinear.get_boundary`` is removed with no
+  replacement.
+- ``ParasiteAxesBase.get_images_artists`` is removed.
+- The "units finalize" signal (previously emitted by Axis instances) is
+  removed. Connect to "units" instead.
+- Passing formatting parameters positionally to ``stem()`` is no longer
+  possible.
+- ``axisartist.clip_path`` is removed with no replacement.

doc/api/next_api_changes/removals/24125-OG.rst

@@ -0,0 +1,4 @@
+``auto_add_to_figure=True`` for ``Axes3D``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... is no longer supported. Instead use ``fig.add_axes(ax)``.

doc/api/next_api_changes/removals/24251-OG.rst

@@ -0,0 +1,5 @@
+The first parameter of ``Axes.grid`` and ``Axis.grid`` has been renamed to *visible*
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The parameter was previously named *b*. This name change only matters if that
+parameter was passed using a keyword argument, e.g. ``grid(b=False)``.

doc/api/next_api_changes/removals/24253-OG.rst

@@ -0,0 +1,6 @@
+Unused positional parameters to ``print_<fmt>`` methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+None of the ``print_<fmt>`` methods implemented by canvas subclasses used
+positional arguments other that the first (the output filename or file-like),
+so these extra parameters are removed.

doc/api/next_api_changes/removals/24355-OG.rst

@@ -0,0 +1,19 @@
+``QuadMesh`` signature
+~~~~~~~~~~~~~~~~~~~~~~
+
+The `.QuadMesh` signature ::
+
+    def __init__(meshWidth, meshHeight, coordinates,
+                 antialiased=True, shading='flat', **kwargs)
+
+is removed and replaced by the new signature ::
+
+    def __init__(coordinates, *, antialiased=True, shading='flat', **kwargs)
+
+In particular:
+
+- The *coordinates* argument must now be a (M, N, 2) array-like. Previously,
+  the grid shape was separately specified as (*meshHeight* + 1, *meshWidth* +
+  1) and *coordinates* could be an array-like of any shape with M * N * 2
+  elements.
+- All parameters except *coordinates* are keyword-only now.

doc/api/next_api_changes/removals/24356-OG.rst

@@ -12,7 +12,7 @@ Changes for 0.98.0
   rather than custom callback handling.  Any users of
   ``matplotlib.cm.ScalarMappable.add_observer`` of the
   :class:`~matplotlib.cm.ScalarMappable` should use the
-  :attr:`matplotlib.cm.ScalarMappable.callbacksSM`
+  ``matplotlib.cm.ScalarMappable.callbacksSM``
   :class:`~matplotlib.cbook.CallbackRegistry` instead.
 
 * New axes function and Axes method provide control over the plot

doc/api/prev_api_changes/api_changes_0.98.0.rst

@@ -192,7 +192,7 @@ Code changes
   by ``self.vline`` for vertical cursors lines and ``self.hline`` is added
   for the horizontal cursors lines.
 
-* On POSIX platforms, the :func:`~matplotlib.cbook.report_memory` function
+* On POSIX platforms, the ``matplotlib.cbook.report_memory`` function
   raises :class:`NotImplementedError` instead of :class:`OSError` if the
   :command:`ps` command cannot be run.
 

doc/api/prev_api_changes/api_changes_1.3.x.rst

@@ -389,9 +389,9 @@ consistent with the behavior on Py2, where a buffer object was
 returned.
 
 
-`matplotlib.font_manager.win32InstalledFonts` return type
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`matplotlib.font_manager.win32InstalledFonts` returns an empty list instead
+``matplotlib.font_manager.win32InstalledFonts`` return type
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``matplotlib.font_manager.win32InstalledFonts`` returns an empty list instead
 of None if no fonts are found.
 
 ``Axes.fmt_xdata`` and ``Axes.fmt_ydata`` error handling