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

Skip to content

Fix interaction between sticky_edges and shared axes. #16450

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

Merged
merged 1 commit into from
Feb 10, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Feb 9, 2020

PR Summary

Closes #16448; see description there.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer anntzer added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Feb 9, 2020
@anntzer anntzer added this to the v3.2.0 milestone Feb 9, 2020
# `get_children` would raise an AttributeError.
if self._xmargin and scalex and self._autoscaleXon:
x_stickies = np.sort(np.concatenate([
artist.sticky_edges.x
Copy link
Member

Choose a reason for hiding this comment

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

Even w/ the comment, the hasattr(ax, "lines") is a bit mysterious to me. Why are you singling out lines in particular versus other children? Why does ax.get_children error out? It should just return None, shouldn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It doesn't matter which children you pick, the point is that for twinned axes this is called even before the lines attribute is created (i.e. the first time self.lines = [] is called on the Axes ever), so get_children() just raises an AttributeError when it tries to return self.lines (among other children). (Yes, Axes init is a mess.)

Copy link
Member

Choose a reason for hiding this comment

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

I believe you, but this seems to be a band-aid rather than fixing the underlying issue, which is that get_children is not working or self.lines should be set (I guess by calling cla)?

I don't understand how self.lines is not created since __init__ calls cla...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, but cla() calls self._sharex.get_xlim() even before setting self.lines, and get_xlim causes a call to unstale_viewLim and tragedy occurs.
Really self.lines should be set even earlier in __init__, and cla() should not do self.lines = [] but just for child in self.get_children(): child.remove() (IOW it's not cla()'s job to create the attributes, just to clear them out) but I'm not going to touch that here...

Copy link
Member

Choose a reason for hiding this comment

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

Can we change get_children to do:

if not hasattr(self, 'lines'):
    # sometimes we haven't even initialized the artist lists yet:
   return []    # or None?  

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually I think this is more likely to hide bugs -- normally no one should call get_children() that early in the axes init process, so I'd rather just workaround this in the sole place I know this can happen. But I can also apply your patch if you really prefer that.

Copy link
Member

Choose a reason for hiding this comment

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

Its just really mystifying why the check would be there, even with the comment.

Copy link
Member

Choose a reason for hiding this comment

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

It is a shorthand for "is the Axes actually built yet?". Agree it would be better if we could be sure that we never call this method before the Axes is fully set up, but short of re-writing the Axes init process (which is if I understand it one of our biggest performance bottle knecks) and making sure things like this that need to be computed don't get computed until as late as possible, we have to put a band-aid someplace.

I agree with @anntzer that putting this check in get_children is likely to mask other bugs in addition to solving this one.

We can't put the fix outside of this function because we may need the rest of it to run.

We could explicitly add state _done_initing, but that get awkward when you start to have sub-classes as now the order (or if!) the subclass calls super ends up really mattering.

@jklymak jklymak merged commit 4312b06 into matplotlib:master Feb 10, 2020
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Feb 10, 2020
@anntzer anntzer deleted the sticky-shared branch February 10, 2020 20:34
tacaswell added a commit that referenced this pull request Feb 10, 2020
…450-on-v3.2.x

Backport PR #16450 on branch v3.2.x (Fix interaction between sticky_edges and shared axes.)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bad interaction between shared axes and pcolormesh sticky edges
3 participants