Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Deprecate plot_date #27850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2024
Merged

Deprecate plot_date #27850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/api/next_api_changes/deprecations/27850-REC.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
``plot_date``
~~~~~~~~~~~~~

Use of `~.Axes.plot_date` has been discouraged since Matplotlib 3.5 and the
function is now formally deprecated.

- ``datetime``-like data should directly be plotted using `~.Axes.plot`.
- If you need to plot plain numeric data as :ref:`date-format` or need to set
a timezone, call ``ax.xaxis.axis_date`` / ``ax.yaxis.axis_date`` before
`~.Axes.plot`. See `.Axis.axis_date`.
8 changes: 4 additions & 4 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1742,17 +1742,17 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
self._request_autoscale_view("y")
return lines

@_api.deprecated("3.9", alternative="plot")
@_preprocess_data(replace_names=["x", "y"], label_namer="y")
@_docstring.dedent_interpd
def plot_date(self, x, y, fmt='o', tz=None, xdate=True, ydate=False,
**kwargs):
"""
[*Discouraged*] Plot coercing the axis to treat floats as dates.
Plot coercing the axis to treat floats as dates.

.. admonition:: Discouraged
.. deprecated:: 3.9

This method exists for historic reasons and will be deprecated in
the future.
This method exists for historic reasons and will be removed in version 3.11.

- ``datetime``-like data should directly be plotted using
`~.Axes.plot`.
Expand Down
22 changes: 14 additions & 8 deletions lib/matplotlib/tests/test_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,8 @@ def test_single_date():
data1 = [-65.54]

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


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

# Different Timezone
plt.subplot(2, 1, 2)
plt.plot_date(time_index, [3] * 3, tz='UTC')
with pytest.warns(mpl.MatplotlibDeprecationWarning):
plt.plot_date(time_index, [3] * 3, tz='UTC')


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

# Different Timezone
plt.subplot(2, 1, 2)
plt.plot_date([3] * 3, time_index, tz='UTC', xdate=False, ydate=True)
with pytest.warns(mpl.MatplotlibDeprecationWarning):
plt.plot_date([3] * 3, time_index, tz='UTC', xdate=False, ydate=True)


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

# Different Timezone
plt.subplot(2, 1, 2)
plt.plot_date(time_index, time_index, tz='US/Eastern', ydate=True)
with pytest.warns(mpl.MatplotlibDeprecationWarning):
plt.plot_date(time_index, time_index, tz='US/Eastern', ydate=True)


@image_comparison(['axisbelow.png'], remove_text=True)
Expand Down
7 changes: 4 additions & 3 deletions lib/matplotlib/tests/test_datetime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,9 +657,10 @@ def test_plot_date(self):
x_ranges = np.array(range(1, range_threshold))
y_ranges = np.array(range(1, range_threshold))

ax1.plot_date(x_dates, y_dates)
ax2.plot_date(x_dates, y_ranges)
ax3.plot_date(x_ranges, y_dates)
with pytest.warns(mpl.MatplotlibDeprecationWarning):
ax1.plot_date(x_dates, y_dates)
ax2.plot_date(x_dates, y_ranges)
ax3.plot_date(x_ranges, y_dates)

@pytest.mark.xfail(reason="Test for quiver not written yet")
@mpl.style.context("default")
Expand Down
3 changes: 2 additions & 1 deletion lib/mpl_toolkits/axes_grid1/tests/test_axes_grid1.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ def test_twin_axes_empty_and_removed():

def test_twin_axes_both_with_units():
host = host_subplot(111)
host.plot_date([0, 1, 2], [0, 1, 2], xdate=False, ydate=True)
with pytest.warns(mpl.MatplotlibDeprecationWarning):
host.plot_date([0, 1, 2], [0, 1, 2], xdate=False, ydate=True)
twin = host.twinx()
twin.plot(["a", "b", "c"])
assert host.get_yticklabels()[0].get_text() == "00:00:00"
Expand Down