-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[MRG] Constrained_layout (geometry manager) #9082
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 am interested in the specifics of how the legend will be constrained. Perhaps through an easily extensible mechanism that can be used to add other Also a mechanism for adding arbitrary text around the |
@has2k1 Thanks. I want to make sure I understand the desired behavior. We are getting into use cases I haven't ever needed for my personal plotting needs, so this is where I need help with what people envision. Are you hoping that if I call I think thats doable, but I need to think about how that gets implemented. Right now I just implement nested layouts and adjacent layouts w a pad. Arbitrarily displaced in axes co-ordinates is doable, but not implemented yet. I don't see why a subplotspec can't contain more than one child that also have displacements relative to their widths. I need to dig into |
As far as I can see See |
Yes.
Yes again. But I fear it would make the code complicated as it would mix two layout mechanisms. There are already four parameters to
And so it seems like Plotnine extensively [1] uses offsetboxes for the legends and it has very finicky parts. Here is a simplified version that demonstrates a custom legend system similar to the one in plotnine. |
@has2k1 Thanks a lot for the examples. That helps. I think it'll be possible to have |
@has2k1 this now makes space for legends. Since it actually queries the underlying See legend is a bit flakey as positions get set at the draw sequence, so for perversely large legends a resize is needed to make the legend fit properly. However, I think the method often yields a decent result. |
lib/matplotlib/constrained_layout.py
Outdated
for child in ax.get_children(): | ||
if isinstance(child, Legend): | ||
bboxn = child._legend_box.get_window_extent(renderer) | ||
bbox = transforms.Bbox.union([bbox, bboxn]) |
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.
I think this would be more specific in sniffing out the legend type stuff.
possible_legends = ax.artists + [ax.legend_] if ax.legend_ else []
for child in possible_legends:
if isinstance(child, (Legend, AnchoredOffsetbox)):
...
However, overall this is a neat little function that can bundle up all types of adornments to the axes (at the risk of complicating it).
I have encountered a related issue when creating an Animation class for plotnine. It may complicate animations, but on the whole specified figure sizes that are just rough estimates final sizes are a worthy price for a good layout. After all, |
@has2k1 Note that
It almost seems that See issue: #9130 |
Removed [WIP]. I think this works, but I'm sure there are edge cases I haven't found. |
|
@has2k1 Just to follow up on your legend examples above. Your first two examples work fine w/o any fiddling. The third example, where you want a global legend doesn't work, and indeed makes the layout collapse in on itself. I'm not sure how to handle this, as you specify the anchored box in figure co-ordinates, but anchor it to one of your subplots, ax1. The constrained_layout then uses the whole area taken up by ax1 and the legend to determine the area the layout needs. That leaves no room for the other subplots, and the whole thing fails. Right now I have "global" colorbars stacked to the right of the gridspec that contains the relevant subplot specs (or to the left, bottom etc). This is hard coded into |
|
The way the plot in the third example is constructed need not be how it should be done. In fact, using figure coordinates is part of the problem.
I have looked a little at what you currently have in place with the goal of making it extendable. i.e. For the
|
For SubplotSpec its pretty much done because it works on the difference between the spine However, we'd need an API for the
Edit: ...and do these artists then get layoutbox properties? |
@has2k1 How about this for an API: Right now we can do That seems the most flexible, and consitent with an API folks will already know. |
Yes an API of the the form gs.add_anchoredbox(anchored_box) is simple and straight forward. I agree with the fuzziness around some of the parameters of the anchored_box. The solution may be a new offsetbox (the 2nd point) A GridSpec that properly encloses an offsetbox of some kind will make composing/arranging multiple plots a lot easier. Packages that use MPL will get a lot more interesting, in fact this feature would rely on it. |
I am trying to get up to speed with what you have so far, but despite the plentiful comments I hit a road block on the do_constrained_layout function. |
@has2k1 Fair enough. I'll try and improve the comments. There may even be obsolete comments in there... |
I was hoping I could add comments from a third party perspective immediately after I understood what was going on. |
@has2k1 That would be fabulous. I just pushed a commit that improved a bit of the doc, and removed the obsolete document bits. Let me know if you have questions, or I can point you towards tests that show how the different parts work. It was all more subtle than I originally thought it would be. |
The pickle test is always going to fail for matplotlib instances that attach I need to change the architecture to only attach kiwisolver variables if |
Haven't followed the discussion at all, but re: pickling, you can perhaps remove the kiwisolver instance at pickle time (we already to that e.g. in |
Yes, a surprising number of people. When we break this we find out rapidly. |
Got it. Interesting interaction - I haven't played with interactive plotting much yet, except to change plot window size. This is clearly a bug in the |
I found another interactive glitch. Make a minimal plot: fig, ax = plt.subplots(constrained_layout=True)
ax.set_xlabel('X label', fontsize=20)
ax.plot([0, 1]) Now click the zoom/pan button and fiddle with the view limits. Then click the home button. Now the constraint management is no longer in effect: reducing the window height by dragging up the bottom chops off the bottom of the legend. |
@efiring - thanks a lot - try the latest commit. The second issue was some missed calls to The first issue was that I was setting both positions when I set the position in constrained layout. Setting only the original is the way to go, and allows |
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.
Partial review. Nothing major.
``figure`` keyword. This is backwards compatible, in that not supplying this | ||
will simply cause ``constrained_layout`` to not operate on the subplots | ||
orgainzed by this ``GridSpec`` instance. Routines that use ``GridSpec`` (i.e. | ||
``ax.subplots``) have been modified to pass the figure to ``GridSpec``. |
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.
should be fig.subplots
. Is that the only one? If there are others, the "i.e." should be "e.g.".
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.
I can never remember the difference between i.e. and e.g. The failure of not teaching latin in high school any more...
A new method to automatically decide spacing between subplots and their | ||
organizing ``GridSpec`` instances has been added. It is meant to | ||
replace the venerable ``tight_layout`` method. It is invoked via | ||
a new ``plt.figure(constrained_layout=True)`` kwarg to |
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.
Delete the "plt.figure".
lib/matplotlib/axes/_base.py
Outdated
@@ -568,11 +568,17 @@ def __init__(self, fig, rect, | |||
right=rcParams['ytick.right'] and rcParams['ytick.major.right'], | |||
which='major') | |||
|
|||
self.layoutbox = None | |||
self.poslayoutbox = None |
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.
Should these have leading underscores? Or are they intended to be part of the public API?
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.
Well, a) when I started, I didn't even know about _privatestuff
, so this naming was in ignorance. b) afterwards, I kind of thought that there may be occasion the knowledgable user would want access to these. However, I think I agree that we don't want this to be public because it could change, so I'll set accordingly.
lib/matplotlib/axes/_base.py
Outdated
@@ -879,6 +887,19 @@ def set_position(self, pos, which='both'): | |||
which : ['both' | 'active' | 'original'], optional | |||
Determines which position variables to change. | |||
|
|||
""" | |||
self._set_position(pos, which='both') | |||
# because this is being called esternally to the library we |
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.
-> "externally"
lib/matplotlib/axes/_base.py
Outdated
""" | ||
Set the spinelayoutbox for this axis... | ||
""" | ||
self.poslayoutbox = layoutbox |
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.
Is there a reason for using setters instead of directly assigning to the attributes? This is related to my question about whether the attributes are part of the API.
lib/matplotlib/axes/_subplots.py
Outdated
maxn=rows*cols, num=num)) | ||
self._subplotspec = GridSpec(rows, cols)[int(num) - 1] | ||
( | ||
"num must be 1 <= num <= {maxn}, not {num}" |
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.
The string could start on the line with the opening parenthesis.
lib/matplotlib/axes/_subplots.py
Outdated
if self.figure.get_constrained_layout(): | ||
gridspecfig = fig | ||
else: | ||
gridspecfig = None |
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.
I don't see gridspecfig being used in this function. And fig is not defined there, either. And the comment suggests that maybe this function should be deprecated, unless someone knows what the use case is.
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.
I'll remove the gridspecfig stuff. No idea about whether the fcn should be deprecated or not...
@@ -243,8 +244,9 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad, | |||
ax.poslayoutbox.edit_bottom_margin_min( | |||
-bbox.y0 + pos.y0 + h_padt) | |||
ax.poslayoutbox.edit_top_margin_min(bbox.y1-pos.y1+h_padt) | |||
# _log.debug('left %f' % (-bbox.x0 + pos.x0 + w_pad)) | |||
# _log.debug('right %f' % (bbox.x1 - pos.x1 + w_pad)) | |||
_log.debug('left %f' % (-bbox.x0 + pos.x0 + w_pad)) |
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.
no need to call %() yourself
lib/matplotlib/rcsetup.py
Outdated
@@ -1286,6 +1286,19 @@ def _validate_linestyle(ls): | |||
'figure.subplot.hspace': [0.2, ValidateInterval(0, 1, closedmin=True, | |||
closedmax=False)], | |||
|
|||
# do constrained_layout. | |||
'figure.constrainedlayout.do': [False, validate_bool], |
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.
Somehow the "do" grates on my aesthetic senses. Maybe "use" or "enable" or "active"? Regardless, the matplotlibrc.template also needs to be updated, since it presently has only "figure.constrainedlayout".
Also, since the kwarg is "constrained_layout", and that form (with underscore) seems prevalent (and readable), maybe the rcParam family name should match it. Unless we can think of something shorter... It's too bad "autolayout" is already used.
|
52a53a6
to
7d84999
Compare
squash + rebase |
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.
The comments are minor issues mainly about style and and clarity.
One issue I have not commented on anywhere is the name generation for the layoutboxes. It may be clearer to have the names generated in one function maybe Layoutbox.make_name
. The function would have an input type of layoutbox e.g 'subplotspec'
then return a unique name. And if you store the type (or whatever suitable name) as a property. You can check on it with child.type == 'subplotspec'
; this would limit the instances of +seq_id()
and the splitting on dots as they are largely a distraction when reading the code.
The other nitpick is just an irritant, the dots after the numbers i.e 0.
, 1.
. I'm not used to seeing them in python code.
lib/matplotlib/gridspec.py
Outdated
state = self.__dict__ | ||
try: | ||
state.pop('_layoutbox') | ||
except: |
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.
except KeyError
def __getstate__(self): | ||
# The renderer should be re-created by the figure, and then cached at | ||
# that point. | ||
state = super(_AxesBase, self).__getstate__() | ||
state['_cachedRenderer'] = None | ||
state.pop('_layoutbox') | ||
state.pop('_poslayoutbox') |
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.
You can use del state['_poslayoutbox']
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.
Is there an advantage? The other state calls are to pop()
.
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.
Other than the intention of the statement being clear. A pop()
is effectively
def pop(self, key):
value = self[key]
del self[key]
return value
invTransFig = fig.transFigure.inverted().transform_bbox | ||
|
||
# list of unique gridspecs that contain child axes: | ||
gss = set([]) |
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.
It does not look like gss
uses any set properties.
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.
It saves me from checking if the gridspec is already in the list.
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.
Ahh I see, axes do not have a 1:1 relationship with gridspecs. Subtle way to handle it.
sschildren = [] | ||
for child in gs.children: | ||
name = (child.name).split('.')[-1][:-3] | ||
if name == 'ss': |
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.
For clarity I think hiding the naming conventions behind functions like is_subplotspec(child)
and is_gridspec(child)
would help.
self._constrained_layout_pads['w_pad'] = None | ||
self._constrained_layout_pads['h_pad'] = None | ||
self._constrained_layout_pads['wspace'] = None | ||
self._constrained_layout_pads['hspace'] = None |
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.
I think this whole block can be contained in the set_constrained_layout
method.
lib/matplotlib/figure.py
Outdated
|
||
padd : dict | ||
Dictionary with possible keywords as above. If a keyword | ||
is specified then it takes precedence over the dictionary. |
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.
No need for padd
parameter, you can use do set_constrained_layout_pads(**constrained)
.
lib/matplotlib/figure.py
Outdated
constrained = rcParams['figure.constrained_layout.use'] | ||
self._constrained = bool(constrained) | ||
if isinstance(constrained, dict): | ||
self.set_constrained_layout_pads(padd=constrained) |
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.
self.set_constrained_layout_pads(**constrained)
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.
Yeah, I didn't know about this construct until recently. I think its a bit obscure that you can specify kwarg dictionaries this way, but perhaps you are correct that we should just make this simpler and use only this form from the start.
|
||
self.stale = True | ||
|
||
def set_constrained_layout_pads(self, **kwargs): |
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.
I think changing the signature of the method to set_constrained_layout_pads(self, w_pad=None, h_pad=None, ...)
, would make the logic below clearer.
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.
OK, I didn't quite get to setting those explicitly, because I wanted to have a for-loop over the possible kwargs, but I simplified as you suggested.
lib/matplotlib/gridspec.py
Outdated
state = self.__dict__ | ||
try: | ||
state.pop('_layoutbox') | ||
except: |
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.
Use del
and except KeyError:
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.
.... except I kept state.pop
just for consistency. If there is a good reason to del
, I can easily change.
I think if you don't do that in some languages you force integer arithmetic, which can be very unfortunate. i.e. 3./10. neq 3./10 Nice that doesn't happen in python, I'll try and find most instances and clean up. |
536dcae
to
13415f9
Compare
Thanks for the review @has2k1 I think I addressed most of your suggestions. Let me know about the pop/del thing. |
13415f9
to
f8dfea7
Compare
Rebase... |
I'm going to make an executive decision and merge this
Thanks @jklymak and everyone who put effort into reviewing this (particularly @has2k1 , @anntzer and @efiring )! |
Thanks a lot everyone! Now here comes the bug reports... 🦆 |
PR Summary
This is my implementation of the geometry manager (See #1109).
This is heavily based on exploratory work by @Tillsten using the
kiwi
solver, and of course ontight_layout
.Latest what's new: https://5396-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/users/next_whats_new/constrained_layout.html
Latest tutorial: https://5398-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/tutorials/intermediate/constrainedlayout_guide.html#sphx-glr-tutorials-intermediate-constrainedlayout-guide-py
Intro
tight_layout()
is great for what it does, but it doesn't handle some cases generally. i.e. if we have twoGridSpecFromSubplotSpec
instances, they need to be positioned manually usingtight_layout()
. Colorbars for individual axes work fine, but colorbars for more than one axis doesn't work. Etc.This PR implements "constrained_layout" via
plt.figure(constrained_layout=True)
for automatic re-drawing. Currently, it works for subplots and colorbars, legends, and suptitles. Nested gridspecs are respected. Spacing is provided both as a pad around axes and as a space between subplots.The following code gives this plot:
A few things to note in the above:
gsl
) have the same margins. They are a bit big because the bottom-right plot has a two-line x-label.constrained_layout
doesn't do any management at the axis level.Installation:
In addition to the normal
matplotlib
installation, you will need to involve kiwisolver:pip install kiwisolver
now works.API dfferences (so far)
In order to get this to work, there are a couple of API changes:
gridspec.GridSpec
now has afig
keyword. If this isn't supplied thenconstrained_layout
won't work.figure
now has aconstrained_layout
keyword. Currently, I don't have it checking fortight_layout
, so they could both run at the same time. These upper level user-facing decisions probaby require input.ax.set_position()
to participate inconstrained_layout
, presumably because the user was purposefully putting the axis where they put it. So, that means internally, we set thelayoutbox
properties of this axis toNone
. However,ax.set_position
gets called internally (i.e. bycolorbar
andaspect
) and for those we presumably want to keep constrained_layout as a possibility. So I made aax._set_position()
for internal calls, which the publicax.set_position()
uses. Internal calls toset_position
should use_set_position
if the axis is to continue to participate in constrained_layout.I think most of these changes are backwards compatible, in that if you don't want to use
constrained_layout
you don't need to change any calls. Backwards compatibility introduces some awkwardness, but is probably worth it.Implementation:
Implementation is via a new package
layoutbox.py
. Basically a nested array of layoutboxe objects are set up, attached to the figure, the gridspec(s), the subplotspecs. An axes has two layoutboxes: one that contains the tight bounding box of the axes, and the second that contains the "position" of the axes (i.e the rectangle that is passed toax.set_position()
).A linear constraint solver is used to decide dimensions. The trick here is that we define margins between an axes bounding box and its position. These margins, and the outer dimesnion of the plot (0,0,1,1) are what constrains the problem externally. Internally, the problem is constrained by relationships between the layoutboxes.
Tests:
These are in
lib/matplotlib/tests/test_constrainedlayout.py
.PR Checklist
legend
to constrained objectssuptitle
to constrained objectssharex
andsharey
?colorbars
; respectpad
.wspace
andhspace
variables. Actually pretty easy.set_position
axestwinx
,twiny
? tight_layout puts axes title below twiny xlabel #5474