Skip to content

MNT: deprecate epoch2num/num2epoch #19483

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
May 11, 2021
Merged

MNT: deprecate epoch2num/num2epoch #19483

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
7 changes: 7 additions & 0 deletions doc/api/next_api_changes/deprecations/19483-JMK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
``epoch2num`` and ``num2epoch`` are deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These methods convert from unix timestamps to matplotlib floats, but are not
useed internally to matplotlib, and should not be needed by endusers.
To convert a unix timestamp to datetime, simply use
`datetime.datetime.utcfromtimestamp`, or to use numpy datetime64
``dt = np.datetim64(e*1e6, 'us')``.
3 changes: 3 additions & 0 deletions lib/matplotlib/dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1729,6 +1729,8 @@ def _get_interval(self):
return self._interval


@_api.deprecated("3.5",
alternative="mdates.date2num(datetime.utcfromtimestamp(e))")
def epoch2num(e):
"""
Convert UNIX time to days since Matplotlib epoch.
Expand All @@ -1750,6 +1752,7 @@ def epoch2num(e):
return (dt + np.asarray(e)) / SEC_PER_DAY


@_api.deprecated("3.5", alternative="mdates.num2date(e).timestamp()")
def num2epoch(d):
"""
Convert days since Matplotlib epoch to UNIX time.
Expand Down
20 changes: 11 additions & 9 deletions lib/matplotlib/tests/test_dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import matplotlib.pyplot as plt
from matplotlib.testing.decorators import image_comparison
import matplotlib.ticker as mticker
import matplotlib._api as _api


def test_date_numpyx():
Expand Down Expand Up @@ -1079,15 +1080,16 @@ def test_change_interval_multiples():


def test_epoch2num():
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we leave tests for deprecated features in place and run them with _api.suppress_matplotlib_deprecation_warning():.

mdates._reset_epoch_test_example()
mdates.set_epoch('0000-12-31')
assert mdates.epoch2num(86400) == 719164.0
assert mdates.num2epoch(719165.0) == 86400 * 2
# set back to the default
mdates._reset_epoch_test_example()
mdates.set_epoch('1970-01-01T00:00:00')
assert mdates.epoch2num(86400) == 1.0
assert mdates.num2epoch(2.0) == 86400 * 2
with _api.suppress_matplotlib_deprecation_warning():
mdates._reset_epoch_test_example()
mdates.set_epoch('0000-12-31')
assert mdates.epoch2num(86400) == 719164.0
assert mdates.num2epoch(719165.0) == 86400 * 2
# set back to the default
mdates._reset_epoch_test_example()
mdates.set_epoch('1970-01-01T00:00:00')
assert mdates.epoch2num(86400) == 1.0
assert mdates.num2epoch(2.0) == 86400 * 2


def test_julian2num():
Expand Down