8000 Merge pull request #27850 from rcomer/plot_date · QuLogic/matplotlib@9618fc6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9618fc6

Browse files
dstansbydstansby
authored
Merge pull request matplotlib#27850 from rcomer/plot_date
Deprecate `plot_date`
2 parents cb8c484 + 8ee9d92 commit 9618fc6

File tree

5 files changed

+34
-16
lines changed

5 files changed

+34
-16
lines changed

‎doc/api/next_api_changes/deprecations/27850-REC.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
``plot_date``
2+
~~~~~~~~~~~~~
3+
4+
Use of `~.Axes.plot_date` has been discouraged since Matplotlib 3.5 and the
5+
function is now formally deprecated.
6+
7+
- ``datetime``-like data should directly be plotted using `~.Axes.plot`.
8+
- If you need to plot plain numeric data as :ref:`date-format` or need to set
9+
a timezone, call ``ax.xaxis.axis_date`` / ``ax.yaxis.axis_date`` before
10+
`~.Axes.plot`. See `.Axis.axis_date`.

‎lib/matplotlib/axes/_axes.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1742,17 +1742,17 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
17421742
self._request_autoscale_view("y")
17431743
return lines
17441744

1745+
@_api.deprecated("3.9", alternative="plot")
17451746
@_preprocess_data(replace_names=["x", "y"], label_namer="y")
17461747
@_docstring.dedent_interpd
17471748
def plot_date(self, x, y, fmt='o', tz=None, xdate=True, ydate=False, 10000
17481749
**kwargs):
17491750
"""
1750-
[*Discouraged*] Plot coercing the axis to treat floats as dates.
1751+
Plot coercing the axis to treat floats as dates.
17511752
1752-
.. admonition:: Discouraged
1753+
.. deprecated:: 3.9
17531754
1754-
This method exists for historic reasons and will be deprecated in
1755-
the future.
1755+
This method exists for historic reasons and will be removed in version 3.11.
17561756
17571757
- ``datetime``-like data should directly be plotted using
17581758
`~.Axes.plot`.

‎lib/matplotlib/tests/test_axes.py

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -870,7 +870,8 @@ def test_single_date():
870870
data1 = [-65.54]
871871

872872
fig, ax = plt.subplots(2, 1)
873-
ax[0].plot_date(time1 + dt, data1, 'o', color='r')
873+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
874+
ax[0].plot_date(time1 + dt, data1, 'o', color='r')
874875
ax[1].plot(time1, data1, 'o', color='r')
875876

876877

@@ -6897,11 +6898,13 @@ def test_date_timezone_x():
68976898
# Same Timezone
68986899
plt.figure(figsize=(20, 12))
68996900
plt.subplot(2, 1, 1)
6900-
plt.plot_date(time_index, [3] * 3, tz='Canada/Eastern')
6901+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
6902+
plt.plot_date(time_index, [3] * 3, tz='Canada/Eastern')
69016903

69026904
# Different Timezone
69036905
plt.subplot(2, 1, 2)
6904-
plt.plot_date(time_index, [3] * 3, tz='UTC')
6906+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
6907+
plt.plot_date(time_index, [3] * 3, tz='UTC')
69056908

69066909

69076910
@image_comparison(['date_timezone_y.png'])
@@ -6914,12 +6917,13 @@ def test_date_timezone_y():
69146917
# Same Timezone
69156918
plt.figure(figsize=(20, 12))
69166919
plt.subplot(2, 1, 1)
6917-
plt.plot_date([3] * 3,
6918-
time_index, tz='Canada/Eastern', xdate=False, ydate=True)
6920+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
6921+
plt.plot_date([3] * 3, time_index, tz='Canada/Eastern', xdate=False, ydate=True)
69196922

69206923
# Different Timezone
69216924
plt.subplot(2, 1, 2)
6922-
plt.plot_date([3] * 3, time_index, tz='UTC', xdate=False, ydate=True)
6925+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
6926+
plt.plot_date([3] * 3, time_index, tz='UTC', xdate=False, ydate=True)
69236927

69246928

69256929
@image_comparison(['date_timezone_x_and_y.png'], tol=1.0)
@@ -6932,11 +6936,13 @@ def test_date_timezone_x_and_y():
69326936
# Same Timezone
69336937
plt.figure(figsize=(20, 12))
69346938
plt.subplot(2, 1, 1)
6935-
plt.plot_date(time_index, time_index, tz='UTC', ydate=True)
6939+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
6940+
plt.plot_date(time_index, time_index, tz='UTC', ydate=True)
69366941

69376942
# Different Timezone
69386943
plt.subplot(2, 1, 2)
6939-
plt.plot_date(time_index, time_index, tz='US/Eastern', ydate=True)
6944+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
6945+
plt.plot_date(time_index, time_index, tz='US/Eastern', ydate=True)
69406946

69416947

69426948
@image_comparison(['axisbelow.png'], remove_text=True)

‎lib/matplotlib/tests/test_datetime.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -657,9 +657,10 @@ def test_plot_date(self):
657657
x_ranges = np.array(range(1, range_threshold))
658658
y_ranges = np.array(range(1, range_threshold))
659659

660-
ax1.plot_date(x_dates, y_dates)
661-
ax2.plot_date(x_dates, y_ranges)
662-
ax3.plot_date(x_ranges, y_dates)
660+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
661+
ax1.plot_date(x_dates, y_dates)
662+
ax2.plot_date(x_dates, y_ranges)
663+
ax3.plot_date(x_ranges, y_dates)
663664

664665
@pytest.mark.xfail(reason="Test for quiver not written yet")
665666
@mpl.style.context("default")

‎lib/mpl_toolkits/axes_grid1/tests/test_axes_grid1.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ def test_twin_axes_empty_and_removed():
9393

9494
def test_twin_axes_both_with_units():
9595
host = host_subplot(111)
96-
host.plot_date([0, 1, 2], [0, 1, 2], xdate=False, ydate=True)
96+
with pytest.warns(mpl.MatplotlibDeprecationWarning):
97+
host.plot_date([0, 1, 2], [0, 1, 2], xdate=False, ydate=True)
9798
twin = host.twinx()
9899
twin.plot(["a", "b", "c"])
99100
assert host.get_yticklabels()[0].get_text() == "00:00:00"

0 commit comments

Comments
 (0)
0