\n'
- html_block += ' \n'
- html_block += '\n'
- self.body.append(html_block)
+ self.body.append(self.starttag(node, 'figcaption'))
+ self.body.append(self.starttag(node, 'p'))
+ self.body.append(self.starttag(node, 'span', CLASS='caption-text'))
+ self.body.append(node['caption'])
+ self.body.append('\n')
+ self.body.append('\n')
def visit_figmpl_latex(self, node):
diff --git a/lib/matplotlib/sphinxext/mathmpl.py b/lib/matplotlib/sphinxext/mathmpl.py
index 3e0d562e2d15..30f024524258 100644
--- a/lib/matplotlib/sphinxext/mathmpl.py
+++ b/lib/matplotlib/sphinxext/mathmpl.py
@@ -146,7 +146,10 @@ def latex2html(node, source):
fontset = node['fontset']
fontsize = node['fontsize']
name = 'math-{}'.format(
- hashlib.md5(f'{latex}{fontset}{fontsize}'.encode()).hexdigest()[-10:])
+ hashlib.sha256(
+ f'{latex}{fontset}{fontsize}'.encode(),
+ usedforsecurity=False,
+ ).hexdigest()[-10:])
destdir = Path(setup.app.builder.outdir, '_images', 'mathmpl')
destdir.mkdir(parents=True, exist_ok=True)
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
index 65b25fb913a5..b5f10d851182 100644
--- a/lib/matplotlib/sphinxext/plot_directive.py
+++ b/lib/matplotlib/sphinxext/plot_directive.py
@@ -32,7 +32,7 @@
import matplotlib.pyplot as plt
plt.plot([1, 2, 3], [4, 5, 6])
- plt.title("A plotting exammple")
+ plt.title("A plotting example")
3. Using **doctest** syntax::
@@ -47,6 +47,12 @@
The ``.. plot::`` directive supports the following options:
+``:filename-prefix:`` : str
+ The base name (without the extension) of the outputted image and script
+ files. The default is to use the same name as the input script, or the
+ name of the RST document if no script is provided. The filename-prefix for
+ each plot directive must be unique.
+
``:format:`` : {'python', 'doctest'}
The format of the input. If unset, the format is auto-detected.
@@ -163,8 +169,10 @@
be customized by changing the *plot_template*. See the source of
:doc:`/api/sphinxext_plot_directive_api` for the templates defined in *TEMPLATE*
and *TEMPLATE_SRCSET*.
+
"""
+from collections import defaultdict
import contextlib
import doctest
from io import StringIO
@@ -182,6 +190,7 @@
from docutils.parsers.rst.directives.images import Image
import jinja2 # Sphinx dependency.
+from sphinx.environment.collectors import EnvironmentCollector
from sphinx.errors import ExtensionError
import matplotlib
@@ -265,6 +274,7 @@ class PlotDirective(Directive):
'scale': directives.nonnegative_int,
'align': Image.align,
'class': directives.class_option,
+ 'filename-prefix': directives.unchanged,
'include-source': _option_boolean,
'show-source-link': _option_boolean,
'format': _option_format,
@@ -312,9 +322,35 @@ def setup(app):
app.connect('build-finished', _copy_css_file)
metadata = {'parallel_read_safe': True, 'parallel_write_safe': True,
'version': matplotlib.__version__}
+ app.connect('builder-inited', init_filename_registry)
+ app.add_env_collector(_FilenameCollector)
return metadata
+# -----------------------------------------------------------------------------
+# Handle Duplicate Filenames
+# -----------------------------------------------------------------------------
+
+def init_filename_registry(app):
+ env = app.builder.env
+ if not hasattr(env, 'mpl_plot_image_basenames'):
+ env.mpl_plot_image_basenames = defaultdict(set)
+
+
+class _FilenameCollector(EnvironmentCollector):
+ def process_doc(self, app, doctree):
+ pass
+
+ def clear_doc(self, app, env, docname):
+ if docname in env.mpl_plot_image_basenames:
+ del env.mpl_plot_image_basenames[docname]
+
+ def merge_other(self, app, env, docnames, other):
+ for docname in other.mpl_plot_image_basenames:
+ env.mpl_plot_image_basenames[docname].update(
+ other.mpl_plot_image_basenames[docname])
+
+
# -----------------------------------------------------------------------------
# Doctest handling
# -----------------------------------------------------------------------------
@@ -600,6 +636,25 @@ def _parse_srcset(entries):
return srcset
+def check_output_base_name(env, output_base):
+ docname = env.docname
+
+ if '.' in output_base or '/' in output_base or '\\' in output_base:
+ raise PlotError(
+ f"The filename-prefix '{output_base}' is invalid. "
+ f"It must not contain dots or slashes.")
+
+ for d in env.mpl_plot_image_basenames:
+ if output_base in env.mpl_plot_image_basenames[d]:
+ if d == docname:
+ raise PlotError(
+ f"The filename-prefix {output_base!r} is used multiple times.")
+ raise PlotError(f"The filename-prefix {output_base!r} is used multiple"
+ f"times (it is also used in {env.doc2path(d)}).")
+
+ env.mpl_plot_image_basenames[docname].add(output_base)
+
+
def render_figures(code, code_path, output_dir, output_base, context,
function_name, config, context_reset=False,
close_figs=False,
@@ -722,7 +777,8 @@ def render_figures(code, code_path, output_dir, output_base, context,
def run(arguments, content, options, state_machine, state, lineno):
document = state_machine.document
- config = document.settings.env.config
+ env = document.settings.env
+ config = env.config
nofigs = 'nofigs' in options
if config.plot_srcset and setup.app.builder.name == 'singlehtml':
@@ -734,6 +790,7 @@ def run(arguments, content, options, state_machine, state, lineno):
options.setdefault('include-source', config.plot_include_source)
options.setdefault('show-source-link', config.plot_html_show_source_link)
+ options.setdefault('filename-prefix', None)
if 'class' in options:
# classes are parsed into a list of string, and output by simply
@@ -775,14 +832,22 @@ def run(arguments, content, options, state_machine, state, lineno):
function_name = None
code = Path(source_file_name).read_text(encoding='utf-8')
- output_base = os.path.basename(source_file_name)
+ if options['filename-prefix']:
+ output_base = options['filename-prefix']
+ check_output_base_name(env, output_base)
+ else:
+ output_base = os.path.basename(source_file_name)
else:
source_file_name = rst_file
code = textwrap.dedent("\n".join(map(str, content)))
- counter = document.attributes.get('_plot_counter', 0) + 1
- document.attributes['_plot_counter'] = counter
- base, ext = os.path.splitext(os.path.basename(source_file_name))
- output_base = '%s-%d.py' % (base, counter)
+ if options['filename-prefix']:
+ output_base = options['filename-prefix']
+ check_output_base_name(env, output_base)
+ else:
+ base, ext = os.path.splitext(os.path.basename(source_file_name))
+ counter = document.attributes.get('_plot_counter', 0) + 1
+ document.attributes['_plot_counter'] = counter
+ output_base = '%s-%d.py' % (base, counter)
function_name = None
caption = options.get('caption', '')
@@ -846,7 +911,7 @@ def run(arguments, content, options, state_machine, state, lineno):
# save script (if necessary)
if options['show-source-link']:
- Path(build_dir, output_base + source_ext).write_text(
+ Path(build_dir, output_base + (source_ext or '.py')).write_text(
doctest.script_from_examples(code)
if source_file_name == rst_file and is_doctest
else code,
@@ -876,7 +941,7 @@ def run(arguments, content, options, state_machine, state, lineno):
# Properly indent the caption
if caption and config.plot_srcset:
- caption = f':caption: {caption}'
+ caption = ':caption: ' + caption.replace('\n', ' ')
elif caption:
caption = '\n' + '\n'.join(' ' + line.strip()
for line in caption.split('\n'))
@@ -896,6 +961,9 @@ def run(arguments, content, options, state_machine, state, lineno):
if nofigs:
images = []
+ if 'alt' in options:
+ options['alt'] = options['alt'].replace('\n', ' ')
+
opts = [
f':{key}: {val}' for key, val in options.items()
if key in ('alt', 'height', 'width', 'scale', 'align', 'class')]
@@ -903,7 +971,7 @@ def run(arguments, content, options, state_machine, state, lineno):
# Not-None src_name signals the need for a source download in the
# generated html
if j == 0 and options['show-source-link']:
- src_name = output_base + source_ext
+ src_name = output_base + (source_ext or '.py')
else:
src_name = None
if config.plot_srcset:
diff --git a/lib/matplotlib/sphinxext/roles.py b/lib/matplotlib/sphinxext/roles.py
index 301adcd8a5f5..c3e57ebc3aec 100644
--- a/lib/matplotlib/sphinxext/roles.py
+++ b/lib/matplotlib/sphinxext/roles.py
@@ -125,6 +125,7 @@ def _mpltype_role(name, rawtext, text, lineno, inliner, options=None, content=No
mpltype = text
type_to_link_target = {
'color': 'colors_def',
+ 'hatch': 'hatch_def',
}
if mpltype not in type_to_link_target:
raise ValueError(f"Unknown mpltype: {mpltype!r}")
diff --git a/lib/matplotlib/spines.py b/lib/matplotlib/spines.py
index 7e77a393f2a2..741491b3dc58 100644
--- a/lib/matplotlib/spines.py
+++ b/lib/matplotlib/spines.py
@@ -232,12 +232,13 @@ def _clear(self):
"""
self._position = None # clear position
- def _adjust_location(self):
- """Automatically set spine bounds to the view interval."""
-
- if self.spine_type == 'circle':
- return
+ def _get_bounds_or_viewLim(self):
+ """
+ Get the bounds of the spine.
+ If self._bounds is None, return self.axes.viewLim.intervalx
+ or self.axes.viewLim.intervaly based on self.spine_type
+ """
if self._bounds is not None:
low, high = self._bounds
elif self.spine_type in ('left', 'right'):
@@ -245,7 +246,16 @@ def _adjust_location(self):
elif self.spine_type in ('top', 'bottom'):
low, high = self.axes.viewLim.intervalx
else:
- raise ValueError(f'unknown spine spine_type: {self.spine_type}')
+ raise ValueError(f'spine_type: {self.spine_type} not supported')
+ return low, high
+
+ def _adjust_location(self):
+ """Automatically set spine bounds to the view interval."""
+
+ if self.spine_type == 'circle':
+ return
+
+ low, high = self._get_bounds_or_viewLim()
if self._patch_type == 'arc':
if self.spine_type in ('bottom', 'top'):
@@ -265,11 +275,17 @@ def _adjust_location(self):
self._path = mpath.Path.arc(np.rad2deg(low), np.rad2deg(high))
if self.spine_type == 'bottom':
- rmin, rmax = self.axes.viewLim.intervaly
+ if self.axis is None:
+ tr = mtransforms.IdentityTransform()
+ else:
+ tr = self.axis.get_transform()
+ rmin, rmax = tr.transform(self.axes.viewLim.intervaly)
try:
rorigin = self.axes.get_rorigin()
except AttributeError:
rorigin = rmin
+ else:
+ rorigin = tr.transform(rorigin)
scaled_diameter = (rmin - rorigin) / (rmax - rorigin)
self._height = scaled_diameter
self._width = scaled_diameter
@@ -418,7 +434,7 @@ def set_bounds(self, low=None, high=None):
'set_bounds() method incompatible with circular spines')
if high is None and np.iterable(low):
low, high = low
- old_low, old_high = self.get_bounds() or (None, None)
+ old_low, old_high = self._get_bounds_or_viewLim()
if low is None:
low = old_low
if high is None:
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
index 43da57c25da5..bd11558b0da9 100644
--- a/lib/matplotlib/stackplot.py
+++ b/lib/matplotlib/stackplot.py
@@ -26,11 +26,11 @@ def stackplot(axes, x, *args,
x : (N,) array-like
y : (M, N) array-like
- The data is assumed to be unstacked. Each of the following
+ The data can be either stacked or unstacked. Each of the following
calls is legal::
- stackplot(x, y) # where y has shape (M, N)
- stackplot(x, y1, y2, y3) # where y1, y2, y3, y4 have length N
+ stackplot(x, y) # where y has shape (M, N) e.g. y = [y1, y2, y3, y4]
+ stackplot(x, y1, y2, y3, y4) # where y1, y2, y3, y4 have length N
baseline : {'zero', 'sym', 'wiggle', 'weighted_wiggle'}
Method used to calculate the baseline:
diff --git a/lib/matplotlib/stackplot.pyi b/lib/matplotlib/stackplot.pyi
index 2981d449b566..9509f858a4bf 100644
--- a/lib/matplotlib/stackplot.pyi
+++ b/lib/matplotlib/stackplot.pyi
@@ -16,3 +16,5 @@ def stackplot(
baseline: Literal["zero", "sym", "wiggle", "weighted_wiggle"] = ...,
**kwargs
) -> list[PolyCollection]: ...
+
+__all__ = ['stackplot']
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
index 84f99732c709..ece8bebf8192 100644
--- a/lib/matplotlib/streamplot.py
+++ b/lib/matplotlib/streamplot.py
@@ -19,7 +19,8 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
cmap=None, norm=None, arrowsize=1, arrowstyle='-|>',
minlength=0.1, transform=None, zorder=None, start_points=None,
maxlength=4.0, integration_direction='both',
- broken_streamlines=True):
+ broken_streamlines=True, *, integration_max_step_scale=1.0,
+ integration_max_error_scale=1.0, num_arrows=1):
"""
Draw streamlines of a vector flow.
@@ -73,6 +74,29 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
If False, forces streamlines to continue until they
leave the plot domain. If True, they may be terminated if they
come too close to another streamline.
+ integration_max_step_scale : float, default: 1.0
+ Multiplier on the maximum allowable step in the streamline integration routine.
+ A value between zero and one results in a max integration step smaller than
+ the default max step, resulting in more accurate streamlines at the cost
+ of greater computation time; a value greater than one does the converse. Must be
+ greater than zero.
+
+ .. versionadded:: 3.11
+
+ integration_max_error_scale : float, default: 1.0
+ Multiplier on the maximum allowable error in the streamline integration routine.
+ A value between zero and one results in a tighter max integration error than
+ the default max error, resulting in more accurate streamlines at the cost
+ of greater computation time; a value greater than one does the converse. Must be
+ greater than zero.
+
+ .. versionadded:: 3.11
+
+ num_arrows : int
+ Number of arrows per streamline. The arrows are spaced equally along the steps
+ each streamline takes. Note that this can be different to being spaced equally
+ along the distance of the streamline.
+
Returns
-------
@@ -92,6 +116,21 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
mask = StreamMask(density)
dmap = DomainMap(grid, mask)
+ if integration_max_step_scale <= 0.0:
+ raise ValueError(
+ "The value of integration_max_step_scale must be > 0, " +
+ f"got {integration_max_step_scale}"
+ )
+
+ if integration_max_error_scale <= 0.0:
+ raise ValueError(
+ "The value of integration_max_error_scale must be > 0, " +
+ f"got {integration_max_error_scale}"
+ )
+
+ if num_arrows < 0:
+ raise ValueError(f"The value of num_arrows must be >= 0, got {num_arrows=}")
+
if zorder is None:
zorder = mlines.Line2D.zorder
@@ -102,8 +141,7 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
if color is None:
color = axes._get_lines.get_next_color()
- if linewidth is None:
- linewidth = mpl.rcParams['lines.linewidth']
+ linewidth = mpl._val_or_rc(linewidth, 'lines.linewidth')
line_kw = {}
arrow_kw = dict(arrowstyle=arrowstyle, mutation_scale=10 * arrowsize)
@@ -152,7 +190,9 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
for xm, ym in _gen_starting_points(mask.shape):
if mask[ym, xm] == 0:
xg, yg = dmap.mask2grid(xm, ym)
- t = integrate(xg, yg, broken_streamlines)
+ t = integrate(xg, yg, broken_streamlines,
+ integration_max_step_scale,
+ integration_max_error_scale)
if t is not None:
trajectories.append(t)
else:
@@ -180,7 +220,8 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
xg = np.clip(xg, 0, grid.nx - 1)
yg = np.clip(yg, 0, grid.ny - 1)
- t = integrate(xg, yg, broken_streamlines)
+ t = integrate(xg, yg, broken_streamlines, integration_max_step_scale,
+ integration_max_error_scale)
if t is not None:
trajectories.append(t)
@@ -206,25 +247,31 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
points = np.transpose([tx, ty])
streamlines.append(points)
- # Add arrows halfway along each trajectory.
+ # Distance along streamline
s = np.cumsum(np.hypot(np.diff(tx), np.diff(ty)))
- n = np.searchsorted(s, s[-1] / 2.)
- arrow_tail = (tx[n], ty[n])
- arrow_head = (np.mean(tx[n:n + 2]), np.mean(ty[n:n + 2]))
-
if isinstance(linewidth, np.ndarray):
line_widths = interpgrid(linewidth, tgx, tgy)[:-1]
line_kw['linewidth'].extend(line_widths)
- arrow_kw['linewidth'] = line_widths[n]
-
if use_multicolor_lines:
color_values = interpgrid(color, tgx, tgy)[:-1]
line_colors.append(color_values)
- arrow_kw['color'] = cmap(norm(color_values[n]))
- p = patches.FancyArrowPatch(
- arrow_tail, arrow_head, transform=transform, **arrow_kw)
- arrows.append(p)
+ # Add arrows along each trajectory.
+ for x in range(1, num_arrows+1):
+ # Get index of distance along streamline to place arrow
+ idx = np.searchsorted(s, s[-1] * (x/(num_arrows+1)))
+ arrow_tail = (tx[idx], ty[idx])
+ arrow_head = (np.mean(tx[idx:idx + 2]), np.mean(ty[idx:idx + 2]))
+
+ if isinstance(linewidth, np.ndarray):
+ arrow_kw['linewidth'] = line_widths[idx]
+
+ if use_multicolor_lines:
+ arrow_kw['color'] = cmap(norm(color_values[idx]))
+
+ p = patches.FancyArrowPatch(
+ arrow_tail, arrow_head, transform=transform, **arrow_kw)
+ arrows.append(p)
lc = mcollections.LineCollection(
streamlines, transform=transform, **line_kw)
@@ -467,7 +514,8 @@ def backward_time(xi, yi):
dxi, dyi = forward_time(xi, yi)
return -dxi, -dyi
- def integrate(x0, y0, broken_streamlines=True):
+ def integrate(x0, y0, broken_streamlines=True, integration_max_step_scale=1.0,
+ integration_max_error_scale=1.0):
"""
Return x, y grid-coordinates of trajectory based on starting point.
@@ -487,14 +535,18 @@ def integrate(x0, y0, broken_streamlines=True):
return None
if integration_direction in ['both', 'backward']:
s, xyt = _integrate_rk12(x0, y0, dmap, backward_time, maxlength,
- broken_streamlines)
+ broken_streamlines,
+ integration_max_step_scale,
+ integration_max_error_scale)
stotal += s
xy_traj += xyt[::-1]
if integration_direction in ['both', 'forward']:
dmap.reset_start_point(x0, y0)
s, xyt = _integrate_rk12(x0, y0, dmap, forward_time, maxlength,
- broken_streamlines)
+ broken_streamlines,
+ integration_max_step_scale,
+ integration_max_error_scale)
stotal += s
xy_traj += xyt[1:]
@@ -511,7 +563,9 @@ class OutOfBounds(IndexError):
pass
-def _integrate_rk12(x0, y0, dmap, f, maxlength, broken_streamlines=True):
+def _integrate_rk12(x0, y0, dmap, f, maxlength, broken_streamlines=True,
+ integration_max_step_scale=1.0,
+ integration_max_error_scale=1.0):
"""
2nd-order Runge-Kutta algorithm with adaptive step size.
@@ -537,7 +591,7 @@ def _integrate_rk12(x0, y0, dmap, f, maxlength, broken_streamlines=True):
# This error is below that needed to match the RK4 integrator. It
# is set for visual reasons -- too low and corners start
# appearing ugly and jagged. Can be tuned.
- maxerror = 0.003
+ maxerror = 0.003 * integration_max_error_scale
# This limit is important (for all integrators) to avoid the
# trajectory skipping some mask cells. We could relax this
@@ -546,6 +600,7 @@ def _integrate_rk12(x0, y0, dmap, f, maxlength, broken_streamlines=True):
# nature of the interpolation, this doesn't boost speed by much
# for quite a bit of complexity.
maxds = min(1. / dmap.mask.nx, 1. / dmap.mask.ny, 0.1)
+ maxds *= integration_max_step_scale
ds = maxds
stotal = 0
diff --git a/lib/matplotlib/streamplot.pyi b/lib/matplotlib/streamplot.pyi
index 9da83096e5a8..ca3553edc2fd 100644
--- a/lib/matplotlib/streamplot.pyi
+++ b/lib/matplotlib/streamplot.pyi
@@ -28,6 +28,10 @@ def streamplot(
maxlength: float = ...,
integration_direction: Literal["forward", "backward", "both"] = ...,
broken_streamlines: bool = ...,
+ *,
+ integration_max_step_scale: float = ...,
+ integration_max_error_scale: float = ...,
+ num_arrows: int = ...,
) -> StreamplotSet: ...
class StreamplotSet:
@@ -80,3 +84,5 @@ class StreamMask:
class InvalidIndexError(Exception): ...
class TerminateTrajectory(Exception): ...
class OutOfBounds(IndexError): ...
+
+__all__ = ['streamplot']
diff --git a/lib/matplotlib/style/__init__.py b/lib/matplotlib/style/__init__.py
index 488c6d6ae1ec..80c6de00a18d 100644
--- a/lib/matplotlib/style/__init__.py
+++ b/lib/matplotlib/style/__init__.py
@@ -1,4 +1,253 @@
-from .core import available, context, library, reload_library, use
+"""
+Core functions and attributes for the matplotlib style library:
+``use``
+ Select style sheet to override the current matplotlib settings.
+``context``
+ Context manager to use a style sheet temporarily.
+``available``
+ List available style sheets. Underscore-prefixed names are considered private and
+ not listed, though may still be accessed directly from ``library``.
+``library``
+ A dictionary of style names and matplotlib settings.
+"""
-__all__ = ["available", "context", "library", "reload_library", "use"]
+import contextlib
+import importlib.resources
+import logging
+import os
+from pathlib import Path
+import warnings
+
+import matplotlib as mpl
+from matplotlib import _api, _docstring, rc_params_from_file, rcParamsDefault
+
+_log = logging.getLogger(__name__)
+
+__all__ = ['use', 'context', 'available', 'library', 'reload_library']
+
+
+_BASE_LIBRARY_PATH = os.path.join(mpl.get_data_path(), 'stylelib')
+# Users may want multiple library paths, so store a list of paths.
+USER_LIBRARY_PATHS = [os.path.join(mpl.get_configdir(), 'stylelib')]
+_STYLE_EXTENSION = 'mplstyle'
+# A list of rcParams that should not be applied from styles
+_STYLE_BLACKLIST = {
+ 'interactive', 'backend', 'webagg.port', 'webagg.address',
+ 'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback',
+ 'toolbar', 'timezone', 'figure.max_open_warning',
+ 'figure.raise_window', 'savefig.directory', 'tk.window_focus',
+ 'docstring.hardcopy', 'date.epoch'}
+
+
+@_docstring.Substitution(
+ "\n".join(map("- {}".format, sorted(_STYLE_BLACKLIST, key=str.lower)))
+)
+def use(style):
+ """
+ Use Matplotlib style settings from a style specification.
+
+ The style name of 'default' is reserved for reverting back to
+ the default style settings.
+
+ .. note::
+
+ This updates the `.rcParams` with the settings from the style.
+ `.rcParams` not defined in the style are kept.
+
+ Parameters
+ ----------
+ style : str, dict, Path or list
+
+ A style specification. Valid options are:
+
+ str
+ - One of the style names in `.style.available` (a builtin style or
+ a style installed in the user library path).
+
+ - A dotted name of the form "package.style_name"; in that case,
+ "package" should be an importable Python package name, e.g. at
+ ``/path/to/package/__init__.py``; the loaded style file is
+ ``/path/to/package/style_name.mplstyle``. (Style files in
+ subpackages are likewise supported.)
+
+ - The path or URL to a style file, which gets loaded by
+ `.rc_params_from_file`.
+
+ dict
+ A mapping of key/value pairs for `matplotlib.rcParams`.
+
+ Path
+ The path to a style file, which gets loaded by
+ `.rc_params_from_file`.
+
+ list
+ A list of style specifiers (str, Path or dict), which are applied
+ from first to last in the list.
+
+ Notes
+ -----
+ The following `.rcParams` are not related to style and will be ignored if
+ found in a style specification:
+
+ %s
+ """
+ if isinstance(style, (str, Path)) or hasattr(style, 'keys'):
+ # If name is a single str, Path or dict, make it a single element list.
+ styles = [style]
+ else:
+ styles = style
+
+ style_alias = {'mpl20': 'default', 'mpl15': 'classic'}
+
+ for style in styles:
+ if isinstance(style, str):
+ style = style_alias.get(style, style)
+ if style == "default":
+ # Deprecation warnings were already handled when creating
+ # rcParamsDefault, no need to reemit them here.
+ with _api.suppress_matplotlib_deprecation_warning():
+ # don't trigger RcParams.__getitem__('backend')
+ style = {k: rcParamsDefault[k] for k in rcParamsDefault
+ if k not in _STYLE_BLACKLIST}
+ elif style in library:
+ style = library[style]
+ elif "." in style:
+ pkg, _, name = style.rpartition(".")
+ try:
+ path = importlib.resources.files(pkg) / f"{name}.{_STYLE_EXTENSION}"
+ style = rc_params_from_file(path, use_default_template=False)
+ except (ModuleNotFoundError, OSError, TypeError) as exc:
+ # There is an ambiguity whether a dotted name refers to a
+ # package.style_name or to a dotted file path. Currently,
+ # we silently try the first form and then the second one;
+ # in the future, we may consider forcing file paths to
+ # either use Path objects or be prepended with "./" and use
+ # the slash as marker for file paths.
+ pass
+ if isinstance(style, (str, Path)):
+ try:
+ style = rc_params_from_file(style, use_default_template=False)
+ except OSError as err:
+ raise OSError(
+ f"{style!r} is not a valid package style, path of style "
+ f"file, URL of style file, or library style name (library "
+ f"styles are listed in `style.available`)") from err
+ filtered = {}
+ for k in style: # don't trigger RcParams.__getitem__('backend')
+ if k in _STYLE_BLACKLIST:
+ _api.warn_external(
+ f"Style includes a parameter, {k!r}, that is not "
+ f"related to style. Ignoring this parameter.")
+ else:
+ filtered[k] = style[k]
+ mpl.rcParams.update(filtered)
+
+
+@contextlib.contextmanager
+def context(style, after_reset=False):
+ """
+ Context manager for using style settings temporarily.
+
+ Parameters
+ ----------
+ style : str, dict, Path or list
+ A style specification. Valid options are:
+
+ str
+ - One of the style names in `.style.available` (a builtin style or
+ a style installed in the user library path).
+
+ - A dotted name of the form "package.style_name"; in that case,
+ "package" should be an importable Python package name, e.g. at
+ ``/path/to/package/__init__.py``; the loaded style file is
+ ``/path/to/package/style_name.mplstyle``. (Style files in
+ subpackages are likewise supported.)
+
+ - The path or URL to a style file, which gets loaded by
+ `.rc_params_from_file`.
+ dict
+ A mapping of key/value pairs for `matplotlib.rcParams`.
+
+ Path
+ The path to a style file, which gets loaded by
+ `.rc_params_from_file`.
+
+ list
+ A list of style specifiers (str, Path or dict), which are applied
+ from first to last in the list.
+
+ after_reset : bool
+ If True, apply style after resetting settings to their defaults;
+ otherwise, apply style on top of the current settings.
+ """
+ with mpl.rc_context():
+ if after_reset:
+ mpl.rcdefaults()
+ use(style)
+ yield
+
+
+def _update_user_library(library):
+ """Update style library with user-defined rc files."""
+ for stylelib_path in map(os.path.expanduser, USER_LIBRARY_PATHS):
+ styles = _read_style_directory(stylelib_path)
+ _update_nested_dict(library, styles)
+ return library
+
+
+@_api.deprecated("3.11")
+def update_user_library(library):
+ return _update_user_library(library)
+
+
+def _read_style_directory(style_dir):
+ """Return dictionary of styles defined in *style_dir*."""
+ styles = dict()
+ for path in Path(style_dir).glob(f"*.{_STYLE_EXTENSION}"):
+ with warnings.catch_warnings(record=True) as warns:
+ styles[path.stem] = rc_params_from_file(path, use_default_template=False)
+ for w in warns:
+ _log.warning('In %s: %s', path, w.message)
+ return styles
+
+
+@_api.deprecated("3.11")
+def read_style_directory(style_dir):
+ return _read_style_directory(style_dir)
+
+
+def _update_nested_dict(main_dict, new_dict):
+ """
+ Update nested dict (only level of nesting) with new values.
+
+ Unlike `dict.update`, this assumes that the values of the parent dict are
+ dicts (or dict-like), so you shouldn't replace the nested dict if it
+ already exists. Instead you should update the sub-dict.
+ """
+ # update named styles specified by user
+ for name, rc_dict in new_dict.items():
+ main_dict.setdefault(name, {}).update(rc_dict)
+ return main_dict
+
+
+@_api.deprecated("3.11")
+def update_nested_dict(main_dict, new_dict):
+ return _update_nested_dict(main_dict, new_dict)
+
+
+# Load style library
+# ==================
+_base_library = _read_style_directory(_BASE_LIBRARY_PATH)
+library = {}
+available = []
+
+
+def reload_library():
+ """Reload the style library."""
+ library.clear()
+ library.update(_update_user_library(_base_library.copy()))
+ available[:] = sorted(name for name in library if not name.startswith('_'))
+
+
+reload_library()
diff --git a/lib/matplotlib/style/__init__.pyi b/lib/matplotlib/style/__init__.pyi
new file mode 100644
index 000000000000..c93b504fe6bd
--- /dev/null
+++ b/lib/matplotlib/style/__init__.pyi
@@ -0,0 +1,20 @@
+from collections.abc import Generator
+import contextlib
+
+from matplotlib import RcParams
+from matplotlib.typing import RcStyleType
+
+USER_LIBRARY_PATHS: list[str] = ...
+
+def use(style: RcStyleType) -> None: ...
+@contextlib.contextmanager
+def context(
+ style: RcStyleType, after_reset: bool = ...
+) -> Generator[None, None, None]: ...
+
+library: dict[str, RcParams]
+available: list[str]
+
+def reload_library() -> None: ...
+
+__all__ = ['use', 'context', 'available', 'library', 'reload_library']
diff --git a/lib/matplotlib/style/core.py b/lib/matplotlib/style/core.py
index e36c3c37a882..c377bc64077a 100644
--- a/lib/matplotlib/style/core.py
+++ b/lib/matplotlib/style/core.py
@@ -11,227 +11,17 @@
A dictionary of style names and matplotlib settings.
"""
-import contextlib
-import importlib.resources
-import logging
-import os
-from pathlib import Path
-import warnings
-
-import matplotlib as mpl
-from matplotlib import _api, _docstring, _rc_params_in_file, rcParamsDefault
-
-_log = logging.getLogger(__name__)
-
-__all__ = ['use', 'context', 'available', 'library', 'reload_library']
-
-
-BASE_LIBRARY_PATH = os.path.join(mpl.get_data_path(), 'stylelib')
-# Users may want multiple library paths, so store a list of paths.
-USER_LIBRARY_PATHS = [os.path.join(mpl.get_configdir(), 'stylelib')]
-STYLE_EXTENSION = 'mplstyle'
-# A list of rcParams that should not be applied from styles
-STYLE_BLACKLIST = {
- 'interactive', 'backend', 'webagg.port', 'webagg.address',
- 'webagg.port_retries', 'webagg.open_in_browser', 'backend_fallback',
- 'toolbar', 'timezone', 'figure.max_open_warning',
- 'figure.raise_window', 'savefig.directory', 'tk.window_focus',
- 'docstring.hardcopy', 'date.epoch'}
-
-
-@_docstring.Substitution(
- "\n".join(map("- {}".format, sorted(STYLE_BLACKLIST, key=str.lower)))
+from .. import _api
+from . import (
+ use, context, available, library, reload_library, USER_LIBRARY_PATHS,
+ _BASE_LIBRARY_PATH as BASE_LIBRARY_PATH,
+ _STYLE_EXTENSION as STYLE_EXTENSION,
+ _STYLE_BLACKLIST as STYLE_BLACKLIST,
)
-def use(style):
- """
- Use Matplotlib style settings from a style specification.
-
- The style name of 'default' is reserved for reverting back to
- the default style settings.
-
- .. note::
-
- This updates the `.rcParams` with the settings from the style.
- `.rcParams` not defined in the style are kept.
-
- Parameters
- ----------
- style : str, dict, Path or list
-
- A style specification. Valid options are:
-
- str
- - One of the style names in `.style.available` (a builtin style or
- a style installed in the user library path).
-
- - A dotted name of the form "package.style_name"; in that case,
- "package" should be an importable Python package name, e.g. at
- ``/path/to/package/__init__.py``; the loaded style file is
- ``/path/to/package/style_name.mplstyle``. (Style files in
- subpackages are likewise supported.)
-
- - The path or URL to a style file, which gets loaded by
- `.rc_params_from_file`.
-
- dict
- A mapping of key/value pairs for `matplotlib.rcParams`.
-
- Path
- The path to a style file, which gets loaded by
- `.rc_params_from_file`.
-
- list
- A list of style specifiers (str, Path or dict), which are applied
- from first to last in the list.
-
- Notes
- -----
- The following `.rcParams` are not related to style and will be ignored if
- found in a style specification:
-
- %s
- """
- if isinstance(style, (str, Path)) or hasattr(style, 'keys'):
- # If name is a single str, Path or dict, make it a single element list.
- styles = [style]
- else:
- styles = style
-
- style_alias = {'mpl20': 'default', 'mpl15': 'classic'}
-
- for style in styles:
- if isinstance(style, str):
- style = style_alias.get(style, style)
- if style == "default":
- # Deprecation warnings were already handled when creating
- # rcParamsDefault, no need to reemit them here.
- with _api.suppress_matplotlib_deprecation_warning():
- # don't trigger RcParams.__getitem__('backend')
- style = {k: rcParamsDefault[k] for k in rcParamsDefault
- if k not in STYLE_BLACKLIST}
- elif style in library:
- style = library[style]
- elif "." in style:
- pkg, _, name = style.rpartition(".")
- try:
- path = importlib.resources.files(pkg) / f"{name}.{STYLE_EXTENSION}"
- style = _rc_params_in_file(path)
- except (ModuleNotFoundError, OSError, TypeError) as exc:
- # There is an ambiguity whether a dotted name refers to a
- # package.style_name or to a dotted file path. Currently,
- # we silently try the first form and then the second one;
- # in the future, we may consider forcing file paths to
- # either use Path objects or be prepended with "./" and use
- # the slash as marker for file paths.
- pass
- if isinstance(style, (str, Path)):
- try:
- style = _rc_params_in_file(style)
- except OSError as err:
- raise OSError(
- f"{style!r} is not a valid package style, path of style "
- f"file, URL of style file, or library style name (library "
- f"styles are listed in `style.available`)") from err
- filtered = {}
- for k in style: # don't trigger RcParams.__getitem__('backend')
- if k in STYLE_BLACKLIST:
- _api.warn_external(
- f"Style includes a parameter, {k!r}, that is not "
- f"related to style. Ignoring this parameter.")
- else:
- filtered[k] = style[k]
- mpl.rcParams.update(filtered)
-
-
-@contextlib.contextmanager
-def context(style, after_reset=False):
- """
- Context manager for using style settings temporarily.
-
- Parameters
- ----------
- style : str, dict, Path or list
- A style specification. Valid options are:
-
- str
- - One of the style names in `.style.available` (a builtin style or
- a style installed in the user library path).
-
- - A dotted name of the form "package.style_name"; in that case,
- "package" should be an importable Python package name, e.g. at
- ``/path/to/package/__init__.py``; the loaded style file is
- ``/path/to/package/style_name.mplstyle``. (Style files in
- subpackages are likewise supported.)
-
- - The path or URL to a style file, which gets loaded by
- `.rc_params_from_file`.
- dict
- A mapping of key/value pairs for `matplotlib.rcParams`.
-
- Path
- The path to a style file, which gets loaded by
- `.rc_params_from_file`.
-
- list
- A list of style specifiers (str, Path or dict), which are applied
- from first to last in the list.
-
- after_reset : bool
- If True, apply style after resetting settings to their defaults;
- otherwise, apply style on top of the current settings.
- """
- with mpl.rc_context():
- if after_reset:
- mpl.rcdefaults()
- use(style)
- yield
-
-
-def update_user_library(library):
- """Update style library with user-defined rc files."""
- for stylelib_path in map(os.path.expanduser, USER_LIBRARY_PATHS):
- styles = read_style_directory(stylelib_path)
- update_nested_dict(library, styles)
- return library
-
-
-def read_style_directory(style_dir):
- """Return dictionary of styles defined in *style_dir*."""
- styles = dict()
- for path in Path(style_dir).glob(f"*.{STYLE_EXTENSION}"):
- with warnings.catch_warnings(record=True) as warns:
- styles[path.stem] = _rc_params_in_file(path)
- for w in warns:
- _log.warning('In %s: %s', path, w.message)
- return styles
-
-
-def update_nested_dict(main_dict, new_dict):
- """
- Update nested dict (only level of nesting) with new values.
-
- Unlike `dict.update`, this assumes that the values of the parent dict are
- dicts (or dict-like), so you shouldn't replace the nested dict if it
- already exists. Instead you should update the sub-dict.
- """
- # update named styles specified by user
- for name, rc_dict in new_dict.items():
- main_dict.setdefault(name, {}).update(rc_dict)
- return main_dict
-
-
-# Load style library
-# ==================
-_base_library = read_style_directory(BASE_LIBRARY_PATH)
-library = {}
-available = []
-
-
-def reload_library():
- """Reload the style library."""
- library.clear()
- library.update(update_user_library(_base_library))
- available[:] = sorted(library.keys())
+__all__ = [
+ "use", "context", "available", "library", "reload_library",
+ "USER_LIBRARY_PATHS", "BASE_LIBRARY_PATH", "STYLE_EXTENSION", "STYLE_BLACKLIST",
+]
-reload_library()
+_api.warn_deprecated("3.11", name=__name__, obj_type="module")
diff --git a/lib/matplotlib/style/core.pyi b/lib/matplotlib/style/core.pyi
index 73400492143c..ee21d2f41ef5 100644
--- a/lib/matplotlib/style/core.pyi
+++ b/lib/matplotlib/style/core.pyi
@@ -5,7 +5,9 @@ from matplotlib import RcParams
from matplotlib.typing import RcStyleType
USER_LIBRARY_PATHS: list[str] = ...
+BASE_LIBRARY_PATH: str = ...
STYLE_EXTENSION: str = ...
+STYLE_BLACKLIST: set[str] = ...
def use(style: RcStyleType) -> None: ...
@contextlib.contextmanager
@@ -17,3 +19,8 @@ library: dict[str, RcParams]
available: list[str]
def reload_library() -> None: ...
+
+__all__ = [
+ "use", "context", "available", "library", "reload_library",
+ "USER_LIBRARY_PATHS", "BASE_LIBRARY_PATH", "STYLE_EXTENSION", "STYLE_BLACKLIST",
+]
diff --git a/lib/matplotlib/style/meson.build b/lib/matplotlib/style/meson.build
index 03e7972132bb..e7a183c8581c 100644
--- a/lib/matplotlib/style/meson.build
+++ b/lib/matplotlib/style/meson.build
@@ -4,6 +4,7 @@ python_sources = [
]
typing_sources = [
+ '__init__.pyi',
'core.pyi',
]
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
index 21518c4c6726..370ce9fe922f 100644
--- a/lib/matplotlib/table.py
+++ b/lib/matplotlib/table.py
@@ -838,5 +838,9 @@ def table(ax,
if rowLabelWidth == 0:
table.auto_set_column_width(-1)
+ # set_fontsize is only effective after cells are added
+ if "fontsize" in kwargs:
+ table.set_fontsize(kwargs["fontsize"])
+
ax.add_table(table)
return table
diff --git a/lib/matplotlib/table.pyi b/lib/matplotlib/table.pyi
index 07d2427f66dc..167d98d3c4cb 100644
--- a/lib/matplotlib/table.pyi
+++ b/lib/matplotlib/table.pyi
@@ -8,7 +8,7 @@ from .transforms import Bbox
from .typing import ColorType
from collections.abc import Sequence
-from typing import Any, Literal, TYPE_CHECKING
+from typing import Any, Literal
from pandas import DataFrame
diff --git a/lib/matplotlib/testing/__init__.py b/lib/matplotlib/testing/__init__.py
index 19113d399626..904ee5d73db4 100644
--- a/lib/matplotlib/testing/__init__.py
+++ b/lib/matplotlib/testing/__init__.py
@@ -1,13 +1,15 @@
"""
Helper functions for testing.
"""
-from pathlib import Path
-from tempfile import TemporaryDirectory
+import itertools
import locale
import logging
import os
+from pathlib import Path
+import string
import subprocess
import sys
+from tempfile import TemporaryDirectory
import matplotlib as mpl
from matplotlib import _api
@@ -103,6 +105,16 @@ def subprocess_run_for_testing(command, env=None, timeout=60, stdout=None,
import pytest
pytest.xfail("Fork failure")
raise
+ except subprocess.CalledProcessError as e:
+ if e.stdout:
+ _log.error(f"Subprocess output:\n{e.stdout}")
+ if e.stderr:
+ _log.error(f"Subprocess error:\n{e.stderr}")
+ raise e
+ if proc.stdout:
+ _log.debug(f"Subprocess output:\n{proc.stdout}")
+ if proc.stderr:
+ _log.debug(f"Subprocess error:\n{proc.stderr}")
return proc
@@ -232,3 +244,44 @@ def is_ci_environment():
return True
return False
+
+
+def _gen_multi_font_text():
+ """
+ Generate text intended for use with multiple fonts to exercise font fallbacks.
+
+ Returns
+ -------
+ fonts : list of str
+ The names of the fonts used to render the test string, sorted by intended
+ priority. This should be set as the font family for the Figure or Text artist.
+ text : str
+ The test string.
+ """
+ # These fonts are serif and sans-serif, and would not normally be combined, but that
+ # should make it easier to see which glyph is from which font.
+ fonts = ['cmr10', 'DejaVu Sans']
+ # cmr10 does not contain accented characters, so they should fall back to DejaVu
+ # Sans. However, some accented capital A versions *are* in cmr10 with non-standard
+ # glyph shapes, so don't test those (otherwise this Latin1 supplement group would
+ # start at 0xA0.)
+ start = 0xC5
+ latin1_supplement = [chr(x) for x in range(start, 0xFF+1)]
+ latin_extended_A = [chr(x) for x in range(0x100, 0x17F+1)]
+ latin_extended_B = [chr(x) for x in range(0x180, 0x24F+1)]
+ count = itertools.count(start - 0xA0)
+ non_basic_characters = '\n'.join(
+ ''.join(line)
+ for _, line in itertools.groupby( # Replace with itertools.batched for Py3.12+.
+ [*latin1_supplement, *latin_extended_A, *latin_extended_B],
+ key=lambda x: next(count) // 32) # 32 characters per line.
+ )
+ test_str = f"""There are basic characters
+{string.ascii_uppercase} {string.ascii_lowercase}
+{string.digits} {string.punctuation}
+and accented characters
+{non_basic_characters}
+in between!"""
+ # The resulting string contains 491 unique characters. Some file formats use 8-bit
+ # tables, which the large number of characters exercises twice over.
+ return fonts, test_str
diff --git a/lib/matplotlib/testing/__init__.pyi b/lib/matplotlib/testing/__init__.pyi
index 6917b6a5a380..7763cb6a9769 100644
--- a/lib/matplotlib/testing/__init__.pyi
+++ b/lib/matplotlib/testing/__init__.pyi
@@ -52,3 +52,4 @@ def ipython_in_subprocess(
all_expected_backends: dict[tuple[int, int], str],
) -> None: ...
def is_ci_environment() -> bool: ...
+def _gen_multi_font_text() -> tuple[list[str], str]: ...
diff --git a/lib/matplotlib/testing/compare.py b/lib/matplotlib/testing/compare.py
index 0f252bc1da8e..fa5cd89481b5 100644
--- a/lib/matplotlib/testing/compare.py
+++ b/lib/matplotlib/testing/compare.py
@@ -19,7 +19,7 @@
from PIL import Image
import matplotlib as mpl
-from matplotlib import cbook
+from matplotlib import cbook, _image
from matplotlib.testing.exceptions import ImageComparisonFailure
_log = logging.getLogger(__name__)
@@ -46,22 +46,20 @@ def get_cache_dir():
def get_file_hash(path, block_size=2 ** 20):
- md5 = hashlib.md5()
+ sha256 = hashlib.sha256(usedforsecurity=False)
with open(path, 'rb') as fd:
while True:
data = fd.read(block_size)
if not data:
break
- md5.update(data)
+ sha256.update(data)
if Path(path).suffix == '.pdf':
- md5.update(str(mpl._get_executable_info("gs").version)
- .encode('utf-8'))
+ sha256.update(str(mpl._get_executable_info("gs").version).encode('utf-8'))
elif Path(path).suffix == '.svg':
- md5.update(str(mpl._get_executable_info("inkscape").version)
- .encode('utf-8'))
+ sha256.update(str(mpl._get_executable_info("inkscape").version).encode('utf-8'))
- return md5.hexdigest()
+ return sha256.hexdigest()
class _ConverterError(Exception):
@@ -99,6 +97,16 @@ def _read_until(self, terminator):
return bytes(buf)
+class _MagickConverter:
+ def __call__(self, orig, dest):
+ try:
+ subprocess.run(
+ [mpl._get_executable_info("magick").executable, orig, dest],
+ check=True)
+ except subprocess.CalledProcessError as e:
+ raise _ConverterError() from e
+
+
class _GSConverter(_Converter):
def __call__(self, orig, dest):
if not self._proc:
@@ -230,6 +238,12 @@ def __call__(self, orig, dest):
def _update_converter():
+ try:
+ mpl._get_executable_info("magick")
+ except mpl.ExecutableNotFoundError:
+ pass
+ else:
+ converter['gif'] = _MagickConverter()
try:
mpl._get_executable_info("gs")
except mpl.ExecutableNotFoundError:
@@ -300,7 +314,7 @@ def convert(filename, cache):
_log.debug("For %s: converting to png.", filename)
convert = converter[path.suffix[1:]]
if path.suffix == ".svg":
- contents = path.read_text()
+ contents = path.read_text(encoding="utf-8")
# NOTE: This check should be kept in sync with font styling in
# `lib/matplotlib/backends/backend_svg.py`. If it changes, then be sure to
# re-generate any SVG test files using this mode, or else such tests will
@@ -397,8 +411,8 @@ def compare_images(expected, actual, tol, in_decorator=False):
Compare two "image" files checking differences within a tolerance.
The two given filenames may point to files which are convertible to
- PNG via the `.converter` dictionary. The underlying RMS is calculated
- with the `.calculate_rms` function.
+ PNG via the `!converter` dictionary. The underlying RMS is calculated
+ in a similar way to the `.calculate_rms` function.
Parameters
----------
@@ -469,17 +483,12 @@ def compare_images(expected, actual, tol, in_decorator=False):
if np.array_equal(expected_image, actual_image):
return None
- # convert to signed integers, so that the images can be subtracted without
- # overflow
- expected_image = expected_image.astype(np.int16)
- actual_image = actual_image.astype(np.int16)
-
- rms = calculate_rms(expected_image, actual_image)
+ rms, abs_diff = _image.calculate_rms_and_diff(expected_image, actual_image)
if rms <= tol:
return None
- save_diff_image(expected, actual, diff_image)
+ Image.fromarray(abs_diff).save(diff_image, format="png")
results = dict(rms=rms, expected=str(expected),
actual=str(actual), diff=str(diff_image), tol=tol)
diff --git a/lib/matplotlib/testing/conftest.py b/lib/matplotlib/testing/conftest.py
index 3f96de611195..2961e7f02f3f 100644
--- a/lib/matplotlib/testing/conftest.py
+++ b/lib/matplotlib/testing/conftest.py
@@ -125,3 +125,54 @@ def test_imshow_xarray(xr):
xr = pytest.importorskip('xarray')
return xr
+
+
+@pytest.fixture
+def text_placeholders(monkeypatch):
+ """
+ Replace texts with placeholder rectangles.
+
+ The rectangle size only depends on the font size and the number of characters. It is
+ thus insensitive to font properties and rendering details. This should be used for
+ tests that depend on text geometries but not the actual text rendering, e.g. layout
+ tests.
+ """
+ from matplotlib.patches import Rectangle
+
+ def patched_get_text_metrics_with_cache(renderer, text, fontprop, ismath, dpi):
+ """
+ Replace ``_get_text_metrics_with_cache`` with fixed results.
+
+ The usual ``renderer.get_text_width_height_descent`` would depend on font
+ metrics; instead the fixed results are based on font size and the length of the
+ string only.
+ """
+ # While get_window_extent returns pixels and font size is in points, font size
+ # includes ascenders and descenders. Leaving out this factor and setting
+ # descent=0 ends up with a box that is relatively close to DejaVu Sans.
+ height = fontprop.get_size()
+ width = len(text) * height / 1.618 # Golden ratio for character size.
+ descent = 0
+ return width, height, descent
+
+ def patched_text_draw(self, renderer):
+ """
+ Replace ``Text.draw`` with a fixed bounding box Rectangle.
+
+ The bounding box corresponds to ``Text.get_window_extent``, which ultimately
+ depends on the above patched ``_get_text_metrics_with_cache``.
+ """
+ if renderer is not None:
+ self._renderer = renderer
+ if not self.get_visible():
+ return
+ if self.get_text() == '':
+ return
+ bbox = self.get_window_extent()
+ rect = Rectangle(bbox.p0, bbox.width, bbox.height,
+ facecolor=self.get_color(), edgecolor='none')
+ rect.draw(renderer)
+
+ monkeypatch.setattr('matplotlib.text._get_text_metrics_with_cache',
+ patched_get_text_metrics_with_cache)
+ monkeypatch.setattr('matplotlib.text.Text.draw', patched_text_draw)
diff --git a/lib/matplotlib/testing/conftest.pyi b/lib/matplotlib/testing/conftest.pyi
index 2af0eb93cc8a..f5d90bc88f73 100644
--- a/lib/matplotlib/testing/conftest.pyi
+++ b/lib/matplotlib/testing/conftest.pyi
@@ -10,3 +10,5 @@ def mpl_test_settings(request: pytest.FixtureRequest) -> None: ...
def pd() -> ModuleType: ...
@pytest.fixture
def xr() -> ModuleType: ...
+@pytest.fixture
+def text_placeholders(monkeypatch: pytest.MonkeyPatch) -> None: ...
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
index 6f1af7debdb3..17509449e768 100644
--- a/lib/matplotlib/testing/decorators.py
+++ b/lib/matplotlib/testing/decorators.py
@@ -204,6 +204,7 @@ def wrapper(*args, extension, request, **kwargs):
if extension not in comparable_formats():
reason = {
+ 'gif': 'because ImageMagick is not installed',
'pdf': 'because Ghostscript is not installed',
'eps': 'because Ghostscript is not installed',
'svg': 'because Inkscape is not installed',
@@ -279,7 +280,7 @@ def image_comparison(baseline_images, extensions=None, tol=0,
extensions : None or list of str
The list of extensions to test, e.g. ``['png', 'pdf']``.
- If *None*, defaults to all supported extensions: png, pdf, and svg.
+ If *None*, defaults to: png, pdf, and svg.
When testing a single extension, it can be directly included in the
names passed to *baseline_images*. In that case, *extensions* must not
@@ -346,7 +347,7 @@ def image_comparison(baseline_images, extensions=None, tol=0,
savefig_kwargs=savefig_kwarg, style=style)
-def check_figures_equal(*, extensions=("png", "pdf", "svg"), tol=0):
+def check_figures_equal(*, extensions=("png", ), tol=0):
"""
Decorator for test cases that generate and compare two figures.
@@ -359,8 +360,13 @@ def check_figures_equal(*, extensions=("png", "pdf", "svg"), tol=0):
Parameters
----------
- extensions : list, default: ["png", "pdf", "svg"]
- The extensions to test.
+ extensions : list, default: ["png"]
+ The extensions to test. Supported extensions are "png", "pdf", "svg".
+
+ Testing with the one default extension is sufficient if the output is not
+ format dependent, e.g. if you test that a ``bar()`` plot yields the same
+ result as some manually placed Rectangles. You should use all extensions
+ if a renderer property is involved, e.g. correct alpha blending.
tol : float
The RMS threshold above which the test is considered failed.
diff --git a/lib/matplotlib/testing/widgets.py b/lib/matplotlib/testing/widgets.py
index 3962567aa7c0..c528ffb2537c 100644
--- a/lib/matplotlib/testing/widgets.py
+++ b/lib/matplotlib/testing/widgets.py
@@ -8,6 +8,8 @@
from unittest import mock
+from matplotlib import _api
+from matplotlib.backend_bases import MouseEvent, KeyEvent
import matplotlib.pyplot as plt
@@ -24,6 +26,7 @@ def noop(*args, **kwargs):
pass
+@_api.deprecated("3.11", alternative="MouseEvent or KeyEvent")
def mock_event(ax, button=1, xdata=0, ydata=0, key=None, step=1):
r"""
Create a mock event that can stand in for `.Event` and its subclasses.
@@ -65,6 +68,7 @@ def mock_event(ax, button=1, xdata=0, ydata=0, key=None, step=1):
return event
+@_api.deprecated("3.11", alternative="callbacks.process(event)")
def do_event(tool, etype, button=1, xdata=0, ydata=0, key=None, step=1):
"""
Trigger an event on the given tool.
@@ -105,15 +109,12 @@ def click_and_drag(tool, start, end, key=None):
An optional key that is pressed during the whole operation
(see also `.KeyEvent`).
"""
- if key is not None:
- # Press key
- do_event(tool, 'on_key_press', xdata=start[0], ydata=start[1],
- button=1, key=key)
+ ax = tool.ax
+ if key is not None: # Press key
+ KeyEvent._from_ax_coords("key_press_event", ax, start, key)._process()
# Click, move, and release mouse
- do_event(tool, 'press', xdata=start[0], ydata=start[1], button=1)
- do_event(tool, 'onmove', xdata=end[0], ydata=end[1], button=1)
- do_event(tool, 'release', xdata=end[0], ydata=end[1], button=1)
- if key is not None:
- # Release key
- do_event(tool, 'on_key_release', xdata=end[0], ydata=end[1],
- button=1, key=key)
+ MouseEvent._from_ax_coords("button_press_event", ax, start, 1)._process()
+ MouseEvent._from_ax_coords("motion_notify_event", ax, end, 1)._process()
+ MouseEvent._from_ax_coords("button_release_event", ax, end, 1)._process()
+ if key is not None: # Release key
+ KeyEvent._from_ax_coords("key_release_event", ax, end, key)._process()
diff --git a/lib/matplotlib/tests/baseline_images/test_agg_filter/agg_filter_alpha.gif b/lib/matplotlib/tests/baseline_images/test_agg_filter/agg_filter_alpha.gif
new file mode 100644
index 000000000000..01a2d0bc288e
Binary files /dev/null and b/lib/matplotlib/tests/baseline_images/test_agg_filter/agg_filter_alpha.gif differ
diff --git a/lib/matplotlib/tests/baseline_images/test_arrow_patches/fancyarrow_test_image.pdf b/lib/matplotlib/tests/baseline_images/test_arrow_patches/fancyarrow_test_image.pdf
deleted file mode 100644
index 124014fc4869..000000000000
Binary files a/lib/matplotlib/tests/baseline_images/test_arrow_patches/fancyarrow_test_image.pdf and /dev/null differ
diff --git a/lib/matplotlib/tests/baseline_images/test_arrow_patches/fancyarrow_test_image.svg b/lib/matplotlib/tests/baseline_images/test_arrow_patches/fancyarrow_test_image.svg
deleted file mode 100644
index 6fb9d9d64991..000000000000
--- a/lib/matplotlib/tests/baseline_images/test_arrow_patches/fancyarrow_test_image.svg
+++ /dev/null
@@ -1,2891 +0,0 @@
-
-
-
-
diff --git a/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.pdf b/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.pdf
index 054fe8d8264f..cac3b8f7751e 100644
Binary files a/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.pdf and b/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.pdf differ
diff --git a/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.png b/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.png
index cf2ebc38391d..1846832dc3f3 100644
Binary files a/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.png and b/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.png differ
diff --git a/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.svg b/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.svg
index e6743bd2a79b..eb2fc6501453 100644
--- a/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.svg
+++ b/lib/matplotlib/tests/baseline_images/test_artist/clip_path_clipping.svg
@@ -1,12 +1,23 @@
-
-
diff --git a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_inset_rasterized.pdf b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_inset_rasterized.pdf
new file mode 100644
index 000000000000..17a80ef876d1
Binary files /dev/null and b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_inset_rasterized.pdf differ
diff --git a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.pdf b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.pdf
index 9214e27e528c..b7a90a37dcf1 100644
Binary files a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.pdf and b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.pdf differ
diff --git a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.png b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.png
index f2827b5b78ea..aea824adc864 100644
Binary files a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.png and b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.png differ
diff --git a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.svg b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.svg
index 1e6229adef8a..d08fff8810b2 100644
--- a/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.svg
+++ b/lib/matplotlib/tests/baseline_images/test_bbox_tight/bbox_inches_tight.svg
@@ -1,531 +1,1062 @@
-
-
`__, even with a static ``svg.hashsalt`` value configured.
-
-The problem was a non-deterministic ID-generation scheme for clip paths; the fix introduces a repeatable, monotonically increasing integer ID scheme as a replacement.
-
-Provided that plots add clip paths themselves in deterministic order, this enables repeatable (a.k.a. reproducible, deterministic) SVG output.
diff --git a/doc/api/next_api_changes/behavior/27891-ES.rst b/doc/api/next_api_changes/behavior/27891-ES.rst
deleted file mode 100644
index f60b4b320a44..000000000000
--- a/doc/api/next_api_changes/behavior/27891-ES.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-ft2font classes are now final
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The ft2font classes `.ft2font.FT2Font`, and `.ft2font.FT2Image` are now final
-and can no longer be subclassed.
diff --git a/doc/api/next_api_changes/behavior/27996-REC.rst b/doc/api/next_api_changes/behavior/27996-REC.rst
deleted file mode 100644
index fe81a34073b8..000000000000
--- a/doc/api/next_api_changes/behavior/27996-REC.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-``InsetIndicator`` artist
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-`~.Axes.indicate_inset` and `~.Axes.indicate_inset_zoom` now return an instance
-of `~matplotlib.inset.InsetIndicator`. Use the
-`~matplotlib.inset.InsetIndicator.rectangle` and
-`~matplotlib.inset.InsetIndicator.connectors` properties of this artist to
-access the objects that were previously returned directly.
diff --git a/doc/api/next_api_changes/behavior/28061-JMK.rst b/doc/api/next_api_changes/behavior/28061-JMK.rst
deleted file mode 100644
index e3ffb783b394..000000000000
--- a/doc/api/next_api_changes/behavior/28061-JMK.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-``imshow`` *interpolation_stage* default changed to 'auto'
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The *interpolation_stage* parameter of `~.Axes.imshow` has a new default
-value 'auto'. For images that are up-sampled less than a factor of
-three or down-sampled, image interpolation will occur in 'rgba' space. For images
-that are up-sampled by a factor of 3 or more, then image interpolation occurs
-in 'data' space.
-
-The previous default was 'data', so down-sampled images may change subtly with
-the new default. However, the new default also avoids floating point artifacts
-at sharp boundaries in a colormap when down-sampling.
-
-The previous behavior can achieved by setting the *interpolation_stage* parameter
-or :rc:`image.interpolation_stage` to 'data'.
-
-imshow default *interpolation* changed to 'auto'
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The *interpolation* parameter of `~.Axes.imshow` has a new default
-value 'auto', changed from 'antialiased', for consistency with *interpolation_stage*
-and because the interpolation is only anti-aliasing during down-sampling. Passing
-'antialiased' still works, and behaves exactly the same as 'auto', but is discouraged.
diff --git a/doc/api/next_api_changes/behavior/28156-AL.rst b/doc/api/next_api_changes/behavior/28156-AL.rst
deleted file mode 100644
index af9c2b142261..000000000000
--- a/doc/api/next_api_changes/behavior/28156-AL.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-dark_background and fivethirtyeight styles no longer set ``savefig.facecolor`` and ``savefig.edgecolor``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-When using these styles, :rc:`savefig.facecolor` and :rc:`savefig.edgecolor`
-now inherit the global default value of "auto", which means that the actual
-figure colors will be used. Previously, these rcParams were set to the same
-values as :rc:`figure.facecolor` and :rc:`figure.edgecolor`, i.e. a saved
-figure would always use the theme colors even if the user manually overrode
-them; this is no longer the case.
-
-This change should have no impact for users that do not manually set the figure
-face and edge colors.
diff --git a/doc/api/next_api_changes/behavior/28177-REC.rst b/doc/api/next_api_changes/behavior/28177-REC.rst
deleted file mode 100644
index d7ea8ec0e947..000000000000
--- a/doc/api/next_api_changes/behavior/28177-REC.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-(Sub)Figure.get_figure
-~~~~~~~~~~~~~~~~~~~~~~
-
-...in future will by default return the direct parent figure, which may be a SubFigure.
-This will make the default behavior consistent with the
-`~matplotlib.artist.Artist.get_figure` method of other artists. To control the
-behavior, use the newly introduced *root* parameter.
diff --git a/doc/api/next_api_changes/behavior/28354-YN.rst b/doc/api/next_api_changes/behavior/28354-YN.rst
deleted file mode 100644
index 69c25575c516..000000000000
--- a/doc/api/next_api_changes/behavior/28354-YN.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Add zorder option in QuiverKey
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-``zorder`` can be used as a keyword argument to `.QuiverKey`. Previously,
-that parameter did not have any effect because the zorder was hard coded.
diff --git a/doc/api/next_api_changes/behavior/28363-TS.rst b/doc/api/next_api_changes/behavior/28363-TS.rst
deleted file mode 100644
index 2242f3929e04..000000000000
--- a/doc/api/next_api_changes/behavior/28363-TS.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Subfigures
-~~~~~~~~~~
-
-`.Figure.subfigures` are now added in row-major order to be consistent with
-`.Figure.subplots`. The return value of `~.Figure.subfigures` is not changed,
-but the order of ``fig.subfigs`` is.
diff --git a/doc/api/next_api_changes/behavior/28375-MP.rst b/doc/api/next_api_changes/behavior/28375-MP.rst
deleted file mode 100644
index 75d7f7cf5030..000000000000
--- a/doc/api/next_api_changes/behavior/28375-MP.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-``transforms.AffineDeltaTransform`` updates correctly on axis limit changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Before this change, transform sub-graphs with ``AffineDeltaTransform`` did not update correctly.
-This PR ensures that changes to the child transform are passed through correctly.
diff --git a/doc/api/next_api_changes/behavior/28437-CH.rst b/doc/api/next_api_changes/behavior/28437-CH.rst
new file mode 100644
index 000000000000..6121dfec8163
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/28437-CH.rst
@@ -0,0 +1,8 @@
+*alpha* parameter handling on images
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When passing and array to ``imshow(..., alpha=...)``, the parameter was silently ignored
+if the image data was a RGB or RBGA image or if :rc:`interpolation_state`
+resolved to "rbga".
+
+This is now fixed, and the alpha array overwrites any previous transparency information.
diff --git a/doc/api/next_api_changes/behavior/28501-OV.rst b/doc/api/next_api_changes/behavior/28501-OV.rst
deleted file mode 100644
index cc816e55f696..000000000000
--- a/doc/api/next_api_changes/behavior/28501-OV.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-The offset string associated with ConciseDateFormatter will now invert when the axis is inverted
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Previously, when the axis was inverted, the offset string associated with ConciseDateFormatter would not change,
-so the offset string indicated the axis was oriented in the wrong direction. Now, when the axis is inverted, the offset
-string is oriented correctly.
diff --git a/doc/api/next_api_changes/behavior/28734-REC.rst b/doc/api/next_api_changes/behavior/28734-REC.rst
deleted file mode 100644
index 825922f4fafb..000000000000
--- a/doc/api/next_api_changes/behavior/28734-REC.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-``suptitle`` in compressed layout
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Compressed layout now automatically positions the `~.Figure.suptitle` just
-above the top row of axes. To keep this title in its previous position,
-either pass ``in_layout=False`` or explicitly set ``y=0.98`` in the
-`~.Figure.suptitle` call.
diff --git a/doc/api/next_api_changes/behavior/29054-AL.rst b/doc/api/next_api_changes/behavior/29054-AL.rst
new file mode 100644
index 000000000000..3c65e9ae9b78
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/29054-AL.rst
@@ -0,0 +1,11 @@
+Minor log tick labels are set depending on number of major log ticks, not on number of decades spanned
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Previously, by default, on a log-scaled axis, the minor ticks would be
+unlabeled if the axis limits spanned more than one decade. The meaning of the
+``minor_thresholds`` parameter to `.LogFormatter` has been altered so that the
+decision of whether to label the minor ticks is now based on the number of
+major ticks drawn within the axis limits.
+
+For example, for an axis spanning from 4 to 60 (with thus a single major log
+tick, at 10), minor ticks are now labeled, even though the axis spans more than
+one decade.
diff --git a/doc/api/next_api_changes/behavior/29256_IMT.rst b/doc/api/next_api_changes/behavior/29256_IMT.rst
new file mode 100644
index 000000000000..57ec8f68d85c
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/29256_IMT.rst
@@ -0,0 +1,6 @@
+Setting titles of figures using webagg backend
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Previously when using the ``webagg`` backend the title of a figure was set using
+``figure.set_label``. Now it is set using ``figure.canvas.manager.set_window_title``
+which is more consistent with other backends.
diff --git a/doc/api/next_api_changes/behavior/29827-ES.rst b/doc/api/next_api_changes/behavior/29827-ES.rst
new file mode 100644
index 000000000000..d25dfa0c6574
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/29827-ES.rst
@@ -0,0 +1,6 @@
+``matplotlib.testing.check_figures_equal`` defaults to PNG only
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In most cases, checking that figures are equal with `.check_figures_equal` does not
+depend on the file format. Consequently, the *extensions* parameter now defaults to
+``['png']`` instead of ``['png', 'pdf', 'svg']``, reducing default test requirements.
diff --git a/doc/api/next_api_changes/behavior/29832-REC.rst b/doc/api/next_api_changes/behavior/29832-REC.rst
new file mode 100644
index 000000000000..a23b043a823b
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/29832-REC.rst
@@ -0,0 +1,11 @@
+Mixing positional and keyword arguments for ``legend`` handles and labels...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... is no longer valid. If passing *handles* and *labels* to ``legend``, they must
+now be passed either both positionally or both as keywords.
+
+Legend labels for ``plot``
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Previously if a sequence was passed to the *label* parameter of `~.Axes.plot` when
+plotting a single dataset, the sequence was automatically cast to string for the legend
+label. Now, if the sequence length is not one an error is raised. To keep the old
+behavior, cast the sequence to string before passing.
diff --git a/doc/api/next_api_changes/behavior/29958-TH.rst b/doc/api/next_api_changes/behavior/29958-TH.rst
new file mode 100644
index 000000000000..cacaf2bac612
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/29958-TH.rst
@@ -0,0 +1,8 @@
+``Axes.add_collection(..., autolim=True)`` updates view limits
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``Axes.add_collection(..., autolim=True)`` has so far only updated the data limits.
+Users needed to additionally call `.Axes.autoscale_view` to update the view limits.
+View limits are now updated as well if ``autolim=True``, using a lazy internal
+update mechanism, so that the costs only apply once also if you add multiple
+collections.
diff --git a/doc/api/next_api_changes/behavior/30272-ES.rst b/doc/api/next_api_changes/behavior/30272-ES.rst
new file mode 100644
index 000000000000..5a03f9bc7972
--- /dev/null
+++ b/doc/api/next_api_changes/behavior/30272-ES.rst
@@ -0,0 +1,2 @@
+``font_manager.findfont`` logs if selected font weight does not match requested
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/api/next_api_changes/deprecations/27385-SS.rst b/doc/api/next_api_changes/deprecations/27385-SS.rst
deleted file mode 100644
index b388ce22eb2b..000000000000
--- a/doc/api/next_api_changes/deprecations/27385-SS.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-``proj3d.proj_transform_clip``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-... is deprecated with no replacement.
diff --git a/doc/api/next_api_changes/deprecations/27551-AL.rst b/doc/api/next_api_changes/deprecations/27551-AL.rst
new file mode 100644
index 000000000000..4811f542bd5f
--- /dev/null
+++ b/doc/api/next_api_changes/deprecations/27551-AL.rst
@@ -0,0 +1,4 @@
+``GridFinder.transform_xy`` and ``GridFinder.inv_transform_xy``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... are deprecated. Directly use the standard transform returned by
+`.GridFinder.get_transform` instead.
diff --git a/doc/api/next_api_changes/deprecations/27786-TH.rst b/doc/api/next_api_changes/deprecations/27786-TH.rst
deleted file mode 100644
index 6b66e0dba963..000000000000
--- a/doc/api/next_api_changes/deprecations/27786-TH.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-Positional parameters in plotting functions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Many plotting functions will restrict positional arguments to the first few parameters
-in the future. All further configuration parameters will have to be passed as keyword
-arguments. This is to enforce better code and and allow for future changes with reduced
-risk of breaking existing code.
diff --git a/doc/api/next_api_changes/deprecations/27972-AL.rst b/doc/api/next_api_changes/deprecations/27972-AL.rst
new file mode 100644
index 000000000000..cf14b24345b5
--- /dev/null
+++ b/doc/api/next_api_changes/deprecations/27972-AL.rst
@@ -0,0 +1,8 @@
+``axes_grid.Grid.ngrids``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+This attribute has been deprecated and renamed ``n_axes``, consistently with
+the new name of the `~.axes_grid.Grid` constructor parameter that allows
+setting the actual number of axes in the grid (the old parameter, ``ngrids``,
+did not actually work since Matplotlib 3.3).
+
+The same change has been made in ``axes_grid.ImageGrid``.
diff --git a/doc/api/next_api_changes/deprecations/28007-TH.rst b/doc/api/next_api_changes/deprecations/28007-TH.rst
deleted file mode 100644
index cfaa329dd9e0..000000000000
--- a/doc/api/next_api_changes/deprecations/28007-TH.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Changing ``Figure.number``
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Changing ``Figure.number`` is deprecated. This value is used by `.pyplot`
-to identify figures. It must stay in sync with the pyplot internal state
-and is not intended to be modified by the user.
diff --git a/doc/api/next_api_changes/deprecations/28048-PR.rst b/doc/api/next_api_changes/deprecations/28048-PR.rst
deleted file mode 100644
index 4e90a3aced19..000000000000
--- a/doc/api/next_api_changes/deprecations/28048-PR.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-``PdfFile.hatchPatterns``
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-... is deprecated.
diff --git a/doc/api/next_api_changes/deprecations/28177-REC.rst b/doc/api/next_api_changes/deprecations/28177-REC.rst
deleted file mode 100644
index a3e630630aeb..000000000000
--- a/doc/api/next_api_changes/deprecations/28177-REC.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-(Sub)Figure.set_figure
-~~~~~~~~~~~~~~~~~~~~~~
-
-...is deprecated and in future will always raise an exception. The parent and
-root figures of a (Sub)Figure are set at instantiation and cannot be changed.
diff --git a/doc/api/next_api_changes/deprecations/28201-AT.rst b/doc/api/next_api_changes/deprecations/28201-AT.rst
deleted file mode 100644
index 56205315a7c1..000000000000
--- a/doc/api/next_api_changes/deprecations/28201-AT.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-``Poly3DCollection.get_vector``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-... is deprecated with no replacement.
diff --git a/doc/api/next_api_changes/deprecations/28670-TAC.rst b/doc/api/next_api_changes/deprecations/28670-TAC.rst
deleted file mode 100644
index e970abf69d54..000000000000
--- a/doc/api/next_api_changes/deprecations/28670-TAC.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Deprecated ``register`` on ``matplotlib.patches._Styles`` and subclasses
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This class method is never used internally. Due to the internal check in the
-method it only accepts subclasses of a private baseclass embedded in the host
-class which makes it unlikely that it has been used externally.
diff --git a/doc/api/next_api_changes/deprecations/28728-TH.rst b/doc/api/next_api_changes/deprecations/28728-TH.rst
deleted file mode 100644
index 56d5a80b439c..000000000000
--- a/doc/api/next_api_changes/deprecations/28728-TH.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-matplotlib.validate_backend
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-...is deprecated. Please use `matplotlib.rcsetup.validate_backend` instead.
-
-
-matplotlib.sanitize_sequence
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-...is deprecated. Please use `matplotlib.cbook.sanitize_sequence` instead.
diff --git a/doc/api/next_api_changes/deprecations/28842-ES.rst b/doc/api/next_api_changes/deprecations/28842-ES.rst
deleted file mode 100644
index d88d3f7b9538..000000000000
--- a/doc/api/next_api_changes/deprecations/28842-ES.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-ft2font module-level constants replaced by enums
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The `.ft2font`-level constants have been converted to `enum` classes, and all API using
-them now take/return the new types.
-
-The following constants are now part of `.ft2font.Kerning` (without the ``KERNING_``
-prefix):
-
-- ``KERNING_DEFAULT``
-- ``KERNING_UNFITTED``
-- ``KERNING_UNSCALED``
-
-The following constants are now part of `.ft2font.LoadFlags` (without the ``LOAD_``
-prefix):
-
-- ``LOAD_DEFAULT``
-- ``LOAD_NO_SCALE``
-- ``LOAD_NO_HINTING``
-- ``LOAD_RENDER``
-- ``LOAD_NO_BITMAP``
-- ``LOAD_VERTICAL_LAYOUT``
-- ``LOAD_FORCE_AUTOHINT``
-- ``LOAD_CROP_BITMAP``
-- ``LOAD_PEDANTIC``
-- ``LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH``
-- ``LOAD_NO_RECURSE``
-- ``LOAD_IGNORE_TRANSFORM``
-- ``LOAD_MONOCHROME``
-- ``LOAD_LINEAR_DESIGN``
-- ``LOAD_NO_AUTOHINT``
-- ``LOAD_TARGET_NORMAL``
-- ``LOAD_TARGET_LIGHT``
-- ``LOAD_TARGET_MONO``
-- ``LOAD_TARGET_LCD``
-- ``LOAD_TARGET_LCD_V``
-
-The following constants are now part of `.ft2font.FaceFlags`:
-
-- ``EXTERNAL_STREAM``
-- ``FAST_GLYPHS``
-- ``FIXED_SIZES``
-- ``FIXED_WIDTH``
-- ``GLYPH_NAMES``
-- ``HORIZONTAL``
-- ``KERNING``
-- ``MULTIPLE_MASTERS``
-- ``SCALABLE``
-- ``SFNT``
-- ``VERTICAL``
-
-The following constants are now part of `.ft2font.StyleFlags`:
-
-- ``ITALIC``
-- ``BOLD``
diff --git a/doc/api/next_api_changes/deprecations/28843-TH.rst b/doc/api/next_api_changes/deprecations/28843-TH.rst
deleted file mode 100644
index 25dc91be3ccc..000000000000
--- a/doc/api/next_api_changes/deprecations/28843-TH.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-FontProperties initialization
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-`.FontProperties` initialization is limited to the two call patterns:
-
-- single positional parameter, interpreted as fontconfig pattern
-- only keyword parameters for setting individual properties
-
-All other previously supported call patterns are deprecated.
diff --git a/doc/api/next_api_changes/deprecations/28933-AL.rst b/doc/api/next_api_changes/deprecations/28933-AL.rst
deleted file mode 100644
index b551c124b4e0..000000000000
--- a/doc/api/next_api_changes/deprecations/28933-AL.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-``AxLine`` ``xy1`` and ``xy2`` setters
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-These setters now each take a single argument, ``xy1`` or ``xy2`` as a tuple.
-The old form, where ``x`` and ``y`` were passed as separate arguments, is
-deprecated.
diff --git a/doc/api/next_api_changes/deprecations/28946-TH.rst b/doc/api/next_api_changes/deprecations/28946-TH.rst
deleted file mode 100644
index 6a2f09108686..000000000000
--- a/doc/api/next_api_changes/deprecations/28946-TH.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Calling ``pyplot.polar()`` with an existing non-polar Axes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This currently plots the data into the non-polar Axes, ignoring
-the "polar" intention. This usage scenario is deprecated and
-will raise an error in the future.
diff --git a/doc/api/next_api_changes/deprecations/28967-ES.rst b/doc/api/next_api_changes/deprecations/28967-ES.rst
deleted file mode 100644
index 8bb238def943..000000000000
--- a/doc/api/next_api_changes/deprecations/28967-ES.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Passing floating-point values to ``RendererAgg.draw_text_image``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Any floating-point values passed to the *x* and *y* parameters were truncated to integers
-silently. This behaviour is now deprecated, and only `int` values should be used.
-
-Passing floating-point values to ``FT2Image``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Any floating-point values passed to the `.FT2Image` constructor, or the *x0*, *y0*, *x1*,
-and *y1* parameters of `.FT2Image.draw_rect_filled` were truncated to integers silently.
-This behaviour is now deprecated, and only `int` values should be used.
diff --git a/doc/api/next_api_changes/deprecations/29135-TH.rst b/doc/api/next_api_changes/deprecations/29135-TH.rst
new file mode 100644
index 000000000000..e2289a248076
--- /dev/null
+++ b/doc/api/next_api_changes/deprecations/29135-TH.rst
@@ -0,0 +1,5 @@
+Parameter ``ListedColormap(..., N=...)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Passing the parameter *N* to `.ListedColormap` is deprecated.
+Please preprocess the list colors yourself if needed.
diff --git a/doc/api/next_api_changes/deprecations/29529-TH.rst b/doc/api/next_api_changes/deprecations/29529-TH.rst
new file mode 100644
index 000000000000..e396e68c4aa1
--- /dev/null
+++ b/doc/api/next_api_changes/deprecations/29529-TH.rst
@@ -0,0 +1,7 @@
+Capitalization of None in matplotlibrc
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In :file:`matplotlibrc` config files every capitalization of None was
+accepted for denoting the Python constant `None`. This is deprecated. The
+only accepted capitalization is now None, i.e. starting with a capital letter
+and all other letters in lowercase.
diff --git a/doc/api/next_api_changes/deprecations/29817-AL.rst b/doc/api/next_api_changes/deprecations/29817-AL.rst
new file mode 100644
index 000000000000..f3b339ed7c10
--- /dev/null
+++ b/doc/api/next_api_changes/deprecations/29817-AL.rst
@@ -0,0 +1,7 @@
+``DviFont.widths``
+~~~~~~~~~~~~~~~~~~
+... is deprecated with no replacement.
+
+Direct access to ``Tfm``'s ``widths``, ``heights``, ``depths`` dicts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... is deprecated; access a glyph's metrics with `.Tfm.get_metrics` instead.
diff --git a/doc/api/next_api_changes/development/28503-ES.rst b/doc/api/next_api_changes/deprecations/29904-tac.rst
similarity index 65%
rename from doc/api/next_api_changes/development/28503-ES.rst
rename to doc/api/next_api_changes/deprecations/29904-tac.rst
index e9b109cb8515..8e4f986ffa77 100644
--- a/doc/api/next_api_changes/development/28503-ES.rst
+++ b/doc/api/next_api_changes/deprecations/29904-tac.rst
@@ -1,13 +1,15 @@
+
Increase to minimum supported versions of dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-For Matplotlib 3.10, the :ref:`minimum supported versions