FIX: do not consider webagg and nbagg "interactive" for fallback #15512

tacaswell · 2019-10-25T04:24:35Z

PR Summary

There is logic in pyplot to determine if the user has is some way
selected a backend which is incompatible with the interactive
framework that we detect is running. This helps prevent issues where
the user is already using one GUI frame work (ex tk) before Matplotlib
is imported and has Matplotlib configured to use Qt. The other place
this behavior is desired is if Matplotlib is configured to use a GUI
framework by default, but is then imported on a headless server. By
detecting there is no DISPLAY we fall back to Agg rather than failing
to import.

From the point of view of having UI events, webagg and nbagg are
interactive backends, however from the point of view of requiring
DISPLAY they are not.

This is the minimal fix, filtering out these two backends in pyplot
rather than changing this in rcsetup, incase anyone is relying on
those lists for other purposes.

closes #14903

This will backport badly due to the change in line light below this one but 🤷‍♀️

Will work on a test tomorrow.

lib/matplotlib/pyplot.py

tacaswell · 2019-10-25T12:28:33Z

force pushed to fix syntax.

tacaswell · 2019-10-28T02:37:12Z

env's don't work the same in windows?

There is logic in pyplot to determine if the user has is some way selected a backend which is incompatible with the interactive framework that we detect is running. This helps prevent issues where the user is already using one GUI frame work (ex tk) before Matplotlib is imported and has Matplotlib configured to use Qt. The other place this behavior is desired is if Matplotlib is configured to use a GUI framework by default, but is then imported on a headless server. By detecting there is no DISPLAY we fall back to Agg rather than failing to import. From the point of view of having UI events, webagg and nbagg are interactive backends, however from the point of view of requiring DISPLAY they are not. This is the minimal fix, filtering out these two backends in pyplot rather than changing this in rcsetup, incase anyone is relying on those lists for other purposes. closes matplotlib#14903

Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>

story645 · 2019-10-31T02:52:43Z

lib/matplotlib/tests/test_backend_webagg.py

+    ret = subprocess.call(
+        [sys.executable, "-c", test_code],


on windows these two lines work fine/return 'WebAgg' and 'nbAgg' respectively.

story645 · 2019-10-31T02:54:08Z

lib/matplotlib/tests/test_backend_webagg.py

+    )
+    ret = subprocess.call(
+        [sys.executable, "-c", test_code],
+        env={"MPLBACKEND": backend, "DISPLAY": ""}


this line, even just env={"MPLBACKEND": backend} or env={"DISPLAY": ""} triggers the windows failures

from the Python docs:

Note
If specified, env must provide any variables required for the program to execute. On Windows, in order to run a side-by-side assembly the specified env must include a valid SystemRoot.

@story645

thanks to @story645 for sorting this out

jklymak · 2019-10-31T15:51:15Z

I think this stuff really needs some docs somewhere or we will forget why we made this change.

tacaswell · 2019-10-31T21:27:33Z

@jklymak There is a long explanation in the commit message which we will see in the future when we check git blame.

dopplershift

Looks sane to me.

lumberbot-app · 2019-10-31T21:50:47Z

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

$ git checkout v3.1.x
$ git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

$ git cherry-pick -m1 126de7f92cf2f7cf32279bb60736ea5c115dd122

You will likely have some merge/cherry-pick conflict here, fix them and commit:

$ git commit -am 'Backport PR #15512: FIX: do not consider webagg and nbagg "interactive" for fallback'

Push to a named branch :

git push YOURFORK v3.1.x:auto-backport-of-pr-15512-on-v3.1.x

Create a PR against branch v3.1.x, I would have named this PR:

"Backport PR #15512 on branch v3.1.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

lumberbot-app · 2019-10-31T21:51:12Z

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

$ git checkout v3.2.x
$ git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

$ git cherry-pick -m1 126de7f92cf2f7cf32279bb60736ea5c115dd122

You will likely have some merge/cherry-pick conflict here, fix them and commit:

$ git commit -am 'Backport PR #15512: FIX: do not consider webagg and nbagg "interactive" for fallback'

Push to a named branch :

git push YOURFORK v3.2.x:auto-backport-of-pr-15512-on-v3.2.x

Create a PR against branch v3.2.x, I would have named this PR:

"Backport PR #15512 on branch v3.2.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

FIX: do not consider webagg and nbagg "interactive" for fallback

…"interactive" for fallback' FIX: do not consider webagg and nbagg "interactive" for fallback

…interactive" for fallback'

…interactive

…interactive" for fallback'

…interactive

…v3.1.x Backport PR #15512 on branch v3.1.x

…v3.2.x Backport PR #15512 on branch v3.2.x

tacaswell added this to the v3.1.2 milestone Oct 25, 2019

QuLogic reviewed Oct 25, 2019

View reviewed changes

lib/matplotlib/pyplot.py Outdated Show resolved Hide resolved

tacaswell force-pushed the fix_webagg_fallback branch from 73c0df7 to 58b8743 Compare October 25, 2019 12:27

tacaswell force-pushed the fix_webagg_fallback branch from b797f29 to 70ad7f7 Compare October 28, 2019 04:14

jklymak requested a review from story645 October 29, 2019 19:46

jklymak added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Oct 29, 2019

story645 mentioned this pull request Oct 30, 2019

Restore build_alllocal.cmd #15574

Closed

tacaswell and others added 5 commits October 30, 2019 22:00

MNT: use set rather than list comprehension to filter backend list

0eaa2db

Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>

TST: correct webagg fallback behavior on headless machine

f6279ac

TST: try to fix windows by directly setting mplbackend env

8271e61

TST: skip the nbagg test if we don't have IPython installed

fd9f102

tacaswell force-pushed the fix_webagg_fallback branch from 70ad7f7 to fd9f102 Compare October 31, 2019 02:00

story645 reviewed Oct 31, 2019

View reviewed changes

TST: fix sub process usage on windows

557e56f

thanks to @story645 for sorting this out

story645 approved these changes Oct 31, 2019

View reviewed changes

dopplershift approved these changes Oct 31, 2019

View reviewed changes

dopplershift merged commit 126de7f into matplotlib:master Oct 31, 2019

lumberbot-app bot added the status: needs manual backport label Oct 31, 2019

tacaswell deleted the fix_webagg_fallback branch November 1, 2019 00:53

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

Merge pull request matplotlib#15512 from tacaswell/fix_webagg_fallback

d5bbd1e

FIX: do not consider webagg and nbagg "interactive" for fallback

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

'Backport PR matplotlib#15512: FIX: do not consider webagg and nbagg …

d8a107b

…"interactive" for fallback' FIX: do not consider webagg and nbagg "interactive" for fallback

story645 mentioned this pull request Nov 1, 2019

Backport PR #15512 on branch v3.1.x #15582

Merged

story645 added the GUI: nbagg label Nov 1, 2019

story645 added the GUI: webagg label Nov 1, 2019

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

'Backport PR matplotlib#15512: FIX: do not consider webagg and nbagg …

9ffc75f

…"interactive" for fallback' FIX: do not consider webagg and nbagg "interactive" for fallback

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

Backport PR matplotlib#15512: FIX: do not consider webagg and nbagg "…

9e371a3

…interactive" for fallback'

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

Backport PR matplotlib#15512: FIX: do not consider webagg and nbagg "…

c941994

…interactive

story645 mentioned this pull request Nov 1, 2019

Backport PR #15512 on branch v3.2.x #15583

Merged

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

Backport PR matplotlib#15512: FIX: do not consider webagg and nbagg "…

eb5a3d7

…interactive" for fallback'

story645 pushed a commit to story645/matplotlib that referenced this pull request Nov 1, 2019

Backport PR matplotlib#15512: FIX: do not consider webagg and nbagg "…

deadd8f

…interactive

timhoffm added a commit that referenced this pull request Nov 1, 2019

Merge pull request #15582 from story645/auto-backport-of-pr-15512-on-…

fccf3d9

…v3.1.x Backport PR #15512 on branch v3.1.x

QuLogic removed the status: needs manual backport label Nov 1, 2019

jklymak added a commit that referenced this pull request Nov 1, 2019

Merge pull request #15583 from story645/auto-backport-of-pr-15512-on-…

2527d3b

…v3.2.x Backport PR #15512 on branch v3.2.x

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FIX: do not consider webagg and nbagg "interactive" for fallback #15512

FIX: do not consider webagg and nbagg "interactive" for fallback #15512

tacaswell commented Oct 25, 2019

tacaswell commented Oct 25, 2019

tacaswell commented Oct 28, 2019

story645 Oct 31, 2019

story645 Oct 31, 2019 •

edited

Loading

jklymak commented Oct 31, 2019

tacaswell commented Oct 31, 2019

dopplershift left a comment

lumberbot-app bot commented Oct 31, 2019

lumberbot-app bot commented Oct 31, 2019

FIX: do not consider webagg and nbagg "interactive" for fallback #15512

FIX: do not consider webagg and nbagg "interactive" for fallback #15512

Conversation

tacaswell commented Oct 25, 2019

PR Summary

tacaswell commented Oct 25, 2019

tacaswell commented Oct 28, 2019

story645 Oct 31, 2019

Choose a reason for hiding this comment

story645 Oct 31, 2019 • edited Loading

Choose a reason for hiding this comment

jklymak commented Oct 31, 2019

tacaswell commented Oct 31, 2019

dopplershift left a comment

Choose a reason for hiding this comment

lumberbot-app bot commented Oct 31, 2019

lumberbot-app bot commented Oct 31, 2019

story645 Oct 31, 2019 •

edited

Loading