Skip to content

Fix #21101 Add validator to errorbar method #21266

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 10 commits into from
Oct 5, 2021
Merged

Fix #21101 Add validator to errorbar method #21266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
de1e5ba
add validator to errorbar method
Kislovskiy Oct 2, 2021
ec1da3b
add check when two inputs have negative numbers
Kislovskiy Oct 2, 2021
3496ba2
add test_xer_yerr_positive
Kislovskiy Oct 2, 2021
e2381b5
don't fail on test_units.py
Kislovskiy Oct 2, 2021
11b1c4b
add a comment to TypeError
Kislovskiy Oct 2, 2021
9b5bbe7
check None in check_if_negative
Kislovskiy Oct 4, 2021
b025271
fix wording & simplify function
Kislovskiy Oct 4, 2021
ced1eb2
Stage all changes in has_negative_values
Kislovskiy Oct 4, 2021
8f63438
allign wording in description and error
Kislovskiy Oct 4, 2021
9d182ae
add validator for timedelta
Kislovskiy Oct 4, 2021
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
15 changes: 14 additions & 1 deletion lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import logging
import math
from numbers import Integral, Number
from datetime import timedelta

import numpy as np
from numpy import ma
Expand Down Expand Up @@ -3180,7 +3181,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
errors.
- *None*: No errorbar.

Note that all error arrays should have *positive* values.
Note that all error arrays should have *non-negative* values.

See :doc:`/gallery/statistics/errorbar_features`
for an example on the usage of ``xerr`` and ``yerr``.
Expand Down Expand Up @@ -3284,6 +3285,18 @@ def errorbar(self, x, y, yerr=None, xerr=None,
if len(x) != len(y):
raise ValueError("'x' and 'y' must have the same size")

def has_negative_values(array):
if array is None:
return False
try:
return np.any(array < 0)
except TypeError: # if array contains 'datetime.timedelta' types
return np.any(array < timedelta(0))

if has_negative_values(xerr) or has_negative_values(yerr):
raise ValueError(
"'xerr' and 'yerr' must have non-negative values")

if isinstance(errorevery, Integral):
errorevery = (0, errorevery)
if isinstance(errorevery, tuple):
Expand Down
19 changes: 19 additions & 0 deletions lib/matplotlib/tests/test_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3513,6 +3513,25 @@ def test_errorbar_every_invalid():
ax.errorbar(x, y, yerr, errorevery='foobar')


def test_xerr_yerr_positive():
ax = plt.figure().subplots()

error_message = "'xerr' and 'yerr' must have non-negative values"

with pytest.raises(ValueError, match=error_message):
ax.errorbar(x=[0], y=[0], xerr=[[-0.5], [1]], yerr=[[-0.5], [1]])
with pytest.raises(ValueError, match=error_message):
ax.errorbar(x=[0], y=[0], xerr=[[-0.5], [1]])
with pytest.raises(ValueError, match=error_message):
ax.errorbar(x=[0], y=[0], yerr=[[-0.5], [1]])
with pytest.raises(ValueError, match=error_message):
x = np.arange(5)
y = [datetime.datetime(2021, 9, i * 2 + 1) for i in x]
ax.errorbar(x=x,
y=y,
yerr=datetime.timedelta(days=-10))


@check_figures_equal()
def test_errorbar_every(fig_test, fig_ref):
x = np.linspace(0, 1, 15)
Expand Down