fix plt.show doesn't warn if a non-GUI backend #10685

zhoubecky · 2018-03-05T17:17:02Z

PR Summary

fix plt.show doesn't warn if a non-GUI backend is being used #7908
will add command and unit tests later

We already have runtime tests for LaTeX and associated dependencies; the check in setup.py is not used for anything.

Previously, changes to the text.latex.unicode or text.latex.preview rcParams (which do change the autogenerated preamble) would not invalidate the tex cache.

1) math.ceil() returns an int on Py3. 2) Window.SetInitialSize and Window.IsShownOnScreen are documented in the wx API; it seems overkill to try to workaround their possible absence (that code was present from the very beginning of the git history). 3) the macros attribute is unused since 7499f7c (2004).

Fix some doc links Put back AGG OO example Remove old example

jklymak · 2018-03-05T19:10:19Z

Thanks for the PR! I just editied the title to be more descriptive and to exclude the issue number (though definitely include the issue # in the PR summary!)

WeatherGod · 2018-03-05T20:17:19Z

lib/matplotlib/backend_bases.py

+                    import warnings
+                    warnings.warn(
+                        "matplotlib is currently using a non-GUI backend, "
+                        "so cannot show the figure")


Might be nice to say which backend is being used

Also, what's the policy now for warnings versus logging warnings?

According to the logging howto

warnings.warn() in library code if the issue is avoidable and the client application should be modified to eliminate the warning

logging.warning() if there is nothing the client application can do about the situation, but the event should still be noted

The former is the case here. One should not try to call show (or expect that it does something) on a non-GUI backend. So, warnings.warn is correct.

timhoffm · 2018-03-05T20:36:37Z

lib/matplotlib/backend_bases.py

@@ -175,20 +175,28 @@ def draw_if_interactive(cls):
                cls.trigger_manager_draw(manager)

    @classmethod
-    def show(cls, block=None):
+    def show(cls, block=None, warn=True):


I don't think we need the warn parameter. Client applications can use the filter mechanism of the warnings module, if they really want to suppress the warning.

ok, I'll remove this parameter. Thanks.

zhoubecky · 2018-03-14T21:41:27Z

Hi @jklymak , I have removed the warning parameter and added a test. Is there anything else I should do to make this better?

QuLogic · 2018-03-14T21:56:06Z

lib/matplotlib/tests/test_backend_svg.py

+
+def test_NonGui_warning():
+    matplotlib.use('Agg')
+    import matplotlib.pyplot as plt


Duplicate import.

QuLogic · 2018-03-14T21:59:07Z

lib/matplotlib/tests/test_backend_svg.py

+    matplotlib.use('Agg')
+    import matplotlib.pyplot as plt
+    plt.plot([1, 2, 3])
+    plt.savefig('myfig')


Not needed?

QuLogic · 2018-03-14T21:59:45Z

lib/matplotlib/tests/test_backend_svg.py

@@ -179,3 +179,22 @@ def psfont(*args, **kwargs):
    ax.text(0.5, 0.5, 'hello')
    with tempfile.TemporaryFile() as tmpfile, pytest.raises(ValueError):
        fig.savefig(tmpfile, format='svg')
+
+
+def test_NonGui_warning():


I'm a bit confused; why does this test belong in the SVG backend test file? (The name should also not be CamelCase.)

QuLogic · 2018-03-14T22:01:21Z

lib/matplotlib/backend_bases.py

+                import warnings
+                warnings.warn(
+                    "matplotlib is currently using a non-GUI backend, "
+                    "so cannot show the figure")


It looks like you missed @WeatherGod's suggestion:

Might be nice to say which backend is being used

QuLogic · 2018-03-14T22:02:21Z

lib/matplotlib/tests/test_backend_svg.py

+
+
+def test_NonGui_warning():
+    matplotlib.use('Agg')


To force an alternate backend, you can mark the function with a decorator: @pytest.mark.backend('Agg')

jklymak

modulo the docstring typo

jklymak · 2018-03-15T17:22:30Z

lib/matplotlib/figure.py

            warnings.warn(
-                "matplotlib is currently using a non-GUI backend, "
-                "so cannot show the figure")
+                ('matplotlib is currently using %s, which is a ' +


Can you fix the docstring typo while you are working on this?

sorry, I don't find the typo. Which line is it?

"warm" should be "warn"... Unless my screen is blurry.

Yes... I think so. It is warn. :)

Line 434/435

oh I see it. Will fix. Thank you

…d test

The workaround for strftime with dates < 1900 is not needed anymore since Py 3.3, see note (2) in https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior

Invalidate texmanager cache when any text.latex.* rc changes.

Rely a bit more on rc_context.

Move some examples out of examples/api

Remove the 'hold' kwarg from codebase

The int version of the buffer size was not updated when the buffer was resized. It's there to prevent a signed/unsigned comparison warning, but it's simpler just to cast the other side of the comparison. There's no problem with the signed-to-unsigned cast since we already know that the result is positive due to the previous check. Fixes matplotlib#10889.

FIX: axes limits reverting to automatic when sharing

Fix overflow when resizing path-to-string buffer.

Note that plt.spectral already raises an exception as of 2.2 anyways (the underlying colormap has already been removed).

Remove deprecated code in image.py

API: Do not suggest a unique filename in save dialogue

DOC: Update definition of area in scatter examples

…b#10914) API: set aspect in Axes.pie to be 'equal' * Changed pie charts default shape to circle (instead of oval), and added tests * Updated comments for default circular pie chart * fix pep8 * removed unneccessary test case and updated docstring * added what's new entry and edited docstring for pie * fix pep8 * fixed typo

Use function signatures in boilerplate.py.

Some more removals of deprecated APIs.

Replace "matplotlibrc" by "rcParams" in the docs where applicable.

FIX: ioerror font cache, second try

…arkers FIX: Postscript allow empty markers

Declare global variables that are created elsewhere

…ao/matplotlib into CinnyCao-becky-fix-matplotlib#7908 Fix the merge conflict

jkseppan · 2018-04-01T18:06:42Z

I merged master into this branch to address the merge conflict, and now Github is showing this as a really huge patch (+3,415 −5,454). But on the command line this still shows up as the same change as before. I wonder if Github is confused or if I am mistaken...

dstansby · 2018-04-01T19:19:12Z

Rebasing on to master should fix things I think.

fix plt.show doesn't warn if a non-GUI backend

jkseppan · 2018-04-01T19:38:19Z

I think the Github diff machinery just has some limits for how complicated commit graphs it can handle. There were some old PRs (at least one from October 2017) merged recently, so if you look at git log --graph the history is a bit messy. The diffs look fine in the CLI.

@zhoubecky Thank you for your contribution!

anntzer and others added 5 commits October 25, 2017 02:01

Remove LaTeX checking in setup.py.

293d11c

We already have runtime tests for LaTeX and associated dependencies; the check in setup.py is not used for anything.

Reset extents in RectangleSelector when not interactive on press.

3a50190

Invalidate texmanager cache when any text.latex.* rc changes.

fd7c87d

Previously, changes to the text.latex.unicode or text.latex.preview rcParams (which do change the autogenerated preamble) would not invalidate the tex cache.

Move some examples out of examples/api

501571b

Fix some doc links Put back AGG OO example Remove old example

jklymak changed the title ~~fix #7908~~ fix plt.show doesn't warn if a non-GUI backend Mar 5, 2018

WeatherGod reviewed Mar 5, 2018

View reviewed changes

timhoffm reviewed Mar 5, 2018

View reviewed changes

tacaswell added this to the v3.0 milestone Mar 5, 2018

jklymak added the status: needs revision label Mar 7, 2018

kalagau and others added 3 commits March 12, 2018 05:40

Add markerfacecolor and markeredgecolor to the rcParams for lines

1d9880c

Declare global variables that are created elsewhere

c5d2c7f

wx_compat is no more.

1671be1

zhoubecky force-pushed the becky-fix-#7908 branch from db846a1 to 63f468e Compare March 14, 2018 20:22

QuLogic reviewed Mar 14, 2018

View reviewed changes

Added examples to lbm

f5fa2ae

jklymak approved these changes Mar 15, 2018

View reviewed changes

jklymak removed the status: needs revision label Mar 15, 2018

pdubcali and others added 10 commits March 15, 2018 13:33

Added more examples to lbm

d6ae63e

Made corrections for pr

d8bb79f

Fix for issue matplotlib#10062

3fd1727

Tests must follow PEP8 as well

7ad9801

bugfix for matplotlib#8818

73101a2

Update docs on Axes.set_prop_cycle

bd8a1e6

Update docs on cycler function

962a2d7

ENH: colorbar ticks adjustable to colorbar size

52e5d81

fix BboxConnectorPatch does not show facecolor matplotlib#8059 and ad…

8e15b70

…d test

Py3fy dates.py.

f98ffad

The workaround for strftime with dates < 1900 is not needed anymore since Py 3.3, see note (2) in https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior

jklymak and others added 23 commits March 29, 2018 09:18

Merge pull request matplotlib#10299 from anntzer/texmanager-cache-keys

980f6ef

Invalidate texmanager cache when any text.latex.* rc changes.

Merge pull request matplotlib#10913 from anntzer/rc_context

00ae375

Rely a bit more on rc_context.

Merge pull request matplotlib#10459 from dstansby/api-examples

d84d779

Move some examples out of examples/api

Merge pull request matplotlib#10485 from dstansby/remove-hold

ffe6021

Remove the 'hold' kwarg from codebase

Merge pull request matplotlib#10798 from shaynair/issue-10062-dev

6466bfa

FIX: axes limits reverting to automatic when sharing

Merge pull request matplotlib#10919 from QuLogic/fix-overflow-resizing

f7b6f89

Fix overflow when resizing path-to-string buffer.

Some more removals of deprecated APIs.

4943487

Note that plt.spectral already raises an exception as of 2.2 anyways (the underlying colormap has already been removed).

Remove deprecated code in image.py

c0bdacb

Merge pull request matplotlib#10562 from dstansby/depr-image

f78e4d4

Remove deprecated code in image.py

Merge pull request matplotlib#10864 from mspacek/patch-1

f916aad

API: Do not suggest a unique filename in save dialogue

Update definition of area in scatter examples

ee1c066

Merge pull request matplotlib#10930 from krrk/scatter-examples

0b0a6a0

DOC: Update definition of area in scatter examples

Use function signatures in boilerplate.py.

86fe16b

Improve boilerplate signature format for short signatures

0293e8a

Merge pull request matplotlib#10918 from anntzer/signature-boilerplate

5a8f4ea

Use function signatures in boilerplate.py.

Merge pull request matplotlib#10926 from anntzer/api-removals

9663522

Some more removals of deprecated APIs.

Merge pull request matplotlib#10898 from anntzer/mplrc

3599db9

Replace "matplotlibrc" by "rcParams" in the docs where applicable.

FIX: Postscript allow empty markers

ba9b7ca

Merge pull request matplotlib#10858 from jklymak/fix-ioerror-font-cache

6bcc8c7

FIX: ioerror font cache, second try

Merge pull request matplotlib#10935 from jklymak/fix-ps-allow-empty-m…

7b5deb3

…arkers FIX: Postscript allow empty markers

Merge pull request matplotlib#10689 from cclauss/declare-globals

b5b0003

Declare global variables that are created elsewhere

jkseppan approved these changes Apr 1, 2018

View reviewed changes

Merge branch 'becky-fix-matplotlib#7908' of https://github.com/CinnyC…

a2a145f

…ao/matplotlib into CinnyCao-becky-fix-matplotlib#7908 Fix the merge conflict

jkseppan merged commit a2a145f into matplotlib:master Apr 1, 2018

jkseppan added a commit that referenced this pull request Apr 1, 2018

Merge pull request #10685 from CinnyCao/becky-fix-#7908

02646cb

fix plt.show doesn't warn if a non-GUI backend

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix plt.show doesn't warn if a non-GUI backend #10685

fix plt.show doesn't warn if a non-GUI backend #10685

zhoubecky commented Mar 5, 2018

jklymak commented Mar 5, 2018

WeatherGod Mar 5, 2018

WeatherGod Mar 5, 2018

timhoffm Mar 5, 2018 •

edited

Loading

timhoffm Mar 5, 2018

zhoubecky Mar 5, 2018

zhoubecky commented Mar 14, 2018

QuLogic Mar 14, 2018

QuLogic Mar 14, 2018

QuLogic Mar 14, 2018

QuLogic Mar 14, 2018

QuLogic Mar 14, 2018

jklymak left a comment

jklymak Mar 15, 2018

zhoubecky Mar 15, 2018

jklymak Mar 15, 2018

zhoubecky Mar 15, 2018

jklymak Mar 15, 2018

zhoubecky Mar 15, 2018

jkseppan commented Apr 1, 2018

dstansby commented Apr 1, 2018

jkseppan commented Apr 1, 2018

fix plt.show doesn't warn if a non-GUI backend #10685

fix plt.show doesn't warn if a non-GUI backend #10685

Conversation

zhoubecky commented Mar 5, 2018

PR Summary

jklymak commented Mar 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timhoffm Mar 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhoubecky commented Mar 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jklymak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkseppan commented Apr 1, 2018

dstansby commented Apr 1, 2018

jkseppan commented Apr 1, 2018

timhoffm Mar 5, 2018 •

edited

Loading