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

Skip to content

ENH: Add argument size validation to quiver. #14424

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
Aug 30, 2019
Merged

ENH: Add argument size validation to quiver. #14424

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
20 changes: 17 additions & 3 deletions lib/matplotlib/quiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,16 @@
U, V : 1D or 2D array-like
The x and y direction components of the arrow vectors.

They must have the same number of elements, matching the number of arrow
locations. They may be masked.
Copy link
Member

Choose a reason for hiding this comment

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

With the same mask or is different allowed?

Copy link
Member Author

Choose a reason for hiding this comment

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

They can be different. The masks are combined so that a masked point in any of U, V, or C is the same as if all were masked.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe more precisely

Elements that are masked in U or V are not drawn.

instead of just just

They may be masked.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
locations. They may be masked.
locations. *U* and *V* may be masked. Only locations unmasked in *U*, *V*, and *C* will be drawn.

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 commiting this suggested change will cause problems due to the line being too long for flake?

Copy link
Member

Choose a reason for hiding this comment

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

That is likely true...


C : 1D or 2D array-like, optional
Numeric data that defines the arrow colors by colormapping via *norm* and
*cmap*.

This does not support explicit colors. If you want to set colors directly,
use *color* instead.
use *color* instead. The size of *C* must match the number of arrow
locations.

units : {'width', 'height', 'dots', 'inches', 'x', 'y' 'xy'}, default: 'width'
The arrow dimensions (except for *length*) are measured in multiples of
Expand Down Expand Up @@ -425,10 +429,13 @@ def _parse_args(*args, caller_name='function'):
Y = Y.ravel()
if len(X) == nc and len(Y) == nr:
X, Y = [a.ravel() for a in np.meshgrid(X, Y)]
elif len(X) != len(Y):
raise ValueError('X and Y must be the same size, but '
f'X.size is {X.size} and Y.size is {Y.size}.')
else:
indexgrid = np.meshgrid(np.arange(nc), np.arange(nr))
X, Y = [np.ravel(a) for a in indexgrid]

# Size validation for U, V, C is left to the set_UVC method.
return X, Y, U, V, C


Expand Down Expand Up @@ -588,9 +595,16 @@ def set_UVC(self, U, V, C=None):
# to an array that might change before draw().
U = ma.masked_invalid(U, copy=True).ravel()
V = ma.masked_invalid(V, copy=True).ravel()
mask = ma.mask_or(U.mask, V.mask, copy=False, shrink=True)
if C is not None:
C = ma.masked_invalid(C, copy=True).ravel()
for name, var in zip(('U', 'V', 'C'), (U, V, C)):
if var is not None and var.size != self.N:
raise ValueError(f'Argument {name} has a size {var.size}'
f' which does not match {self.N},'
' the number of arrow positions')

mask = ma.mask_or(U.mask, V.mask, copy=False, shrink=True)
if C is not None:
mask = ma.mask_or(mask, C.mask, copy=False, shrink=True)
if mask is ma.nomask:
C = C.filled()
Expand Down
21 changes: 21 additions & 0 deletions lib/matplotlib/tests/test_quiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,27 @@ def test_quiver_number_of_args():
plt.quiver(X, X, X, X, X, X)


def test_quiver_arg_sizes():
X2 = [1, 2]
X3 = [1, 2, 3]
with pytest.raises(ValueError,
match=('X and Y must be the same size, but '
'X.size is 2 and Y.size is 3.')):
plt.quiver(X2, X3, X2, X2)
with pytest.raises(ValueError,
match=('Argument U has a size 3 which does not match 2,'
' the number of arrow positions')):
plt.quiver(X2, X2, X3, X2)
with pytest.raises(ValueError,
match=('Argument V has a size 3 which does not match 2,'
' the number of arrow positions')):
plt.quiver(X2, X2, X2, X3)
with pytest.raises(ValueError,
match=('Argument C has a size 3 which does not match 2,'
' the number of arrow positions')):
plt.quiver(X2, X2, X2, X2, X3)


def test_no_warnings():
fig, ax = plt.subplots()

Expand Down