Skip to content

MNT: Deprecate date_ticker_factory #23081

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 2 commits into from
May 21, 2022
Merged

MNT: Deprecate date_ticker_factory #23081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
711afeb
Deprecate date_ticker_factory
oscargus May 20, 2022
56909f4
Update doc/api/next_api_changes/deprecations/23081-OG.rst
oscargus May 21, 2022
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
8 changes: 8 additions & 0 deletions doc/api/next_api_changes/deprecations/23081-OG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
``date_ticker_factory`` deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``date_ticker_factory`` method in the `matplotlib.dates` module is
deprecated. Instead use `~.AutoDateLocator` and `~.AutoDateFormatter` for a
more flexible and scalable locator and formatter.

If you need the exact ``date_ticker_factory`` behavior, please copy the code.
2 changes: 2 additions & 0 deletions lib/matplotlib/dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1782,6 +1782,8 @@ def num2epoch(d):
return np.asarray(d) * SEC_PER_DAY - dt


@_api.deprecated("3.6", alternative="`AutoDateLocator` and `AutoDateFormatter`"
" or vendor the code")
def date_ticker_factory(span, tz=None, numticks=5):
"""
Create a date locator with *numticks* (approx) and a date formatter
Expand Down
5 changes: 3 additions & 2 deletions lib/matplotlib/tests/test_dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1319,8 +1319,9 @@ def test_concise_formatter_call():
(200, mdates.MonthLocator),
(2000, mdates.YearLocator)))
def test_date_ticker_factory(span, expected_locator):
locator, _ = mdates.date_ticker_factory(span)
assert isinstance(locator, expected_locator)
with pytest.warns(_api.MatplotlibDeprecationWarning):
locator, _ = mdates.date_ticker_factory(span)
assert isinstance(locator, expected_locator)


def test_usetex_newline():
Expand Down