BUG Ignore invisible axes in computing tight_layout #8244

Merged
merged 4 commits into from Mar 12, 2017

Conversation

Projects
None yet
7 participants
Contributor

ResidentMario commented Mar 8, 2017

cf. #8225

Should pass tests. But, we'll see. Maybe this has side-effects.

@ResidentMario ResidentMario Ignore invisible axes in computing tight_layout.
3989c06

tacaswell added this to the 2.0.1 (next bug fix release) milestone Mar 8, 2017

Contributor

tomspur commented Mar 9, 2017

This only fails pep8:
[gw1] linux -- Python 3.6.0 /home/travis/build/matplotlib/matplotlib/venv/bin/python /home/travis/build/matplotlib/matplotlib/lib/matplotlib/tight_layout.py:126:80: E501 line too long (99 > 79 characters) tight_bbox_raw = union([ax.get_tightbbox(renderer) for ax in subplots if ax.get_visible()])

Contributor

ResidentMario commented Mar 9, 2017

Gotcha. @tomspur Presumably I should add a test somewhere too, right?

These CIs are taking five-ever...

Contributor

tomspur commented Mar 9, 2017

Yes, a test/picture helps to understand this issue and stops from breaking it again :)

@ResidentMario ResidentMario another attempt; add a test
c23e5f6
@@ -157,6 +158,15 @@ def test_tight_layout8():
example_plot(ax, fontsize=24)
+@image_comparison(baseline_images=['tight_layout9'])
+def test_tight_layout9():
@tacaswell

tacaswell Mar 10, 2017

Owner

How is this passing? The baseline images have not been added...

@ResidentMario

ResidentMario Mar 10, 2017

Contributor

Bear with me here, I have no idea how matplotlib handles its tests. 😅 Was planning on getting back to this in a later commit, but you've caught me red-handed.

lib/matplotlib/tight_layout.py
@@ -123,6 +123,9 @@ def auto_adjust_subplotpars(fig, renderer,
for subplots, ax_bbox, (num1, num2) in zip(subplot_list,
ax_bbox_list,
num1num2_list):
+ if all([not ax.get_visible() for ax in subplots]):
@tacaswell

tacaswell Mar 10, 2017

Owner

shouldn't this just be filtering out invisible axes? subplots = [ax for ox in subplots if ax.get_visible()]

Would it make more sense to make sure what ever calls method does that filtering?

@WeatherGod

WeatherGod Mar 10, 2017

Member

yeah, I don't understand why you changed what I originally suggested. I suggested putting a filter in the list comprehension down below. Now, it does make sense to skip this iteration if all the axes in this group are invisible. So, I would put the filter in the list comprehension down below, and also change this one from a any to an all.

@WeatherGod

WeatherGod Mar 10, 2017

Member

grrr, I fail reading comprehension... you do have a all. But the filter should still be down below.

@ResidentMario

ResidentMario Mar 10, 2017 • edited

Contributor

The first commit tried that approach (see here).

But it actually failed to fix the issue. If you try to use that code with the original minimal failing example:

import matplotlib.pyplot as plt
f, axarr = plt.subplots(2, 2)
axarr[1][1].set_visible(False)
plt.tight_layout()

The union op will fail because the list comprehension will pass it an empty list ([]).

@ResidentMario

ResidentMario Mar 10, 2017

Contributor

Before making a PR, please check that your commit actually fixes the issue...ahem. 😅

Skipping the laying calculations altogether (the approach here) meanwhile seems to work.

@WeatherGod

WeatherGod Mar 10, 2017

Member

Yes, that's why you need both approaches. if a subset of the subplots are not visible, then the way the code is currently, the invisible axes still have get_tightbbox called on them, which would also fail. You need to protect that (my original approach), and protect from a union() call on an empty list (your current approach).

@ResidentMario

ResidentMario Mar 10, 2017

Contributor

OK, I understand you now—I've re-added the conditional check.

Owner

tacaswell commented Mar 10, 2017

attn @NelleV @anntzer @Kojoley Something is going wrong with pytest here. Running this locally I get:

15:47 $ python -m pytest -vv lib/matplotlib/tests/test_tightlayout.py 
========================================================================================================================================================================================================= test session starts ==========================================================================================================================================================================================================
platform linux -- Python 3.6.0, pytest-3.0.6, py-1.4.32, pluggy-0.4.0 -- /tmp/mpl_stock/bin/python
cachedir: .cache
rootdir: /home/tcaswell/source/p/matplotlib, inifile: pytest.ini
collected 36 items 

lib/matplotlib/tests/test_tightlayout.py::test_tight_layout1[0-tight_layout1-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout1[0-tight_layout1-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout1[0-tight_layout1-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout2[0-tight_layout2-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout2[0-tight_layout2-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout2[0-tight_layout2-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout3[0-tight_layout3-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout3[0-tight_layout3-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout3[0-tight_layout3-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout4[0-tight_layout4-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py XPASS
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout4[0-tight_layout4-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py XPASS
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout4[0-tight_layout4-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py XPASS
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout5[0-tight_layout5-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout5[0-tight_layout5-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout5[0-tight_layout5-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout6[0-tight_layout6-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout6[0-tight_layout6-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout6[0-tight_layout6-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout7[0-tight_layout7-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout7[0-tight_layout7-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout7[0-tight_layout7-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout8[0-tight_layout8-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout8[0-tight_layout8-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout8[0-tight_layout8-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout9[0-tight_layout9-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py xfail
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout9[0-tight_layout9-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py xfail
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout9[0-tight_layout9-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py xfail
lib/matplotlib/tests/test_tightlayout.py::test_outward_ticks[0-outward_ticks-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_outward_ticks[0-outward_ticks-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_outward_ticks[0-outward_ticks-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout_offsetboxes[0-tight_layout_offsetboxes1-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout_offsetboxes[0-tight_layout_offsetboxes1-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout_offsetboxes[0-tight_layout_offsetboxes1-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout_offsetboxes[1-tight_layout_offsetboxes2-png] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout_offsetboxes[1-tight_layout_offsetboxes2-pdf] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED
lib/matplotlib/tests/test_tightlayout.py::test_tight_layout_offsetboxes[1-tight_layout_offsetboxes2-svg] <- /home/tcaswell/source/p/matplotlib/lib/matplotlib/tests/test_tightlayout.py PASSED

=========================================================================================================================================================================================== 30 passed, 3 xfailed, 3 xpassed in 10.63 seconds ===========================================================================================================================================================================================

I would expect the three xfail to be real fails (due to missing files).

Contributor

anntzer commented Mar 10, 2017

This is the culprit (decorators.py, copy_baseline):

        if os.path.exists(orig_expected_fname):
            shutil.copyfile(orig_expected_fname, expected_fname)
        else:
            reason = ("Do not have baseline image {0} because this "
                      "file does not exist: {1}".format(expected_fname,
                                                        orig_expected_fname))
            if is_called_from_pytest():
                import pytest
                pytest.xfail(reason)
            else:
                from ._nose import knownfail
                knownfail(reason)
        return expected_fname

I would just remove that chunk and replace by a real fail in the actual test function.

Owner

tacaswell commented Mar 10, 2017

See #8262 for a fix to my previous comment, sorry to have hi-jacked this PR with other issues.

Contributor

ResidentMario commented Mar 10, 2017

Always happy to be breaking things productively. 👍

ResidentMario added some commits Mar 10, 2017

@ResidentMario ResidentMario re-add conditional check.
53b5aa3
@ResidentMario ResidentMario append test images.
761e7f6
Contributor

ResidentMario commented Mar 12, 2017

This passes tests locally, except for an unrelated error in tight_layout8. A different unrelated failure appears to occur on travis (which reset and is now running again for some reason?).

Contributor

NelleV commented Mar 12, 2017

We have some flaky test, so we sometimes restart some tests by hand (hence travis rerunning magically :) )

Contributor

ResidentMario commented Mar 12, 2017

All green. LGTM?

@tacaswell

Only concern would be if we really need the image comparison tests here. The bug it is fixing is 'do raise'.

@NelleV NelleV merged commit 27f6781 into matplotlib:master Mar 12, 2017

5 checks passed

codecov/patch 100% of diff hit (target 80%)
Details
codecov/project/library 58.45% (+0.53%) compared to 8a77cfb
Details
codecov/project/tests 98.58% (target 97.9%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Contributor

NelleV commented Mar 12, 2017

Thanks @ResidentMario !

ResidentMario deleted the ResidentMario:8225 branch Mar 12, 2017

@@ -157,6 +158,15 @@ def test_tight_layout8():
example_plot(ax, fontsize=24)
+@image_comparison(baseline_images=['tight_layout9'])
+def test_tight_layout9():
@WeatherGod

WeatherGod Mar 16, 2017

Member

There are now two test functions in one file with the same name. So the first one gets clobbered by the second one.

@WeatherGod

WeatherGod Mar 16, 2017 • edited

Member

Sorry, please ignore. I misread test_tight_layout8 as test_tight_layout9. Really need to fix the default fonts on this computer...

@QuLogic QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Mar 27, 2017

@NelleV @QuLogic NelleV + QuLogic Merge pull request #8244 from ResidentMario/8225
BUG Ignore invisible axes in computing tight_layout
3ff1153

QuLogic removed the Needs backport label Mar 27, 2017

Member

QuLogic commented Mar 27, 2017

Backported to v2.0.x as 3ff1153.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment