Fix wx_compat code for wxPython >= 4.0.0b2 #9187

RobinD42 · 2017-09-14T19:18:05Z

PR Summary

Some arg names in wx.ToolBar.AddTool are being changed in order to be more consistent with other tool methods, and also for better compatibility with Classic. This change trips up the code in wx_compat since it is using keyword args when calling AddTool. This PR is one possible fix. Another would be to not use the keyword args and just use positional args since the order and types have not changed.

See: wxWidgets/Phoenix#527

PR Checklist

Has Pytest style unit tests
Code is PEP 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

anntzer · 2017-09-14T21:26:55Z

lib/matplotlib/backends/wx_compat.py

-                       longHelpString=tooltip_text,
-                       kind=kind)
+
+        if LooseVersion(wx.VERSION_STRING) >= LooseVersion("4.0.0b2"):


Would all of these work for the old wx as well? In other words, could we just drop the code in the else clause if we decide not to support the beta versions of phoenix (once the actual release of phoenix comes)?

Yes. At that point I think there could also be a bit more simplification for Classic wxPython support as well, since the new AddTool signature matches the signature for DoAddTool in Classic. So it would then boil down to just a difference in method names.

Can you change the PR accordingly?

Changes to use DoAddTool in Classic, which is the same as AddTool in Phoenix. Includes a note about even more possible simplification when support for all pre-release builds of Phoenix is dropped.

RobinD42 · 2017-09-15T17:27:43Z

Additional refactoring implemented, along with a note about what can be removed in the future.

anntzer

Thanks for the very clear PR.

anntzer · 2017-09-20T19:09:45Z

@RobinD42 Actually you need to fix a minor style nitpick (https://travis-ci.org/matplotlib/matplotlib/jobs/275984202#L3031). You can just drop the second call to LooseVersion, as the first one will implicitly coerce the second one to LooseVersion as well when doing the comparison.

tacaswell · 2017-09-21T12:44:14Z

@RobinD42 Do you mind if I push commits to your branch?

krlsmnk · 2017-09-21T18:04:15Z

Hello everyone! I am a CS grad student who is very new to Python and to Github (crazy, I know). I am using wxPython and matplotlib for a research project, and seem to be getting the error described above.

Currently, I have:
Copied entire file contents of "wx_compat.py" into a blank document.
Saved this document, named "wx_compat.py" as a .py file
Moved this file to directory: /matplotlib/backends/wx_compat.py

I am still receiving the error. What am I doing wrong?

RobinD42 · 2017-09-21T18:09:45Z

@tacaswell,

Do you mind if I push commits to your branch?

Feel free to do so.

RobinD42 · 2017-09-21T18:12:06Z

@krlsmnk,

When you say,

Copied entire file contents of "wx_compat.py" into a blank document.

Where did you get it from? Does it include the changes from this PR?

krlsmnk · 2017-09-21T18:25:25Z

From:
https://github.com/RobinD42/matplotlib/blob/f85a6c16fe03025682ab8223ef350443c973451f/lib/matplotlib/backends/wx_compat.py

Says it was updated 21 hours ago; I assume that's the most recent.

RobinD42 · 2017-09-21T18:53:08Z

@krischer, I guess the next step would be to ensure that the file you moved into place is actually the one being imported, and not some other one that may be elsewhere on your system. There are various things that can be checked, for example you can import the module in your code and then check its __file__ attribute.

from matplotlib.backends import wx_compat
print(wx_compat.__file__)

krischer · 2017-09-21T18:55:29Z

@RobinD42 I think you pinged the wrong person ;)

RobinD42 · 2017-09-21T18:58:39Z

Oops, that should have been @krlsmnk of course. Too many kr's here I guess. 😉

The old url only points to sdists now, which caused travis to try building wxpython itself, with no success. Wheels are now at the new url.

tacaswell · 2017-09-22T02:00:45Z

Fixed the style issue and moved @anntzer 's commit from #9208 to this PR so it gets test coverage.

tacaswell · 2017-09-22T03:32:33Z

Thanks @RobinD42 !

tacaswell · 2017-09-22T03:32:45Z

@meeseeksdev backport to v2.1.x

PR Summary Some arg names in `wx.ToolBar.AddTool` are being changed in order to be more consistent with other tool methods, and also for better compatibility with Classic. This change trips up the code in `wx_compat` since it is using keyword args when calling `AddTool`. This PR is one possible fix. Another would be to not use the keyword args and just use positional args since the order and types have not changed.  See: wxWidgets/Phoenix#527 PR Checklist - [ ] Has Pytest style unit tests - [x] Code is PEP 8 compliant - [ ] New features are documented, with examples if plot related - [ ] Documentation is sphinx and numpydoc compliant - [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there) - [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Backport PR #9187 on branch v2.1.x

ewan1983 · 2017-09-25T08:36:36Z

File "C:\Anaconda2\lib\site-packages\matplotlib\pyplot.py", line 535, in figure
**kwargs)
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\backend_wxagg.py", line 116, in new_figure_manager
return new_figure_manager_given_figure(num, fig)
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\backend_wxagg.py", line 123, in new_figure_manager_given_figure
frame = FigureFrameWxAgg(num, figure)
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\backend_wx.py", line 1275, in init
self.toolbar = self._get_toolbar(statbar)
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\backend_wxagg.py", line 28, in _get_toolbar
toolbar = NavigationToolbar2WxAgg(self.canvas)
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\backend_wx.py", line 1582, in init
NavigationToolbar2.init(self, canvas)
File "C:\Anaconda2\lib\site-packages\matplotlib\backend_bases.py", line 2760, in init
self._init_toolbar()
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\backend_wx.py", line 1609, in _init_toolbar
tooltip_text)
File "C:\Anaconda2\lib\site-packages\matplotlib\backends\wx_compat.py", line 154, in _AddTool
if not is_phoenix or LooseVersion(wx.VERSION_STRING) >= "4.0.0b2":
File "C:\Anaconda2\lib\distutils\version.py", line 296, in cmp
return cmp(self.version, other.version)
AttributeError: 'unicode' object has no attribute 'version'

Removing LooseVersion solved my problem. Not sure what had happened to my anaconda.

anntzer · 2017-09-25T08:44:44Z

Ah the joys of Py2.
str("4.0.0b2") should work.

krlsmnk · 2017-09-25T16:36:28Z

So do I import wx_compat in addition to both Matplotlib and wx, or as a replacement for one of them?

I currently commented out my wx import, and imported:
from matplotlib.backends import wx_compat as wx

and app = wx.App(False)
tells me the wx_compat module doesn't have that attribute

…にしたがってwx_compat.pyを修正してみたが上手くいかず。しかしバグの可能性が高い。

Fix wx_compat code for wxPython >= 4.0.0b2

a83a102

RobinD42 mentioned this pull request Sep 14, 2017

Missing signature for wx.Toolbar.AddTool() wxWidgets/Phoenix#527

Closed

anntzer reviewed Sep 14, 2017

View reviewed changes

Further refactoring and simplification of _AddTool.

1f982fb

Changes to use DoAddTool in Classic, which is the same as AddTool in Phoenix. Includes a note about even more possible simplification when support for all pre-release builds of Phoenix is dropped.

anntzer approved these changes Sep 15, 2017

View reviewed changes

tacaswell added this to the 2.1 (next point release) milestone Sep 20, 2017

tacaswell added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Sep 20, 2017

Shorten line, remove 2nd LooseVersion in comparrison

f85a6c1

anntzer mentioned this pull request Sep 20, 2017

Update wxpython wheel url for travis. #9208

Closed

6 tasks

tacaswell and others added 2 commits September 21, 2017 21:59

STY: remove extra line

ffbb57e

Update wxpython wheel url for travis.

a6f38ab

The old url only points to sdists now, which caused travis to try building wxpython itself, with no success. Wheels are now at the new url.

tacaswell approved these changes Sep 22, 2017

View reviewed changes

tacaswell merged commit 80ffe40 into matplotlib:master Sep 22, 2017

lumberbot-app bot mentioned this pull request Sep 22, 2017

Backport PR #9187 on branch v2.1.x #9216

Merged

6 tasks

tacaswell added a commit that referenced this pull request Sep 22, 2017

Merge pull request #9216 from matplotlib/auto-backport-of-pr-9187

a1f635f

Backport PR #9187 on branch v2.1.x

anntzer mentioned this pull request Sep 28, 2017

backend toolbar error with wxPython 4.0.0b2 #9250

Closed

anntzer mentioned this pull request Oct 11, 2017

Toolbar issue: Python3, wx4, windows only #9371

Closed

RobinD42 deleted the fix-AddTool-for-wxPy4.0.0b2 branch January 22, 2018 23:57

BrennanGit mentioned this pull request Feb 1, 2018

Switch to using StrictVersion in wx_compat.py #10362

Merged

6 tasks

Uh oh!

Fix wx_compat code for wxPython >= 4.0.0b2 #9187

Fix wx_compat code for wxPython >= 4.0.0b2 #9187

Uh oh!

Conversation

RobinD42 commented Sep 14, 2017

PR Summary

PR Checklist

Uh oh!

anntzer Sep 14, 2017

Choose a reason for hiding this comment

Uh oh!

RobinD42 Sep 14, 2017

Choose a reason for hiding this comment

Uh oh!

anntzer Sep 14, 2017

Choose a reason for hiding this comment

Uh oh!

RobinD42 commented Sep 15, 2017

Uh oh!

anntzer left a comment

Choose a reason for hiding this comment

Uh oh!

anntzer commented Sep 20, 2017

Uh oh!

tacaswell commented Sep 21, 2017

Uh oh!

krlsmnk commented Sep 21, 2017

Uh oh!

RobinD42 commented Sep 21, 2017

Uh oh!

RobinD42 commented Sep 21, 2017

Uh oh!

krlsmnk commented Sep 21, 2017

Uh oh!

RobinD42 commented Sep 21, 2017

Uh oh!

krischer commented Sep 21, 2017

Uh oh!

RobinD42 commented Sep 21, 2017

Uh oh!

tacaswell commented Sep 22, 2017

Uh oh!

tacaswell commented Sep 22, 2017

Uh oh!

tacaswell commented Sep 22, 2017

Uh oh!

ewan1983 commented Sep 25, 2017

Uh oh!

anntzer commented Sep 25, 2017

Uh oh!

krlsmnk commented Sep 25, 2017

Uh oh!

Uh oh!