-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Add support for multiple hatches, edgecolors and linewidths in histograms #28073
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
Conversation
|
I'd suggest showing what this does with an example either in the GitHub pr description, or ideally in the gallery |
|
I'm not really sure if I need to add a new test or just modify an exisiting one(test_hist_stacked_bar) in test_axes.py |
|
I guess there are two things here:
|
|
pinging @story645 for review. The failing tests are unrelated |
story645
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also needs updated documentation that the patch properties are now vectorized (@timhoffm any concerns here?)
What should we be concerned about? We already have vectorized This should also get a what's new entry. |
My bias is vectorize everything so I don't have concerns, but in the past for some vectorization discussions there have been concerns about the tradeoffs. But if there isn't opposition, awesome! |
|
I don't see any drawbacks for |
|
So we are planning to vectorize all parameters of Patches? Like joinstyle, capstyle etc. |
Not at this time w/ the current architecture, especially because nobody has asked for those. |
150c63b to
2351cbd
Compare
|
Codecov is acting fishy, it passed once and failed again after squashing. Anything else to add/change? |
|
As of the last commit, this behavior is consistent for all histtypes unless mentioned otherwise:
|
|
@Impaler343 I started trying to flow chart that and then realized it's probably clearer as a table. Let me know if this jives with what you're saying:
|
Have bolded the corrected ones |
|
I'm unable to fix CircleCI errors for docs. Could someone help me out? |
|
Hi, so the error is in your what's new: /home/circleci/project/doc/users/next_whats_new/histogram_vectorized_parameters.rst:47: WARNING: Explicit markup ends without a blank line; unexpected unindent. error: https://app.circleci.com/pipelines/github/matplotlib/matplotlib/31532/workflows/2533c013-7833-4d0c-ae72-dead7c7fbc76/jobs/83481?invite=true#step-113-207133_109 |
|
Ok it turns out the vectorization of
|
I think this input is ambiguous cause it can mean either:
So I think it's ok to error out (unless/until someone comes around expecting 1 or 2) but we should maybe special case and have a better error message, like if not all(colors) (if any are NaN) "Ambiguous color specification: colors in the list may not be None" Or something like that. |
|
The added lines have all been covered, codecov seems to still fail |
|
Cause I think this maybe got lost, I was suggesting that this construction makes the skip case clearer: for patch, lbl in itertools.zip_longest(patches, labels):
if not patch: continue
p = patch[0]
kwargs.update({
'hatch': next(hatches),
'linewidth': next(linewidths),
'linestyle': next(linestyles),
'edgecolor': next(edgecolors),
'facecolor': next(facecolors),
})
p._internal_update(kwargs)
if lbl is not None:
p.set_label(lbl)
for p in patch[1:]:
p._internal_update(kwargs)
p.set_label('_nolegend_') |
story645
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for all your patience and extra thanks for tracing through and figuring out and testing our histogram color semantics/precedence 😅
I think the plot tests are now at a state where it's easy to see which parameter failed but there's also now only six image tests.
I'm pretty sure that the color semantics test doesn't try to draw anything but there might be a "build only artist tree" function that I'm missing.
lib/matplotlib/tests/test_axes.py
Outdated
| def test_hist_none_patch(): | ||
| # To cover None patches when excess labels are provided | ||
| labels = ["First", "Second"] | ||
| patches = [[1, 2]] | ||
| fig, ax = plt.subplots() | ||
| ax.hist(patches, label=labels) | ||
| _, lbls = ax.get_legend_handles_labels() | ||
| assert (len(lbls) < len(labels) and len(patches) < len(labels)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please elaborate what this tests? What are None patches? Does this express what you want to test?
| def test_hist_none_patch(): | |
| # To cover None patches when excess labels are provided | |
| labels = ["First", "Second"] | |
| patches = [[1, 2]] | |
| fig, ax = plt.subplots() | |
| ax.hist(patches, label=labels) | |
| _, lbls = ax.get_legend_handles_labels() | |
| assert (len(lbls) < len(labels) and len(patches) < len(labels)) | |
| def test_hist_unused_labels(): | |
| # When a list with one dataset and N elements is provided and N labels, ensure | |
| # hat the first label is used for the dataset and all other labels are ignored | |
| fig, ax = plt.subplots() | |
| ax.hist([[1, 2, 3]], label=["values", "unused", "also unused"]) | |
| _, labels = ax.get_legend_handles_labels() | |
| assert labels == ["values"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
None patches are the ones generated when the number of labels specified are more than the number of patches(Filled in by zip_longest). The suggested test also covers the line and has clearer labels, ill change it up
|
#28533 reminded me that this should get a versionadded directive https://matplotlib.org/devdocs/devel/api_changes.html#announce-new-and-deprecated-api |
|
The doc build failure could be fixed by rebasing on |
|
I'm so glad that this finally got merged! Thank you for the timely reviews |
|
Thanks for keeping up with all the reviews! |
PR summary
Closes #26718 Distributes keyword args passed to each Patch using a cycler. Probably not the best way to do this?
PR checklist