Merge remote-tracking branch 'fabioz/weak_widget_references'

Author: nicoddemus

pytestqt/_tests/pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = -p pytestqt.plugin

pytestqt/_tests/test_basics.py

@@ -1,22 +1,23 @@
-from pytestqt.qt_compat import QtGui, Qt, QEvent, QtCore
+import weakref
 import pytest
+from pytestqt.qt_compat import QtGui, Qt, QEvent, QtCore
 
 
 def test_basics(qtbot):
     """
     Basic test that works more like a sanity check to ensure we are setting up a QApplication
-    properly and are able to display a simple event_recorder. 
+    properly and are able to display a simple event_recorder.
     """
-    assert type(QtGui.qApp) is QtGui.QApplication
+    assert isinstance(QtGui.qApp, QtGui.QApplication)
     widget = QtGui.QWidget()
     qtbot.addWidget(widget)
     widget.setWindowTitle('W1')
     widget.show()
-    
+
     assert widget.isVisible()
     assert widget.windowTitle() == 'W1'
-    
-    
+
+
 def test_key_events(qtbot, event_recorder):
     """
     Basic key events test.
@@ -27,16 +28,16 @@ def extract(key_event):
             key_event.key(),
             key_event.text(),
         )
-        
+
     event_recorder.registerEvent(QtGui.QKeyEvent, extract)
-    
+
     qtbot.keyPress(event_recorder, 'a')
     assert event_recorder.event_data == (QEvent.KeyPress, int(Qt.Key_A), 'a')
-    
+
     qtbot.keyRelease(event_recorder, 'a')
     assert event_recorder.event_data == (QEvent.KeyRelease, int(Qt.Key_A), 'a')
-    
-    
+
+
 def test_mouse_events(qtbot, event_recorder):
     """
     Basic mouse events test.
@@ -49,10 +50,10 @@ def extract(mouse_event):
         )
 
     event_recorder.registerEvent(QtGui.QMouseEvent, extract)
-    
+
     qtbot.mousePress(event_recorder, Qt.LeftButton)
     assert event_recorder.event_data == (QEvent.MouseButtonPress, Qt.LeftButton, Qt.NoModifier)
-    
+
     qtbot.mousePress(event_recorder, Qt.RightButton, Qt.AltModifier)
     assert event_recorder.event_data == (QEvent.MouseButtonPress, Qt.RightButton, Qt.AltModifier)
 
@@ -67,32 +68,41 @@ def test_stop_for_interaction(qtbot):
     QtCore.QTimer.singleShot(0, widget.close)
     qtbot.stopForInteraction()
 
-    
+
+def test_widget_kept_as_weakref(qtbot):
+    """
+    Test if the widget is kept as a weak reference in QtBot
+    """
+    widget = QtGui.QWidget()
+    qtbot.add_widget(widget)
+    widget = weakref.ref(widget)
+    assert widget() is None
+
+
 class EventRecorder(QtGui.QWidget):
+
     """
     Widget that records some kind of events sent to it.
-    
+
     When this event_recorder receives a registered event (by calling `registerEvent`), it will call
-    the associated *extract* function and hold the return value from the function in the 
+    the associated *extract* function and hold the return value from the function in the
     `event_data` member.
     """
-        
+
     def __init__(self):
         QtGui.QWidget.__init__(self)
         self._event_types = {}
         self.event_data = None
-        
-        
+
     def registerEvent(self, event_type, extract_func):
         self._event_types[event_type] = extract_func
-        
-    
+
     def event(self, ev):
         for event_type, extract_func in self._event_types.items():
-            if type(ev) is event_type:
+            if isinstance(ev, event_type):
                 self.event_data = extract_func(ev)
                 return True
-        
+
         return False
 
 
@@ -101,5 +111,3 @@ def event_recorder(qtbot):
     widget = EventRecorder()
     qtbot.addWidget(widget)
     return widget
-
-

pytestqt/plugin.py

@@ -2,6 +2,7 @@
 import functools
 import sys
 import traceback
+import weakref
 
 import pytest
 
@@ -173,7 +174,9 @@ def _close(self):
         Clear up method. Called at the end of each test that uses a ``qtbot`` fixture.
         """
         for w in self._widgets:
-            w.close()
+            w = w()
+            if w is not None:
+                w.close()
         self._widgets[:] = []
 
     def addWidget(self, widget):
@@ -184,7 +187,9 @@ def addWidget(self, widget):
         :param QWidget widget:
             Widget to keep track of.
         """
-        self._widgets.append(widget)
+        self._widgets.append(weakref.ref(widget))
+
+    add_widget = addWidget  # pep-8 alias
 
     def waitForWindowShown(self, widget):
         """
@@ -197,6 +202,8 @@ def waitForWindowShown(self, widget):
         """
         QtTest.QTest.qWaitForWindowShown(widget)
 
+    wait_for_window_shown = waitForWindowShown  # pep-8 alias
+
     def stopForInteraction(self):
         """
         Stops the current test flow, letting the user interact with any visible widget.
@@ -209,12 +216,15 @@ def stopForInteraction(self):
 
         .. note:: As a convenience, it is also aliased as `stop`.
         """
-        widget_visibility = [widget.isVisible() for widget in self._widgets]
+        widget_and_visibility = []
+        for weak_widget in self._widgets:
+            widget = weak_widget()
+            if widget is not None:
+                widget_and_visibility.append((widget, widget.isVisible()))
 
         self._app.exec_()
 
-        for index, visible in enumerate(widget_visibility):
-            widget = self._widgets[index]
+        for widget, visible in widget_and_visibility:
             widget.setVisible(visible)
 
     stop = stopForInteraction
@@ -256,6 +266,8 @@ def waitSignal(self, signal=None, timeout=1000):
             blocker.connect(signal)
         return blocker
 
+    wait_signal = waitSignal  # pep-8 alias
+
 
 class SignalBlocker(object):