Factor out legend/figlegend nargs validation. #26189
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oscargus
reviewed
Jun 26, 2023
lib/matplotlib/tests/test_legend.py
Outdated
| @@ -453,16 +453,8 @@ def test_legend_label_arg(self): | |||
| def test_legend_label_three_args(self): | |||
| fig, ax = plt.subplots() | |||
| lines = ax.plot(range(10)) | |||
| with mock.patch('matplotlib.legend.Legend') as Legend: | |||
| with pytest.raises(Exception): | |||
There was a problem hiding this comment.
Should be possible to have an exact exception type (and matching error message)? (And below.)
Currently Figure.legend supposedly supports extra_args, forwarding them to the Legend constructor, but because all parameters of the Legend constructor except for the first two have become keyword-only, extra_args actually causes a TypeError to be raised when calling Legend(...) (try e.g. `plt.figlegend([], [], "right")`). So just don't bother with extra_args anymore, check the case of "more than two positional args" in _parse_legend_args, and also fix test_legend_label_three_args, which was actually hiding the above exception via a mock and not really testing a relevant case anymore.
oscargus
approved these changes
Jun 26, 2023
timhoffm
approved these changes
Jun 26, 2023
QuLogic
approved these changes
Jun 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently Figure.legend supposedly supports extra_args, forwarding them to the Legend constructor, but because all parameters of the Legend constructor except for the first two have become keyword-only, extra_args actually causes a TypeError to be raised when calling Legend(...) (try e.g.
plt.figlegend([], [], "right")). So just don't bother with extra_args anymore, check the case of "more than two positional args" in _parse_legend_args, and also fix test_legend_label_three_args, which was actually hiding the above exception via a mock and not really testing a relevant case anymore.PR summary
PR checklist