Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit b69e833

Browse filesBrowse files
dstansbytacaswell
dstansby
authored and
tacaswell
committed
Move around some more changes to general headers
1 parent 1b9199c commit b69e833
Copy full SHA for b69e833

File tree

Expand file treeCollapse file tree

1 file changed

+129
-131
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+129
-131
lines changed

‎doc/api/prev_api_changes/api_changes_3.1.0.rst

Copy file name to clipboardExpand all lines: doc/api/prev_api_changes/api_changes_3.1.0.rst
+129-131Lines changed: 129 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
API Changes for 3.1.0
22
=====================
33

4+
Testing
5+
-------
6+
7+
The ``--no-network`` flag to ``tests.py`` has been removed (no test requires
8+
internet access anymore). If it is desired to disable internet access both for
9+
old and new versions of Matplotlib, use ``tests.py -m 'not network'`` (which is
10+
now a no-op).
11+
12+
The image comparison test decorators now skip (rather than xfail) the test for
13+
uncomparable formats. The affected decorators are `~.image_comparison` and
14+
`~.check_figures_equal`. The deprecated `~.ImageComparisonTest` class is
15+
likewise changed.
16+
417
Dependency changes
518
------------------
619

@@ -42,8 +55,22 @@ The following API elements have been removed:
4255
- ``font_manager.cachedir``
4356
- ``__version__numpy__``
4457

45-
Deprecations
46-
------------
58+
Signature deprecations
59+
----------------------
60+
The following signature related behaviours are deprecated:
61+
62+
- The ``withdash`` keyword argument to ``text()``. Consider using
63+
``annotate()`` instead.
64+
- Passing (n, 1)-shaped error arrays to errorbar(), which was not
65+
documented and did not work for ``n = 2``. Pass a 1D array instead.
66+
- The ``frameon`` kwarg to ``savefig`` and the ``savefig.frameon`` rcParam.
67+
To emulate ``frameon = False``, set ``facecolor`` to fully
68+
transparent (``"none"``, or ``(0, 0, 0, 0)``).
69+
- Passing a non-1D (typically, (n, 1)-shaped) input to `Axes.pie`.
70+
Pass a 1D array instead.
71+
72+
Class/method/attribute deprecations
73+
-----------------------------------
4774

4875
- ``Spine.is_frame_like``
4976

@@ -78,6 +105,99 @@ different behavior from the 2D Axis' `axis.Axis.get_ticks_position` method.
78105
- ``dates.hours()``
79106
- ``dates.weeks()``
80107

108+
- ``axes3d.Axes3D.w_xaxis``
109+
- ``axes3d.Axes3D.w_yaxis``
110+
- ``axes3d.Axes3D.w_zaxis``
111+
112+
Use ``axes3d.Axes3D.xaxis``, ``axes3d.Axes3D.yaxis``,
113+
and ``axes3d.Axes3D.zaxis`` instead.
114+
115+
- ``cbook.dedent``
116+
- ``docstring.Appender``
117+
- ``docstring.dedent``
118+
- ``docstring.copy_dedent``
119+
120+
Use the standard library's docstring manipulation tools instead, such as
121+
`inspect.cleandoc` and `inspect.getdoc`.
122+
123+
- ``matplotlib.testing.decorators.switch_backend`` decorator
124+
125+
Test functions should use ``pytest.mark.backend(...)``, and the mark will be
126+
picked up by the ``matplotlib.testing.conftest.mpl_test_settings`` fixture.
127+
128+
- ``.color`` attribute of `Quiver` objects
129+
130+
Instead, use (as for any `Collection`) the ``get_facecolor`` method.
131+
Note that setting to the ``.color`` attribute did not update the quiver artist,
132+
whereas calling ``set_facecolor`` does.
133+
134+
- ``matplotlib.scale.get_scale_docs()``
135+
- ``matplotlib.pyplot.get_scale_docs()``
136+
137+
These are considered internal and will be removed from the public API in a
138+
future version.
139+
140+
- ``get_py2exe_datafiles``
141+
- ``tk_window_focus``
142+
143+
- ``backend_gtk3.FileChooserDialog``
144+
- ``backend_gtk3.NavigationToolbar2GTK3.get_filechooser``
145+
- ``backend_gtk3.SaveFigureGTK3.get_filechooser``
146+
147+
- ``backend_ps.PsBackendHelper``, ``backend_ps.ps_backend_helper``,
148+
149+
- ``cbook.iterable``
150+
- ``cbook.get_label``
151+
152+
- ``font_manager.OSXInstalledFonts``
153+
154+
- ``mlab.demean``
155+
156+
- ``TextToPath.glyph_to_path``
157+
158+
Instead call ``font.get_path()`` and manually transform the path.
159+
160+
- ``matplotlib.ticker.MaxNLocator.default_params`` class variable
161+
162+
The defaults are not supposed to be user-configurable.
163+
164+
- ``NavigationToolbar2QT.adj_window`` attribute
165+
166+
This is unused and always ``None``.
167+
168+
- ``LogTransformBase``
169+
- ``Log10Transform``
170+
- ``Log2Transform``,
171+
- ``NaturalLogTransformLog``
172+
- ``InvertedLogTransformBase``
173+
- ``InvertedLog10Transform``
174+
- ``InvertedLog2Transform``
175+
- ``InvertedNaturalLogTransform``
176+
177+
These classes defined in :mod:`matplotlib.scales` are deprecated.
178+
As a replacement, use the general `LogTransform` and `InvertedLogTransform`
179+
classes, whose constructors take a *base* argument.
180+
181+
- ``path.get_paths_extents``
182+
183+
Use `~.path.get_path_collection_extents` instead.
184+
185+
- ``Path.has_nonfinite`` attribute
186+
187+
Use ``not np.isfinite(path.vertices).all()`` instead.
188+
189+
- ``text.TextWithDash``
190+
191+
192+
- ``NavigationToolbar2QT.buttons``
193+
- ``Line2D.verticalOffset``
194+
- ``Quiver.keytext``
195+
- ``Quiver.keyvec``
196+
- ``SpanSelector.buttonDown``
197+
198+
These are unused and never updated.
199+
200+
- ``GraphicsContextPS.shouldstroke``
81201

82202
`Text` now has a ``c`` alias for the ``color`` property
83203
-------------------------------------------------------
@@ -218,13 +338,6 @@ API changes
218338
The arguments of `matplotlib.testing.compare.calculate_rms` have been renamed
219339
from ``expectedImage, actualImage``, to ``expected_image, actual_image``.
220340

221-
Deprecations
222-
------------
223-
224-
The ``matplotlib.testing.decorators.switch_backend`` decorator is deprecated.
225-
Test functions should use ``pytest.mark.backend(...)``, and the mark will be
226-
picked up by the ``matplotlib.testing.conftest.mpl_test_settings`` fixture.
227-
228341
Matplotlib.use now has an ImportError for interactive backend
229342
-------------------------------------------------------------
230343

@@ -254,21 +367,6 @@ a non-mathtext string with ``usetex=False`` would rely on the mathtext parser
254367
(but not on usetex support!) to parse the string. The mathtext parser is not
255368
invoked anymore, which may cause slight changes in glyph positioning.
256369

257-
Deprecations
258-
------------
259-
260-
The ``.color`` attribute of `Quiver` objects is deprecated. Instead, use (as
261-
for any `Collection`) the ``get_facecolor`` method. Note that setting to the
262-
``.color`` attribute did not update the quiver artist, whereas calling
263-
``set_facecolor`` does.
264-
265-
Deprecations
266-
------------
267-
268-
The function ``matplotlib.scale.get_scale_docs()`` and its alias
269-
``matplotlib.pyplot.get_scale_docs()`` are considered internal and will be
270-
removed from the public API in a future version.
271-
272370
Passing a single string as *labels* to `Sankey.add`
273371
---------------------------------------------------
274372

@@ -282,38 +380,9 @@ is passed, it is used to label all the flows.
282380
API deprecations
283381
----------------
284382

285-
The following API elements are deprecated:
286-
287-
- ``get_py2exe_datafiles``, ``tk_window_focus``,
288-
- ``backend_gtk3.FileChooserDialog``,
289-
``backend_gtk3.NavigationToolbar2GTK3.get_filechooser``,
290-
``backend_gtk3.SaveFigureGTK3.get_filechooser``,
291-
- ``backend_ps.PsBackendHelper``, ``backend_ps.ps_backend_helper``,
292-
- ``cbook.iterable``,
293-
- ``cbook.get_label``, ``cbook.iterable``,
294-
- ``font_manager.OSXInstalledFonts``,
295-
- ``mlab.demean``,
296-
297383
The following environment variables are deprecated:
298384
- ``MATPLOTLIBDATA``,
299385

300-
Deprecations
301-
------------
302-
303-
The ``Path.has_nonfinite`` attribute is deprecated (use ``not
304-
np.isfinite(path.vertices).all()`` instead).
305-
306-
Deprecations
307-
------------
308-

309-
``TextToPath.glyph_to_path`` is deprecated (call ``font.get_path()`` and
310-
manually transform the path instead).
311-
312-
Deprecations
313-
------------
314-
315-
The (unused and always None) ``NavigationToolbar2QT.adj_window`` attribute is
316-
deprecated.
317386

318387
``OldScalarFormatter.pprint_val``, ``ScalarFormatter.pprint_val``, and ``LogFormatter.pprint_val`` are deprecated
319388
-----------------------------------------------------------------------------------------------------------------
@@ -466,9 +535,7 @@ on a 3D axes now raises a ``NotImplementedError``.
466535
Deprecations
467536
------------
468537

469-
The class variable ``matplotlib.ticker.MaxNLocator.default_params`` is
470-
deprecated and will be removed in a future version. The defaults are not
471-
supposed to be user-configurable.
538+
472539

473540
``matplotlib.ticker.MaxNLocator`` and its ``set_params`` method will issue
474541
a warning on unknown keyword arguments instead of silently ignoring them.
@@ -483,9 +550,7 @@ nothing; this now is equivalent to calling ``add_subplot(111)`` instead.
483550
Deprecations
484551
------------
485552

486-
The following (unused and never updated) attributes are deprecated:
487-
``NavigationToolbar2QT.buttons``, ``Line2D.verticalOffset``, ``Quiver.keytext``,
488-
``Quiver.keyvec``, ``SpanSelector.buttonDown``.
553+
489554

490555
The ``interp_at_native`` parameter to ``BboxImage``, which has no effect since
491556
Matplotlib 2.0, is deprecated.
@@ -508,16 +573,6 @@ instead, or rely on numpy to do it).
508573
See Whats new for details. The previous behavior can be achieved by passing
509574
``shade=False``.
510575

511-
Deprecations
512-
------------
513-
514-
- The ``LogTransformBase``, ``Log10Transform``, ``Log2Transform``,
515-
``NaturalLogTransformLog``, ``InvertedLogTransformBase``,
516-
``InvertedLog10Transform``, ``InvertedLog2Transform``, and
517-
``InvertedNaturalLogTransform`` classes (all defined in
518-
:mod:`matplotlib.scales`) are deprecated. As a replacement, use the general
519-
`LogTransform` and `InvertedLogTransform` classes, whose constructors take a
520-
*base* argument.
521576

522577
Changes to search paths for FreeType and libpng
523578
-----------------------------------------------
@@ -613,8 +668,8 @@ Previously, when a weight string was passed to `FontManager.score_weight`,
613668

614669
`FontManager.score_weight` now raises an exception on such inputs.
615670

616-
Removal of deprecated :mod:`matplotlib.mlab` code
617-
-------------------------------------------------
671+
:mod:`matplotlib.mlab` removals
672+
-------------------------------
618673

619674
Lots of code inside the :mod:`matplotlib.mlab` module which was deprecated
620675
in Matplotlib 2.2 has been removed. See below for a list:
@@ -772,9 +827,6 @@ take the renderer as argument anymore (that argument is unused).
772827
Deprecations
773828
------------
774829

775-
The ``text.TextWithDash`` class and the ``withdash`` keyword argument to
776-
``text()`` is deprecated. Consider using ``annotate()`` instead.
777-
778830
`~Axes.bxp` now respects :rc:`boxplot.boxprops.linewidth` even when *patch_artist* is set
779831
-----------------------------------------------------------------------------------------
780832

@@ -829,26 +881,11 @@ Passing 'normal' to `Axes.axis()` is deprecated
829881

830882
Use ``axis('auto')`` instead.
831883

832-
833-
The image comparison test decorators now skip (rather than xfail) the test for uncomparable formats
834-
---------------------------------------------------------------------------------------------------
835-
836-
The affected decorators are `~.image_comparison` and `~.check_figures_equal`.
837-
The deprecated `~.ImageComparisonTest` class is likewise changed.
838-
:orphan:
839-
840884
Drop support for ``pgi`` in the GTK3 backends
841885
---------------------------------------------
842886
``pgi``, an alternative implementation to PyGObject, is no longer supported in
843887
the GTK3 backends. PyGObject should be used instead.
844888

845-
API changes
846-
-----------
847-
848-
The ``--no-network`` flag to ``tests.py`` has been removed (no test requires
849-
internet access anymore). If it is desired to disable internet access both for
850-
old and new versions of Matplotlib, use ``tests.py -m 'not network'`` (which is
851-
now a no-op).
852889

853890
Minor ticks that collide with major ticks are always hidden
854891
-----------------------------------------------------------
@@ -899,7 +936,7 @@ The ``collections.CIRCLE_AREA_FACTOR`` constant has been removed.
899936
Deprecations
900937
------------
901938

902-
``GraphicsContextPS.shouldstroke`` is deprecated.
939+
903940

904941
Stricter `~.Axes.plot` format string parsing
905942
--------------------------------------------
@@ -910,12 +947,6 @@ specifying more than one linestyle (e.g. ``"---."`` which specifies both
910947

911948
This now raises a ValueError instead.
912949

913-
Deprecations
914-
------------
915-
916-
``path.get_paths_extents`` is deprecated; use
917-
`~.path.get_path_collection_extents` instead.
918-
919950
API changes
920951
-----------
921952

@@ -929,28 +960,9 @@ deprecated.
929960
Deprecations
930961
------------
931962

932-
Passing a non-1D (typically, (n, 1)-shaped) input to `Axes.pie` is deprecated.
933-
Pass a 1D array instead.
934-
935-
Deprecations
936-
------------
937-
938963
The `TextPath` constructor used to silently drop ignored arguments; this
939964
behavior is deprecated.
940965

941-
Deprecations
942-
------------
943-
944-
The ``frameon`` kwarg to ``savefig`` and the ``savefig.frameon`` rcParam
945-
are deprecated. To emulate ``frameon = False``, set ``facecolor`` to fully
946-
transparent (``"none"``, or ``(0, 0, 0, 0)``).
947-
948-
Deprecations
949-
------------
950-
951-
``cbook.dedent``, ``docstring.Appender``, ``docstring.dedent``, and
952-
``docstring.copy_dedent`` are deprecated (use the standard library's docstring
953-
manipulation tools, such as `inspect.cleandoc` and `inspect.getdoc` instead).
954966

955967
Changes to `matplotlib.axes.Axes.spy`
956968
-------------------------------------
@@ -1006,16 +1018,9 @@ function, except the first one (the version where the deprecation occurred),
10061018
are now keyword-only. The goal is to avoid accidentally setting the "message"
10071019
argument when the "name" (or "alternative") argument was intended, as this has
10081020
repeatedly occurred in the past.
1009-
Deprecations
1010-
````````````
1011-
1012-
Support for passing (n, 1)-shaped error arrays to errorbar(), which was not
1013-
documented and did not work for ``n = 2``, is deprecated (pass a 1D array
1014-
instead).
1015-
10161021

1017-
Removal of deprecated :mod:`matplotlib.pylab` code
1018-
--------------------------------------------------
1022+
:mod:`matplotlib.pylab` removals
1023+
--------------------------------
10191024

10201025
Lots of code inside the :mod:`matplotlib.mlab` module which was deprecated
10211026
in Matplotlib 2.2 has been removed. This means the following functions are
@@ -1067,13 +1072,6 @@ no longer available in the `matplotlib.pylab` module:
10671072
- ``stineman_interp``
10681073
- ``vector_lengths``
10691074

1070-
Deprecations
1071-
------------
1072-
1073-
``axes3d.Axes3D.w_xaxis``, ``.w_yaxis``, and ``.w_zaxis`` are deprecated (use
1074-
``.xaxis``, ``.yaxis``, and ``.zaxis`` instead).
1075-
1076-
10771075
Autoscaling changes
10781076
-------------------
10791077

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.