8000 Clean up next api_changes · matplotlib/matplotlib@ed4fe75 · GitHub
[go: up one dir, main page]

Skip to content

Commit ed4fe75

Browse files
committed
Clean up next api_changes
1 parent b52a284 commit ed4fe75

File tree

1 file changed

+77
-71
lines changed

1 file changed

+77
-71
lines changed

doc/api/api_changes.rst

Lines changed: 77 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ Drop support for python 2
2828
Matplotlib 3 only supports python 3.5 and higher
2929

3030

31+
Hold machinery removed
32+
----------------------
33+
34+
Setting or unsetting ``hold`` (deprecated in version 2.1) has now
35+
been completely removed. Matplotlib now always behaves as if ``hold=True``.
36+
To clear an axes you can manually use :meth:`~.axes.Axes.cla()`,
37+
or to clear an entire figure use :meth:`~.figure.Figure.clf()`.
38+
39+
3140
`.Axes.hist2d` now uses `~.Axes.pcolormesh` instead of `~.Axes.pcolorfast`
3241
--------------------------------------------------------------------------
3342

@@ -61,46 +70,51 @@ The following classes, methods, functions, and attributes are deprecated:
6170

6271
- ``RcParams.msg_depr``, ``RcParams.msg_depr_ignore``,
6372
``RcParams.msg_depr_set``, ``RcParams.msg_obsolete``,
64-
``RcParams.msg_backend_obsolete``,
65-
- ``afm.parse_afm``,
66-
- ``backend_pgf.get_texcommand``,
67-
- ``backend_ps.get_bbox``,
68-
- ``backend_qt5.error_msg_qt``, ``backend_qt5.exception_handler``,
69-
- ``backend_wx.FigureCanvasWx.macros``,
70-
- ``cbook.GetRealpathAndStat``, ``cbook.Locked``,
73+
``RcParams.msg_backend_obsolete``
74+
- ``afm.parse_afm``
75+
- ``backend_pgf.get_texcommand``
76+
- ``backend_ps.get_bbox``
77+
- ``backend_qt5.error_msg_qt``, ``backend_qt5.exception_handler``
78+
- ``backend_wx.FigureCanvasWx.macros``
79+
- ``cbook.GetRealpathAndStat``, ``cbook.Locked``
7180
- ``cbook.is_numlike`` (use ``isinstance(..., numbers.Number)`` instead),
72-
``cbook.listFiles``, ``cbook.unicode_safe``,
73-
- ``container.Container.set_remove_method``,
74-
- ``contour.ContourLabeler.cl``, ``.cl_xy``, and ``.cl_cvalues``,
75-
- ``dates.DateFormatter.strftime_pre_1900``, ``dates.DateFormatter.strftime``,
76-
- ``font_manager.TempCache``,
77-
- ``mathtext.unichr_safe`` (use ``chr`` instead),
78-
- ``table.Table.get_child_artists`` (use ``get_children`` instead),
81+
``cbook.listFiles``, ``cbook.unicode_safe``
82+
- ``container.Container.set_remove_method``
83+
- ``contour.ContourLabeler.cl``, ``.cl_xy``, and ``.cl_cvalues``
84+
- ``dates.DateFormatter.strftime_pre_1900``, ``dates.DateFormatter.strftime``
85+
- ``font_manager.TempCache``
86+
- ``mathtext.unichr_safe`` (use ``chr`` instead)
87+
- ``table.Table.get_child_artists`` (use ``get_children`` instead)
7988
- ``testing.compare.ImageComparisonTest``, ``testing.compare.compare_float``,
80-
- ``testing.decorators.CleanupTest``,
81-
``testing.decorators.skip_if_command_unavailable``,
89+
- ``testing.decorators.CleanupTest``
90+
``testing.decorators.skip_if_command_unavailable``
8291
- ``FigureCanvasQT.keyAutoRepeat`` (directly check
8392
``event.guiEvent.isAutoRepeat()`` in the event handler to decide whether to
84-
handle autorepeated key presses).
85-
- ``FigureCanvasWx.macros``,
93+
handle autorepeated key presses)
94+
- ``FigureCanvasWx.macros``
8695
- ``_ImageBase.iterpnames``, use the ``interpolation_names`` property instead.
8796
(this affects classes that inherit from ``_ImageBase`` including
88-
:class:`FigureImage`, :class:`BboxImage`, and :class:`AxesImage`),
89-
- ``patches.Polygon.xy``,
90-
- ``texmanager.dvipng_hack_alpha``,
91-
- ``text.Annotation.arrow``,
97+
:class:`FigureImage`, :class:`BboxImage`, and :class:`AxesImage`)
98+
- ``patches.Polygon.xy``
99+
- ``texmanager.dvipng_hack_alpha``
100+
- ``text.Annotation.arrow``
101+
- `.Legend.draggable()`, in favor of `.Legend.set_draggable()`
102+
(``Legend.draggable`` may be reintroduced as a property in future releases)
103+
92104

93105
The following rcParams are deprecated:
94-
- ``examples.directory`` (use ``datapath`` instead),
95-
- ``pgf.debug`` (the pgf backend relies on logging),
96-
- ``text.latex.unicode``,
106+
107+
- ``examples.directory`` (use ``datapath`` instead)
108+
- ``pgf.debug`` (the pgf backend relies on logging)
109+
- ``text.latex.unicode``
97110

98111
The following keyword arguments are deprecated:
99-
- passing ``verts`` to ``Axes.scatter`` (use ``marker`` instead),
100-
- passing ``obj_type`` to ``cbook.deprecated``,
112+
113+
- passing ``verts`` to ``Axes.scatter`` (use ``marker`` instead)
114+
- passing ``obj_type`` to ``cbook.deprecated``
101115

102116
The following call signatures are deprecated:
103-
- passing a ``wx.EvtHandler`` as first argument to ``backend_wx.TimerWx``,
117+
- passing a ``wx.EvtHandler`` as first argument to ``backend_wx.TimerWx``
104118

105119
Deprecated methods removed from `matplotlib.testing`
106120
----------------------------------------------------
@@ -111,6 +125,15 @@ from :mod:`matplotlib.testing.decorators`.
111125
The entire contents of `testing.noseclasses` have also been removed.
112126

113127

128+
``matplotlib.cbook.deprecation.mplDeprecation`` is deprecated
129+
-------------------------------------------------------------
130+
131+
:class:`matplotlib.cbook.deprecation.mplDeprecation` will be removed in
132+
future versions. It is just an alias for
133+
:class:`matplotlib.cbook.deprecation.MatplotlibDeprecationWarning`.
134+
Please use the :class:`~.MatplotlibDeprecationWarning` directly if neccessary.
135+
136+
114137
matplotlib.cbook.Bunch deprecated
115138
---------------------------------
116139

@@ -119,6 +142,16 @@ The ``matplotlib.cbook.Bunch`` class has been deprecated. Instead, use
119142
functionality.
120143

121144

145+
Deprecation of certain marker styles
146+
------------------------------------
147+
148+
Using ``(n, 3)`` as marker style to specify a circle marker is deprecated. Use
149+
``"o"`` instead.
150+
151+
Using ``([(x0, y0), (x1, y1), ...], 0)`` as marker style to specify a custom
152+
marker path is deprecated. Use ``[(x0, y0), (x1, y1), ...]`` instead.
153+
154+
122155
Removal of deprecated backends
123156
------------------------------
124157

@@ -130,15 +163,6 @@ Deprecated backends have been removed:
130163
* GDK
131164

132165

133-
Hold machinery removed
134-
----------------------
135-
136-
Setting or unsetting ``hold`` (deprecated in version 2.1) has now
137-
been completely removed. Matplotlib now always behaves as if ``hold=True``.
138-
To clear an axes you can manually use :meth:`~.axes.Axes.cla()`,
139-
or to clear an entire figure use :meth:`~.figure.Figure.clf()`.
140-
141-
142166
``Axes3D.get_xlim``, ``get_ylim`` and ``get_zlim`` now return a tuple
143167
---------------------------------------------------------------------
144168

@@ -213,16 +237,6 @@ These arguments were renamed in 2.0 to ``x``/``y`` following the change of the
213237
default alignment from ``edge`` to ``center``.
214238

215239

216-
Deprecation of certain marker styles
217-
------------------------------------
218-
219-
Using ``(n, 3)`` as marker style to specify a circle marker is deprecated. Use
220-
``"o"`` instead.
221-
222-
Using ``([(x0, y0), (x1, y1), ...], 0)`` as marker style to specify a custom
223-
marker path is deprecated. Use ``[(x0, y0), (x1, y1), ...]`` instead.
224-
225-
226240
Different exception types for undocumented options
227241
--------------------------------------------------
228242

@@ -243,7 +257,7 @@ Improved call signature for Axes.margins()
243257
------------------------------------------
244258

245259
:meth:`matplotlib.axes.Axes.margins` and :meth:`mpl_toolkits.mplot3d.Axes3D.margins`
246-
no longer accept arbitrary keywords. ``TypeError`` will therefore be raised
260+
no longer accept arbitrary keywords. ``TypeError`` will therefore be raised
247261
if unknown kwargs are passed; previously they would be silently ignored.
248262

249263
If too many positional arguments are passed, ``TypeError`` will be raised
@@ -254,8 +268,8 @@ warning if only two positional arguments are passed. To supply only ``x`` and
254268
``y`` margins, use keyword arguments.
255269

256270

257-
Remove lib/mpl_examples
258-
-----------------------
271+
lib/mpl_examples removed
272+
------------------------
259273

260274
The symlink from lib/mpl_examples to ../examples has been removed.
261275
This is not installed as an importable package and should not affect
@@ -287,20 +301,12 @@ unhandled positional arguments. If two or more arguments are passed
287301
will be raised instead of treating X as Y and Y as linefmt.
288302

289303

290-
``matplotlib.cbook.deprecation.mplDeprecation`` is deprecated
291-
-------------------------------------------------------------
292-
293-
:class:`matplotlib.cbook.deprecation.mplDeprecation` will be removed in
294-
future versions. It is just an alias for
295-
:class:`matplotlib.cbook.deprecation.MatplotlibDeprecationWarning`.
296-
Please use the :class:`~.MatplotlibDeprecationWarning` directly if neccessary.
297-
298-
299-
The cleanup decorators and test classes in matplotlib.testing.decorators no longer destroy the warnings filter on exit
300-
----------------------------------------------------------------------------------------------------------------------
304+
Cleanup decorators and test classes no longer destroy warnings filter on exit
305+
-----------------------------------------------------------------------------
301306

302-
Instead, they restore the warnings filter that existed before the test started
303-
using ``warnings.catch_warnings``.
307+
The decorators and classes in matplotlib.testing.decorators no longer
308+
destroy the warnings filter on exit. Instead, they restore the warnings
309+
filter that existed before the test started using ``warnings.catch_warnings``.
304310

305311

306312
Non-interactive FigureManager classes are now aliases of FigureManagerBase
@@ -315,13 +321,13 @@ adding or overriding any attribute or method), are now direct aliases for
315321
Change to the output of `.image.thumbnail`
316322
------------------------------------------
317323

318-
When called with ``preview=False``, ``image.thumbnail`` previously returned an
324+
When called with ``preview=False``, `.image.thumbnail` previously returned an
319325
figure whose canvas class was set according to the output file extension. It
320326
now returns a figure whose canvas class is the base `FigureCanvasBase` (and
321327
relies on `FigureCanvasBase.print_figure`) to handle the canvas switching
322328
properly).
323329

324-
As a side effect of this change, `image.thumbnail` now also supports .ps, .eps,
330+
As a side effect of this change, `.image.thumbnail` now also supports .ps, .eps,
325331
and .svgz output.
326332

327333

@@ -376,7 +382,7 @@ Changes to backend loading
376382

377383
Failure to load backend modules (``macosx`` on non-framework builds and
378384
``gtk3`` when running headless) now raises `ImportError` (instead of
379-
`RuntimeError` and `TypeError`, respectively.
385+
`RuntimeError` and `TypeError`, respectively).
380386

381387
Third-party backends that integrate with an interactive framework are now
382388
encouraged to define the ``required_interactive_framework`` global value to one
@@ -386,11 +392,11 @@ backend to another (specifically, whether they use the same interactive
386392
framework).
387393

388394

389-
Changed default `AutoDateLocator` kwarg ``interval_multiples`` to ``True``
390-
--------------------------------------------------------------------------
395+
Changed default `AutoDateLocator` kwarg *interval_multiples* to ``True``
396+
------------------------------------------------------------------------
391397

392398
The default value of the tick locator for dates, `.dates.AutoDateLocator`
393-
kwarg ``interval_multiples`` was set to ``False`` which leads to not-nice
399+
kwarg *interval_multiples* was set to ``False`` which leads to not-nice
394400
looking automatic ticks in many instances. The much nicer
395401
``interval_multiples=True`` is the new default. See below to get the
396402
old behavior back:
@@ -430,9 +436,9 @@ old behavior back:
430436

431437
`.Axes.get_position` used to return the original position unless a
432438
draw had been triggered or `.Axes.apply_aspect` had been called, even
433-
if the kwarg *original* was set to *False*. Now `.Axes.apply_aspect`
439+
if the kwarg *original* was set to ``False``. Now `.Axes.apply_aspect`
434440
is called so ``ax.get_position()`` will return the new modified position.
435-
To get the old behaviour, ``ax.get_position(original=True)``.
441+
To get the old behaviour use ``ax.get_position(original=True)``.
436442

437443

438444
The ticks for colorbar now adjust for the size of the colorbar

0 commit comments

Comments
 (0)
0