Skip to content

Do not pass gridspec_kw to inner layouts in subplot_mosaic #24189

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
tacaswell merged 16 commits into from
Oct 21, 2022
Merged

Do not pass gridspec_kw to inner layouts in subplot_mosaic #24189

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8522e9e
Do not pass width/height ratios to nested layouts
joshbarrass Oct 16, 2022
666ab55
Add test case for width_ratios
joshbarrass Oct 16, 2022
57a0a01
Add test case for height_ratios
joshbarrass Oct 16, 2022
e23ebe3
Add behaviour change file
joshbarrass Oct 16, 2022
56b629d
Double backticks in rst
joshbarrass Oct 16, 2022
779caae
Rename to suit new PR
joshbarrass Oct 16, 2022
26cb4a4
Fix doc build warning (underline too short)
joshbarrass Oct 16, 2022
36d18ab
Completely disable passing of gridspec_kw to inner layouts
joshbarrass Oct 17, 2022
e4e83d4
Remove the new, now unneeded, nested_gw_kw dict
joshbarrass Oct 17, 2022
acf1d26
Apply doc(string) suggestions from code review
joshbarrass Oct 19, 2022
e584e8f
Shorter api change explanation
joshbarrass Oct 19, 2022
2a3e919
Shorter gridspec_kw docstring
joshbarrass Oct 19, 2022
a0f8cd9
Correction of function names in docstrings
joshbarrass Oct 19, 2022
ecf1aef
Modify behaviour msg to clarify the reasoning behind the change
joshbarrass Oct 20, 2022
cb9b48b
Clarify context of nested layouts in docstrings
joshbarrass Oct 21, 2022
b4307f7
Remove trailing whitespace
joshbarrass Oct 21, 2022
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
10 changes: 10 additions & 0 deletions doc/api/next_api_changes/behavior/24189-JB.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
``fig.subplot_mosaic`` no longer passes the ``gridspec_kw`` args to nested gridspecs.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For nested `.Figure.subplot_mosaic` layouts, it is almost always
inappropriate for *gridspec_kw* arguments to be passed to lower nest
levels, and these arguments are incompatible with the lower levels in
many cases. This dictionary is no longer passed to the inner
layouts. Users who need to modify *gridspec_kw* at multiple levels
should use `.Figure.subfigures` to get nesting, and construct the
inner layouts with `.Figure.subplots` or `.Figure.subplot_mosaic`.
12 changes: 8 additions & 4 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1838,21 +1838,25 @@ def subplot_mosaic(self, mosaic, *, sharex=False, sharey=False,
Defines the relative widths of the columns. Each column gets a
relative width of ``width_ratios[i] / sum(width_ratios)``.
If not given, all columns will have the same width. Equivalent
to ``gridspec_kw={'width_ratios': [...]}``.
to ``gridspec_kw={'width_ratios': [...]}``. This argument applies
only to the outer layout.
Comment thread
joshbarrass marked this conversation as resolved.
Resolved

height_ratios : array-like of length *nrows*, optional
Defines the relative heights of the rows. Each row gets a
relative height of ``height_ratios[i] / sum(height_ratios)``.
If not given, all rows will have the same height. Equivalent
to ``gridspec_kw={'height_ratios': [...]}``.
to ``gridspec_kw={'height_ratios': [...]}``. This argument
applies only to the outer layout.
Comment thread
joshbarrass marked this conversation as resolved.
Resolved

subplot_kw : dict, optional
Dictionary with keywords passed to the `.Figure.add_subplot` call
used to create each subplot.

gridspec_kw : dict, optional
Dictionary with keywords passed to the `.GridSpec` constructor used
to create the grid the subplots are placed on.
to create the grid the subplots are placed on. This argument
applies only to the outer layout. For more complex layouts, users
should use `.Figure.subfigures` to create the nesting.
Comment thread
joshbarrass marked this conversation as resolved.
Resolved

empty_sentinel : object, optional
Entry in the layout to mean "leave this space empty". Defaults
Expand Down Expand Up @@ -2022,7 +2026,7 @@ def _do_layout(gs, mosaic, unique_ids, nested):
# recursively add the nested mosaic
rows, cols = nested_mosaic.shape
nested_output = _do_layout(
gs[j, k].subgridspec(rows, cols, **gridspec_kw),
gs[j, k].subgridspec(rows, cols),
nested_mosaic,
*_identify_keys_and_nested(nested_mosaic)
)
Expand Down
20 changes: 20 additions & 0 deletions lib/matplotlib/tests/test_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -922,6 +922,26 @@ def test_nested_tuple(self, fig_test, fig_ref):
fig_ref.subplot_mosaic([["F"], [x]])
fig_test.subplot_mosaic([["F"], [xt]])

def test_nested_width_ratios(self):
x = [["A", [["B"],
["C"]]]]
width_ratios = [2, 1]

fig, axd = plt.subplot_mosaic(x, width_ratios=width_ratios)

assert axd["A"].get_gridspec().get_width_ratios() == width_ratios
assert axd["B"].get_gridspec().get_width_ratios() != width_ratios

def test_nested_height_ratios(self):
x = [["A", [["B"],
["C"]]], ["D", "D"]]
height_ratios = [1, 2]

fig, axd = plt.subplot_mosaic(x, height_ratios=height_ratios)

assert axd["D"].get_gridspec().get_height_ratios() == height_ratios
assert axd["B"].get_gridspec().get_height_ratios() != height_ratios

@check_figures_equal(extensions=["png"])
@pytest.mark.parametrize(
"x, empty_sentinel",
Expand Down