Skip to content
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.

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

Add deprecation for setting data with non sequence type in Line2D #25196

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/api/next_api_changes/deprecations/25196-EP.rst
@@ -0,0 +1,4 @@
``Line2D``
~~~~~~~~~~
When creating a Line2D or using `.Line2D.set_xdata` and `.Line2D.set_ydata`,
passing x/y data as non sequence is deprecated.
18 changes: 16 additions & 2 deletions lib/matplotlib/lines.py
Expand Up @@ -1274,7 +1274,14 @@ def set_xdata(self, x):
x : 1D array
"""
if not np.iterable(x):
raise RuntimeError('x must be a sequence')
# When deprecation cycle is completed
# raise RuntimeError('x must be a sequence')
_api.warn_deprecated(
since=3.7,
message="Setting data with a non sequence type "
"is deprecated since %(since)s and will be "
"remove %(removal)s")
x = [x, ]
self._xorig = copy.copy(x)
self._invalidx = True
self.stale = True
Expand All @@ -1288,7 +1295,14 @@ def set_ydata(self, y):
y : 1D array
"""
if not np.iterable(y):
raise RuntimeError('y must be a sequence')
# When deprecation cycle is completed
# raise RuntimeError('y must be a sequence')
_api.warn_deprecated(
since=3.7,
message="Setting data with a non sequence type "
"is deprecated since %(since)s and will be "
"remove %(removal)s")
y = [y, ]
self._yorig = copy.copy(y)
self._invalidy = True
self.stale = True
Expand Down
8 changes: 6 additions & 2 deletions lib/matplotlib/tests/test_lines.py
Expand Up @@ -20,6 +20,7 @@
import matplotlib.pyplot as plt
import matplotlib.transforms as mtransforms
from matplotlib.testing.decorators import image_comparison, check_figures_equal
from matplotlib._api.deprecation import MatplotlibDeprecationWarning


def test_segment_hits():
Expand Down Expand Up @@ -91,9 +92,12 @@ def test_invalid_line_data():
mlines.Line2D([], 1)

line = mlines.Line2D([], [])
with pytest.raises(RuntimeError, match='x must be'):
# when deprecation cycle is completed
# with pytest.raises(RuntimeError, match='x must be'):
with pytest.warns(MatplotlibDeprecationWarning):
line.set_xdata(0)
with pytest.raises(RuntimeError, match='y must be'):
# with pytest.raises(RuntimeError, match='y must be'):
with pytest.warns(MatplotlibDeprecationWarning):
line.set_ydata(0)


Expand Down