Backport PR #9187: Fix wx_compat code for wxPython >= 4.0.0b2

tacaswell · MeeseeksDev[bot] · commit 5d0d3f538d8d · 2017-09-22T03:33:16.000Z
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
diff --git a/.travis.yml b/.travis.yml
@@ -124,7 +124,7 @@ install:
       echo 'PyQt5 is available' ||
       echo 'PyQt5 is not available'
     pip install -U --pre \
-      -f https://wxpython.org/Phoenix/release-extras/linux/gtk3/ubuntu-14.04 \
+      -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-14.04 \
       wxPython &&
       python -c 'import wx' &&
       echo 'wxPython is available' ||
diff --git a/lib/matplotlib/backends/wx_compat.py b/lib/matplotlib/backends/wx_compat.py
@@ -139,24 +139,36 @@
     StockCursor = wx.StockCursor
 
 
+# wxPython Classic's DoAddTool has become AddTool in Phoenix. Otherwise
+# they are the same, except for early betas and prerelease builds of
+# Phoenix. This function provides a shim that does the RightThing based on
+# which wxPython is in use.
 def _AddTool(parent, wx_ids, text, bmp, tooltip_text):
+    if text in ['Pan', 'Zoom']:
+        kind = wx.ITEM_CHECK
+    else:
+        kind = wx.ITEM_NORMAL
     if is_phoenix:
-        if text in ['Pan', 'Zoom']:
-            kind = wx.ITEM_CHECK
-        else:
-            kind = wx.ITEM_NORMAL
-        parent.AddTool(wx_ids[text], label=text,
-                       bitmap=bmp,
-                       bmpDisabled=wx.NullBitmap,
-                       shortHelpString=text,
-                       longHelpString=tooltip_text,
-                       kind=kind)
+        add_tool = parent.AddTool
+    else:
+        add_tool = parent.DoAddTool
+
+    if not is_phoenix or LooseVersion(wx.VERSION_STRING) >= "4.0.0b2":
+        # NOTE: when support for Phoenix prior to 4.0.0b2 is dropped then
+        # all that is needed is this clause, and the if and else clause can
+        # be removed.
+        kwargs = dict(label=text,
+                      bitmap=bmp,
+                      bmpDisabled=wx.NullBitmap,
+                      shortHelp=text,
+                      longHelp=tooltip_text,
+                      kind=kind)
     else:
-        if text in ['Pan', 'Zoom']:
-            parent.AddCheckTool(
-                wx_ids[text],
-                bmp,
-                shortHelp=text,
-                longHelp=tooltip_text)
-        else:
-            parent.AddSimpleTool(wx_ids[text], bmp, text, tooltip_text)
+        kwargs = dict(label=text,
+                      bitmap=bmp,
+                      bmpDisabled=wx.NullBitmap,
+                      shortHelpString=text,
+                      longHelpString=tooltip_text,
+                      kind=kind)
+
+    return add_tool(wx_ids[text], **kwargs)
