code format and using class decorator to inject QTest methods

Author: nicoddemus

pytestqt/_tests/test_basics.py

@@ -2,24 +2,11 @@
 import pytest
 
 
-#===================================================================================================
-# fixtures
-#===================================================================================================
-@pytest.fixture
-def event_recorder(qtbot):
-    widget = EventRecorder()
-    qtbot.addWidget(widget)
-    return widget
-
-
-#===================================================================================================
-# testBasics
-#===================================================================================================
-def testBasics(qtbot):
-    '''
+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. 
-    '''
+    """
     assert type(QtGui.qApp) is QtGui.QApplication
     widget = QtGui.QWidget()
     qtbot.addWidget(widget)
@@ -30,13 +17,10 @@ def testBasics(qtbot):
     assert widget.windowTitle() == 'W1'
 
 
-#===================================================================================================
-# testKeyEvents
-#===================================================================================================
-def testKeyEvents(qtbot, event_recorder):
-    '''
+def test_key_events(qtbot, event_recorder):
+    """
     Basic key events test.
-    '''
+    """
     def extract(key_event):
         return (
             key_event.type(),
@@ -53,20 +37,17 @@ def extract(key_event):
     assert event_recorder.event_data == (QEvent.KeyRelease, int(Qt.Key_A), 'a')
 
 
-#===================================================================================================
-# testMouseEvents
-#===================================================================================================
-def testMouseEvents(qtbot, event_recorder):
-    '''
+def test_mouse_events(qtbot, event_recorder):
+    """
     Basic mouse events test.
-    '''
+    """
     def extract(mouse_event):
         return (
             mouse_event.type(),
             mouse_event.button(),
             mouse_event.modifiers(),
         )
-        
+
     event_recorder.registerEvent(QtGui.QMouseEvent, extract)
 
     qtbot.mousePress(event_recorder, Qt.LeftButton)
@@ -76,17 +57,14 @@ def extract(mouse_event):
     assert event_recorder.event_data == (QEvent.MouseButtonPress, Qt.RightButton, Qt.AltModifier)
 
 
-#===================================================================================================
-# EventRecorder
-#===================================================================================================
 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 
     `event_data` member.
-    '''
+    """
 
     def __init__(self):
         QtGui.QWidget.__init__(self)
@@ -105,10 +83,14 @@ def event(self, ev):
                 return True
 
         return False
-    
-    
-#===================================================================================================
-# main
-#===================================================================================================
+
+
+@pytest.fixture
+def event_recorder(qtbot):
+    widget = EventRecorder()
+    qtbot.addWidget(widget)
+    return widget
+
+
 if __name__ == '__main__':
     pytest.main(args=['-s'])

pytestqt/plugin.py

@@ -2,11 +2,49 @@
 from pytestqt.qt_compat import QtGui 
 from pytestqt.qt_compat import QtTest
 
-#===================================================================================================
-# QtBot
-#===================================================================================================
+
+def _inject_qtest_methods(cls):
+    """
+    Injects QTest methods into the given class QtBot, so the user can access
+    them directly without having to import QTest.
+    """
+
+    def create_qtest_proxy_method(method_name):
+
+        def result(*args, **kwargs):
+            m = getattr(QtTest.QTest, method_name)
+            return m(*args, **kwargs)
+
+        result.__name__ = method_name
+        return staticmethod(result)
+
+    # inject methods from QTest into QtBot
+    method_names = set([
+        'keyPress',
+        'keyClick',
+        'keyClicks',
+        'keyEvent',
+        'keyPress',
+        'keyRelease',
+        'keyToAscii',
+
+        'mouseClick',
+        'mouseDClick',
+        'mouseEvent',
+        'mouseMove',
+        'mousePress',
+        'mouseRelease',
+    ])
+    for method_name in method_names:
+        method = create_qtest_proxy_method(method_name)
+        setattr(cls, method_name, method)
+
+    return cls
+
+
+@_inject_qtest_methods
 class QtBot(object):
-    '''
+    """
     Instances of this class are responsible for sending events to `Qt` objects (usually widgets), 
     simulating user input. 
     
@@ -103,51 +141,51 @@ class QtBot(object):
     
     .. _QTest API: http://doc.qt.digia.com/4.7/qtest.html
     
-    '''
+    """
 
     def __init__(self, app):
-        '''
+        """
         :param QApplication app: 
             The current QApplication instance.
-        '''
+        """
         self._app = app
         self._widgets = []
 
 
     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()
         self._widgets[:] = []
 
 
     def addWidget(self, widget):
-        '''
+        """
         Adds a widget to be tracked by this bot. This is not required, but will ensure that the
         widget gets closed by the end of the test, so it is highly recommended.
         
         :param QWidget widget: 
             Widget to keep track of.
-        '''
+        """
         self._widgets.append(widget)
 
 
     def waitForWindowShown(self, widget):
-        '''
+        """
         Waits until the window is shown in the screen. This is mainly useful for asynchronous 
         systems like X11, where a window will be mapped to screen some time after being asked to 
         show itself on the screen. 
         
         :param QWidget widget:
             Widget to wait on.
-        '''
+        """
         QtTest.QTest.qWaitForWindowShown(widget)
 
 
     def stopForInteraction(self):
-        '''
+        """
         Stops the current test flow, letting the user interact with any visible widget.
         
         This is mainly useful so that you can verify the current state of the program while writing
@@ -157,7 +195,7 @@ def stopForInteraction(self):
         of the widgets as they were before this call.
 
         .. note:: As a convenience, it is aliased as `stop`.
-        '''
+        """
         widget_visibility = [widget.isVisible() for widget in self._widgets]
 
         self._app.exec_()    
@@ -170,15 +208,12 @@ def stopForInteraction(self):
     stop = stopForInteraction
 
 
-#===================================================================================================
-# pytest_configure
-#===================================================================================================
 def pytest_configure(config):
-    '''
+    """
     PyTest plugin API. Called before the start of each test session.
     
     :param config.Config config:  
-    '''
+    """
     qt_app_instance = QtGui.QApplication([])
     config.qt_app_instance = qt_app_instance
 
@@ -191,56 +226,15 @@ def exit_qapp():
     config._cleanup.append(exit_qapp)
 
 
-#===================================================================================================
-# qtbot
-#===================================================================================================
 @pytest.fixture
 def qtbot(request):
-    '''
+    """
     Fixture used to create a QtBot instance for using during testing. 
     
-    Make sure to call addWidget for each top-level widget you create to ensure that they are
-    properly closed after the test ends.
-    '''
+    Make sure to call addWidget for each top-level widget you create to ensure
+    that they are properly closed after the test ends.
+    """
     result = QtBot(request.config.qt_app_instance)
     request.addfinalizer(result._close)
     return result
 
-
-
-
-#===================================================================================================
-# Inject QtTest Functions
-#===================================================================================================
-def _createQTestProxyMethod(method_name):
-    
-    def result(*args, **kwargs):
-        method = getattr(QtTest.QTest, method_name) 
-        return method(*args, **kwargs)
-    
-    result.__name__ = method_name
-    return staticmethod(result)
-
-# inject methods from QTest into QtBot
-method_names = set([
-    'keyPress',
-    'keyClick',
-    'keyClicks',
-    'keyEvent',
-    'keyPress',
-    'keyRelease',
-    'keyToAscii',
-    
-    'mouseClick',
-    'mouseDClick',
-    'mouseEvent',
-    'mouseMove',
-    'mousePress',
-    'mouseRelease',
-    
-    
-])
-for method_name in method_names:        
-    method = _createQTestProxyMethod(method_name)
-    setattr(QtBot, method_name, method)
-