NotificationsYou must be signed in to change notification settings
Fork8.1k
Star22.1k

Commit1133d85

committed

BUG: Warn when an existing layout manager changes to tight layout

1 parent8d2d4c2 commit1133d85Copy full SHA for 1133d85

File tree

2 files changed

+16

-2

lines changed

lib/matplotlib
- figure.py
- tests
  - test_figure.py

2 files changed

+16

-2

lines changed

`‎lib/matplotlib/figure.py‎`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -2506,6 +2506,10 @@ def _check_layout_engines_compat(self, old, new):`
`2506`	`2506`	`"""`
`2507`	`2507`	`ifoldisNoneornewisNone:`
`2508`	`2508`	`returnTrue`
	`2509`	`+ifisinstance(old,ConstrainedLayoutEngine) \`
	`2510`	`+andisinstance(new,TightLayoutEngine):`
	`2511`	`+_api.warn_external("The layout manager has been changed to "`
	`2512`	`+"'tight'.")`
`2509`	`2513`	`ifold.colorbar_gridspec==new.colorbar_gridspec:`
`2510`	`2514`	`returnTrue`
`2511`	`2515`	`# colorbar layout different, so check if any colorbars are on the`

`‎lib/matplotlib/tests/test_figure.py‎`

Lines changed: 12 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -571,7 +571,8 @@ def test_invalid_layouts():`
`571`	`571`
`572`	`572`	`# test that layouts can be swapped if no colorbar:`
`573`	`573`	`fig,ax=plt.subplots(layout="constrained")`
`574`		`-fig.set_layout_engine("tight")`
	`574`	`+withpytest.warns(UserWarning):`
	`575`	`+fig.set_layout_engine("tight")`
`575`	`576`	`assertisinstance(fig.get_layout_engine(),TightLayoutEngine)`
`576`	`577`	`fig.set_layout_engine("constrained")`
`577`	`578`	`assertisinstance(fig.get_layout_engine(),ConstrainedLayoutEngine)`
`@@ -581,7 +582,8 @@ def test_invalid_layouts():`
`581`	`582`	`pc=ax.pcolormesh(np.random.randn(2,2))`
`582`	`583`	`fig.colorbar(pc)`
`583`	`584`	`withpytest.raises(RuntimeError,match='Colorbar layout of new layout'):`
`584`		`-fig.set_layout_engine("tight")`
	`585`	`+withpytest.warns(UserWarning):`
	`586`	`+fig.set_layout_engine("tight")`
`585`	`587`	`fig.set_layout_engine("none")`
`586`	`588`	`withpytest.raises(RuntimeError,match='Colorbar layout of new layout'):`
`587`	`589`	`fig.set_layout_engine("tight")`
`@@ -598,6 +600,14 @@ def test_invalid_layouts():`
`598`	`600`	`fig.set_layout_engine("constrained")`
`599`	`601`
`600`	`602`
	`603`	`+deftest_layout_change_warning():`
	`604`	`+"""Raise a warning when an existing layout manager is changed to tight."""`
	`605`	`+forlayoutin ('constrained','compressed'):`
	`606`	`+fig,ax=plt.subplots(layout=layout)`
	`607`	`+withpytest.warns(UserWarning,match='The layout manager has been'):`
	`608`	`+plt.tight_layout()`
	`609`	`+`
	`610`	`+`
`601`	`611`	`@check_figures_equal(extensions=["png","pdf"])`
`602`	`612`	`deftest_add_artist(fig_test,fig_ref):`
`603`	`613`	`fig_test.dpi=100`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit1133d85

File tree

2 files changed

2 files changed

`‎lib/matplotlib/figure.py‎`

`‎lib/matplotlib/tests/test_figure.py‎`

0 commit comments