Skip to content

plt.stairs: fix unit handling for orientation="horizontal" #31666

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
story645 merged 1 commit into from
May 17, 2026
+6 −2
Merged

plt.stairs: fix unit handling for orientation="horizontal" #31666

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
8 changes: 6 additions & 2 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7827,8 +7827,12 @@ def stairs(self, values, edges=None, *,
if edges is None:
edges = np.arange(len(values) + 1)

edges, values, baseline = self._process_unit_info(
[("x", edges), ("y", values), ("y", baseline)], kwargs)
if orientation == "vertical":
edges, values, baseline = self._process_unit_info(
[("x", edges), ("y", values), ("y", baseline)], kwargs)
else:
edges, values, baseline = self._process_unit_info(
[("y", edges), ("x", values), ("x", baseline)], kwargs)
Comment on lines +7833 to +7835

@story645 story645 May 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since vertical is the default, should it be the fallback position? Or will this error out if an orientation besides horizontal or vertical is provided?

@stiglers-eponym stiglers-eponym May 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I just followed the convention that is used in mpatches.StepPatch (in patches.py) to which orientation is passed. The current behavior is that any value that is not "vertical" will be interpreted like "horizontal".

One can of course change this behavior, but that was not my intention in this PR.

@story645 story645 May 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I hear that that's a separate discussion. I'm also wondering why stairs has to do unit processing if it's being done inside the patch creation code. Is it cause of:

https://github.com/stiglers-eponym/matplotlib/blob/6bcc38ad70066c391e327884af8bf917975cfd3f/lib/matplotlib/axes/_axes.py#L7855-L7863

And if so can that information be populated from patch.get_data()?

@timhoffm timhoffm May 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The issue is that Artists are currently not responsible for data limit handling. For the patch itself, this is done in add_patch() through _update_patch_limits(). But I suspect this cannot handle the sticky edges of the baseline, and it would not be reasonable to special case this there. Therefore, the baseline handling is left directly to stairs(), which implies the need for unit conversion.

The long-term solution will be #30342. I don't think a partial rewrite to handle the current limitations in another way is reasonable. Therefore, the proposed minimal fix is the way to go.


patch = mpatches.StepPatch(values,
edges,
Expand Down
Loading