MNT: add shared test helper function clickcell

Factor out `TestParametersPanel._clickcell` to a shared function.

Author: pavoljuhas

src/diffpy/pdfgui/tests/TestParametersPanel.py

@@ -23,7 +23,7 @@
 
 from diffpy.pdfgui.gui.parameterspanel import ParametersPanel
 from diffpy.pdfgui.control.parameter import Parameter
-from diffpy.pdfgui.tests.testutils import GUITestCase
+from diffpy.pdfgui.tests.testutils import GUITestCase, clickcell
 
 # ----------------------------------------------------------------------------
 
@@ -48,22 +48,6 @@ def tearDown(self):
         return
 
 
-    def _clickcell(self, leftright, row, col, **kw):
-        gp = self.panel.grid_parameters
-        assert leftright in ('left', 'right')
-        if leftright == "left":
-            eventtype = wx.grid.EVT_GRID_CELL_LEFT_CLICK.typeId
-        else:
-            eventtype = wx.grid.EVT_GRID_CELL_RIGHT_CLICK.typeId
-        kbd = {'kbd': wx.KeyboardState(**kw)}
-        # TODO: remove this after deprecations of wxpython 3
-        if wx.VERSION[0] == 3:
-            kbd = {k.replace('Down', ''): v for k, v in kw.items()}
-        e = wx.grid.GridEvent(gp.Id, eventtype, gp, row, col, **kbd)
-        gp.ProcessEvent(e)
-        return
-
-
     def test_onPopupFixFree(self):
         "Check ParametersPanel.onPopupFixFree"
         # event is not used, we just generate and reuse dummy event.
@@ -108,21 +92,21 @@ def test_onCellLeftClick(self):
         self.assertFalse(self.panel.mainFrame.altered)
         self.assertEqual("0", gp.GetCellValue(0, 1))
         self.assertFalse(p.fixed)
-        self._clickcell("left", 0, 1)
+        clickcell(gp, "left", 0, 1)
         self.assertEqual("1", gp.GetCellValue(0, 1))
         self.assertTrue(p.fixed)
         self.assertTrue(self.panel.mainFrame.altered)
-        self._clickcell("left", 0, 1)
+        clickcell(gp, "left", 0, 1)
         self.assertEqual("0", gp.GetCellValue(0, 1))
-        self._clickcell("left", 0, 1, controlDown=True)
+        clickcell(gp, "left", 0, 1, controlDown=True)
         self.assertEqual("0", gp.GetCellValue(0, 1))
-        self._clickcell("left", 0, 1, shiftDown=True)
+        clickcell(gp, "left", 0, 1, shiftDown=True)
         self.assertEqual("0", gp.GetCellValue(0, 1))
         gp.SelectAll()
-        self._clickcell("left", 0, 1)
+        clickcell(gp, "left", 0, 1)
         self.assertEqual("0", gp.GetCellValue(0, 1))
         gp.ClearSelection()
-        self._clickcell("left", 0, 1)
+        clickcell(gp, "left", 0, 1)
         self.assertEqual("1", gp.GetCellValue(0, 1))
         return
 
@@ -133,7 +117,7 @@ def test_onCellRightClick(self):
         gp = self.panel.grid_parameters
         gp.PopupMenu = lambda menu, pos: None
         try:
-            self._clickcell("right", 0, 1)
+            clickcell(gp, "right", 0, 1)
         finally:
             del gp.PopupMenu
         self.assertTrue(self.panel.did_popupIDs)

src/diffpy/pdfgui/tests/testutils.py

@@ -76,6 +76,37 @@ def tooltiptext(widget):
     tt = widget.GetToolTip()
     return tt.GetTip()
 
+
+def clickcell(grid, leftright, row, col, **kw):
+    """Simulate left or right mouse click over wx.grid.Grid
+
+    Parameters
+    ----------
+    grid : wx.grid.Grid
+        The grid object to be clicked
+    leftright : str
+        The button that is clicked, possible values are ("left", "right").
+    row : int
+        The zero-based row of the clicked cell.
+    col : int
+        The zero-based columnt of the clicked cell.
+    kw : misc, optional
+        Keyword arguments for the wx.GridEvent constructor.
+        Typically a keyboard modifier for the click.
+    """
+    assert leftright in ('left', 'right')
+    if leftright == "left":
+        eventtype = wx.grid.EVT_GRID_CELL_LEFT_CLICK.typeId
+    else:
+        eventtype = wx.grid.EVT_GRID_CELL_RIGHT_CLICK.typeId
+    kbd = {'kbd': wx.KeyboardState(**kw)}
+    # TODO: remove this after deprecations of wxpython 3
+    if wx.VERSION[0] == 3:
+        kbd = {k.replace('Down', ''): v for k, v in kw.items()}
+    e = wx.grid.GridEvent(grid.Id, eventtype, grid, row, col, **kbd)
+    grid.ProcessEvent(e)
+    return
+
 # GUI-specialized TestCase ---------------------------------------------------
 
 class GUITestCase(TestCase):