NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Raises ValueError on unequal lengths of labels and handles input#24063

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

grgkaran03 wants to merge5 commits intomatplotlib:mainfromgrgkaran03:kg-feature

Closed

Raises ValueError on unequal lengths of labels and handles input#24063

grgkaran03 wants to merge5 commits intomatplotlib:mainfromgrgkaran03:kg-feature

Conversation

Copy link

Contributor

grgkaran03 commentedOct 1, 2022•
edited
Loading

…_args

PR Summary

Verifying that the inputs are of a consistent length in _parse_legend_args.
Number of elements in handles and labels should be equal, addressing the issue#24050 .

PR Checklist

Tests and Styling

Has pytest style unit tests (andpytest passes).
IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).

grgkaran03 added3 commits

October 1, 2022 15:34

verifying that the inputs are of a consistent length in _parse_legend…

6a25122

…_args

verify consistency of length of handles and labels

f61fed4

verify length consistancy

9719a9a

Copy link

ContributorAuthor

grgkaran03 commentedOct 1, 2022

@QuLogic, please review the changes...
Also, how do I overcome these failing tests?

Copy link

Member

oscargus commentedOct 1, 2022

The failing tests are not related to your PR. However, your PR would need a test that checks that the exception is raised. This should probably go intohttps://github.com/matplotlib/matplotlib/blob/main/lib/matplotlib/tests/test_legend.py

Here is a similar test to see how to check for an exception:

matplotlib/lib/matplotlib/tests/test_legend.py

Lines 255 to 260 infd5cf5c

	deftest_legend_positional_handles_only(self):
	lines=plt.plot(range(10))
	withpytest.raises(TypeError,match='but found an Artist'):
	# a single arg is interpreted as labels
	# it's a common error to just pass handles
	plt.legend(lines)